Datadog v4.34.0 published on Friday, Oct 4, 2024 by Pulumi
datadog.getMonitor
Explore with Pulumi AI
Use this data source to retrieve information about an existing monitor for use in other resources.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as datadog from "@pulumi/datadog";
const test = datadog.getMonitor({
nameFilter: "My awesome monitor",
monitorTagsFilters: ["foo:bar"],
});
import pulumi
import pulumi_datadog as datadog
test = datadog.get_monitor(name_filter="My awesome monitor",
monitor_tags_filters=["foo:bar"])
package main
import (
"github.com/pulumi/pulumi-datadog/sdk/v4/go/datadog"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := datadog.LookupMonitor(ctx, &datadog.LookupMonitorArgs{
NameFilter: pulumi.StringRef("My awesome monitor"),
MonitorTagsFilters: []string{
"foo:bar",
},
}, nil)
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Datadog = Pulumi.Datadog;
return await Deployment.RunAsync(() =>
{
var test = Datadog.GetMonitor.Invoke(new()
{
NameFilter = "My awesome monitor",
MonitorTagsFilters = new[]
{
"foo:bar",
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.datadog.DatadogFunctions;
import com.pulumi.datadog.inputs.GetMonitorArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var test = DatadogFunctions.getMonitor(GetMonitorArgs.builder()
.nameFilter("My awesome monitor")
.monitorTagsFilters("foo:bar")
.build());
}
}
variables:
test:
fn::invoke:
Function: datadog:getMonitor
Arguments:
nameFilter: My awesome monitor
monitorTagsFilters:
- foo:bar
Using getMonitor
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getMonitor(args: GetMonitorArgs, opts?: InvokeOptions): Promise<GetMonitorResult>
function getMonitorOutput(args: GetMonitorOutputArgs, opts?: InvokeOptions): Output<GetMonitorResult>
def get_monitor(monitor_tags_filters: Optional[Sequence[str]] = None,
name_filter: Optional[str] = None,
tags_filters: Optional[Sequence[str]] = None,
opts: Optional[InvokeOptions] = None) -> GetMonitorResult
def get_monitor_output(monitor_tags_filters: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
name_filter: Optional[pulumi.Input[str]] = None,
tags_filters: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetMonitorResult]
func LookupMonitor(ctx *Context, args *LookupMonitorArgs, opts ...InvokeOption) (*LookupMonitorResult, error)
func LookupMonitorOutput(ctx *Context, args *LookupMonitorOutputArgs, opts ...InvokeOption) LookupMonitorResultOutput
> Note: This function is named LookupMonitor
in the Go SDK.
public static class GetMonitor
{
public static Task<GetMonitorResult> InvokeAsync(GetMonitorArgs args, InvokeOptions? opts = null)
public static Output<GetMonitorResult> Invoke(GetMonitorInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetMonitorResult> getMonitor(GetMonitorArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: datadog:index/getMonitor:getMonitor
arguments:
# arguments dictionary
The following arguments are supported:
- List<string>
- A list of monitor tags to limit the search. This filters on the tags set on the monitor itself.
- Name
Filter string - A monitor name to limit the search.
- List<string>
- A list of tags to limit the search. This filters on the monitor scope.
- []string
- A list of monitor tags to limit the search. This filters on the tags set on the monitor itself.
- Name
Filter string - A monitor name to limit the search.
- []string
- A list of tags to limit the search. This filters on the monitor scope.
- List<String>
- A list of monitor tags to limit the search. This filters on the tags set on the monitor itself.
- name
Filter String - A monitor name to limit the search.
- List<String>
- A list of tags to limit the search. This filters on the monitor scope.
- string[]
- A list of monitor tags to limit the search. This filters on the tags set on the monitor itself.
- name
Filter string - A monitor name to limit the search.
- string[]
- A list of tags to limit the search. This filters on the monitor scope.
- Sequence[str]
- A list of monitor tags to limit the search. This filters on the tags set on the monitor itself.
- name_
filter str - A monitor name to limit the search.
- Sequence[str]
- A list of tags to limit the search. This filters on the monitor scope.
- List<String>
- A list of monitor tags to limit the search. This filters on the tags set on the monitor itself.
- name
Filter String - A monitor name to limit the search.
- List<String>
- A list of tags to limit the search. This filters on the monitor scope.
getMonitor Result
The following output properties are available:
- Enable
Logs boolSample - Whether or not a list of log values which triggered the alert is included. This is only used by log monitors.
- Enable
Samples bool - Whether or not a list of samples which triggered the alert is included. This is only used by CI Test and Pipeline monitors.
- Escalation
Message string - Message included with a re-notification for this monitor.
- Evaluation
Delay int - Time (in seconds) for which evaluation is delayed. This is only used by metric monitors.
- Group
Retention stringDuration - The time span after which groups with missing data are dropped from the monitor state. The minimum value is one hour, and the maximum value is 72 hours. Example values are: 60m, 1h, and 2d. This option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors.
- Groupby
Simple boolMonitor - Whether or not to trigger one alert if any source breaches a threshold.
- Id string
- The provider-assigned unique ID for this managed resource.
- bool
- Whether or not notifications from the monitor automatically inserts its triggering tags into the title.
- Locked bool
- Whether or not changes to the monitor are restricted to the creator or admins.
- Message string
- Message included with notifications for this monitor
- Monitor
Threshold List<GetWindows Monitor Monitor Threshold Window> - Mapping containing
recovery_window
andtrigger_window
values, e.g.last_15m
. This is only used by anomaly monitors. - Monitor
Thresholds List<GetMonitor Monitor Threshold> - Alert thresholds of the monitor.
- Name string
- Name of the monitor
- New
Group intDelay - Time (in seconds) to skip evaluations for new groups.
- New
Host intDelay - Time (in seconds) allowing a host to boot and applications to fully start before starting the evaluation of monitor results.
- No
Data intTimeframe - The number of minutes before the monitor notifies when data stops reporting.
- Notification
Preset stringName - Toggles the display of additional content sent in the monitor notification. Valid values are:
show_all
,hide_query
,hide_handles
, andhide_all
. - Notify
Audit bool - Whether or not tagged users are notified on changes to the monitor.
- Notify
Bies List<string> - Controls what granularity a monitor alerts on. Only available for monitors with groupings. For instance, a monitor grouped by
cluster
,namespace
, andpod
can be configured to only notify on each newcluster
violating the alert conditions by settingnotify_by
to['cluster']
. Tags mentioned innotify_by
must be a subset of the grouping tags in the query. For example, a query grouped bycluster
andnamespace
cannot notify onregion
. Settingnotify_by
to[*]
configures the monitor to notify as a simple-alert. - Notify
No boolData - Whether or not this monitor notifies when data stops reporting.
- On
Missing stringData - Controls how groups or monitors are treated if an evaluation does not return any data points. The default option results in different behavior depending on the monitor query type. For monitors using
Count
queries, an empty monitor evaluation is treated as 0 and is compared to the threshold conditions. For monitors using any query type other thanCount
, for exampleGauge
,Measure
, orRate
, the monitor shows the last known status. This option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors. Valid values are:show_no_data
,show_and_notify_no_data
,resolve
, anddefault
. - Query string
- Query of the monitor.
- Renotify
Interval int - The number of minutes after the last notification before the monitor re-notifies on the current status.
- Renotify
Occurrences int - The number of re-notification messages that should be sent on the current status.
- Renotify
Statuses List<string> - The types of statuses for which re-notification messages should be sent. Valid values are
alert
,warn
,no data
. - Require
Full boolWindow - Whether or not the monitor needs a full window of data before it is evaluated.
- Restricted
Roles List<string> - Scheduling
Options List<GetMonitor Scheduling Option> - Configuration options for scheduling.
- List<string>
- List of tags associated with the monitor.
- Timeout
H int - Number of hours of the monitor not reporting data before it automatically resolves from a triggered state.
- Type string
- Type of the monitor.
- List<string>
- A list of monitor tags to limit the search. This filters on the tags set on the monitor itself.
- Name
Filter string - A monitor name to limit the search.
- List<string>
- A list of tags to limit the search. This filters on the monitor scope.
- Enable
Logs boolSample - Whether or not a list of log values which triggered the alert is included. This is only used by log monitors.
- Enable
Samples bool - Whether or not a list of samples which triggered the alert is included. This is only used by CI Test and Pipeline monitors.
- Escalation
Message string - Message included with a re-notification for this monitor.
- Evaluation
Delay int - Time (in seconds) for which evaluation is delayed. This is only used by metric monitors.
- Group
Retention stringDuration - The time span after which groups with missing data are dropped from the monitor state. The minimum value is one hour, and the maximum value is 72 hours. Example values are: 60m, 1h, and 2d. This option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors.
- Groupby
Simple boolMonitor - Whether or not to trigger one alert if any source breaches a threshold.
- Id string
- The provider-assigned unique ID for this managed resource.
- bool
- Whether or not notifications from the monitor automatically inserts its triggering tags into the title.
- Locked bool
- Whether or not changes to the monitor are restricted to the creator or admins.
- Message string
- Message included with notifications for this monitor
- Monitor
Threshold []GetWindows Monitor Monitor Threshold Window - Mapping containing
recovery_window
andtrigger_window
values, e.g.last_15m
. This is only used by anomaly monitors. - Monitor
Thresholds []GetMonitor Monitor Threshold - Alert thresholds of the monitor.
- Name string
- Name of the monitor
- New
Group intDelay - Time (in seconds) to skip evaluations for new groups.
- New
Host intDelay - Time (in seconds) allowing a host to boot and applications to fully start before starting the evaluation of monitor results.
- No
Data intTimeframe - The number of minutes before the monitor notifies when data stops reporting.
- Notification
Preset stringName - Toggles the display of additional content sent in the monitor notification. Valid values are:
show_all
,hide_query
,hide_handles
, andhide_all
. - Notify
Audit bool - Whether or not tagged users are notified on changes to the monitor.
- Notify
Bies []string - Controls what granularity a monitor alerts on. Only available for monitors with groupings. For instance, a monitor grouped by
cluster
,namespace
, andpod
can be configured to only notify on each newcluster
violating the alert conditions by settingnotify_by
to['cluster']
. Tags mentioned innotify_by
must be a subset of the grouping tags in the query. For example, a query grouped bycluster
andnamespace
cannot notify onregion
. Settingnotify_by
to[*]
configures the monitor to notify as a simple-alert. - Notify
No boolData - Whether or not this monitor notifies when data stops reporting.
- On
Missing stringData - Controls how groups or monitors are treated if an evaluation does not return any data points. The default option results in different behavior depending on the monitor query type. For monitors using
Count
queries, an empty monitor evaluation is treated as 0 and is compared to the threshold conditions. For monitors using any query type other thanCount
, for exampleGauge
,Measure
, orRate
, the monitor shows the last known status. This option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors. Valid values are:show_no_data
,show_and_notify_no_data
,resolve
, anddefault
. - Query string
- Query of the monitor.
- Renotify
Interval int - The number of minutes after the last notification before the monitor re-notifies on the current status.
- Renotify
Occurrences int - The number of re-notification messages that should be sent on the current status.
- Renotify
Statuses []string - The types of statuses for which re-notification messages should be sent. Valid values are
alert
,warn
,no data
. - Require
Full boolWindow - Whether or not the monitor needs a full window of data before it is evaluated.
- Restricted
Roles []string - Scheduling
Options []GetMonitor Scheduling Option - Configuration options for scheduling.
- []string
- List of tags associated with the monitor.
- Timeout
H int - Number of hours of the monitor not reporting data before it automatically resolves from a triggered state.
- Type string
- Type of the monitor.
- []string
- A list of monitor tags to limit the search. This filters on the tags set on the monitor itself.
- Name
Filter string - A monitor name to limit the search.
- []string
- A list of tags to limit the search. This filters on the monitor scope.
- enable
Logs BooleanSample - Whether or not a list of log values which triggered the alert is included. This is only used by log monitors.
- enable
Samples Boolean - Whether or not a list of samples which triggered the alert is included. This is only used by CI Test and Pipeline monitors.
- escalation
Message String - Message included with a re-notification for this monitor.
- evaluation
Delay Integer - Time (in seconds) for which evaluation is delayed. This is only used by metric monitors.
- group
Retention StringDuration - The time span after which groups with missing data are dropped from the monitor state. The minimum value is one hour, and the maximum value is 72 hours. Example values are: 60m, 1h, and 2d. This option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors.
- groupby
Simple BooleanMonitor - Whether or not to trigger one alert if any source breaches a threshold.
- id String
- The provider-assigned unique ID for this managed resource.
- Boolean
- Whether or not notifications from the monitor automatically inserts its triggering tags into the title.
- locked Boolean
- Whether or not changes to the monitor are restricted to the creator or admins.
- message String
- Message included with notifications for this monitor
- monitor
Threshold List<GetWindows Monitor Monitor Threshold Window> - Mapping containing
recovery_window
andtrigger_window
values, e.g.last_15m
. This is only used by anomaly monitors. - monitor
Thresholds List<GetMonitor Monitor Threshold> - Alert thresholds of the monitor.
- name String
- Name of the monitor
- new
Group IntegerDelay - Time (in seconds) to skip evaluations for new groups.
- new
Host IntegerDelay - Time (in seconds) allowing a host to boot and applications to fully start before starting the evaluation of monitor results.
- no
Data IntegerTimeframe - The number of minutes before the monitor notifies when data stops reporting.
- notification
Preset StringName - Toggles the display of additional content sent in the monitor notification. Valid values are:
show_all
,hide_query
,hide_handles
, andhide_all
. - notify
Audit Boolean - Whether or not tagged users are notified on changes to the monitor.
- notify
Bies List<String> - Controls what granularity a monitor alerts on. Only available for monitors with groupings. For instance, a monitor grouped by
cluster
,namespace
, andpod
can be configured to only notify on each newcluster
violating the alert conditions by settingnotify_by
to['cluster']
. Tags mentioned innotify_by
must be a subset of the grouping tags in the query. For example, a query grouped bycluster
andnamespace
cannot notify onregion
. Settingnotify_by
to[*]
configures the monitor to notify as a simple-alert. - notify
No BooleanData - Whether or not this monitor notifies when data stops reporting.
- on
Missing StringData - Controls how groups or monitors are treated if an evaluation does not return any data points. The default option results in different behavior depending on the monitor query type. For monitors using
Count
queries, an empty monitor evaluation is treated as 0 and is compared to the threshold conditions. For monitors using any query type other thanCount
, for exampleGauge
,Measure
, orRate
, the monitor shows the last known status. This option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors. Valid values are:show_no_data
,show_and_notify_no_data
,resolve
, anddefault
. - query String
- Query of the monitor.
- renotify
Interval Integer - The number of minutes after the last notification before the monitor re-notifies on the current status.
- renotify
Occurrences Integer - The number of re-notification messages that should be sent on the current status.
- renotify
Statuses List<String> - The types of statuses for which re-notification messages should be sent. Valid values are
alert
,warn
,no data
. - require
Full BooleanWindow - Whether or not the monitor needs a full window of data before it is evaluated.
- restricted
Roles List<String> - scheduling
Options List<GetMonitor Scheduling Option> - Configuration options for scheduling.
- List<String>
- List of tags associated with the monitor.
- timeout
H Integer - Number of hours of the monitor not reporting data before it automatically resolves from a triggered state.
- type String
- Type of the monitor.
- List<String>
- A list of monitor tags to limit the search. This filters on the tags set on the monitor itself.
- name
Filter String - A monitor name to limit the search.
- List<String>
- A list of tags to limit the search. This filters on the monitor scope.
- enable
Logs booleanSample - Whether or not a list of log values which triggered the alert is included. This is only used by log monitors.
- enable
Samples boolean - Whether or not a list of samples which triggered the alert is included. This is only used by CI Test and Pipeline monitors.
- escalation
Message string - Message included with a re-notification for this monitor.
- evaluation
Delay number - Time (in seconds) for which evaluation is delayed. This is only used by metric monitors.
- group
Retention stringDuration - The time span after which groups with missing data are dropped from the monitor state. The minimum value is one hour, and the maximum value is 72 hours. Example values are: 60m, 1h, and 2d. This option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors.
- groupby
Simple booleanMonitor - Whether or not to trigger one alert if any source breaches a threshold.
- id string
- The provider-assigned unique ID for this managed resource.
- boolean
- Whether or not notifications from the monitor automatically inserts its triggering tags into the title.
- locked boolean
- Whether or not changes to the monitor are restricted to the creator or admins.
- message string
- Message included with notifications for this monitor
- monitor
Threshold GetWindows Monitor Monitor Threshold Window[] - Mapping containing
recovery_window
andtrigger_window
values, e.g.last_15m
. This is only used by anomaly monitors. - monitor
Thresholds GetMonitor Monitor Threshold[] - Alert thresholds of the monitor.
- name string
- Name of the monitor
- new
Group numberDelay - Time (in seconds) to skip evaluations for new groups.
- new
Host numberDelay - Time (in seconds) allowing a host to boot and applications to fully start before starting the evaluation of monitor results.
- no
Data numberTimeframe - The number of minutes before the monitor notifies when data stops reporting.
- notification
Preset stringName - Toggles the display of additional content sent in the monitor notification. Valid values are:
show_all
,hide_query
,hide_handles
, andhide_all
. - notify
Audit boolean - Whether or not tagged users are notified on changes to the monitor.
- notify
Bies string[] - Controls what granularity a monitor alerts on. Only available for monitors with groupings. For instance, a monitor grouped by
cluster
,namespace
, andpod
can be configured to only notify on each newcluster
violating the alert conditions by settingnotify_by
to['cluster']
. Tags mentioned innotify_by
must be a subset of the grouping tags in the query. For example, a query grouped bycluster
andnamespace
cannot notify onregion
. Settingnotify_by
to[*]
configures the monitor to notify as a simple-alert. - notify
No booleanData - Whether or not this monitor notifies when data stops reporting.
- on
Missing stringData - Controls how groups or monitors are treated if an evaluation does not return any data points. The default option results in different behavior depending on the monitor query type. For monitors using
Count
queries, an empty monitor evaluation is treated as 0 and is compared to the threshold conditions. For monitors using any query type other thanCount
, for exampleGauge
,Measure
, orRate
, the monitor shows the last known status. This option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors. Valid values are:show_no_data
,show_and_notify_no_data
,resolve
, anddefault
. - query string
- Query of the monitor.
- renotify
Interval number - The number of minutes after the last notification before the monitor re-notifies on the current status.
- renotify
Occurrences number - The number of re-notification messages that should be sent on the current status.
- renotify
Statuses string[] - The types of statuses for which re-notification messages should be sent. Valid values are
alert
,warn
,no data
. - require
Full booleanWindow - Whether or not the monitor needs a full window of data before it is evaluated.
- restricted
Roles string[] - scheduling
Options GetMonitor Scheduling Option[] - Configuration options for scheduling.
- string[]
- List of tags associated with the monitor.
- timeout
H number - Number of hours of the monitor not reporting data before it automatically resolves from a triggered state.
- type string
- Type of the monitor.
- string[]
- A list of monitor tags to limit the search. This filters on the tags set on the monitor itself.
- name
Filter string - A monitor name to limit the search.
- string[]
- A list of tags to limit the search. This filters on the monitor scope.
- enable_
logs_ boolsample - Whether or not a list of log values which triggered the alert is included. This is only used by log monitors.
- enable_
samples bool - Whether or not a list of samples which triggered the alert is included. This is only used by CI Test and Pipeline monitors.
- escalation_
message str - Message included with a re-notification for this monitor.
- evaluation_
delay int - Time (in seconds) for which evaluation is delayed. This is only used by metric monitors.
- group_
retention_ strduration - The time span after which groups with missing data are dropped from the monitor state. The minimum value is one hour, and the maximum value is 72 hours. Example values are: 60m, 1h, and 2d. This option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors.
- groupby_
simple_ boolmonitor - Whether or not to trigger one alert if any source breaches a threshold.
- id str
- The provider-assigned unique ID for this managed resource.
- bool
- Whether or not notifications from the monitor automatically inserts its triggering tags into the title.
- locked bool
- Whether or not changes to the monitor are restricted to the creator or admins.
- message str
- Message included with notifications for this monitor
- monitor_
threshold_ Sequence[Getwindows Monitor Monitor Threshold Window] - Mapping containing
recovery_window
andtrigger_window
values, e.g.last_15m
. This is only used by anomaly monitors. - monitor_
thresholds Sequence[GetMonitor Monitor Threshold] - Alert thresholds of the monitor.
- name str
- Name of the monitor
- new_
group_ intdelay - Time (in seconds) to skip evaluations for new groups.
- new_
host_ intdelay - Time (in seconds) allowing a host to boot and applications to fully start before starting the evaluation of monitor results.
- no_
data_ inttimeframe - The number of minutes before the monitor notifies when data stops reporting.
- notification_
preset_ strname - Toggles the display of additional content sent in the monitor notification. Valid values are:
show_all
,hide_query
,hide_handles
, andhide_all
. - notify_
audit bool - Whether or not tagged users are notified on changes to the monitor.
- notify_
bies Sequence[str] - Controls what granularity a monitor alerts on. Only available for monitors with groupings. For instance, a monitor grouped by
cluster
,namespace
, andpod
can be configured to only notify on each newcluster
violating the alert conditions by settingnotify_by
to['cluster']
. Tags mentioned innotify_by
must be a subset of the grouping tags in the query. For example, a query grouped bycluster
andnamespace
cannot notify onregion
. Settingnotify_by
to[*]
configures the monitor to notify as a simple-alert. - notify_
no_ booldata - Whether or not this monitor notifies when data stops reporting.
- on_
missing_ strdata - Controls how groups or monitors are treated if an evaluation does not return any data points. The default option results in different behavior depending on the monitor query type. For monitors using
Count
queries, an empty monitor evaluation is treated as 0 and is compared to the threshold conditions. For monitors using any query type other thanCount
, for exampleGauge
,Measure
, orRate
, the monitor shows the last known status. This option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors. Valid values are:show_no_data
,show_and_notify_no_data
,resolve
, anddefault
. - query str
- Query of the monitor.
- renotify_
interval int - The number of minutes after the last notification before the monitor re-notifies on the current status.
- renotify_
occurrences int - The number of re-notification messages that should be sent on the current status.
- renotify_
statuses Sequence[str] - The types of statuses for which re-notification messages should be sent. Valid values are
alert
,warn
,no data
. - require_
full_ boolwindow - Whether or not the monitor needs a full window of data before it is evaluated.
- restricted_
roles Sequence[str] - scheduling_
options Sequence[GetMonitor Scheduling Option] - Configuration options for scheduling.
- Sequence[str]
- List of tags associated with the monitor.
- timeout_
h int - Number of hours of the monitor not reporting data before it automatically resolves from a triggered state.
- type str
- Type of the monitor.
- Sequence[str]
- A list of monitor tags to limit the search. This filters on the tags set on the monitor itself.
- name_
filter str - A monitor name to limit the search.
- Sequence[str]
- A list of tags to limit the search. This filters on the monitor scope.
- enable
Logs BooleanSample - Whether or not a list of log values which triggered the alert is included. This is only used by log monitors.
- enable
Samples Boolean - Whether or not a list of samples which triggered the alert is included. This is only used by CI Test and Pipeline monitors.
- escalation
Message String - Message included with a re-notification for this monitor.
- evaluation
Delay Number - Time (in seconds) for which evaluation is delayed. This is only used by metric monitors.
- group
Retention StringDuration - The time span after which groups with missing data are dropped from the monitor state. The minimum value is one hour, and the maximum value is 72 hours. Example values are: 60m, 1h, and 2d. This option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors.
- groupby
Simple BooleanMonitor - Whether or not to trigger one alert if any source breaches a threshold.
- id String
- The provider-assigned unique ID for this managed resource.
- Boolean
- Whether or not notifications from the monitor automatically inserts its triggering tags into the title.
- locked Boolean
- Whether or not changes to the monitor are restricted to the creator or admins.
- message String
- Message included with notifications for this monitor
- monitor
Threshold List<Property Map>Windows - Mapping containing
recovery_window
andtrigger_window
values, e.g.last_15m
. This is only used by anomaly monitors. - monitor
Thresholds List<Property Map> - Alert thresholds of the monitor.
- name String
- Name of the monitor
- new
Group NumberDelay - Time (in seconds) to skip evaluations for new groups.
- new
Host NumberDelay - Time (in seconds) allowing a host to boot and applications to fully start before starting the evaluation of monitor results.
- no
Data NumberTimeframe - The number of minutes before the monitor notifies when data stops reporting.
- notification
Preset StringName - Toggles the display of additional content sent in the monitor notification. Valid values are:
show_all
,hide_query
,hide_handles
, andhide_all
. - notify
Audit Boolean - Whether or not tagged users are notified on changes to the monitor.
- notify
Bies List<String> - Controls what granularity a monitor alerts on. Only available for monitors with groupings. For instance, a monitor grouped by
cluster
,namespace
, andpod
can be configured to only notify on each newcluster
violating the alert conditions by settingnotify_by
to['cluster']
. Tags mentioned innotify_by
must be a subset of the grouping tags in the query. For example, a query grouped bycluster
andnamespace
cannot notify onregion
. Settingnotify_by
to[*]
configures the monitor to notify as a simple-alert. - notify
No BooleanData - Whether or not this monitor notifies when data stops reporting.
- on
Missing StringData - Controls how groups or monitors are treated if an evaluation does not return any data points. The default option results in different behavior depending on the monitor query type. For monitors using
Count
queries, an empty monitor evaluation is treated as 0 and is compared to the threshold conditions. For monitors using any query type other thanCount
, for exampleGauge
,Measure
, orRate
, the monitor shows the last known status. This option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors. Valid values are:show_no_data
,show_and_notify_no_data
,resolve
, anddefault
. - query String
- Query of the monitor.
- renotify
Interval Number - The number of minutes after the last notification before the monitor re-notifies on the current status.
- renotify
Occurrences Number - The number of re-notification messages that should be sent on the current status.
- renotify
Statuses List<String> - The types of statuses for which re-notification messages should be sent. Valid values are
alert
,warn
,no data
. - require
Full BooleanWindow - Whether or not the monitor needs a full window of data before it is evaluated.
- restricted
Roles List<String> - scheduling
Options List<Property Map> - Configuration options for scheduling.
- List<String>
- List of tags associated with the monitor.
- timeout
H Number - Number of hours of the monitor not reporting data before it automatically resolves from a triggered state.
- type String
- Type of the monitor.
- List<String>
- A list of monitor tags to limit the search. This filters on the tags set on the monitor itself.
- name
Filter String - A monitor name to limit the search.
- List<String>
- A list of tags to limit the search. This filters on the monitor scope.
Supporting Types
GetMonitorMonitorThreshold
- Critical string
- Critical
Recovery string - Ok string
- Unknown string
- Warning string
- Warning
Recovery string
- Critical string
- Critical
Recovery string - Ok string
- Unknown string
- Warning string
- Warning
Recovery string
- critical String
- critical
Recovery String - ok String
- unknown String
- warning String
- warning
Recovery String
- critical string
- critical
Recovery string - ok string
- unknown string
- warning string
- warning
Recovery string
- critical str
- critical_
recovery str - ok str
- unknown str
- warning str
- warning_
recovery str
- critical String
- critical
Recovery String - ok String
- unknown String
- warning String
- warning
Recovery String
GetMonitorMonitorThresholdWindow
- Recovery
Window string - Trigger
Window string
- Recovery
Window string - Trigger
Window string
- recovery
Window String - trigger
Window String
- recovery
Window string - trigger
Window string
- recovery_
window str - trigger_
window str
- recovery
Window String - trigger
Window String
GetMonitorSchedulingOption
- Custom
Schedules List<GetMonitor Scheduling Option Custom Schedule> - Configuration options for the custom schedules. If
start
is omitted, the monitor creation time will be used. - Evaluation
Windows List<GetMonitor Scheduling Option Evaluation Window> - Configuration options for the evaluation window. If
hour_starts
is set, no other fields may be set. Otherwise,day_starts
andmonth_starts
must be set together.
- Custom
Schedules []GetMonitor Scheduling Option Custom Schedule - Configuration options for the custom schedules. If
start
is omitted, the monitor creation time will be used. - Evaluation
Windows []GetMonitor Scheduling Option Evaluation Window - Configuration options for the evaluation window. If
hour_starts
is set, no other fields may be set. Otherwise,day_starts
andmonth_starts
must be set together.
- custom
Schedules List<GetMonitor Scheduling Option Custom Schedule> - Configuration options for the custom schedules. If
start
is omitted, the monitor creation time will be used. - evaluation
Windows List<GetMonitor Scheduling Option Evaluation Window> - Configuration options for the evaluation window. If
hour_starts
is set, no other fields may be set. Otherwise,day_starts
andmonth_starts
must be set together.
- custom
Schedules GetMonitor Scheduling Option Custom Schedule[] - Configuration options for the custom schedules. If
start
is omitted, the monitor creation time will be used. - evaluation
Windows GetMonitor Scheduling Option Evaluation Window[] - Configuration options for the evaluation window. If
hour_starts
is set, no other fields may be set. Otherwise,day_starts
andmonth_starts
must be set together.
- custom_
schedules Sequence[GetMonitor Scheduling Option Custom Schedule] - Configuration options for the custom schedules. If
start
is omitted, the monitor creation time will be used. - evaluation_
windows Sequence[GetMonitor Scheduling Option Evaluation Window] - Configuration options for the evaluation window. If
hour_starts
is set, no other fields may be set. Otherwise,day_starts
andmonth_starts
must be set together.
- custom
Schedules List<Property Map> - Configuration options for the custom schedules. If
start
is omitted, the monitor creation time will be used. - evaluation
Windows List<Property Map> - Configuration options for the evaluation window. If
hour_starts
is set, no other fields may be set. Otherwise,day_starts
andmonth_starts
must be set together.
GetMonitorSchedulingOptionCustomSchedule
- Recurrences
List<Get
Monitor Scheduling Option Custom Schedule Recurrence> - A list of recurrence definitions. Length must be 1.
- Recurrences
[]Get
Monitor Scheduling Option Custom Schedule Recurrence - A list of recurrence definitions. Length must be 1.
- recurrences
List<Get
Monitor Scheduling Option Custom Schedule Recurrence> - A list of recurrence definitions. Length must be 1.
- recurrences
Get
Monitor Scheduling Option Custom Schedule Recurrence[] - A list of recurrence definitions. Length must be 1.
- recurrences
Sequence[Get
Monitor Scheduling Option Custom Schedule Recurrence] - A list of recurrence definitions. Length must be 1.
- recurrences List<Property Map>
- A list of recurrence definitions. Length must be 1.
GetMonitorSchedulingOptionCustomScheduleRecurrence
GetMonitorSchedulingOptionEvaluationWindow
- Day
Starts string - The time of the day at which a one day cumulative evaluation window starts. Must be defined in UTC time in
HH:mm
format. - Hour
Starts int - The minute of the hour at which a one hour cumulative evaluation window starts. Must be between 0 and 59.
- Month
Starts int - The day of the month at which a one month cumulative evaluation window starts. Must be a value of 1.
- Day
Starts string - The time of the day at which a one day cumulative evaluation window starts. Must be defined in UTC time in
HH:mm
format. - Hour
Starts int - The minute of the hour at which a one hour cumulative evaluation window starts. Must be between 0 and 59.
- Month
Starts int - The day of the month at which a one month cumulative evaluation window starts. Must be a value of 1.
- day
Starts String - The time of the day at which a one day cumulative evaluation window starts. Must be defined in UTC time in
HH:mm
format. - hour
Starts Integer - The minute of the hour at which a one hour cumulative evaluation window starts. Must be between 0 and 59.
- month
Starts Integer - The day of the month at which a one month cumulative evaluation window starts. Must be a value of 1.
- day
Starts string - The time of the day at which a one day cumulative evaluation window starts. Must be defined in UTC time in
HH:mm
format. - hour
Starts number - The minute of the hour at which a one hour cumulative evaluation window starts. Must be between 0 and 59.
- month
Starts number - The day of the month at which a one month cumulative evaluation window starts. Must be a value of 1.
- day_
starts str - The time of the day at which a one day cumulative evaluation window starts. Must be defined in UTC time in
HH:mm
format. - hour_
starts int - The minute of the hour at which a one hour cumulative evaluation window starts. Must be between 0 and 59.
- month_
starts int - The day of the month at which a one month cumulative evaluation window starts. Must be a value of 1.
- day
Starts String - The time of the day at which a one day cumulative evaluation window starts. Must be defined in UTC time in
HH:mm
format. - hour
Starts Number - The minute of the hour at which a one hour cumulative evaluation window starts. Must be between 0 and 59.
- month
Starts Number - The day of the month at which a one month cumulative evaluation window starts. Must be a value of 1.
Package Details
- Repository
- Datadog pulumi/pulumi-datadog
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
datadog
Terraform Provider.