community.general.datadog_monitor module – Manages Datadog monitors

Note

This module is part of the community.general collection (version 5.4.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install community.general.

To use it in a playbook, specify: community.general.datadog_monitor.

Synopsis

Requirements

The below requirements are needed on the host that executes this module.

  • datadog

Parameters

Parameter

Comments

api_host

string

added in 0.2.0 of community.general

The URL to the Datadog API. Default value is https://api.datadoghq.com.

This value can also be set with the DATADOG_HOST environment variable.

api_key

string / required

Your Datadog API key.

app_key

string / required

Your Datadog app key.

escalation_message

string

A message to include with a re-notification. Supports the @username’ notification we allow elsewhere.

Not applicable if renotify_interval=None.

evaluation_delay

string

Time to delay evaluation (in seconds).

Effective for sparse values.

id

string

The ID of the alert.

If set, will be used instead of the name to locate the alert.

include_tags

boolean

added in 1.3.0 of community.general

Whether notifications from this monitor automatically inserts its triggering tags into the title.

Choices:

  • no

  • yes ← (default)

locked

boolean

Whether changes to this monitor should be restricted to the creator or admins.

Choices:

  • no ← (default)

  • yes

name

string / required

The name of the alert.

new_host_delay

string

A positive integer representing the number of seconds to wait before evaluating the monitor for new hosts.

This gives the host time to fully initialize.

no_data_timeframe

string

The number of minutes before a monitor will notify when data stops reporting.

Must be at least 2x the monitor timeframe for metric alerts or 2 minutes for service checks.

If not specified, it defaults to 2x timeframe for metric, 2 minutes for service.

notification_message

string

A message to include with notifications for this monitor.

Email notifications can be sent to specific users by using the same @username’ notation as events.

Monitor message template variables can be accessed by using double square brackets, i.e ‘[[’ and ‘]]’.

notify_audit

boolean

Whether tagged users will be notified on changes to this monitor.

Choices:

  • no ← (default)

  • yes

notify_no_data

boolean

Whether this monitor will notify when data stops reporting.

Choices:

  • no ← (default)

  • yes

priority

integer

added in 4.6.0 of community.general

Integer from 1 (high) to 5 (low) indicating alert severity.

query

string

The monitor query to notify on.

Syntax varies depending on what type of monitor you are creating.

renotify_interval

string

The number of minutes after the last notification before a monitor will re-notify on the current status.

It will only re-notify if it is not resolved.

require_full_window

boolean

Whether this monitor needs a full window of data before it gets evaluated.

We highly recommend you set this to False for sparse metrics, otherwise some evaluations will be skipped.

Choices:

  • no

  • yes

silenced

dictionary

Dictionary of scopes to silence, with timestamps or None.

Each scope will be muted until the given POSIX timestamp or forever if the value is None.

state

string / required

The designated state of the monitor.

Choices:

  • present

  • absent

  • mute

  • unmute

tags

list / elements=string

A list of tags to associate with your monitor when creating or updating.

This can help you categorize and filter monitors.

thresholds

dictionary

A dictionary of thresholds by status.

Only available for service checks and metric alerts.

Because each of them can have multiple thresholds, we do not define them directly in the query.

If not specified, it defaults to: {'ok': 1, 'critical': 1, 'warning': 1}.

timeout_h

string

The number of hours of the monitor not reporting data before it will automatically resolve from a triggered state.

type

string

The type of the monitor.

The types query alert, trace-analytics alert and rum alert were added in community.general 2.1.0.

The type composite was added in community.general 3.4.0.

Choices:

  • metric alert

  • service check

  • event alert

  • event-v2 alert

  • process alert

  • log alert

  • query alert

  • trace-analytics alert

  • rum alert

  • composite

Examples

- name: Create a metric monitor
  community.general.datadog_monitor:
    type: "metric alert"
    name: "Test monitor"
    state: "present"
    query: "datadog.agent.up.over('host:host1').last(2).count_by_status()"
    notification_message: "Host [[host.name]] with IP [[host.ip]] is failing to report to datadog."
    api_key: "9775a026f1ca7d1c6c5af9d94d9595a4"
    app_key: "87ce4a24b5553d2e482ea8a8500e71b8ad4554ff"

- name: Deletes a monitor
  community.general.datadog_monitor:
    name: "Test monitor"
    state: "absent"
    api_key: "9775a026f1ca7d1c6c5af9d94d9595a4"
    app_key: "87ce4a24b5553d2e482ea8a8500e71b8ad4554ff"

- name: Mutes a monitor
  community.general.datadog_monitor:
    name: "Test monitor"
    state: "mute"
    silenced: '{"*":None}'
    api_key: "9775a026f1ca7d1c6c5af9d94d9595a4"
    app_key: "87ce4a24b5553d2e482ea8a8500e71b8ad4554ff"

- name: Unmutes a monitor
  community.general.datadog_monitor:
    name: "Test monitor"
    state: "unmute"
    api_key: "9775a026f1ca7d1c6c5af9d94d9595a4"
    app_key: "87ce4a24b5553d2e482ea8a8500e71b8ad4554ff"

- name: Use datadoghq.eu platform instead of datadoghq.com
  community.general.datadog_monitor:
    name: "Test monitor"
    state: "absent"
    api_host: https://api.datadoghq.eu
    api_key: "9775a026f1ca7d1c6c5af9d94d9595a4"
    app_key: "87ce4a24b5553d2e482ea8a8500e71b8ad4554ff"

Authors

  • Sebastian Kornehl (@skornehl)