Class: Ansible::Ruby::Modules::Datadog_monitor

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/extras/monitoring/datadog_monitor.rb

Overview

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

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#api_key ⇒ Object

Returns Your DataDog API key.

Returns:

  • (Object) —

    Your DataDog API key.



12
 
# File 'lib/ansible/ruby/modules/generated/extras/monitoring/datadog_monitor.rb', line 12

attribute :api_key

#app_key ⇒ Object

Returns Your DataDog app key.

Returns:

  • (Object) —

    Your DataDog app key.



16
 
# File 'lib/ansible/ruby/modules/generated/extras/monitoring/datadog_monitor.rb', line 16

attribute :app_key

#escalation_message ⇒ Object?

Returns A message to include with a re-notification. Supports the ‘@username’ notification we allow elsewhere. Not applicable if renotify_interval is None.

Returns:

  • (Object, nil) —

    A message to include with a re-notification. Supports the ‘@username’ notification we allow elsewhere. Not applicable if renotify_interval is None



56
 
# File 'lib/ansible/ruby/modules/generated/extras/monitoring/datadog_monitor.rb', line 56

attribute :escalation_message

#message ⇒ Object?

Returns 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.

Returns:

  • (Object, nil) —

    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.



35
 
# File 'lib/ansible/ruby/modules/generated/extras/monitoring/datadog_monitor.rb', line 35

attribute :message

#name ⇒ Object

Returns The name of the alert.

Returns:

  • (Object) —

    The name of the alert.



31
 
# File 'lib/ansible/ruby/modules/generated/extras/monitoring/datadog_monitor.rb', line 31

attribute :name

#no_data_timeframe ⇒ Integer?

Returns 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.

Returns:

  • (Integer, nil) —

    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.



46
 
# File 'lib/ansible/ruby/modules/generated/extras/monitoring/datadog_monitor.rb', line 46

attribute :no_data_timeframe

#notify_audit ⇒ Boolean?

Returns A boolean indicating whether tagged users will be notified on changes to this monitor.

Returns:

  • (Boolean, nil) —

    A boolean indicating whether tagged users will be notified on changes to this monitor.



59
 
# File 'lib/ansible/ruby/modules/generated/extras/monitoring/datadog_monitor.rb', line 59

attribute :notify_audit

#notify_no_data ⇒ Boolean?

Returns A boolean indicating whether this monitor will notify when data stops reporting..

Returns:

  • (Boolean, nil) —

    A boolean indicating whether this monitor will notify when data stops reporting..



42
 
# File 'lib/ansible/ruby/modules/generated/extras/monitoring/datadog_monitor.rb', line 42

attribute :notify_no_data

#query ⇒ Object?

Returns The monitor query to notify on with syntax varying depending on what type of monitor you are creating.

Returns:

  • (Object, nil) —

    The monitor query to notify on with syntax varying depending on what type of monitor you are creating.



28
 
# File 'lib/ansible/ruby/modules/generated/extras/monitoring/datadog_monitor.rb', line 28

attribute :query

#renotify_interval ⇒ Object?

Returns 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.

Returns:

  • (Object, nil) —

    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.



53
 
# File 'lib/ansible/ruby/modules/generated/extras/monitoring/datadog_monitor.rb', line 53

attribute :renotify_interval

#silenced ⇒ String?

Returns Dictionary of scopes to timestamps or None. Each scope will be muted until the given POSIX timestamp or forever if the value is None.

Returns:

  • (String, nil) —

    Dictionary of scopes to timestamps or None. Each scope will be muted until the given POSIX timestamp or forever if the value is None.



38
 
# File 'lib/ansible/ruby/modules/generated/extras/monitoring/datadog_monitor.rb', line 38

attribute :silenced

#state ⇒ :present, ...

Returns The designated state of the monitor.

Returns:

  • (:present, :absent, :muted, :unmuted) —

    The designated state of the monitor.



20
 
# File 'lib/ansible/ruby/modules/generated/extras/monitoring/datadog_monitor.rb', line 20

attribute :state

#thresholds ⇒ Array<String>, ...

Returns 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.

Returns:

  • (Array<String>, String, nil) —

    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.



63
 
# File 'lib/ansible/ruby/modules/generated/extras/monitoring/datadog_monitor.rb', line 63

attribute :thresholds

#timeout_h ⇒ Object?

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

Returns:

  • (Object, nil) —

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



50
 
# File 'lib/ansible/ruby/modules/generated/extras/monitoring/datadog_monitor.rb', line 50

attribute :timeout_h

#type ⇒ :"metric alert", ...

Returns The type of the monitor.,The ‘event alert’is available starting at Ansible 2.1.

Returns:

  • (:"metric alert", :"service check", :"event alert", nil) —

    The type of the monitor.,The ‘event alert’is available starting at Ansible 2.1



24
 
# File 'lib/ansible/ruby/modules/generated/extras/monitoring/datadog_monitor.rb', line 24

attribute :type