Monitor

Import

Import is supported using the following syntax

 $ pulumi import datadog:index/monitor:Monitor bytes_received_localhost 2081

Create a Monitor Resource

new Monitor(name: string, args: MonitorArgs, opts?: CustomResourceOptions);

def Monitor(resource_name: str, opts: Optional[ResourceOptions] = None, enable_logs_sample: Optional[bool] = None, escalation_message: Optional[str] = None, evaluation_delay: Optional[int] = None, force_delete: Optional[bool] = None, include_tags: Optional[bool] = None, locked: Optional[bool] = None, message: Optional[str] = None, monitor_threshold_windows: Optional[MonitorMonitorThresholdWindowsArgs] = None, monitor_thresholds: Optional[MonitorMonitorThresholdsArgs] = None, name: Optional[str] = None, new_host_delay: Optional[int] = None, no_data_timeframe: Optional[int] = None, notify_audit: Optional[bool] = None, notify_no_data: Optional[bool] = None, priority: Optional[int] = None, query: Optional[str] = None, renotify_interval: Optional[int] = None, require_full_window: Optional[bool] = None, silenced: Optional[Mapping[str, Any]] = None, tags: Optional[Sequence[str]] = None, threshold_windows: Optional[MonitorThresholdWindowsArgs] = None, thresholds: Optional[MonitorThresholdsArgs] = None, timeout_h: Optional[int] = None, type: Optional[str] = None, validate: Optional[bool] = None)

func NewMonitor(ctx *Context, name string, args MonitorArgs, opts ...ResourceOption) (*Monitor, error)

public Monitor(string name, MonitorArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args MonitorArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args MonitorArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args MonitorArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

Monitor Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The Monitor resource accepts the following input properties:

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.

Name string

Name of Datadog monitor.

Query string

The monitor query to notify on. Note this is not the same query you see in the UI and the syntax is different depending on the monitor type, please see the API Reference for details. Warning: terraform plan won’t perform any validation of the query contents.

Type string

The type of the monitor. The mapping from these types to the types found in the Datadog Web UI can be found in the Datadog API documentation page. Note: The monitor type cannot be changed after a monitor is created.

EnableLogsSample bool

A boolean indicating whether or not to include a list of log values which triggered the alert. This is only used by log monitors. Defaults to false.

EscalationMessage string

A message to include with a re-notification. Supports the @username notification allowed elsewhere.

EvaluationDelay int

(Only applies to metric alert) Time (in seconds) to delay evaluation, as a non-negative integer. For example, if the value is set to 300 (5min), the timeframe is set to last_5m and the time is 7:00, the monitor will evaluate data from 6:50 to 6:55. This is useful for AWS CloudWatch and other backfilled metrics to ensure the monitor will always have data during evaluation.

ForceDelete bool

A boolean indicating whether this monitor can be deleted even if it’s referenced by other resources (e.g. SLO, composite monitor).

IncludeTags bool

A boolean indicating whether notifications from this monitor automatically insert its triggering tags into the title. Defaults to true.

Locked bool

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

MonitorThresholdWindows MonitorMonitorThresholdWindowsArgs

A mapping containing recovery_window and trigger_window values, e.g. last_15m . Can only be used for, and are required for, anomaly monitors.

MonitorThresholds MonitorMonitorThresholdsArgs

Alert thresholds of the monitor.

NewHostDelay int

Time (in seconds) to allow a host to boot and applications to fully start before starting the evaluation of monitor results. Should be a non negative integer. Defaults to 300.

NoDataTimeframe int

The number of minutes before a monitor will notify when data stops reporting. Provider defaults to 10 minutes. We recommend at least 2x the monitor timeframe for metric alerts or 2 minutes for service checks.

NotifyAudit bool

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

NotifyNoData bool

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

Priority int

RenotifyInterval int

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.

RequireFullWindow bool

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 s metrics, otherwise some evaluations will be skipped. Default: true for on average, at all times and in total aggregation. false otherwise.

Silenced Dictionary<string, object>

Each scope will be muted until the given POSIX timestamp or forever if the value is 0. Use -1 if you want to unmute the scope. Deprecated: the silenced parameter is being deprecated in favor of the downtime resource. This will be removed in the next major version of the Terraform Provider.

Deprecated: use Downtime Resource instead

Tags List<string>

A list of tags to associate with your monitor. This can help you categorize and filter monitors in the manage monitors page of the UI. Note: it’s not currently possible to filter by these tags when querying via the API

ThresholdWindows MonitorThresholdWindowsArgs

A mapping containing recovery_window and trigger_window values, e.g. last_15m. Can only be used for, and are required for, anomaly monitors.

Deprecated: Define monitor_threshold_windows list with one element instead.

Thresholds MonitorThresholdsArgs

Alert thresholds of the monitor.

Deprecated: Define monitor_thresholds list with one element instead.

TimeoutH int

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

Validate bool

If set to false, skip the validation call done during plan.

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.

Name string

Name of Datadog monitor.

Query string

Type string

EnableLogsSample bool

A boolean indicating whether or not to include a list of log values which triggered the alert. This is only used by log monitors. Defaults to false.

EscalationMessage string

A message to include with a re-notification. Supports the @username notification allowed elsewhere.

EvaluationDelay int

ForceDelete bool

A boolean indicating whether this monitor can be deleted even if it’s referenced by other resources (e.g. SLO, composite monitor).

IncludeTags bool

A boolean indicating whether notifications from this monitor automatically insert its triggering tags into the title. Defaults to true.

Locked bool

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

MonitorThresholdWindows MonitorMonitorThresholdWindows

A mapping containing recovery_window and trigger_window values, e.g. last_15m . Can only be used for, and are required for, anomaly monitors.

MonitorThresholds MonitorMonitorThresholds

Alert thresholds of the monitor.

NewHostDelay int

Time (in seconds) to allow a host to boot and applications to fully start before starting the evaluation of monitor results. Should be a non negative integer. Defaults to 300.

NoDataTimeframe int

NotifyAudit bool

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

NotifyNoData bool

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

Priority int

RenotifyInterval int

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.

RequireFullWindow bool

Silenced map[string]interface{}

Deprecated: use Downtime Resource instead

Tags []string

ThresholdWindows MonitorThresholdWindows

A mapping containing recovery_window and trigger_window values, e.g. last_15m. Can only be used for, and are required for, anomaly monitors.

Deprecated: Define monitor_threshold_windows list with one element instead.

Thresholds MonitorThresholds

Alert thresholds of the monitor.

Deprecated: Define monitor_thresholds list with one element instead.

TimeoutH int

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

Validate bool

If set to false, skip the validation call done during plan.

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.

name string

Name of Datadog monitor.

query string

type string

enableLogsSample boolean

A boolean indicating whether or not to include a list of log values which triggered the alert. This is only used by log monitors. Defaults to false.

escalationMessage string

A message to include with a re-notification. Supports the @username notification allowed elsewhere.

evaluationDelay number

forceDelete boolean

A boolean indicating whether this monitor can be deleted even if it’s referenced by other resources (e.g. SLO, composite monitor).

includeTags boolean

A boolean indicating whether notifications from this monitor automatically insert its triggering tags into the title. Defaults to true.

locked boolean

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

monitorThresholdWindows MonitorMonitorThresholdWindows

A mapping containing recovery_window and trigger_window values, e.g. last_15m . Can only be used for, and are required for, anomaly monitors.

monitorThresholds MonitorMonitorThresholds

Alert thresholds of the monitor.

newHostDelay number

Time (in seconds) to allow a host to boot and applications to fully start before starting the evaluation of monitor results. Should be a non negative integer. Defaults to 300.

noDataTimeframe number

notifyAudit boolean

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

notifyNoData boolean

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

priority number

renotifyInterval number

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.

requireFullWindow boolean

silenced {[key: string]: any}

Deprecated: use Downtime Resource instead

tags string[]

thresholdWindows MonitorThresholdWindows

A mapping containing recovery_window and trigger_window values, e.g. last_15m. Can only be used for, and are required for, anomaly monitors.

Deprecated: Define monitor_threshold_windows list with one element instead.

thresholds MonitorThresholds

Alert thresholds of the monitor.

Deprecated: Define monitor_thresholds list with one element instead.

timeoutH number

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

validate boolean

If set to false, skip the validation call done during plan.

message str

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 str

Name of Datadog monitor.

query str

type str

enable_logs_sample bool

A boolean indicating whether or not to include a list of log values which triggered the alert. This is only used by log monitors. Defaults to false.

escalation_message str

A message to include with a re-notification. Supports the @username notification allowed elsewhere.

evaluation_delay int

force_delete bool

A boolean indicating whether this monitor can be deleted even if it’s referenced by other resources (e.g. SLO, composite monitor).

include_tags bool

A boolean indicating whether notifications from this monitor automatically insert its triggering tags into the title. Defaults to true.

locked bool

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

monitor_threshold_windows MonitorMonitorThresholdWindowsArgs

A mapping containing recovery_window and trigger_window values, e.g. last_15m . Can only be used for, and are required for, anomaly monitors.

monitor_thresholds MonitorMonitorThresholdsArgs

Alert thresholds of the monitor.

new_host_delay int

Time (in seconds) to allow a host to boot and applications to fully start before starting the evaluation of monitor results. Should be a non negative integer. Defaults to 300.

no_data_timeframe int

notify_audit bool

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

notify_no_data bool

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

priority int

renotify_interval int

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.

require_full_window bool

silenced Mapping[str, Any]

Deprecated: use Downtime Resource instead

tags Sequence[str]

threshold_windows MonitorThresholdWindowsArgs

A mapping containing recovery_window and trigger_window values, e.g. last_15m. Can only be used for, and are required for, anomaly monitors.

Deprecated: Define monitor_threshold_windows list with one element instead.

thresholds MonitorThresholdsArgs

Alert thresholds of the monitor.

Deprecated: Define monitor_thresholds list with one element instead.

timeout_h int

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

validate bool

If set to false, skip the validation call done during plan.

Outputs

All input properties are implicitly available as output properties. Additionally, the Monitor resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

Look up an Existing Monitor Resource

Get an existing Monitor resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: MonitorState, opts?: CustomResourceOptions): Monitor

@staticmethod
def get(resource_name: str, id: str, opts: Optional[ResourceOptions] = None, enable_logs_sample: Optional[bool] = None, escalation_message: Optional[str] = None, evaluation_delay: Optional[int] = None, force_delete: Optional[bool] = None, include_tags: Optional[bool] = None, locked: Optional[bool] = None, message: Optional[str] = None, monitor_threshold_windows: Optional[MonitorMonitorThresholdWindowsArgs] = None, monitor_thresholds: Optional[MonitorMonitorThresholdsArgs] = None, name: Optional[str] = None, new_host_delay: Optional[int] = None, no_data_timeframe: Optional[int] = None, notify_audit: Optional[bool] = None, notify_no_data: Optional[bool] = None, priority: Optional[int] = None, query: Optional[str] = None, renotify_interval: Optional[int] = None, require_full_window: Optional[bool] = None, silenced: Optional[Mapping[str, Any]] = None, tags: Optional[Sequence[str]] = None, threshold_windows: Optional[MonitorThresholdWindowsArgs] = None, thresholds: Optional[MonitorThresholdsArgs] = None, timeout_h: Optional[int] = None, type: Optional[str] = None, validate: Optional[bool] = None) -> Monitor

func GetMonitor(ctx *Context, name string, id IDInput, state *MonitorState, opts ...ResourceOption) (*Monitor, error)

public static Monitor Get(string name, Input<string> id, MonitorState? state, CustomResourceOptions? opts = null)

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

EnableLogsSample bool

A boolean indicating whether or not to include a list of log values which triggered the alert. This is only used by log monitors. Defaults to false.

EscalationMessage string

A message to include with a re-notification. Supports the @username notification allowed elsewhere.

EvaluationDelay int

ForceDelete bool

A boolean indicating whether this monitor can be deleted even if it’s referenced by other resources (e.g. SLO, composite monitor).

IncludeTags bool

A boolean indicating whether notifications from this monitor automatically insert its triggering tags into the title. Defaults to true.

Locked bool

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

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.

MonitorThresholdWindows MonitorMonitorThresholdWindowsArgs

A mapping containing recovery_window and trigger_window values, e.g. last_15m . Can only be used for, and are required for, anomaly monitors.

MonitorThresholds MonitorMonitorThresholdsArgs

Alert thresholds of the monitor.

Name string

Name of Datadog monitor.

NewHostDelay int

Time (in seconds) to allow a host to boot and applications to fully start before starting the evaluation of monitor results. Should be a non negative integer. Defaults to 300.

NoDataTimeframe int

NotifyAudit bool

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

NotifyNoData bool

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

Priority int

Query string

RenotifyInterval int

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.

RequireFullWindow bool

Silenced Dictionary<string, object>

Deprecated: use Downtime Resource instead

Tags List<string>

ThresholdWindows MonitorThresholdWindowsArgs

A mapping containing recovery_window and trigger_window values, e.g. last_15m. Can only be used for, and are required for, anomaly monitors.

Deprecated: Define monitor_threshold_windows list with one element instead.

Thresholds MonitorThresholdsArgs

Alert thresholds of the monitor.

Deprecated: Define monitor_thresholds list with one element instead.

TimeoutH int

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

Type string

Validate bool

If set to false, skip the validation call done during plan.

EnableLogsSample bool

A boolean indicating whether or not to include a list of log values which triggered the alert. This is only used by log monitors. Defaults to false.

EscalationMessage string

A message to include with a re-notification. Supports the @username notification allowed elsewhere.

EvaluationDelay int

ForceDelete bool

A boolean indicating whether this monitor can be deleted even if it’s referenced by other resources (e.g. SLO, composite monitor).

IncludeTags bool

A boolean indicating whether notifications from this monitor automatically insert its triggering tags into the title. Defaults to true.

Locked bool

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

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.

MonitorThresholdWindows MonitorMonitorThresholdWindows

A mapping containing recovery_window and trigger_window values, e.g. last_15m . Can only be used for, and are required for, anomaly monitors.

MonitorThresholds MonitorMonitorThresholds

Alert thresholds of the monitor.

Name string

Name of Datadog monitor.

NewHostDelay int

Time (in seconds) to allow a host to boot and applications to fully start before starting the evaluation of monitor results. Should be a non negative integer. Defaults to 300.

NoDataTimeframe int

NotifyAudit bool

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

NotifyNoData bool

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

Priority int

Query string

RenotifyInterval int

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.

RequireFullWindow bool

Silenced map[string]interface{}

Deprecated: use Downtime Resource instead

Tags []string

ThresholdWindows MonitorThresholdWindows

A mapping containing recovery_window and trigger_window values, e.g. last_15m. Can only be used for, and are required for, anomaly monitors.

Deprecated: Define monitor_threshold_windows list with one element instead.

Thresholds MonitorThresholds

Alert thresholds of the monitor.

Deprecated: Define monitor_thresholds list with one element instead.

TimeoutH int

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

Type string

Validate bool

If set to false, skip the validation call done during plan.

enableLogsSample boolean

A boolean indicating whether or not to include a list of log values which triggered the alert. This is only used by log monitors. Defaults to false.

escalationMessage string

A message to include with a re-notification. Supports the @username notification allowed elsewhere.

evaluationDelay number

forceDelete boolean

A boolean indicating whether this monitor can be deleted even if it’s referenced by other resources (e.g. SLO, composite monitor).

includeTags boolean

A boolean indicating whether notifications from this monitor automatically insert its triggering tags into the title. Defaults to true.

locked boolean

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

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.

monitorThresholdWindows MonitorMonitorThresholdWindows

A mapping containing recovery_window and trigger_window values, e.g. last_15m . Can only be used for, and are required for, anomaly monitors.

monitorThresholds MonitorMonitorThresholds

Alert thresholds of the monitor.

name string

Name of Datadog monitor.

newHostDelay number

Time (in seconds) to allow a host to boot and applications to fully start before starting the evaluation of monitor results. Should be a non negative integer. Defaults to 300.

noDataTimeframe number

notifyAudit boolean

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

notifyNoData boolean

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

priority number

query string

renotifyInterval number

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.

requireFullWindow boolean

silenced {[key: string]: any}

Deprecated: use Downtime Resource instead

tags string[]

thresholdWindows MonitorThresholdWindows

A mapping containing recovery_window and trigger_window values, e.g. last_15m. Can only be used for, and are required for, anomaly monitors.

Deprecated: Define monitor_threshold_windows list with one element instead.

thresholds MonitorThresholds

Alert thresholds of the monitor.

Deprecated: Define monitor_thresholds list with one element instead.

timeoutH number

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

type string

validate boolean

If set to false, skip the validation call done during plan.

enable_logs_sample bool

A boolean indicating whether or not to include a list of log values which triggered the alert. This is only used by log monitors. Defaults to false.

escalation_message str

A message to include with a re-notification. Supports the @username notification allowed elsewhere.

evaluation_delay int

force_delete bool

A boolean indicating whether this monitor can be deleted even if it’s referenced by other resources (e.g. SLO, composite monitor).

include_tags bool

A boolean indicating whether notifications from this monitor automatically insert its triggering tags into the title. Defaults to true.

locked bool

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

message str

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_threshold_windows MonitorMonitorThresholdWindowsArgs

A mapping containing recovery_window and trigger_window values, e.g. last_15m . Can only be used for, and are required for, anomaly monitors.

monitor_thresholds MonitorMonitorThresholdsArgs

Alert thresholds of the monitor.

name str

Name of Datadog monitor.

new_host_delay int

Time (in seconds) to allow a host to boot and applications to fully start before starting the evaluation of monitor results. Should be a non negative integer. Defaults to 300.

no_data_timeframe int

notify_audit bool