ansible.builtin.datadog_monitor (v2.4.3.0-1) — module

Install Ansible via pip

Install with pip install ansible==2.4.3.0.post1

Description

Manages monitors within Datadog

Options like described on http://docs.datadoghq.com/api/

Requirements

• datadog

Inputs

    
id:
    default: null
    description:
    - The id of the alert. If set, will be used instead of the name to locate the alert.
    required: false
    version_added: '2.3'
    version_added_collection: ansible.builtin

name:
    description:
    - The name of the alert.
    required: true

tags:
    default: None
    description:
    - A list of tags to associate with your monitor when creating or updating. This can
      help you categorize and filter monitors.
    required: false
    version_added: '2.2'
    version_added_collection: ansible.builtin

type:
    choices:
    - metric alert
    - service check
    - event alert
    default: null
    description:
    - The type of the monitor.
    - The 'event alert'is available starting at Ansible 2.1
    required: false

query:
    default: null
    description:
    - The monitor query to notify on with syntax varying depending on what type of monitor
      you are creating.
    required: false

state:
    choices:
    - present
    - absent
    - muted
    - unmuted
    description:
    - The designated state of the monitor.
    required: true

locked:
    default: false
    description:
    - A boolean indicating whether changes to this monitor should be restricted to the
      creator or admins.
    required: false
    version_added: '2.2'
    version_added_collection: ansible.builtin

api_key:
    description:
    - Your DataDog API key.
    required: true

app_key:
    description:
    - Your DataDog app key.
    required: true

message:
    default: null
    description:
    - 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 ']]'.
    required: false

silenced:
    default: ''
    description:
    - 'Dictionary of scopes to timestamps or None. Each scope will be muted until the
      given POSIX timestamp or forever if the value is None. '
    required: false

timeout_h:
    default: null
    description:
    - The number of hours of the monitor not reporting data before it will automatically
      resolve from a triggered state.
    required: false

thresholds:
    default:
      critical: 1
      ok: 1
      warning: 1
    description:
    - A dictionary of thresholds by status. This option is only available for service
      checks and metric alerts. Because each of them can have multiple thresholds, we
      don't define them directly in the query."]
    required: false

notify_audit:
    default: false
    description:
    - A boolean indicating whether tagged users will be notified on changes to this monitor.
    required: false

new_host_delay:
    default: null
    description:
    - 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.
    required: false
    version_added: '2.4'
    version_added_collection: ansible.builtin

notify_no_data:
    default: false
    description:
    - A boolean indicating whether this monitor will notify when data stops reporting..
    required: false

no_data_timeframe:
    default: 2x timeframe for metric, 2 minutes for service
    description:
    - 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.
    required: false

renotify_interval:
    default: null
    description:
    - 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's not resolved.
    required: false

escalation_message:
    default: null
    description:
    - A message to include with a re-notification. Supports the '@username' notification
      we allow elsewhere. Not applicable if renotify_interval is None
    required: false

require_full_window:
    default: null
    description:
    - A boolean indicating whether this monitor needs a full window of data before it's
      evaluated. We highly recommend you set this to False for sparse metrics, otherwise
      some evaluations will be skipped.
    required: false
    version_added: '2.3'
    version_added_collection: ansible.builtin