Documentation

datadog_monitor - Manages Datadog monitors

New in version 2.0.

Synopsis

Manages monitors within Datadog Options like described on http://docs.datadoghq.com/api/

Requirements (on host that executes module)

  • datadog

Options

parameter required default choices comments
api_key
 yes
    Your DataDog API key.
    app_key
    		 yes
      Your DataDog app key.
      escalation_message
      		 no
        A message to include with a re-notification. Supports the '@username' notification we allow elsewhere. Not applicable if renotify_interval is None
        message
        		 no
          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.
          name
          		 yes
            The name of the alert.
            no_data_timeframe
            		 no 2x timeframe for metric, 2 minutes for service
              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.
              notify_audit
              		 no
                A boolean indicating whether tagged users will be notified on changes to this monitor.
                notify_no_data
                		 no
                  A boolean indicating whether this monitor will notify when data stops reporting..
                  query
                  		 no
                    The monitor query to notify on with syntax varying depending on what type of monitor you are creating.
                    renotify_interval
                    		 no
                      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.
                      silenced
                      		 no
                        Dictionary of scopes to timestamps or None. Each scope will be muted until the given POSIX timestamp or forever if the value is None.
                        state
                        		 yes
                        • present
                        • absent
                        • muted
                        • unmuted
                        The designated state of the monitor.
                        thresholds
                        		 no {u'warning': 1, u'ok': 1, u'critical': 1}
                          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.
                          timeout_h
                          		 no
                            The number of hours of the monitor not reporting data before it will automatically resolve from a triggered state.
                            type
                            		 no
                            • metric alert
                            • service check
                            • event alert
                            The type of the monitor.
                            The 'event alert'is available starting at Ansible 2.1

                            Examples

                            # Create a metric monitor
datadog_monitor:
  type: "metric alert"
  name: "Test monitor"
  state: "present"
  query: "datadog.agent.up".over("host:host1").last(2).count_by_status()"
  message: "Some message."
  api_key: "9775a026f1ca7d1c6c5af9d94d9595a4"
  app_key: "87ce4a24b5553d2e482ea8a8500e71b8ad4554ff"

# Deletes a monitor
datadog_monitor:
  name: "Test monitor"
  state: "absent"
  api_key: "9775a026f1ca7d1c6c5af9d94d9595a4"
  app_key: "87ce4a24b5553d2e482ea8a8500e71b8ad4554ff"

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

# Unmutes a monitor
datadog_monitor:
  name: "Test monitor"
  state: "unmute"
  api_key: "9775a026f1ca7d1c6c5af9d94d9595a4"
  app_key: "87ce4a24b5553d2e482ea8a8500e71b8ad4554ff"

                            This is an Extras Module

                            For more information on what this means please read Extras Modules

                            For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.