Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/serverless-framework-configuration/_shared/latest--datadog-monitors-monitor.json
Parent schema serverless-framework-configuration
Type: object

Datadog Monitor 4.6.0. Source:- No source definition found, add manually please

Properties

Query string | Aws_CF_FunctionString required

The monitor query

Type string | Aws_CF_FunctionString required

The type of the monitor

Message string | Aws_CF_FunctionString

A message to include with notifications for the monitor

Name string | Aws_CF_FunctionString

Name of the monitor

Tags string[]

Tags associated with the monitor

Priority integer

Integer from 1 (high) to 5 (low) indicating alert severity.

Options object
21 nested properties
EnableLogsSample boolean

Whether or not to include a sample of the logs

EscalationMessage string | Aws_CF_FunctionString

Message to include with a re-notification when renotify_interval is set

EvaluationDelay integer

Time in seconds to delay evaluation

IncludeTags boolean

Whether or not to include triggering tags into notification title

Default: true
Locked boolean

Whether or not changes to this monitor should be restricted to the creator or admins

MinLocationFailed integer

Number of locations allowed to fail before triggering alert

NewHostDelay integer

Time in seconds to allow a host to start reporting data before starting the evaluation of monitor results

Default: 300
NoDataTimeframe integer

Number of minutes data stopped reporting before notifying

NotifyAudit boolean

Whether or not to notify tagged users when changes are made to the monitor

NotifyNoData boolean

Whether or not to notify when data stops reporting

RenotifyInterval integer

Number of minutes after the last notification before the monitor re-notifies on the current status

RequireFullWindow boolean

Whether or not the monitor requires a full window of data before it is evaluated

SyntheticsCheckID integer

ID of the corresponding synthetics check

Thresholds object
5 nested properties
Critical number

Threshold value for triggering an alert

CriticalRecovery number

Threshold value for recovering from an alert state

OK number

Threshold value for recovering from an alert state

Warning number

Threshold value for triggering a warning

WarningRecovery number

Threshold value for recovering from a warning state

ThresholdWindows object
2 nested properties
TriggerWindow string | Aws_CF_FunctionString

How long a metric must be anomalous before triggering an alert

RecoveryWindow string | Aws_CF_FunctionString

How long an anomalous metric must be normal before recovering from an alert state

TimeoutH integer

Number of hours of the monitor not reporting data before it automatically resolves

RenotifyOccurrences integer

The number of times re-notification messages should be sent on the current status at the provided re-notification interval.

RenotifyStatuses string[]

The types of monitor statuses for which re-notification messages are sent.

MinFailureDuration integer

How long the test should be in failure before alerting (integer, number of seconds, max 7200).

min=0max=7200
NewGroupDelay integer

Time (in seconds) to skip evaluations for new groups. For example, this option can be used to skip evaluations for new hosts while they initialize. Must be a non negative integer.

min=0
Variables MonitorFormulaAndFunctionEventQueryDefinition[]

List of requests that can be used in the monitor query.

Multi boolean

Whether or not the monitor is multi alert

RestrictedRoles string[]

A list of unique role identifiers to define which roles are allowed to edit the monitor. The unique identifiers for all roles can be pulled from the Roles API and are located in the data.id field. Editing a monitor includes any updates to the monitor configuration, monitor deletion, and muting of the monitor for any amount of time. restricted_roles is the successor of locked. For more information about locked and restricted_roles, see the monitor options docs.

Definitions

Creator object
Name string | Aws_CF_FunctionString

Name of the creator of the monitor

Handle string | Aws_CF_FunctionString

Handle of the creator of the monitor

Email string | Aws_CF_FunctionString

Email of the creator of the monitor

MonitorThresholds object
Critical number

Threshold value for triggering an alert

CriticalRecovery number

Threshold value for recovering from an alert state

OK number

Threshold value for recovering from an alert state

Warning number

Threshold value for triggering a warning

WarningRecovery number

Threshold value for recovering from a warning state

MonitorThresholdWindows object
TriggerWindow string | Aws_CF_FunctionString

How long a metric must be anomalous before triggering an alert

RecoveryWindow string | Aws_CF_FunctionString

How long an anomalous metric must be normal before recovering from an alert state

MonitorOptions object
EnableLogsSample boolean

Whether or not to include a sample of the logs

EscalationMessage string | Aws_CF_FunctionString

Message to include with a re-notification when renotify_interval is set

EvaluationDelay integer

Time in seconds to delay evaluation

IncludeTags boolean

Whether or not to include triggering tags into notification title

Default: true
Locked boolean

Whether or not changes to this monitor should be restricted to the creator or admins

MinLocationFailed integer

Number of locations allowed to fail before triggering alert

NewHostDelay integer

Time in seconds to allow a host to start reporting data before starting the evaluation of monitor results

Default: 300
NoDataTimeframe integer

Number of minutes data stopped reporting before notifying

NotifyAudit boolean

Whether or not to notify tagged users when changes are made to the monitor

NotifyNoData boolean

Whether or not to notify when data stops reporting

RenotifyInterval integer

Number of minutes after the last notification before the monitor re-notifies on the current status

RequireFullWindow boolean

Whether or not the monitor requires a full window of data before it is evaluated

SyntheticsCheckID integer

ID of the corresponding synthetics check

Thresholds object
5 nested properties
Critical number

Threshold value for triggering an alert

CriticalRecovery number

Threshold value for recovering from an alert state

OK number

Threshold value for recovering from an alert state

Warning number

Threshold value for triggering a warning

WarningRecovery number

Threshold value for recovering from a warning state

ThresholdWindows object
2 nested properties
TriggerWindow string | Aws_CF_FunctionString

How long a metric must be anomalous before triggering an alert

RecoveryWindow string | Aws_CF_FunctionString

How long an anomalous metric must be normal before recovering from an alert state

TimeoutH integer

Number of hours of the monitor not reporting data before it automatically resolves

RenotifyOccurrences integer

The number of times re-notification messages should be sent on the current status at the provided re-notification interval.

RenotifyStatuses string[]

The types of monitor statuses for which re-notification messages are sent.

MinFailureDuration integer

How long the test should be in failure before alerting (integer, number of seconds, max 7200).

min=0max=7200
NewGroupDelay integer

Time (in seconds) to skip evaluations for new groups. For example, this option can be used to skip evaluations for new hosts while they initialize. Must be a non negative integer.

min=0
Variables MonitorFormulaAndFunctionEventQueryDefinition[]

List of requests that can be used in the monitor query.

MonitorFormulaAndFunctionEventQueryDefinition object

A formula and functions events query.

DataSource string | Aws_CF_FunctionString required

Data source for event platform-based queries.

Compute object required

Compute options.

3 nested properties
Aggregation string | Aws_CF_FunctionString required

Data source for event platform-based queries.

Interval integer

A time interval in milliseconds.

min=0
Metric string | Aws_CF_FunctionString

Measurable attribute to compute.

Name string | Aws_CF_FunctionString required

Name of the monitor

Search object

Search options.

1 nested properties
Query string | Aws_CF_FunctionString required

The monitor query.

Indexes string[]

An array of index names to query in the stream. Omit or use [] to query all indexes at once.

MonitorFormulaAndFunctionEventsDataSource string | Aws_CF_FunctionString

Data source for event platform-based queries.

MonitorFormulaAndFunctionEventAggregation string | Aws_CF_FunctionString

Data source for event platform-based queries.

MonitorFormulaAndFunctionEventQueryGroupBy object

Credentials for the Datadog API

Facet string | Aws_CF_FunctionString required

Event facet.

Limit integer

Event facet.

Sort object

Options for sorting group by results.

3 nested properties
Aggregation string | Aws_CF_FunctionString required

Data source for event platform-based queries.

Metric string | Aws_CF_FunctionString

Options for sorting group by results.

Order string | Aws_CF_FunctionString

Direction of sort.

DatadogCredentials object

Credentials for the Datadog API

ApiKey string | Aws_CF_FunctionString required

Datadog API key

ApplicationKey string | Aws_CF_FunctionString required

Datadog application key

ApiURL string | Aws_CF_FunctionString

Datadog API URL (defaults to https://api.datadoghq.com) Use https://api.datadoghq.eu for EU accounts.