@pulumi/signalfx 7.1.4 → 7.1.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/alertMutingRule.d.ts +27 -33
- package/alertMutingRule.js +2 -18
- package/alertMutingRule.js.map +1 -1
- package/aws/externalIntegration.d.ts +7 -19
- package/aws/externalIntegration.js +0 -12
- package/aws/externalIntegration.js.map +1 -1
- package/aws/integration.d.ts +68 -135
- package/aws/integration.js +0 -37
- package/aws/integration.js.map +1 -1
- package/aws/tokenIntegration.d.ts +5 -16
- package/aws/tokenIntegration.js +0 -11
- package/aws/tokenIntegration.js.map +1 -1
- package/azure/integration.d.ts +39 -95
- package/azure/integration.js +0 -26
- package/azure/integration.js.map +1 -1
- package/dashboard.d.ts +62 -62
- package/dashboardGroup.d.ts +21 -54
- package/dashboardGroup.js +0 -33
- package/dashboardGroup.js.map +1 -1
- package/dataLink.d.ts +12 -46
- package/dataLink.js +0 -28
- package/dataLink.js.map +1 -1
- package/detector.d.ts +55 -114
- package/detector.js +0 -51
- package/detector.js.map +1 -1
- package/eventFeedChart.d.ts +20 -38
- package/eventFeedChart.js +0 -18
- package/eventFeedChart.js.map +1 -1
- package/gcp/integration.d.ts +30 -61
- package/gcp/integration.js +0 -19
- package/gcp/integration.js.map +1 -1
- package/heatmapChart.d.ts +44 -78
- package/heatmapChart.js +0 -34
- package/heatmapChart.js.map +1 -1
- package/jira/integration.d.ts +21 -48
- package/jira/integration.js +0 -21
- package/jira/integration.js.map +1 -1
- package/listChart.d.ts +62 -109
- package/listChart.js +0 -44
- package/listChart.js.map +1 -1
- package/log/timeline.d.ts +23 -42
- package/log/timeline.js +0 -19
- package/log/timeline.js.map +1 -1
- package/log/view.d.ts +29 -50
- package/log/view.js +0 -21
- package/log/view.js.map +1 -1
- package/metricRuleset.d.ts +9 -31
- package/metricRuleset.js +0 -22
- package/metricRuleset.js.map +1 -1
- package/opsgenie/integration.d.ts +12 -25
- package/opsgenie/integration.js +0 -13
- package/opsgenie/integration.js.map +1 -1
- package/orgToken.d.ts +36 -47
- package/orgToken.js +0 -29
- package/orgToken.js.map +1 -1
- package/package.json +2 -2
- package/pagerduty/getIntegration.d.ts +12 -20
- package/pagerduty/getIntegration.js +0 -20
- package/pagerduty/getIntegration.js.map +1 -1
- package/pagerduty/integration.d.ts +9 -20
- package/pagerduty/integration.js +0 -11
- package/pagerduty/integration.js.map +1 -1
- package/servicenow/integration.d.ts +15 -44
- package/servicenow/integration.js +0 -17
- package/servicenow/integration.js.map +1 -1
- package/singleValueChart.d.ts +38 -73
- package/singleValueChart.js +0 -35
- package/singleValueChart.js.map +1 -1
- package/slack/integration.d.ts +9 -21
- package/slack/integration.js +0 -12
- package/slack/integration.js.map +1 -1
- package/slo.d.ts +12 -52
- package/slo.js +0 -37
- package/slo.js.map +1 -1
- package/tableChart.d.ts +14 -30
- package/tableChart.js +0 -16
- package/tableChart.js.map +1 -1
- package/team.d.ts +29 -50
- package/team.js +0 -21
- package/team.js.map +1 -1
- package/textChart.d.ts +11 -26
- package/textChart.js +0 -15
- package/textChart.js.map +1 -1
- package/timeChart.d.ts +92 -146
- package/timeChart.js +0 -66
- package/timeChart.js.map +1 -1
- package/types/input.d.ts +211 -182
- package/types/output.d.ts +211 -182
- package/victorops/integration.d.ts +9 -21
- package/victorops/integration.js +0 -12
- package/victorops/integration.js.map +1 -1
- package/webhookIntegration.d.ts +36 -28
- package/webhookIntegration.js +4 -16
- package/webhookIntegration.js.map +1 -1
package/dataLink.d.ts
CHANGED
|
@@ -5,34 +5,6 @@ import * as outputs from "./types/output";
|
|
|
5
5
|
* Manage Splunk Observability Cloud [Data Links](https://docs.signalfx.com/en/latest/managing/data-links.html).
|
|
6
6
|
*
|
|
7
7
|
* ## Example
|
|
8
|
-
*
|
|
9
|
-
* ## Arguments
|
|
10
|
-
*
|
|
11
|
-
* The following arguments are supported in the resource block:
|
|
12
|
-
*
|
|
13
|
-
* * `propertyName` - (Optional) Name (key) of the metadata that's the trigger of a data link. If you specify `propertyValue`, you must specify `propertyName`.
|
|
14
|
-
* * `propertyValue` - (Optional) Value of the metadata that's the trigger of a data link. If you specify this property, you must also specify `propertyName`.
|
|
15
|
-
* * `contextDashboardId` - (Optional) If provided, scopes this data link to the supplied dashboard id. If omitted then the link will be global.
|
|
16
|
-
* * `targetExternalUrl` - (Optional) Link to an external URL
|
|
17
|
-
* * `name` (Required) User-assigned target name. Use this value to differentiate between the link targets for a data link object.
|
|
18
|
-
* * `url`- (Required) URL string for a Splunk instance or external system data link target. [See the supported template variables](https://dev.splunk.com/observability/docs/administration/datalinks/).
|
|
19
|
-
* * `timeFormat` - (Optional) [Designates the format](https://dev.splunk.com/observability/docs/administration/datalinks/) of `minimumTimeWindow` in the same data link target object. Must be one of `"ISO8601"`, `"EpochSeconds"` or `"Epoch"` (which is milliseconds). Defaults to `"ISO8601"`.
|
|
20
|
-
* * `minimumTimeWindow` - (Optional) The [minimum time window](https://dev.splunk.com/observability/docs/administration/datalinks/) for a search sent to an external site. Defaults to `6000`
|
|
21
|
-
* * `propertyKeyMapping` - Describes the relationship between Splunk Observability Cloud metadata keys and external system properties when the key names are different.
|
|
22
|
-
* * `targetSignalfxDashboard` - (Optional) Link to a Splunk Observability Cloud dashboard
|
|
23
|
-
* * `name` (Required) User-assigned target name. Use this value to differentiate between the link targets for a data link object.
|
|
24
|
-
* * `isDefault` - (Optional) Flag that designates a target as the default for a data link object. `true` by default
|
|
25
|
-
* * `dashboardId` - (Required) SignalFx-assigned ID of the dashboard link target
|
|
26
|
-
* * `dashboardGroupId` - (Required) SignalFx-assigned ID of the dashboard link target's dashboard group
|
|
27
|
-
* * `targetSplunk` - (Optional) Link to an external URL
|
|
28
|
-
* * `name` (Required) User-assigned target name. Use this value to differentiate between the link targets for a data link object.
|
|
29
|
-
* * `propertyKeyMapping` - Describes the relationship between Splunk Observability Cloud metadata keys and external system properties when the key names are different.
|
|
30
|
-
*
|
|
31
|
-
* ## Attributes
|
|
32
|
-
*
|
|
33
|
-
* In a addition to all arguments above, the following attributes are exported:
|
|
34
|
-
*
|
|
35
|
-
* * `id` - The ID of the link.
|
|
36
8
|
*/
|
|
37
9
|
export declare class DataLink extends pulumi.CustomResource {
|
|
38
10
|
/**
|
|
@@ -51,17 +23,15 @@ export declare class DataLink extends pulumi.CustomResource {
|
|
|
51
23
|
*/
|
|
52
24
|
static isInstance(obj: any): obj is DataLink;
|
|
53
25
|
/**
|
|
54
|
-
*
|
|
26
|
+
* If provided, scopes this data link to the supplied dashboard id. If omitted then the link will be global.
|
|
55
27
|
*/
|
|
56
28
|
readonly contextDashboardId: pulumi.Output<string | undefined>;
|
|
57
29
|
/**
|
|
58
|
-
* Name (key) of the metadata that's the trigger of a data link. If you specify `propertyValue`, you must specify
|
|
59
|
-
* `propertyName`.
|
|
30
|
+
* Name (key) of the metadata that's the trigger of a data link. If you specify `propertyValue`, you must specify `propertyName`.
|
|
60
31
|
*/
|
|
61
32
|
readonly propertyName: pulumi.Output<string | undefined>;
|
|
62
33
|
/**
|
|
63
|
-
* Value of the metadata that's the trigger of a data link. If you specify this property, you must also specify
|
|
64
|
-
* `propertyName`.
|
|
34
|
+
* Value of the metadata that's the trigger of a data link. If you specify this property, you must also specify `propertyName`.
|
|
65
35
|
*/
|
|
66
36
|
readonly propertyValue: pulumi.Output<string | undefined>;
|
|
67
37
|
/**
|
|
@@ -73,7 +43,7 @@ export declare class DataLink extends pulumi.CustomResource {
|
|
|
73
43
|
*/
|
|
74
44
|
readonly targetSignalfxDashboards: pulumi.Output<outputs.DataLinkTargetSignalfxDashboard[] | undefined>;
|
|
75
45
|
/**
|
|
76
|
-
* Link to
|
|
46
|
+
* Link to an external URL
|
|
77
47
|
*/
|
|
78
48
|
readonly targetSplunks: pulumi.Output<outputs.DataLinkTargetSplunk[] | undefined>;
|
|
79
49
|
/**
|
|
@@ -90,17 +60,15 @@ export declare class DataLink extends pulumi.CustomResource {
|
|
|
90
60
|
*/
|
|
91
61
|
export interface DataLinkState {
|
|
92
62
|
/**
|
|
93
|
-
*
|
|
63
|
+
* If provided, scopes this data link to the supplied dashboard id. If omitted then the link will be global.
|
|
94
64
|
*/
|
|
95
65
|
contextDashboardId?: pulumi.Input<string>;
|
|
96
66
|
/**
|
|
97
|
-
* Name (key) of the metadata that's the trigger of a data link. If you specify `propertyValue`, you must specify
|
|
98
|
-
* `propertyName`.
|
|
67
|
+
* Name (key) of the metadata that's the trigger of a data link. If you specify `propertyValue`, you must specify `propertyName`.
|
|
99
68
|
*/
|
|
100
69
|
propertyName?: pulumi.Input<string>;
|
|
101
70
|
/**
|
|
102
|
-
* Value of the metadata that's the trigger of a data link. If you specify this property, you must also specify
|
|
103
|
-
* `propertyName`.
|
|
71
|
+
* Value of the metadata that's the trigger of a data link. If you specify this property, you must also specify `propertyName`.
|
|
104
72
|
*/
|
|
105
73
|
propertyValue?: pulumi.Input<string>;
|
|
106
74
|
/**
|
|
@@ -112,7 +80,7 @@ export interface DataLinkState {
|
|
|
112
80
|
*/
|
|
113
81
|
targetSignalfxDashboards?: pulumi.Input<pulumi.Input<inputs.DataLinkTargetSignalfxDashboard>[]>;
|
|
114
82
|
/**
|
|
115
|
-
* Link to
|
|
83
|
+
* Link to an external URL
|
|
116
84
|
*/
|
|
117
85
|
targetSplunks?: pulumi.Input<pulumi.Input<inputs.DataLinkTargetSplunk>[]>;
|
|
118
86
|
}
|
|
@@ -121,17 +89,15 @@ export interface DataLinkState {
|
|
|
121
89
|
*/
|
|
122
90
|
export interface DataLinkArgs {
|
|
123
91
|
/**
|
|
124
|
-
*
|
|
92
|
+
* If provided, scopes this data link to the supplied dashboard id. If omitted then the link will be global.
|
|
125
93
|
*/
|
|
126
94
|
contextDashboardId?: pulumi.Input<string>;
|
|
127
95
|
/**
|
|
128
|
-
* Name (key) of the metadata that's the trigger of a data link. If you specify `propertyValue`, you must specify
|
|
129
|
-
* `propertyName`.
|
|
96
|
+
* Name (key) of the metadata that's the trigger of a data link. If you specify `propertyValue`, you must specify `propertyName`.
|
|
130
97
|
*/
|
|
131
98
|
propertyName?: pulumi.Input<string>;
|
|
132
99
|
/**
|
|
133
|
-
* Value of the metadata that's the trigger of a data link. If you specify this property, you must also specify
|
|
134
|
-
* `propertyName`.
|
|
100
|
+
* Value of the metadata that's the trigger of a data link. If you specify this property, you must also specify `propertyName`.
|
|
135
101
|
*/
|
|
136
102
|
propertyValue?: pulumi.Input<string>;
|
|
137
103
|
/**
|
|
@@ -143,7 +109,7 @@ export interface DataLinkArgs {
|
|
|
143
109
|
*/
|
|
144
110
|
targetSignalfxDashboards?: pulumi.Input<pulumi.Input<inputs.DataLinkTargetSignalfxDashboard>[]>;
|
|
145
111
|
/**
|
|
146
|
-
* Link to
|
|
112
|
+
* Link to an external URL
|
|
147
113
|
*/
|
|
148
114
|
targetSplunks?: pulumi.Input<pulumi.Input<inputs.DataLinkTargetSplunk>[]>;
|
|
149
115
|
}
|
package/dataLink.js
CHANGED
|
@@ -9,34 +9,6 @@ const utilities = require("./utilities");
|
|
|
9
9
|
* Manage Splunk Observability Cloud [Data Links](https://docs.signalfx.com/en/latest/managing/data-links.html).
|
|
10
10
|
*
|
|
11
11
|
* ## Example
|
|
12
|
-
*
|
|
13
|
-
* ## Arguments
|
|
14
|
-
*
|
|
15
|
-
* The following arguments are supported in the resource block:
|
|
16
|
-
*
|
|
17
|
-
* * `propertyName` - (Optional) Name (key) of the metadata that's the trigger of a data link. If you specify `propertyValue`, you must specify `propertyName`.
|
|
18
|
-
* * `propertyValue` - (Optional) Value of the metadata that's the trigger of a data link. If you specify this property, you must also specify `propertyName`.
|
|
19
|
-
* * `contextDashboardId` - (Optional) If provided, scopes this data link to the supplied dashboard id. If omitted then the link will be global.
|
|
20
|
-
* * `targetExternalUrl` - (Optional) Link to an external URL
|
|
21
|
-
* * `name` (Required) User-assigned target name. Use this value to differentiate between the link targets for a data link object.
|
|
22
|
-
* * `url`- (Required) URL string for a Splunk instance or external system data link target. [See the supported template variables](https://dev.splunk.com/observability/docs/administration/datalinks/).
|
|
23
|
-
* * `timeFormat` - (Optional) [Designates the format](https://dev.splunk.com/observability/docs/administration/datalinks/) of `minimumTimeWindow` in the same data link target object. Must be one of `"ISO8601"`, `"EpochSeconds"` or `"Epoch"` (which is milliseconds). Defaults to `"ISO8601"`.
|
|
24
|
-
* * `minimumTimeWindow` - (Optional) The [minimum time window](https://dev.splunk.com/observability/docs/administration/datalinks/) for a search sent to an external site. Defaults to `6000`
|
|
25
|
-
* * `propertyKeyMapping` - Describes the relationship between Splunk Observability Cloud metadata keys and external system properties when the key names are different.
|
|
26
|
-
* * `targetSignalfxDashboard` - (Optional) Link to a Splunk Observability Cloud dashboard
|
|
27
|
-
* * `name` (Required) User-assigned target name. Use this value to differentiate between the link targets for a data link object.
|
|
28
|
-
* * `isDefault` - (Optional) Flag that designates a target as the default for a data link object. `true` by default
|
|
29
|
-
* * `dashboardId` - (Required) SignalFx-assigned ID of the dashboard link target
|
|
30
|
-
* * `dashboardGroupId` - (Required) SignalFx-assigned ID of the dashboard link target's dashboard group
|
|
31
|
-
* * `targetSplunk` - (Optional) Link to an external URL
|
|
32
|
-
* * `name` (Required) User-assigned target name. Use this value to differentiate between the link targets for a data link object.
|
|
33
|
-
* * `propertyKeyMapping` - Describes the relationship between Splunk Observability Cloud metadata keys and external system properties when the key names are different.
|
|
34
|
-
*
|
|
35
|
-
* ## Attributes
|
|
36
|
-
*
|
|
37
|
-
* In a addition to all arguments above, the following attributes are exported:
|
|
38
|
-
*
|
|
39
|
-
* * `id` - The ID of the link.
|
|
40
12
|
*/
|
|
41
13
|
class DataLink extends pulumi.CustomResource {
|
|
42
14
|
/**
|
package/dataLink.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"dataLink.js","sourceRoot":"","sources":["../dataLink.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AAGzC,yCAAyC;AAEzC
|
|
1
|
+
{"version":3,"file":"dataLink.js","sourceRoot":"","sources":["../dataLink.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AAGzC,yCAAyC;AAEzC;;;;GAIG;AACH,MAAa,QAAS,SAAQ,MAAM,CAAC,cAAc;IAC/C;;;;;;;;OAQG;IACI,MAAM,CAAC,GAAG,CAAC,IAAY,EAAE,EAA2B,EAAE,KAAqB,EAAE,IAAmC;QACnH,OAAO,IAAI,QAAQ,CAAC,IAAI,EAAO,KAAK,kCAAO,IAAI,KAAE,EAAE,EAAE,EAAE,IAAG,CAAC;IAC/D,CAAC;IAKD;;;OAGG;IACI,MAAM,CAAC,UAAU,CAAC,GAAQ;QAC7B,IAAI,GAAG,KAAK,SAAS,IAAI,GAAG,KAAK,IAAI,EAAE;YACnC,OAAO,KAAK,CAAC;SAChB;QACD,OAAO,GAAG,CAAC,cAAc,CAAC,KAAK,QAAQ,CAAC,YAAY,CAAC;IACzD,CAAC;IAmCD,YAAY,IAAY,EAAE,WAA0C,EAAE,IAAmC;QACrG,IAAI,cAAc,GAAkB,EAAE,CAAC;QACvC,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;QAClB,IAAI,IAAI,CAAC,EAAE,EAAE;YACT,MAAM,KAAK,GAAG,WAAwC,CAAC;YACvD,cAAc,CAAC,oBAAoB,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC,CAAC,SAAS,CAAC;YACpF,cAAc,CAAC,cAAc,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC;YACxE,cAAc,CAAC,eAAe,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,SAAS,CAAC;YAC1E,cAAc,CAAC,oBAAoB,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC,CAAC,SAAS,CAAC;YACpF,cAAc,CAAC,0BAA0B,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,wBAAwB,CAAC,CAAC,CAAC,SAAS,CAAC;YAChG,cAAc,CAAC,eAAe,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,SAAS,CAAC;SAC7E;aAAM;YACH,MAAM,IAAI,GAAG,WAAuC,CAAC;YACrD,cAAc,CAAC,oBAAoB,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,CAAC,SAAS,CAAC;YAClF,cAAc,CAAC,cAAc,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC;YACtE,cAAc,CAAC,eAAe,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,SAAS,CAAC;YACxE,cAAc,CAAC,oBAAoB,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,CAAC,SAAS,CAAC;YAClF,cAAc,CAAC,0BAA0B,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,wBAAwB,CAAC,CAAC,CAAC,SAAS,CAAC;YAC9F,cAAc,CAAC,eAAe,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,SAAS,CAAC;SAC3E;QACD,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,CAAC,CAAC;QACnE,KAAK,CAAC,QAAQ,CAAC,YAAY,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,CAAC,CAAC;IAC7D,CAAC;;AAnFL,4BAoFC;AAtEG,gBAAgB;AACO,qBAAY,GAAG,kCAAkC,CAAC"}
|
package/detector.d.ts
CHANGED
|
@@ -52,57 +52,6 @@ import * as outputs from "./types/output";
|
|
|
52
52
|
*
|
|
53
53
|
* Or configure one inline:
|
|
54
54
|
*
|
|
55
|
-
* ## Arguments
|
|
56
|
-
*
|
|
57
|
-
* * `name` - (Required) Name of the detector.
|
|
58
|
-
* * `programText` - (Required) Signalflow program text for the detector. More info [in the Splunk Observability Cloud docs](https://dev.splunk.com/observability/docs/signalflow/).
|
|
59
|
-
* * `description` - (Optional) Description of the detector.
|
|
60
|
-
* * `authorizedWriterTeams` - (Optional) Team IDs that have write access to this detector. Remember to use an admin's token if using this feature and to include that admin's team id (or user id in `authorizedWriterUsers`).
|
|
61
|
-
* * `authorizedWriterUsers` - (Optional) User IDs that have write access to this detector. Remember to use an admin's token if using this feature and to include that admin's user id (or team id in `authorizedWriterTeams`).
|
|
62
|
-
* * `maxDelay` - (Optional) How long (in seconds) to wait for late datapoints. See [Delayed Datapoints](https://docs.splunk.com/observability/en/data-visualization/charts/chart-builder.html#delayed-datapoints) for more info. Max value is `900` seconds (15 minutes). `Auto` (as little as possible) by default.
|
|
63
|
-
* * `minDelay` - (Optional) How long (in seconds) to wait even if the datapoints are arriving in a timely fashion. Max value is 900 (15m).
|
|
64
|
-
* * `showDataMarkers` - (Optional) When `true`, markers will be drawn for each datapoint within the visualization. `true` by default.
|
|
65
|
-
* * `showEventLines` - (Optional) When `true`, the visualization will display a vertical line for each event trigger. `false` by default.
|
|
66
|
-
* * `disableSampling` - (Optional) When `false`, the visualization may sample the output timeseries rather than displaying them all. `false` by default.
|
|
67
|
-
* * `timeRange` - (Optional) Seconds to display in the visualization. This is a rolling range from the current time. Example: `3600` corresponds to `-1h` in web UI. `3600` by default.
|
|
68
|
-
* * `startTime` - (Optional) Seconds since epoch. Used for visualization. Conflicts with `timeRange`.
|
|
69
|
-
* * `endTime` - (Optional) Seconds since epoch. Used for visualization. Conflicts with `timeRange`.
|
|
70
|
-
* * `tags` - (Optional) Tags associated with the detector.
|
|
71
|
-
* * `teams` - (Optional) Team IDs to associate the detector to.
|
|
72
|
-
* * `rule` - (Required) Set of rules used for alerting.
|
|
73
|
-
* * `detectLabel` - (Required) A detect label which matches a detect label within `programText`.
|
|
74
|
-
* * `severity` - (Required) The severity of the rule, must be one of: `"Critical"`, `"Major"`, `"Minor"`, `"Warning"`, `"Info"`.
|
|
75
|
-
* * `description` - (Optional) Description for the rule. Displays as the alert condition in the Alert Rules tab of the detector editor in the web UI.
|
|
76
|
-
* * `disabled` - (Optional) When true, notifications and events will not be generated for the detect label. `false` by default.
|
|
77
|
-
* * `notifications` - (Optional) List of strings specifying where notifications will be sent when an incident occurs. See [Create A Single Detector](https://dev.splunk.com/observability/reference/api/detectors/latest) for more info.
|
|
78
|
-
* * `parameterizedBody` - (Optional) Custom notification message body when an alert is triggered. See [Set Up Detectors to Trigger Alerts](https://docs.splunk.com/observability/en/alerts-detectors-notifications/create-detectors-for-alerts.html) for more info.
|
|
79
|
-
* * `parameterizedSubject` - (Optional) Custom notification message subject when an alert is triggered. See [Set Up Detectors to Trigger Alerts](https://docs.splunk.com/observability/en/alerts-detectors-notifications/create-detectors-for-alerts.html) for more info.
|
|
80
|
-
* * `runbookUrl` - (Optional) URL of page to consult when an alert is triggered. This can be used with custom notification messages.
|
|
81
|
-
* * `tip` - (Optional) Plain text suggested first course of action, such as a command line to execute. This can be used with custom notification messages.
|
|
82
|
-
* * `vizOptions` - (Optional) Plot-level customization options, associated with a publish statement.
|
|
83
|
-
* * `label` - (Required) Label used in the publish statement that displays the plot (metric time series data) you want to customize.
|
|
84
|
-
* * `displayName` - (Optional) Specifies an alternate value for the Plot Name column of the Data Table associated with the chart.
|
|
85
|
-
* * `color` - (Optional) Color to use : gray, blue, azure, navy, brown, orange, yellow, iris, magenta, pink, purple, violet, lilac, emerald, green, aquamarine.
|
|
86
|
-
* * `valueUnit` - (Optional) A unit to attach to this plot. Units support automatic scaling (eg thousands of bytes will be displayed as kilobytes). Values values are `Bit, Kilobit, Megabit, Gigabit, Terabit, Petabit, Exabit, Zettabit, Yottabit, Byte, Kibibyte, Mebibyte, Gibibyte (note: this was previously typoed as Gigibyte), Tebibyte, Pebibyte, Exbibyte, Zebibyte, Yobibyte, Nanosecond, Microsecond, Millisecond, Second, Minute, Hour, Day, Week`.
|
|
87
|
-
* * `valuePrefix`, `valueSuffix` - (Optional) Arbitrary prefix/suffix to display with the value of this plot.
|
|
88
|
-
*
|
|
89
|
-
* **Notes**
|
|
90
|
-
*
|
|
91
|
-
* Use both `maxDelay` in your detector configuration and an `extrapolation` policy in your program text to reduce false positives and false negatives.
|
|
92
|
-
*
|
|
93
|
-
* - `maxDelay` allows Splunk Observability Cloud to continue with computation if there is a lag in receiving data points.
|
|
94
|
-
* - `extrapolation` allows you to specify how to handle missing data. An extrapolation policy can be added to individual signals by updating the data block in your `programText`.
|
|
95
|
-
*
|
|
96
|
-
* See [Delayed Datapoints](https://docs.splunk.com/observability/en/data-visualization/charts/chart-builder.html#delayed-datapoints) for more info.
|
|
97
|
-
*
|
|
98
|
-
* ## Attributes
|
|
99
|
-
*
|
|
100
|
-
* In a addition to all arguments above, the following attributes are exported:
|
|
101
|
-
*
|
|
102
|
-
* * `id` - The ID of the detector.
|
|
103
|
-
* * `labelResolutions` - The resolutions of the detector alerts in milliseconds that indicate how often data is analyzed to determine if an alert should be triggered.
|
|
104
|
-
* * `url` - The URL of the detector.
|
|
105
|
-
*
|
|
106
55
|
* ## Import
|
|
107
56
|
*
|
|
108
57
|
* Detectors can be imported using their string ID (recoverable from URL: `/#/detector/v2/abc123/edit`, e.g.
|
|
@@ -128,76 +77,73 @@ export declare class Detector extends pulumi.CustomResource {
|
|
|
128
77
|
*/
|
|
129
78
|
static isInstance(obj: any): obj is Detector;
|
|
130
79
|
/**
|
|
131
|
-
* Team IDs that have write access to this
|
|
80
|
+
* Team IDs that have write access to this detector. Remember to use an admin's token if using this feature and to include that admin's team id (or user id in `authorizedWriterUsers`).
|
|
132
81
|
*/
|
|
133
82
|
readonly authorizedWriterTeams: pulumi.Output<string[] | undefined>;
|
|
134
83
|
/**
|
|
135
|
-
* User IDs that have write access to this
|
|
84
|
+
* User IDs that have write access to this detector. Remember to use an admin's token if using this feature and to include that admin's user id (or team id in `authorizedWriterTeams`).
|
|
136
85
|
*/
|
|
137
86
|
readonly authorizedWriterUsers: pulumi.Output<string[] | undefined>;
|
|
138
87
|
/**
|
|
139
|
-
* Description of the detector
|
|
88
|
+
* Description of the detector.
|
|
140
89
|
*/
|
|
141
90
|
readonly description: pulumi.Output<string | undefined>;
|
|
142
91
|
/**
|
|
143
|
-
*
|
|
92
|
+
* When `false`, the visualization may sample the output timeseries rather than displaying them all. `false` by default.
|
|
144
93
|
*/
|
|
145
94
|
readonly disableSampling: pulumi.Output<boolean | undefined>;
|
|
146
95
|
/**
|
|
147
|
-
* Seconds since epoch. Used for visualization
|
|
96
|
+
* Seconds since epoch. Used for visualization. Conflicts with `timeRange`.
|
|
148
97
|
*/
|
|
149
98
|
readonly endTime: pulumi.Output<number | undefined>;
|
|
150
99
|
/**
|
|
151
|
-
*
|
|
152
|
-
* should be triggered
|
|
100
|
+
* The resolutions of the detector alerts in milliseconds that indicate how often data is analyzed to determine if an alert should be triggered.
|
|
153
101
|
*/
|
|
154
102
|
readonly labelResolutions: pulumi.Output<{
|
|
155
103
|
[key: string]: number;
|
|
156
104
|
}>;
|
|
157
105
|
/**
|
|
158
|
-
*
|
|
106
|
+
* allows Splunk Observability Cloud to continue with computation if there is a lag in receiving data points.
|
|
159
107
|
*/
|
|
160
108
|
readonly maxDelay: pulumi.Output<number | undefined>;
|
|
161
109
|
/**
|
|
162
|
-
*
|
|
163
|
-
* is 900 (15m)
|
|
110
|
+
* How long (in seconds) to wait even if the datapoints are arriving in a timely fashion. Max value is 900 (15m).
|
|
164
111
|
*/
|
|
165
112
|
readonly minDelay: pulumi.Output<number | undefined>;
|
|
166
113
|
/**
|
|
167
|
-
* Name of the detector
|
|
114
|
+
* Name of the detector.
|
|
168
115
|
*/
|
|
169
116
|
readonly name: pulumi.Output<string>;
|
|
170
117
|
/**
|
|
171
|
-
* Signalflow program text for the detector. More info
|
|
118
|
+
* Signalflow program text for the detector. More info [in the Splunk Observability Cloud docs](https://dev.splunk.com/observability/docs/signalflow/).
|
|
172
119
|
*/
|
|
173
120
|
readonly programText: pulumi.Output<string>;
|
|
174
121
|
/**
|
|
175
|
-
* Set of rules used for alerting
|
|
122
|
+
* Set of rules used for alerting.
|
|
176
123
|
*/
|
|
177
124
|
readonly rules: pulumi.Output<outputs.DetectorRule[]>;
|
|
178
125
|
/**
|
|
179
|
-
*
|
|
126
|
+
* When `true`, markers will be drawn for each datapoint within the visualization. `true` by default.
|
|
180
127
|
*/
|
|
181
128
|
readonly showDataMarkers: pulumi.Output<boolean | undefined>;
|
|
182
129
|
/**
|
|
183
|
-
*
|
|
130
|
+
* When `true`, the visualization will display a vertical line for each event trigger. `false` by default.
|
|
184
131
|
*/
|
|
185
132
|
readonly showEventLines: pulumi.Output<boolean | undefined>;
|
|
186
133
|
/**
|
|
187
|
-
* Seconds since epoch. Used for visualization
|
|
134
|
+
* Seconds since epoch. Used for visualization. Conflicts with `timeRange`.
|
|
188
135
|
*/
|
|
189
136
|
readonly startTime: pulumi.Output<number | undefined>;
|
|
190
137
|
/**
|
|
191
|
-
* Tags associated with the detector
|
|
138
|
+
* Tags associated with the detector.
|
|
192
139
|
*/
|
|
193
140
|
readonly tags: pulumi.Output<string[] | undefined>;
|
|
194
141
|
/**
|
|
195
|
-
* Team IDs to associate the detector to
|
|
142
|
+
* Team IDs to associate the detector to.
|
|
196
143
|
*/
|
|
197
144
|
readonly teams: pulumi.Output<string[] | undefined>;
|
|
198
145
|
/**
|
|
199
|
-
* Seconds to display in the visualization. This is a rolling range from the current time. Example: 3600
|
|
200
|
-
* to 3600
|
|
146
|
+
* Seconds to display in the visualization. This is a rolling range from the current time. Example: `3600` corresponds to `-1h` in web UI. `3600` by default.
|
|
201
147
|
*/
|
|
202
148
|
readonly timeRange: pulumi.Output<number | undefined>;
|
|
203
149
|
/**
|
|
@@ -205,11 +151,11 @@ export declare class Detector extends pulumi.CustomResource {
|
|
|
205
151
|
*/
|
|
206
152
|
readonly timezone: pulumi.Output<string | undefined>;
|
|
207
153
|
/**
|
|
208
|
-
* URL of the detector
|
|
154
|
+
* The URL of the detector.
|
|
209
155
|
*/
|
|
210
156
|
readonly url: pulumi.Output<string>;
|
|
211
157
|
/**
|
|
212
|
-
* Plot-level customization options, associated with a publish statement
|
|
158
|
+
* Plot-level customization options, associated with a publish statement.
|
|
213
159
|
*/
|
|
214
160
|
readonly vizOptions: pulumi.Output<outputs.DetectorVizOption[] | undefined>;
|
|
215
161
|
/**
|
|
@@ -226,76 +172,73 @@ export declare class Detector extends pulumi.CustomResource {
|
|
|
226
172
|
*/
|
|
227
173
|
export interface DetectorState {
|
|
228
174
|
/**
|
|
229
|
-
* Team IDs that have write access to this
|
|
175
|
+
* Team IDs that have write access to this detector. Remember to use an admin's token if using this feature and to include that admin's team id (or user id in `authorizedWriterUsers`).
|
|
230
176
|
*/
|
|
231
177
|
authorizedWriterTeams?: pulumi.Input<pulumi.Input<string>[]>;
|
|
232
178
|
/**
|
|
233
|
-
* User IDs that have write access to this
|
|
179
|
+
* User IDs that have write access to this detector. Remember to use an admin's token if using this feature and to include that admin's user id (or team id in `authorizedWriterTeams`).
|
|
234
180
|
*/
|
|
235
181
|
authorizedWriterUsers?: pulumi.Input<pulumi.Input<string>[]>;
|
|
236
182
|
/**
|
|
237
|
-
* Description of the detector
|
|
183
|
+
* Description of the detector.
|
|
238
184
|
*/
|
|
239
185
|
description?: pulumi.Input<string>;
|
|
240
186
|
/**
|
|
241
|
-
*
|
|
187
|
+
* When `false`, the visualization may sample the output timeseries rather than displaying them all. `false` by default.
|
|
242
188
|
*/
|
|
243
189
|
disableSampling?: pulumi.Input<boolean>;
|
|
244
190
|
/**
|
|
245
|
-
* Seconds since epoch. Used for visualization
|
|
191
|
+
* Seconds since epoch. Used for visualization. Conflicts with `timeRange`.
|
|
246
192
|
*/
|
|
247
193
|
endTime?: pulumi.Input<number>;
|
|
248
194
|
/**
|
|
249
|
-
*
|
|
250
|
-
* should be triggered
|
|
195
|
+
* The resolutions of the detector alerts in milliseconds that indicate how often data is analyzed to determine if an alert should be triggered.
|
|
251
196
|
*/
|
|
252
197
|
labelResolutions?: pulumi.Input<{
|
|
253
198
|
[key: string]: pulumi.Input<number>;
|
|
254
199
|
}>;
|
|
255
200
|
/**
|
|
256
|
-
*
|
|
201
|
+
* allows Splunk Observability Cloud to continue with computation if there is a lag in receiving data points.
|
|
257
202
|
*/
|
|
258
203
|
maxDelay?: pulumi.Input<number>;
|
|
259
204
|
/**
|
|
260
|
-
*
|
|
261
|
-
* is 900 (15m)
|
|
205
|
+
* How long (in seconds) to wait even if the datapoints are arriving in a timely fashion. Max value is 900 (15m).
|
|
262
206
|
*/
|
|
263
207
|
minDelay?: pulumi.Input<number>;
|
|
264
208
|
/**
|
|
265
|
-
* Name of the detector
|
|
209
|
+
* Name of the detector.
|
|
266
210
|
*/
|
|
267
211
|
name?: pulumi.Input<string>;
|
|
268
212
|
/**
|
|
269
|
-
* Signalflow program text for the detector. More info
|
|
213
|
+
* Signalflow program text for the detector. More info [in the Splunk Observability Cloud docs](https://dev.splunk.com/observability/docs/signalflow/).
|
|
270
214
|
*/
|
|
271
215
|
programText?: pulumi.Input<string>;
|
|
272
216
|
/**
|
|
273
|
-
* Set of rules used for alerting
|
|
217
|
+
* Set of rules used for alerting.
|
|
274
218
|
*/
|
|
275
219
|
rules?: pulumi.Input<pulumi.Input<inputs.DetectorRule>[]>;
|
|
276
220
|
/**
|
|
277
|
-
*
|
|
221
|
+
* When `true`, markers will be drawn for each datapoint within the visualization. `true` by default.
|
|
278
222
|
*/
|
|
279
223
|
showDataMarkers?: pulumi.Input<boolean>;
|
|
280
224
|
/**
|
|
281
|
-
*
|
|
225
|
+
* When `true`, the visualization will display a vertical line for each event trigger. `false` by default.
|
|
282
226
|
*/
|
|
283
227
|
showEventLines?: pulumi.Input<boolean>;
|
|
284
228
|
/**
|
|
285
|
-
* Seconds since epoch. Used for visualization
|
|
229
|
+
* Seconds since epoch. Used for visualization. Conflicts with `timeRange`.
|
|
286
230
|
*/
|
|
287
231
|
startTime?: pulumi.Input<number>;
|
|
288
232
|
/**
|
|
289
|
-
* Tags associated with the detector
|
|
233
|
+
* Tags associated with the detector.
|
|
290
234
|
*/
|
|
291
235
|
tags?: pulumi.Input<pulumi.Input<string>[]>;
|
|
292
236
|
/**
|
|
293
|
-
* Team IDs to associate the detector to
|
|
237
|
+
* Team IDs to associate the detector to.
|
|
294
238
|
*/
|
|
295
239
|
teams?: pulumi.Input<pulumi.Input<string>[]>;
|
|
296
240
|
/**
|
|
297
|
-
* Seconds to display in the visualization. This is a rolling range from the current time. Example: 3600
|
|
298
|
-
* to 3600
|
|
241
|
+
* Seconds to display in the visualization. This is a rolling range from the current time. Example: `3600` corresponds to `-1h` in web UI. `3600` by default.
|
|
299
242
|
*/
|
|
300
243
|
timeRange?: pulumi.Input<number>;
|
|
301
244
|
/**
|
|
@@ -303,11 +246,11 @@ export interface DetectorState {
|
|
|
303
246
|
*/
|
|
304
247
|
timezone?: pulumi.Input<string>;
|
|
305
248
|
/**
|
|
306
|
-
* URL of the detector
|
|
249
|
+
* The URL of the detector.
|
|
307
250
|
*/
|
|
308
251
|
url?: pulumi.Input<string>;
|
|
309
252
|
/**
|
|
310
|
-
* Plot-level customization options, associated with a publish statement
|
|
253
|
+
* Plot-level customization options, associated with a publish statement.
|
|
311
254
|
*/
|
|
312
255
|
vizOptions?: pulumi.Input<pulumi.Input<inputs.DetectorVizOption>[]>;
|
|
313
256
|
}
|
|
@@ -316,69 +259,67 @@ export interface DetectorState {
|
|
|
316
259
|
*/
|
|
317
260
|
export interface DetectorArgs {
|
|
318
261
|
/**
|
|
319
|
-
* Team IDs that have write access to this
|
|
262
|
+
* Team IDs that have write access to this detector. Remember to use an admin's token if using this feature and to include that admin's team id (or user id in `authorizedWriterUsers`).
|
|
320
263
|
*/
|
|
321
264
|
authorizedWriterTeams?: pulumi.Input<pulumi.Input<string>[]>;
|
|
322
265
|
/**
|
|
323
|
-
* User IDs that have write access to this
|
|
266
|
+
* User IDs that have write access to this detector. Remember to use an admin's token if using this feature and to include that admin's user id (or team id in `authorizedWriterTeams`).
|
|
324
267
|
*/
|
|
325
268
|
authorizedWriterUsers?: pulumi.Input<pulumi.Input<string>[]>;
|
|
326
269
|
/**
|
|
327
|
-
* Description of the detector
|
|
270
|
+
* Description of the detector.
|
|
328
271
|
*/
|
|
329
272
|
description?: pulumi.Input<string>;
|
|
330
273
|
/**
|
|
331
|
-
*
|
|
274
|
+
* When `false`, the visualization may sample the output timeseries rather than displaying them all. `false` by default.
|
|
332
275
|
*/
|
|
333
276
|
disableSampling?: pulumi.Input<boolean>;
|
|
334
277
|
/**
|
|
335
|
-
* Seconds since epoch. Used for visualization
|
|
278
|
+
* Seconds since epoch. Used for visualization. Conflicts with `timeRange`.
|
|
336
279
|
*/
|
|
337
280
|
endTime?: pulumi.Input<number>;
|
|
338
281
|
/**
|
|
339
|
-
*
|
|
282
|
+
* allows Splunk Observability Cloud to continue with computation if there is a lag in receiving data points.
|
|
340
283
|
*/
|
|
341
284
|
maxDelay?: pulumi.Input<number>;
|
|
342
285
|
/**
|
|
343
|
-
*
|
|
344
|
-
* is 900 (15m)
|
|
286
|
+
* How long (in seconds) to wait even if the datapoints are arriving in a timely fashion. Max value is 900 (15m).
|
|
345
287
|
*/
|
|
346
288
|
minDelay?: pulumi.Input<number>;
|
|
347
289
|
/**
|
|
348
|
-
* Name of the detector
|
|
290
|
+
* Name of the detector.
|
|
349
291
|
*/
|
|
350
292
|
name?: pulumi.Input<string>;
|
|
351
293
|
/**
|
|
352
|
-
* Signalflow program text for the detector. More info
|
|
294
|
+
* Signalflow program text for the detector. More info [in the Splunk Observability Cloud docs](https://dev.splunk.com/observability/docs/signalflow/).
|
|
353
295
|
*/
|
|
354
296
|
programText: pulumi.Input<string>;
|
|
355
297
|
/**
|
|
356
|
-
* Set of rules used for alerting
|
|
298
|
+
* Set of rules used for alerting.
|
|
357
299
|
*/
|
|
358
300
|
rules: pulumi.Input<pulumi.Input<inputs.DetectorRule>[]>;
|
|
359
301
|
/**
|
|
360
|
-
*
|
|
302
|
+
* When `true`, markers will be drawn for each datapoint within the visualization. `true` by default.
|
|
361
303
|
*/
|
|
362
304
|
showDataMarkers?: pulumi.Input<boolean>;
|
|
363
305
|
/**
|
|
364
|
-
*
|
|
306
|
+
* When `true`, the visualization will display a vertical line for each event trigger. `false` by default.
|
|
365
307
|
*/
|
|
366
308
|
showEventLines?: pulumi.Input<boolean>;
|
|
367
309
|
/**
|
|
368
|
-
* Seconds since epoch. Used for visualization
|
|
310
|
+
* Seconds since epoch. Used for visualization. Conflicts with `timeRange`.
|
|
369
311
|
*/
|
|
370
312
|
startTime?: pulumi.Input<number>;
|
|
371
313
|
/**
|
|
372
|
-
* Tags associated with the detector
|
|
314
|
+
* Tags associated with the detector.
|
|
373
315
|
*/
|
|
374
316
|
tags?: pulumi.Input<pulumi.Input<string>[]>;
|
|
375
317
|
/**
|
|
376
|
-
* Team IDs to associate the detector to
|
|
318
|
+
* Team IDs to associate the detector to.
|
|
377
319
|
*/
|
|
378
320
|
teams?: pulumi.Input<pulumi.Input<string>[]>;
|
|
379
321
|
/**
|
|
380
|
-
* Seconds to display in the visualization. This is a rolling range from the current time. Example: 3600
|
|
381
|
-
* to 3600
|
|
322
|
+
* Seconds to display in the visualization. This is a rolling range from the current time. Example: `3600` corresponds to `-1h` in web UI. `3600` by default.
|
|
382
323
|
*/
|
|
383
324
|
timeRange?: pulumi.Input<number>;
|
|
384
325
|
/**
|
|
@@ -386,7 +327,7 @@ export interface DetectorArgs {
|
|
|
386
327
|
*/
|
|
387
328
|
timezone?: pulumi.Input<string>;
|
|
388
329
|
/**
|
|
389
|
-
* Plot-level customization options, associated with a publish statement
|
|
330
|
+
* Plot-level customization options, associated with a publish statement.
|
|
390
331
|
*/
|
|
391
332
|
vizOptions?: pulumi.Input<pulumi.Input<inputs.DetectorVizOption>[]>;
|
|
392
333
|
}
|
package/detector.js
CHANGED
|
@@ -56,57 +56,6 @@ const utilities = require("./utilities");
|
|
|
56
56
|
*
|
|
57
57
|
* Or configure one inline:
|
|
58
58
|
*
|
|
59
|
-
* ## Arguments
|
|
60
|
-
*
|
|
61
|
-
* * `name` - (Required) Name of the detector.
|
|
62
|
-
* * `programText` - (Required) Signalflow program text for the detector. More info [in the Splunk Observability Cloud docs](https://dev.splunk.com/observability/docs/signalflow/).
|
|
63
|
-
* * `description` - (Optional) Description of the detector.
|
|
64
|
-
* * `authorizedWriterTeams` - (Optional) Team IDs that have write access to this detector. Remember to use an admin's token if using this feature and to include that admin's team id (or user id in `authorizedWriterUsers`).
|
|
65
|
-
* * `authorizedWriterUsers` - (Optional) User IDs that have write access to this detector. Remember to use an admin's token if using this feature and to include that admin's user id (or team id in `authorizedWriterTeams`).
|
|
66
|
-
* * `maxDelay` - (Optional) How long (in seconds) to wait for late datapoints. See [Delayed Datapoints](https://docs.splunk.com/observability/en/data-visualization/charts/chart-builder.html#delayed-datapoints) for more info. Max value is `900` seconds (15 minutes). `Auto` (as little as possible) by default.
|
|
67
|
-
* * `minDelay` - (Optional) How long (in seconds) to wait even if the datapoints are arriving in a timely fashion. Max value is 900 (15m).
|
|
68
|
-
* * `showDataMarkers` - (Optional) When `true`, markers will be drawn for each datapoint within the visualization. `true` by default.
|
|
69
|
-
* * `showEventLines` - (Optional) When `true`, the visualization will display a vertical line for each event trigger. `false` by default.
|
|
70
|
-
* * `disableSampling` - (Optional) When `false`, the visualization may sample the output timeseries rather than displaying them all. `false` by default.
|
|
71
|
-
* * `timeRange` - (Optional) Seconds to display in the visualization. This is a rolling range from the current time. Example: `3600` corresponds to `-1h` in web UI. `3600` by default.
|
|
72
|
-
* * `startTime` - (Optional) Seconds since epoch. Used for visualization. Conflicts with `timeRange`.
|
|
73
|
-
* * `endTime` - (Optional) Seconds since epoch. Used for visualization. Conflicts with `timeRange`.
|
|
74
|
-
* * `tags` - (Optional) Tags associated with the detector.
|
|
75
|
-
* * `teams` - (Optional) Team IDs to associate the detector to.
|
|
76
|
-
* * `rule` - (Required) Set of rules used for alerting.
|
|
77
|
-
* * `detectLabel` - (Required) A detect label which matches a detect label within `programText`.
|
|
78
|
-
* * `severity` - (Required) The severity of the rule, must be one of: `"Critical"`, `"Major"`, `"Minor"`, `"Warning"`, `"Info"`.
|
|
79
|
-
* * `description` - (Optional) Description for the rule. Displays as the alert condition in the Alert Rules tab of the detector editor in the web UI.
|
|
80
|
-
* * `disabled` - (Optional) When true, notifications and events will not be generated for the detect label. `false` by default.
|
|
81
|
-
* * `notifications` - (Optional) List of strings specifying where notifications will be sent when an incident occurs. See [Create A Single Detector](https://dev.splunk.com/observability/reference/api/detectors/latest) for more info.
|
|
82
|
-
* * `parameterizedBody` - (Optional) Custom notification message body when an alert is triggered. See [Set Up Detectors to Trigger Alerts](https://docs.splunk.com/observability/en/alerts-detectors-notifications/create-detectors-for-alerts.html) for more info.
|
|
83
|
-
* * `parameterizedSubject` - (Optional) Custom notification message subject when an alert is triggered. See [Set Up Detectors to Trigger Alerts](https://docs.splunk.com/observability/en/alerts-detectors-notifications/create-detectors-for-alerts.html) for more info.
|
|
84
|
-
* * `runbookUrl` - (Optional) URL of page to consult when an alert is triggered. This can be used with custom notification messages.
|
|
85
|
-
* * `tip` - (Optional) Plain text suggested first course of action, such as a command line to execute. This can be used with custom notification messages.
|
|
86
|
-
* * `vizOptions` - (Optional) Plot-level customization options, associated with a publish statement.
|
|
87
|
-
* * `label` - (Required) Label used in the publish statement that displays the plot (metric time series data) you want to customize.
|
|
88
|
-
* * `displayName` - (Optional) Specifies an alternate value for the Plot Name column of the Data Table associated with the chart.
|
|
89
|
-
* * `color` - (Optional) Color to use : gray, blue, azure, navy, brown, orange, yellow, iris, magenta, pink, purple, violet, lilac, emerald, green, aquamarine.
|
|
90
|
-
* * `valueUnit` - (Optional) A unit to attach to this plot. Units support automatic scaling (eg thousands of bytes will be displayed as kilobytes). Values values are `Bit, Kilobit, Megabit, Gigabit, Terabit, Petabit, Exabit, Zettabit, Yottabit, Byte, Kibibyte, Mebibyte, Gibibyte (note: this was previously typoed as Gigibyte), Tebibyte, Pebibyte, Exbibyte, Zebibyte, Yobibyte, Nanosecond, Microsecond, Millisecond, Second, Minute, Hour, Day, Week`.
|
|
91
|
-
* * `valuePrefix`, `valueSuffix` - (Optional) Arbitrary prefix/suffix to display with the value of this plot.
|
|
92
|
-
*
|
|
93
|
-
* **Notes**
|
|
94
|
-
*
|
|
95
|
-
* Use both `maxDelay` in your detector configuration and an `extrapolation` policy in your program text to reduce false positives and false negatives.
|
|
96
|
-
*
|
|
97
|
-
* - `maxDelay` allows Splunk Observability Cloud to continue with computation if there is a lag in receiving data points.
|
|
98
|
-
* - `extrapolation` allows you to specify how to handle missing data. An extrapolation policy can be added to individual signals by updating the data block in your `programText`.
|
|
99
|
-
*
|
|
100
|
-
* See [Delayed Datapoints](https://docs.splunk.com/observability/en/data-visualization/charts/chart-builder.html#delayed-datapoints) for more info.
|
|
101
|
-
*
|
|
102
|
-
* ## Attributes
|
|
103
|
-
*
|
|
104
|
-
* In a addition to all arguments above, the following attributes are exported:
|
|
105
|
-
*
|
|
106
|
-
* * `id` - The ID of the detector.
|
|
107
|
-
* * `labelResolutions` - The resolutions of the detector alerts in milliseconds that indicate how often data is analyzed to determine if an alert should be triggered.
|
|
108
|
-
* * `url` - The URL of the detector.
|
|
109
|
-
*
|
|
110
59
|
* ## Import
|
|
111
60
|
*
|
|
112
61
|
* Detectors can be imported using their string ID (recoverable from URL: `/#/detector/v2/abc123/edit`, e.g.
|
package/detector.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"detector.js","sourceRoot":"","sources":["../detector.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AAGzC,yCAAyC;AAEzC
|
|
1
|
+
{"version":3,"file":"detector.js","sourceRoot":"","sources":["../detector.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AAGzC,yCAAyC;AAEzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0DG;AACH,MAAa,QAAS,SAAQ,MAAM,CAAC,cAAc;IAC/C;;;;;;;;OAQG;IACI,MAAM,CAAC,GAAG,CAAC,IAAY,EAAE,EAA2B,EAAE,KAAqB,EAAE,IAAmC;QACnH,OAAO,IAAI,QAAQ,CAAC,IAAI,EAAO,KAAK,kCAAO,IAAI,KAAE,EAAE,EAAE,EAAE,IAAG,CAAC;IAC/D,CAAC;IAKD;;;OAGG;IACI,MAAM,CAAC,UAAU,CAAC,GAAQ;QAC7B,IAAI,GAAG,KAAK,SAAS,IAAI,GAAG,KAAK,IAAI,EAAE;YACnC,OAAO,KAAK,CAAC;SAChB;QACD,OAAO,GAAG,CAAC,cAAc,CAAC,KAAK,QAAQ,CAAC,YAAY,CAAC;IACzD,CAAC;IA2FD,YAAY,IAAY,EAAE,WAA0C,EAAE,IAAmC;QACrG,IAAI,cAAc,GAAkB,EAAE,CAAC;QACvC,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;QAClB,IAAI,IAAI,CAAC,EAAE,EAAE;YACT,MAAM,KAAK,GAAG,WAAwC,CAAC;YACvD,cAAc,CAAC,uBAAuB,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,qBAAqB,CAAC,CAAC,CAAC,SAAS,CAAC;YAC1F,cAAc,CAAC,uBAAuB,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,qBAAqB,CAAC,CAAC,CAAC,SAAS,CAAC;YAC1F,cAAc,CAAC,aAAa,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC;YACtE,cAAc,CAAC,iBAAiB,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,CAAC,SAAS,CAAC;YAC9E,cAAc,CAAC,SAAS,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC;YAC9D,cAAc,CAAC,kBAAkB,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC,CAAC,SAAS,CAAC;YAChF,cAAc,CAAC,UAAU,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC;YAChE,cAAc,CAAC,UAAU,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC;YAChE,cAAc,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;YACxD,cAAc,CAAC,aAAa,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC;YACtE,cAAc,CAAC,OAAO,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;YAC1D,cAAc,CAAC,iBAAiB,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,CAAC,SAAS,CAAC;YAC9E,cAAc,CAAC,gBAAgB,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC,CAAC,SAAS,CAAC;YAC5E,cAAc,CAAC,WAAW,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC;YAClE,cAAc,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;YACxD,cAAc,CAAC,OAAO,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;YAC1D,cAAc,CAAC,WAAW,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC;YAClE,cAAc,CAAC,UAAU,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC;YAChE,cAAc,CAAC,KAAK,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC;YACtD,cAAc,CAAC,YAAY,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC;SACvE;aAAM;YACH,MAAM,IAAI,GAAG,WAAuC,CAAC;YACrD,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,WAAW,KAAK,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBACxD,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAC;aAC9D;YACD,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,KAAK,KAAK,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBAClD,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;aACxD;YACD,cAAc,CAAC,uBAAuB,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC,CAAC,SAAS,CAAC;YACxF,cAAc,CAAC,uBAAuB,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC,CAAC,SAAS,CAAC;YACxF,cAAc,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC;YACpE,cAAc,CAAC,iBAAiB,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,SAAS,CAAC;YAC5E,cAAc,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC;YAC5D,cAAc,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC;YAC9D,cAAc,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC;YAC9D,cAAc,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;YACtD,cAAc,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC;YACpE,cAAc,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;YACxD,cAAc,CAAC,iBAAiB,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,SAAS,CAAC;YAC5E,cAAc,CAAC,gBAAgB,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,SAAS,CAAC;YAC1E,cAAc,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC;YAChE,cAAc,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;YACtD,cAAc,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;YACxD,cAAc,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC;YAChE,cAAc,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC;YAC9D,cAAc,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC;YAClE,cAAc,CAAC,kBAAkB,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;YACvD,cAAc,CAAC,KAAK,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;SAC7C;QACD,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,CAAC,CAAC;QACnE,KAAK,CAAC,QAAQ,CAAC,YAAY,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,CAAC,CAAC;IAC7D,CAAC;;AA7KL,4BA8KC;AAhKG,gBAAgB;AACO,qBAAY,GAAG,kCAAkC,CAAC"}
|