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

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/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, fix_inclusion, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

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

Instance Method Details

#api_key ⇒ String

Returns Your DataDog API key.

Returns:

  • (String) —

    Your DataDog API key.



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

attribute :api_key

#app_key ⇒ String

Returns Your DataDog app key.

Returns:

  • (String) —

    Your DataDog app key.



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

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



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

attribute :escalation_message

#evaluation_delay ⇒ Object?

Returns Time to delay evaluation (in seconds). It is effective for sparse values.

Returns:

  • (Object, nil) —

    Time to delay evaluation (in seconds). It is effective for sparse values.



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

attribute :evaluation_delay

#id ⇒ Object?

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

Returns:

  • (Object, nil) —

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



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

attribute :id

#locked ⇒ :yes, ...

Returns A boolean indicating whether changes to this monitor should be restricted to the creator or admins.

Returns:

  • (:yes, :no, nil) —

    A boolean indicating whether changes to this monitor should be restricted to the creator or admins.



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

attribute :locked

#message ⇒ String?

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. Monitor message template variables can be accessed by using double square brackets, i.e ‘[[’ and ‘]]’.

Returns:

  • (String, 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. Monitor message template variables can be accessed by using double square brackets, i.e ‘[[’ and ‘]]’.



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

attribute :message

#name ⇒ String

Returns The name of the alert.

Returns:

  • (String) —

    The name of the alert.



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

attribute :name

#new_host_delay ⇒ Object?

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

Returns:

  • (Object, nil) —

    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.



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

attribute :new_host_delay

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



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

attribute :no_data_timeframe

#notify_audit ⇒ :yes, ...

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

Returns:

  • (:yes, :no, nil) —

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



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

attribute :notify_audit

#notify_no_data ⇒ :yes, ...

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

Returns:

  • (:yes, :no, nil) —

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



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

attribute :notify_no_data

#query ⇒ String?

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

Returns:

  • (String, nil) —

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



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

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.



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

attribute :renotify_interval

#require_full_window ⇒ Object?

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

Returns:

  • (Object, nil) —

    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.



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

attribute :require_full_window

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



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

attribute :silenced

#state ⇒ :present, ...

Returns The designated state of the monitor.

Returns:

  • (:present, :absent, :mute, :unmute) —

    The designated state of the monitor.



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

attribute :state

#tags ⇒ Object?

Returns A list of tags to associate with your monitor when creating or updating. This can help you categorize and filter monitors.

Returns:

  • (Object, nil) —

    A list of tags to associate with your monitor when creating or updating. This can help you categorize and filter monitors.



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

attribute :tags

#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.“]



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

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.



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

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



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

attribute :type