@pulumi/signalfx 7.0.1 → 7.0.2
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 +37 -19
- package/alertMutingRule.js +22 -4
- package/alertMutingRule.js.map +1 -1
- package/aws/externalIntegration.d.ts +23 -11
- package/aws/externalIntegration.js +16 -4
- package/aws/externalIntegration.js.map +1 -1
- package/aws/integration.d.ts +141 -72
- package/aws/integration.js +41 -4
- package/aws/integration.js.map +1 -1
- package/aws/tokenIntegration.d.ts +18 -7
- package/aws/tokenIntegration.js +13 -2
- package/aws/tokenIntegration.js.map +1 -1
- package/azure/integration.d.ts +101 -45
- package/azure/integration.js +29 -3
- package/azure/integration.js.map +1 -1
- package/config/vars.d.ts +3 -3
- package/dashboard.d.ts +62 -62
- package/dashboardGroup.d.ts +62 -27
- package/dashboardGroup.js +41 -6
- package/dashboardGroup.js.map +1 -1
- package/dataLink.d.ts +52 -18
- package/dataLink.js +31 -3
- package/dataLink.js.map +1 -1
- package/detector.d.ts +133 -70
- package/detector.js +70 -15
- package/detector.js.map +1 -1
- package/eventFeedChart.d.ts +38 -20
- package/eventFeedChart.js +18 -0
- package/eventFeedChart.js.map +1 -1
- package/gcp/integration.d.ts +64 -33
- package/gcp/integration.js +22 -3
- package/gcp/integration.js.map +1 -1
- package/getDimensionValues.d.ts +18 -2
- package/getDimensionValues.js +18 -2
- package/getDimensionValues.js.map +1 -1
- package/heatmapChart.d.ts +80 -46
- package/heatmapChart.js +36 -2
- package/heatmapChart.js.map +1 -1
- package/jira/integration.d.ts +51 -24
- package/jira/integration.js +24 -3
- package/jira/integration.js.map +1 -1
- package/listChart.d.ts +111 -64
- package/listChart.js +46 -2
- package/listChart.js.map +1 -1
- package/log/timeline.d.ts +44 -24
- package/log/timeline.js +21 -1
- package/log/timeline.js.map +1 -1
- package/log/view.d.ts +54 -31
- package/log/view.js +25 -2
- package/log/view.js.map +1 -1
- package/metricRuleset.d.ts +33 -11
- package/metricRuleset.js +24 -2
- package/metricRuleset.js.map +1 -1
- package/opsgenie/integration.d.ts +28 -15
- package/opsgenie/integration.js +16 -3
- package/opsgenie/integration.js.map +1 -1
- package/orgToken.d.ts +50 -39
- package/orgToken.js +32 -3
- package/orgToken.js.map +1 -1
- package/package.json +1 -1
- package/pagerduty/getIntegration.d.ts +22 -14
- package/pagerduty/getIntegration.js +22 -2
- package/pagerduty/getIntegration.js.map +1 -1
- package/pagerduty/integration.d.ts +23 -12
- package/pagerduty/integration.js +14 -3
- package/pagerduty/integration.js.map +1 -1
- package/provider.d.ts +6 -6
- package/servicenow/integration.d.ts +46 -17
- package/servicenow/integration.js +19 -2
- package/servicenow/integration.js.map +1 -1
- package/singleValueChart.d.ts +74 -39
- package/singleValueChart.js +36 -1
- package/singleValueChart.js.map +1 -1
- package/slack/integration.d.ts +24 -12
- package/slack/integration.js +15 -3
- package/slack/integration.js.map +1 -1
- package/tableChart.d.ts +32 -16
- package/tableChart.js +18 -2
- package/tableChart.js.map +1 -1
- package/team.d.ts +54 -33
- package/team.js +25 -4
- package/team.js.map +1 -1
- package/textChart.d.ts +27 -12
- package/textChart.js +16 -1
- package/textChart.js.map +1 -1
- package/timeChart.d.ts +148 -94
- package/timeChart.js +68 -2
- package/timeChart.js.map +1 -1
- package/types/input.d.ts +0 -577
- package/types/output.d.ts +0 -577
- package/victorops/integration.d.ts +24 -12
- package/victorops/integration.js +15 -3
- package/victorops/integration.js.map +1 -1
- package/webhookIntegration.d.ts +31 -15
- package/webhookIntegration.js +19 -3
- package/webhookIntegration.js.map +1 -1
package/detector.d.ts
CHANGED
|
@@ -2,13 +2,13 @@ import * as pulumi from "@pulumi/pulumi";
|
|
|
2
2
|
import * as inputs from "./types/input";
|
|
3
3
|
import * as outputs from "./types/output";
|
|
4
4
|
/**
|
|
5
|
-
* Provides a
|
|
5
|
+
* Provides a Splunk Observability Cloud detector resource. This can be used to create and manage detectors.
|
|
6
6
|
*
|
|
7
|
-
*
|
|
7
|
+
* If you're interested in using Splunk Observability Cloud detector features such as Historical Anomaly, Resource Running Out, or others, consider building them in the UI first and then use the "Show SignalFlow" feature to extract the value for `programText`. You can also see the [documentation for detector functions in signalflow-library](https://github.com/signalfx/signalflow-library/tree/master/library/signalfx/detectors).
|
|
8
8
|
*
|
|
9
|
-
* > **NOTE** When you want to
|
|
9
|
+
* > **NOTE** When you want to change or remove write permissions for a user other than yourself regarding detectors, use a session token of an administrator to authenticate the Splunk Observability Cloud provider. See [Operations that require a session token for an administrator](https://dev.splunk.com/observability/docs/administration/authtokens#Operations-that-require-a-session-token-for-an-administrator).
|
|
10
10
|
*
|
|
11
|
-
* ## Example
|
|
11
|
+
* ## Example
|
|
12
12
|
*
|
|
13
13
|
* ```typescript
|
|
14
14
|
* import * as pulumi from "@pulumi/pulumi";
|
|
@@ -51,15 +51,18 @@ import * as outputs from "./types/output";
|
|
|
51
51
|
* }));
|
|
52
52
|
* }
|
|
53
53
|
* ```
|
|
54
|
-
* ## Notification Format
|
|
55
54
|
*
|
|
56
|
-
*
|
|
55
|
+
* ## Notification format
|
|
56
|
+
*
|
|
57
|
+
* As Splunk Observability Cloud supports different notification mechanisms, use a comma-delimited string to provide inputs. If you want to specify multiple notifications, each must be a member in the list, like so:
|
|
57
58
|
*
|
|
58
59
|
* ```typescript
|
|
59
60
|
* import * as pulumi from "@pulumi/pulumi";
|
|
60
61
|
* ```
|
|
61
62
|
*
|
|
62
|
-
*
|
|
63
|
+
* See [Splunk Observability Cloud Docs](https://dev.splunk.com/observability/reference/api/detectors/latest) for more information.
|
|
64
|
+
*
|
|
65
|
+
* Here are some example of how to configure each notification type:
|
|
63
66
|
*
|
|
64
67
|
* ### Email
|
|
65
68
|
*
|
|
@@ -69,15 +72,15 @@ import * as outputs from "./types/output";
|
|
|
69
72
|
*
|
|
70
73
|
* ### Jira
|
|
71
74
|
*
|
|
72
|
-
* Note that the `credentialId` is the
|
|
75
|
+
* Note that the `credentialId` is the Splunk-provided ID shown after setting up your Jira integration. See also `signalfx.jira.Integration`.
|
|
73
76
|
*
|
|
74
77
|
* ```typescript
|
|
75
78
|
* import * as pulumi from "@pulumi/pulumi";
|
|
76
79
|
* ```
|
|
77
80
|
*
|
|
78
|
-
* ###
|
|
81
|
+
* ### OpsGenie
|
|
79
82
|
*
|
|
80
|
-
* Note that the `credentialId` is the
|
|
83
|
+
* Note that the `credentialId` is the Splunk-provided ID shown after setting up your Opsgenie integration. `Team` here is hardcoded as the `responderType` as that is the only acceptable type as per the API docs.
|
|
81
84
|
*
|
|
82
85
|
* ```typescript
|
|
83
86
|
* import * as pulumi from "@pulumi/pulumi";
|
|
@@ -91,7 +94,7 @@ import * as outputs from "./types/output";
|
|
|
91
94
|
*
|
|
92
95
|
* ### Slack
|
|
93
96
|
*
|
|
94
|
-
* Exclude the `#` on the channel name
|
|
97
|
+
* Exclude the `#` on the channel name:
|
|
95
98
|
*
|
|
96
99
|
* ```typescript
|
|
97
100
|
* import * as pulumi from "@pulumi/pulumi";
|
|
@@ -113,26 +116,78 @@ import * as outputs from "./types/output";
|
|
|
113
116
|
* import * as pulumi from "@pulumi/pulumi";
|
|
114
117
|
* ```
|
|
115
118
|
*
|
|
116
|
-
* ### VictorOps
|
|
119
|
+
* ### Splunk On-Call (formerly VictorOps)
|
|
117
120
|
*
|
|
118
121
|
* ```typescript
|
|
119
122
|
* import * as pulumi from "@pulumi/pulumi";
|
|
120
123
|
* ```
|
|
121
124
|
*
|
|
122
|
-
* ###
|
|
125
|
+
* ### Webhooks
|
|
123
126
|
*
|
|
124
|
-
*
|
|
127
|
+
* You need to include all the commas even if you only use a credential id.
|
|
125
128
|
*
|
|
126
129
|
* You can either configure a Webhook to use an existing integration's credential id:
|
|
127
130
|
* ```typescript
|
|
128
131
|
* import * as pulumi from "@pulumi/pulumi";
|
|
129
132
|
* ```
|
|
130
133
|
*
|
|
131
|
-
*
|
|
134
|
+
* Or configure one inline:
|
|
135
|
+
*
|
|
132
136
|
* ```typescript
|
|
133
137
|
* import * as pulumi from "@pulumi/pulumi";
|
|
134
138
|
* ```
|
|
135
139
|
*
|
|
140
|
+
* ## Arguments
|
|
141
|
+
*
|
|
142
|
+
* * `name` - (Required) Name of the detector.
|
|
143
|
+
* * `programText` - (Required) Signalflow program text for the detector. More info [in the Splunk Observability Cloud docs](https://dev.splunk.com/observability/docs/signalflow/).
|
|
144
|
+
* * `description` - (Optional) Description of the detector.
|
|
145
|
+
* * `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`).
|
|
146
|
+
* * `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`).
|
|
147
|
+
* * `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.
|
|
148
|
+
* * `minDelay` - (Optional) How long (in seconds) to wait even if the datapoints are arriving in a timely fashion. Max value is 900 (15m).
|
|
149
|
+
* * `showDataMarkers` - (Optional) When `true`, markers will be drawn for each datapoint within the visualization. `true` by default.
|
|
150
|
+
* * `showEventLines` - (Optional) When `true`, the visualization will display a vertical line for each event trigger. `false` by default.
|
|
151
|
+
* * `disableSampling` - (Optional) When `false`, the visualization may sample the output timeseries rather than displaying them all. `false` by default.
|
|
152
|
+
* * `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.
|
|
153
|
+
* * `startTime` - (Optional) Seconds since epoch. Used for visualization. Conflicts with `timeRange`.
|
|
154
|
+
* * `endTime` - (Optional) Seconds since epoch. Used for visualization. Conflicts with `timeRange`.
|
|
155
|
+
* * `tags` - (Optional) Tags associated with the detector.
|
|
156
|
+
* * `teams` - (Optional) Team IDs to associate the detector to.
|
|
157
|
+
* * `rule` - (Required) Set of rules used for alerting.
|
|
158
|
+
* * `detectLabel` - (Required) A detect label which matches a detect label within `programText`.
|
|
159
|
+
* * `severity` - (Required) The severity of the rule, must be one of: `"Critical"`, `"Major"`, `"Minor"`, `"Warning"`, `"Info"`.
|
|
160
|
+
* * `description` - (Optional) Description for the rule. Displays as the alert condition in the Alert Rules tab of the detector editor in the web UI.
|
|
161
|
+
* * `disabled` - (Optional) When true, notifications and events will not be generated for the detect label. `false` by default.
|
|
162
|
+
* * `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.
|
|
163
|
+
* * `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.
|
|
164
|
+
* * `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.
|
|
165
|
+
* * `runbookUrl` - (Optional) URL of page to consult when an alert is triggered. This can be used with custom notification messages.
|
|
166
|
+
* * `tip` - (Optional) Plain text suggested first course of action, such as a command line to execute. This can be used with custom notification messages.
|
|
167
|
+
* * `vizOptions` - (Optional) Plot-level customization options, associated with a publish statement.
|
|
168
|
+
* * `label` - (Required) Label used in the publish statement that displays the plot (metric time series data) you want to customize.
|
|
169
|
+
* * `displayName` - (Optional) Specifies an alternate value for the Plot Name column of the Data Table associated with the chart.
|
|
170
|
+
* * `color` - (Optional) Color to use : gray, blue, azure, navy, brown, orange, yellow, iris, magenta, pink, purple, violet, lilac, emerald, green, aquamarine.
|
|
171
|
+
* * `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`.
|
|
172
|
+
* * `valuePrefix`, `valueSuffix` - (Optional) Arbitrary prefix/suffix to display with the value of this plot.
|
|
173
|
+
*
|
|
174
|
+
* **Notes**
|
|
175
|
+
*
|
|
176
|
+
* Use both `maxDelay` in your detector configuration and an `extrapolation` policy in your program text to reduce false positives and false negatives.
|
|
177
|
+
*
|
|
178
|
+
* - `maxDelay` allows Splunk Observability Cloud to continue with computation if there is a lag in receiving data points.
|
|
179
|
+
* - `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`.
|
|
180
|
+
*
|
|
181
|
+
* See [Delayed Datapoints](https://docs.splunk.com/observability/en/data-visualization/charts/chart-builder.html#delayed-datapoints) for more info.
|
|
182
|
+
*
|
|
183
|
+
* ## Attributes
|
|
184
|
+
*
|
|
185
|
+
* In a addition to all arguments above, the following attributes are exported:
|
|
186
|
+
*
|
|
187
|
+
* * `id` - The ID of the detector.
|
|
188
|
+
* * `labelResolutions` - The resolutions of the detector alerts in milliseconds that indicate how often data is analyzed to determine if an alert should be triggered.
|
|
189
|
+
* * `url` - The URL of the detector.
|
|
190
|
+
*
|
|
136
191
|
* ## Import
|
|
137
192
|
*
|
|
138
193
|
* Detectors can be imported using their string ID (recoverable from URL`/#/detector/v2/abc123/edit`, e.g.
|
|
@@ -158,73 +213,76 @@ export declare class Detector extends pulumi.CustomResource {
|
|
|
158
213
|
*/
|
|
159
214
|
static isInstance(obj: any): obj is Detector;
|
|
160
215
|
/**
|
|
161
|
-
* Team IDs that have write access to this
|
|
216
|
+
* Team IDs that have write access to this dashboard
|
|
162
217
|
*/
|
|
163
218
|
readonly authorizedWriterTeams: pulumi.Output<string[] | undefined>;
|
|
164
219
|
/**
|
|
165
|
-
* User IDs that have write access to this
|
|
220
|
+
* User IDs that have write access to this dashboard
|
|
166
221
|
*/
|
|
167
222
|
readonly authorizedWriterUsers: pulumi.Output<string[] | undefined>;
|
|
168
223
|
/**
|
|
169
|
-
* Description
|
|
224
|
+
* Description of the detector
|
|
170
225
|
*/
|
|
171
226
|
readonly description: pulumi.Output<string | undefined>;
|
|
172
227
|
/**
|
|
173
|
-
* When
|
|
228
|
+
* (false by default) When false, samples a subset of the output MTS in the visualization.
|
|
174
229
|
*/
|
|
175
230
|
readonly disableSampling: pulumi.Output<boolean | undefined>;
|
|
176
231
|
/**
|
|
177
|
-
* Seconds since epoch. Used for visualization
|
|
232
|
+
* Seconds since epoch. Used for visualization
|
|
178
233
|
*/
|
|
179
234
|
readonly endTime: pulumi.Output<number | undefined>;
|
|
180
235
|
/**
|
|
181
|
-
*
|
|
236
|
+
* Resolutions of the detector alerts in milliseconds that indicate how often data is analyzed to determine if an alert
|
|
237
|
+
* should be triggered
|
|
182
238
|
*/
|
|
183
239
|
readonly labelResolutions: pulumi.Output<{
|
|
184
240
|
[key: string]: number;
|
|
185
241
|
}>;
|
|
186
242
|
/**
|
|
187
|
-
*
|
|
243
|
+
* Maximum time (in seconds) to wait for late datapoints. Max value is 900 (15m)
|
|
188
244
|
*/
|
|
189
245
|
readonly maxDelay: pulumi.Output<number | undefined>;
|
|
190
246
|
/**
|
|
191
|
-
*
|
|
247
|
+
* Minimum time (in seconds) for the computation to wait even if the datapoints are arriving in a timely fashion. Max value
|
|
248
|
+
* is 900 (15m)
|
|
192
249
|
*/
|
|
193
250
|
readonly minDelay: pulumi.Output<number | undefined>;
|
|
194
251
|
/**
|
|
195
|
-
* Name of the detector
|
|
252
|
+
* Name of the detector
|
|
196
253
|
*/
|
|
197
254
|
readonly name: pulumi.Output<string>;
|
|
198
255
|
/**
|
|
199
|
-
* Signalflow program text for the detector. More info
|
|
256
|
+
* Signalflow program text for the detector. More info at "https://developers.signalfx.com/docs/signalflow-overview"
|
|
200
257
|
*/
|
|
201
258
|
readonly programText: pulumi.Output<string>;
|
|
202
259
|
/**
|
|
203
|
-
* Set of rules used for alerting
|
|
260
|
+
* Set of rules used for alerting
|
|
204
261
|
*/
|
|
205
262
|
readonly rules: pulumi.Output<outputs.DetectorRule[]>;
|
|
206
263
|
/**
|
|
207
|
-
* When
|
|
264
|
+
* (true by default) When true, markers will be drawn for each datapoint within the visualization.
|
|
208
265
|
*/
|
|
209
266
|
readonly showDataMarkers: pulumi.Output<boolean | undefined>;
|
|
210
267
|
/**
|
|
211
|
-
* When
|
|
268
|
+
* (false by default) When true, vertical lines will be drawn for each triggered event within the visualization.
|
|
212
269
|
*/
|
|
213
270
|
readonly showEventLines: pulumi.Output<boolean | undefined>;
|
|
214
271
|
/**
|
|
215
|
-
* Seconds since epoch. Used for visualization
|
|
272
|
+
* Seconds since epoch. Used for visualization
|
|
216
273
|
*/
|
|
217
274
|
readonly startTime: pulumi.Output<number | undefined>;
|
|
218
275
|
/**
|
|
219
|
-
* Tags associated with the detector
|
|
276
|
+
* Tags associated with the detector
|
|
220
277
|
*/
|
|
221
278
|
readonly tags: pulumi.Output<string[] | undefined>;
|
|
222
279
|
/**
|
|
223
|
-
* Team IDs to associate the detector to
|
|
280
|
+
* Team IDs to associate the detector to
|
|
224
281
|
*/
|
|
225
282
|
readonly teams: pulumi.Output<string[] | undefined>;
|
|
226
283
|
/**
|
|
227
|
-
* Seconds to display in the visualization. This is a rolling range from the current time. Example:
|
|
284
|
+
* Seconds to display in the visualization. This is a rolling range from the current time. Example: 3600 = `-1h`. Defaults
|
|
285
|
+
* to 3600
|
|
228
286
|
*/
|
|
229
287
|
readonly timeRange: pulumi.Output<number | undefined>;
|
|
230
288
|
/**
|
|
@@ -232,11 +290,11 @@ export declare class Detector extends pulumi.CustomResource {
|
|
|
232
290
|
*/
|
|
233
291
|
readonly timezone: pulumi.Output<string | undefined>;
|
|
234
292
|
/**
|
|
235
|
-
*
|
|
293
|
+
* URL of the detector
|
|
236
294
|
*/
|
|
237
295
|
readonly url: pulumi.Output<string>;
|
|
238
296
|
/**
|
|
239
|
-
* Plot-level customization options, associated with a publish statement
|
|
297
|
+
* Plot-level customization options, associated with a publish statement
|
|
240
298
|
*/
|
|
241
299
|
readonly vizOptions: pulumi.Output<outputs.DetectorVizOption[] | undefined>;
|
|
242
300
|
/**
|
|
@@ -253,73 +311,76 @@ export declare class Detector extends pulumi.CustomResource {
|
|
|
253
311
|
*/
|
|
254
312
|
export interface DetectorState {
|
|
255
313
|
/**
|
|
256
|
-
* Team IDs that have write access to this
|
|
314
|
+
* Team IDs that have write access to this dashboard
|
|
257
315
|
*/
|
|
258
316
|
authorizedWriterTeams?: pulumi.Input<pulumi.Input<string>[]>;
|
|
259
317
|
/**
|
|
260
|
-
* User IDs that have write access to this
|
|
318
|
+
* User IDs that have write access to this dashboard
|
|
261
319
|
*/
|
|
262
320
|
authorizedWriterUsers?: pulumi.Input<pulumi.Input<string>[]>;
|
|
263
321
|
/**
|
|
264
|
-
* Description
|
|
322
|
+
* Description of the detector
|
|
265
323
|
*/
|
|
266
324
|
description?: pulumi.Input<string>;
|
|
267
325
|
/**
|
|
268
|
-
* When
|
|
326
|
+
* (false by default) When false, samples a subset of the output MTS in the visualization.
|
|
269
327
|
*/
|
|
270
328
|
disableSampling?: pulumi.Input<boolean>;
|
|
271
329
|
/**
|
|
272
|
-
* Seconds since epoch. Used for visualization
|
|
330
|
+
* Seconds since epoch. Used for visualization
|
|
273
331
|
*/
|
|
274
332
|
endTime?: pulumi.Input<number>;
|
|
275
333
|
/**
|
|
276
|
-
*
|
|
334
|
+
* Resolutions of the detector alerts in milliseconds that indicate how often data is analyzed to determine if an alert
|
|
335
|
+
* should be triggered
|
|
277
336
|
*/
|
|
278
337
|
labelResolutions?: pulumi.Input<{
|
|
279
338
|
[key: string]: pulumi.Input<number>;
|
|
280
339
|
}>;
|
|
281
340
|
/**
|
|
282
|
-
*
|
|
341
|
+
* Maximum time (in seconds) to wait for late datapoints. Max value is 900 (15m)
|
|
283
342
|
*/
|
|
284
343
|
maxDelay?: pulumi.Input<number>;
|
|
285
344
|
/**
|
|
286
|
-
*
|
|
345
|
+
* Minimum time (in seconds) for the computation to wait even if the datapoints are arriving in a timely fashion. Max value
|
|
346
|
+
* is 900 (15m)
|
|
287
347
|
*/
|
|
288
348
|
minDelay?: pulumi.Input<number>;
|
|
289
349
|
/**
|
|
290
|
-
* Name of the detector
|
|
350
|
+
* Name of the detector
|
|
291
351
|
*/
|
|
292
352
|
name?: pulumi.Input<string>;
|
|
293
353
|
/**
|
|
294
|
-
* Signalflow program text for the detector. More info
|
|
354
|
+
* Signalflow program text for the detector. More info at "https://developers.signalfx.com/docs/signalflow-overview"
|
|
295
355
|
*/
|
|
296
356
|
programText?: pulumi.Input<string>;
|
|
297
357
|
/**
|
|
298
|
-
* Set of rules used for alerting
|
|
358
|
+
* Set of rules used for alerting
|
|
299
359
|
*/
|
|
300
360
|
rules?: pulumi.Input<pulumi.Input<inputs.DetectorRule>[]>;
|
|
301
361
|
/**
|
|
302
|
-
* When
|
|
362
|
+
* (true by default) When true, markers will be drawn for each datapoint within the visualization.
|
|
303
363
|
*/
|
|
304
364
|
showDataMarkers?: pulumi.Input<boolean>;
|
|
305
365
|
/**
|
|
306
|
-
* When
|
|
366
|
+
* (false by default) When true, vertical lines will be drawn for each triggered event within the visualization.
|
|
307
367
|
*/
|
|
308
368
|
showEventLines?: pulumi.Input<boolean>;
|
|
309
369
|
/**
|
|
310
|
-
* Seconds since epoch. Used for visualization
|
|
370
|
+
* Seconds since epoch. Used for visualization
|
|
311
371
|
*/
|
|
312
372
|
startTime?: pulumi.Input<number>;
|
|
313
373
|
/**
|
|
314
|
-
* Tags associated with the detector
|
|
374
|
+
* Tags associated with the detector
|
|
315
375
|
*/
|
|
316
376
|
tags?: pulumi.Input<pulumi.Input<string>[]>;
|
|
317
377
|
/**
|
|
318
|
-
* Team IDs to associate the detector to
|
|
378
|
+
* Team IDs to associate the detector to
|
|
319
379
|
*/
|
|
320
380
|
teams?: pulumi.Input<pulumi.Input<string>[]>;
|
|
321
381
|
/**
|
|
322
|
-
* Seconds to display in the visualization. This is a rolling range from the current time. Example:
|
|
382
|
+
* Seconds to display in the visualization. This is a rolling range from the current time. Example: 3600 = `-1h`. Defaults
|
|
383
|
+
* to 3600
|
|
323
384
|
*/
|
|
324
385
|
timeRange?: pulumi.Input<number>;
|
|
325
386
|
/**
|
|
@@ -327,11 +388,11 @@ export interface DetectorState {
|
|
|
327
388
|
*/
|
|
328
389
|
timezone?: pulumi.Input<string>;
|
|
329
390
|
/**
|
|
330
|
-
*
|
|
391
|
+
* URL of the detector
|
|
331
392
|
*/
|
|
332
393
|
url?: pulumi.Input<string>;
|
|
333
394
|
/**
|
|
334
|
-
* Plot-level customization options, associated with a publish statement
|
|
395
|
+
* Plot-level customization options, associated with a publish statement
|
|
335
396
|
*/
|
|
336
397
|
vizOptions?: pulumi.Input<pulumi.Input<inputs.DetectorVizOption>[]>;
|
|
337
398
|
}
|
|
@@ -340,67 +401,69 @@ export interface DetectorState {
|
|
|
340
401
|
*/
|
|
341
402
|
export interface DetectorArgs {
|
|
342
403
|
/**
|
|
343
|
-
* Team IDs that have write access to this
|
|
404
|
+
* Team IDs that have write access to this dashboard
|
|
344
405
|
*/
|
|
345
406
|
authorizedWriterTeams?: pulumi.Input<pulumi.Input<string>[]>;
|
|
346
407
|
/**
|
|
347
|
-
* User IDs that have write access to this
|
|
408
|
+
* User IDs that have write access to this dashboard
|
|
348
409
|
*/
|
|
349
410
|
authorizedWriterUsers?: pulumi.Input<pulumi.Input<string>[]>;
|
|
350
411
|
/**
|
|
351
|
-
* Description
|
|
412
|
+
* Description of the detector
|
|
352
413
|
*/
|
|
353
414
|
description?: pulumi.Input<string>;
|
|
354
415
|
/**
|
|
355
|
-
* When
|
|
416
|
+
* (false by default) When false, samples a subset of the output MTS in the visualization.
|
|
356
417
|
*/
|
|
357
418
|
disableSampling?: pulumi.Input<boolean>;
|
|
358
419
|
/**
|
|
359
|
-
* Seconds since epoch. Used for visualization
|
|
420
|
+
* Seconds since epoch. Used for visualization
|
|
360
421
|
*/
|
|
361
422
|
endTime?: pulumi.Input<number>;
|
|
362
423
|
/**
|
|
363
|
-
*
|
|
424
|
+
* Maximum time (in seconds) to wait for late datapoints. Max value is 900 (15m)
|
|
364
425
|
*/
|
|
365
426
|
maxDelay?: pulumi.Input<number>;
|
|
366
427
|
/**
|
|
367
|
-
*
|
|
428
|
+
* Minimum time (in seconds) for the computation to wait even if the datapoints are arriving in a timely fashion. Max value
|
|
429
|
+
* is 900 (15m)
|
|
368
430
|
*/
|
|
369
431
|
minDelay?: pulumi.Input<number>;
|
|
370
432
|
/**
|
|
371
|
-
* Name of the detector
|
|
433
|
+
* Name of the detector
|
|
372
434
|
*/
|
|
373
435
|
name?: pulumi.Input<string>;
|
|
374
436
|
/**
|
|
375
|
-
* Signalflow program text for the detector. More info
|
|
437
|
+
* Signalflow program text for the detector. More info at "https://developers.signalfx.com/docs/signalflow-overview"
|
|
376
438
|
*/
|
|
377
439
|
programText: pulumi.Input<string>;
|
|
378
440
|
/**
|
|
379
|
-
* Set of rules used for alerting
|
|
441
|
+
* Set of rules used for alerting
|
|
380
442
|
*/
|
|
381
443
|
rules: pulumi.Input<pulumi.Input<inputs.DetectorRule>[]>;
|
|
382
444
|
/**
|
|
383
|
-
* When
|
|
445
|
+
* (true by default) When true, markers will be drawn for each datapoint within the visualization.
|
|
384
446
|
*/
|
|
385
447
|
showDataMarkers?: pulumi.Input<boolean>;
|
|
386
448
|
/**
|
|
387
|
-
* When
|
|
449
|
+
* (false by default) When true, vertical lines will be drawn for each triggered event within the visualization.
|
|
388
450
|
*/
|
|
389
451
|
showEventLines?: pulumi.Input<boolean>;
|
|
390
452
|
/**
|
|
391
|
-
* Seconds since epoch. Used for visualization
|
|
453
|
+
* Seconds since epoch. Used for visualization
|
|
392
454
|
*/
|
|
393
455
|
startTime?: pulumi.Input<number>;
|
|
394
456
|
/**
|
|
395
|
-
* Tags associated with the detector
|
|
457
|
+
* Tags associated with the detector
|
|
396
458
|
*/
|
|
397
459
|
tags?: pulumi.Input<pulumi.Input<string>[]>;
|
|
398
460
|
/**
|
|
399
|
-
* Team IDs to associate the detector to
|
|
461
|
+
* Team IDs to associate the detector to
|
|
400
462
|
*/
|
|
401
463
|
teams?: pulumi.Input<pulumi.Input<string>[]>;
|
|
402
464
|
/**
|
|
403
|
-
* Seconds to display in the visualization. This is a rolling range from the current time. Example:
|
|
465
|
+
* Seconds to display in the visualization. This is a rolling range from the current time. Example: 3600 = `-1h`. Defaults
|
|
466
|
+
* to 3600
|
|
404
467
|
*/
|
|
405
468
|
timeRange?: pulumi.Input<number>;
|
|
406
469
|
/**
|
|
@@ -408,7 +471,7 @@ export interface DetectorArgs {
|
|
|
408
471
|
*/
|
|
409
472
|
timezone?: pulumi.Input<string>;
|
|
410
473
|
/**
|
|
411
|
-
* Plot-level customization options, associated with a publish statement
|
|
474
|
+
* Plot-level customization options, associated with a publish statement
|
|
412
475
|
*/
|
|
413
476
|
vizOptions?: pulumi.Input<pulumi.Input<inputs.DetectorVizOption>[]>;
|
|
414
477
|
}
|
package/detector.js
CHANGED
|
@@ -6,13 +6,13 @@ exports.Detector = void 0;
|
|
|
6
6
|
const pulumi = require("@pulumi/pulumi");
|
|
7
7
|
const utilities = require("./utilities");
|
|
8
8
|
/**
|
|
9
|
-
* Provides a
|
|
9
|
+
* Provides a Splunk Observability Cloud detector resource. This can be used to create and manage detectors.
|
|
10
10
|
*
|
|
11
|
-
*
|
|
11
|
+
* If you're interested in using Splunk Observability Cloud detector features such as Historical Anomaly, Resource Running Out, or others, consider building them in the UI first and then use the "Show SignalFlow" feature to extract the value for `programText`. You can also see the [documentation for detector functions in signalflow-library](https://github.com/signalfx/signalflow-library/tree/master/library/signalfx/detectors).
|
|
12
12
|
*
|
|
13
|
-
* > **NOTE** When you want to
|
|
13
|
+
* > **NOTE** When you want to change or remove write permissions for a user other than yourself regarding detectors, use a session token of an administrator to authenticate the Splunk Observability Cloud provider. See [Operations that require a session token for an administrator](https://dev.splunk.com/observability/docs/administration/authtokens#Operations-that-require-a-session-token-for-an-administrator).
|
|
14
14
|
*
|
|
15
|
-
* ## Example
|
|
15
|
+
* ## Example
|
|
16
16
|
*
|
|
17
17
|
* ```typescript
|
|
18
18
|
* import * as pulumi from "@pulumi/pulumi";
|
|
@@ -55,15 +55,18 @@ const utilities = require("./utilities");
|
|
|
55
55
|
* }));
|
|
56
56
|
* }
|
|
57
57
|
* ```
|
|
58
|
-
* ## Notification Format
|
|
59
58
|
*
|
|
60
|
-
*
|
|
59
|
+
* ## Notification format
|
|
60
|
+
*
|
|
61
|
+
* As Splunk Observability Cloud supports different notification mechanisms, use a comma-delimited string to provide inputs. If you want to specify multiple notifications, each must be a member in the list, like so:
|
|
61
62
|
*
|
|
62
63
|
* ```typescript
|
|
63
64
|
* import * as pulumi from "@pulumi/pulumi";
|
|
64
65
|
* ```
|
|
65
66
|
*
|
|
66
|
-
*
|
|
67
|
+
* See [Splunk Observability Cloud Docs](https://dev.splunk.com/observability/reference/api/detectors/latest) for more information.
|
|
68
|
+
*
|
|
69
|
+
* Here are some example of how to configure each notification type:
|
|
67
70
|
*
|
|
68
71
|
* ### Email
|
|
69
72
|
*
|
|
@@ -73,15 +76,15 @@ const utilities = require("./utilities");
|
|
|
73
76
|
*
|
|
74
77
|
* ### Jira
|
|
75
78
|
*
|
|
76
|
-
* Note that the `credentialId` is the
|
|
79
|
+
* Note that the `credentialId` is the Splunk-provided ID shown after setting up your Jira integration. See also `signalfx.jira.Integration`.
|
|
77
80
|
*
|
|
78
81
|
* ```typescript
|
|
79
82
|
* import * as pulumi from "@pulumi/pulumi";
|
|
80
83
|
* ```
|
|
81
84
|
*
|
|
82
|
-
* ###
|
|
85
|
+
* ### OpsGenie
|
|
83
86
|
*
|
|
84
|
-
* Note that the `credentialId` is the
|
|
87
|
+
* Note that the `credentialId` is the Splunk-provided ID shown after setting up your Opsgenie integration. `Team` here is hardcoded as the `responderType` as that is the only acceptable type as per the API docs.
|
|
85
88
|
*
|
|
86
89
|
* ```typescript
|
|
87
90
|
* import * as pulumi from "@pulumi/pulumi";
|
|
@@ -95,7 +98,7 @@ const utilities = require("./utilities");
|
|
|
95
98
|
*
|
|
96
99
|
* ### Slack
|
|
97
100
|
*
|
|
98
|
-
* Exclude the `#` on the channel name
|
|
101
|
+
* Exclude the `#` on the channel name:
|
|
99
102
|
*
|
|
100
103
|
* ```typescript
|
|
101
104
|
* import * as pulumi from "@pulumi/pulumi";
|
|
@@ -117,26 +120,78 @@ const utilities = require("./utilities");
|
|
|
117
120
|
* import * as pulumi from "@pulumi/pulumi";
|
|
118
121
|
* ```
|
|
119
122
|
*
|
|
120
|
-
* ### VictorOps
|
|
123
|
+
* ### Splunk On-Call (formerly VictorOps)
|
|
121
124
|
*
|
|
122
125
|
* ```typescript
|
|
123
126
|
* import * as pulumi from "@pulumi/pulumi";
|
|
124
127
|
* ```
|
|
125
128
|
*
|
|
126
|
-
* ###
|
|
129
|
+
* ### Webhooks
|
|
127
130
|
*
|
|
128
|
-
*
|
|
131
|
+
* You need to include all the commas even if you only use a credential id.
|
|
129
132
|
*
|
|
130
133
|
* You can either configure a Webhook to use an existing integration's credential id:
|
|
131
134
|
* ```typescript
|
|
132
135
|
* import * as pulumi from "@pulumi/pulumi";
|
|
133
136
|
* ```
|
|
134
137
|
*
|
|
135
|
-
*
|
|
138
|
+
* Or configure one inline:
|
|
139
|
+
*
|
|
136
140
|
* ```typescript
|
|
137
141
|
* import * as pulumi from "@pulumi/pulumi";
|
|
138
142
|
* ```
|
|
139
143
|
*
|
|
144
|
+
* ## Arguments
|
|
145
|
+
*
|
|
146
|
+
* * `name` - (Required) Name of the detector.
|
|
147
|
+
* * `programText` - (Required) Signalflow program text for the detector. More info [in the Splunk Observability Cloud docs](https://dev.splunk.com/observability/docs/signalflow/).
|
|
148
|
+
* * `description` - (Optional) Description of the detector.
|
|
149
|
+
* * `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`).
|
|
150
|
+
* * `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`).
|
|
151
|
+
* * `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.
|
|
152
|
+
* * `minDelay` - (Optional) How long (in seconds) to wait even if the datapoints are arriving in a timely fashion. Max value is 900 (15m).
|
|
153
|
+
* * `showDataMarkers` - (Optional) When `true`, markers will be drawn for each datapoint within the visualization. `true` by default.
|
|
154
|
+
* * `showEventLines` - (Optional) When `true`, the visualization will display a vertical line for each event trigger. `false` by default.
|
|
155
|
+
* * `disableSampling` - (Optional) When `false`, the visualization may sample the output timeseries rather than displaying them all. `false` by default.
|
|
156
|
+
* * `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.
|
|
157
|
+
* * `startTime` - (Optional) Seconds since epoch. Used for visualization. Conflicts with `timeRange`.
|
|
158
|
+
* * `endTime` - (Optional) Seconds since epoch. Used for visualization. Conflicts with `timeRange`.
|
|
159
|
+
* * `tags` - (Optional) Tags associated with the detector.
|
|
160
|
+
* * `teams` - (Optional) Team IDs to associate the detector to.
|
|
161
|
+
* * `rule` - (Required) Set of rules used for alerting.
|
|
162
|
+
* * `detectLabel` - (Required) A detect label which matches a detect label within `programText`.
|
|
163
|
+
* * `severity` - (Required) The severity of the rule, must be one of: `"Critical"`, `"Major"`, `"Minor"`, `"Warning"`, `"Info"`.
|
|
164
|
+
* * `description` - (Optional) Description for the rule. Displays as the alert condition in the Alert Rules tab of the detector editor in the web UI.
|
|
165
|
+
* * `disabled` - (Optional) When true, notifications and events will not be generated for the detect label. `false` by default.
|
|
166
|
+
* * `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.
|
|
167
|
+
* * `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.
|
|
168
|
+
* * `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.
|
|
169
|
+
* * `runbookUrl` - (Optional) URL of page to consult when an alert is triggered. This can be used with custom notification messages.
|
|
170
|
+
* * `tip` - (Optional) Plain text suggested first course of action, such as a command line to execute. This can be used with custom notification messages.
|
|
171
|
+
* * `vizOptions` - (Optional) Plot-level customization options, associated with a publish statement.
|
|
172
|
+
* * `label` - (Required) Label used in the publish statement that displays the plot (metric time series data) you want to customize.
|
|
173
|
+
* * `displayName` - (Optional) Specifies an alternate value for the Plot Name column of the Data Table associated with the chart.
|
|
174
|
+
* * `color` - (Optional) Color to use : gray, blue, azure, navy, brown, orange, yellow, iris, magenta, pink, purple, violet, lilac, emerald, green, aquamarine.
|
|
175
|
+
* * `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`.
|
|
176
|
+
* * `valuePrefix`, `valueSuffix` - (Optional) Arbitrary prefix/suffix to display with the value of this plot.
|
|
177
|
+
*
|
|
178
|
+
* **Notes**
|
|
179
|
+
*
|
|
180
|
+
* Use both `maxDelay` in your detector configuration and an `extrapolation` policy in your program text to reduce false positives and false negatives.
|
|
181
|
+
*
|
|
182
|
+
* - `maxDelay` allows Splunk Observability Cloud to continue with computation if there is a lag in receiving data points.
|
|
183
|
+
* - `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`.
|
|
184
|
+
*
|
|
185
|
+
* See [Delayed Datapoints](https://docs.splunk.com/observability/en/data-visualization/charts/chart-builder.html#delayed-datapoints) for more info.
|
|
186
|
+
*
|
|
187
|
+
* ## Attributes
|
|
188
|
+
*
|
|
189
|
+
* In a addition to all arguments above, the following attributes are exported:
|
|
190
|
+
*
|
|
191
|
+
* * `id` - The ID of the detector.
|
|
192
|
+
* * `labelResolutions` - The resolutions of the detector alerts in milliseconds that indicate how often data is analyzed to determine if an alert should be triggered.
|
|
193
|
+
* * `url` - The URL of the detector.
|
|
194
|
+
*
|
|
140
195
|
* ## Import
|
|
141
196
|
*
|
|
142
197
|
* Detectors can be imported using their string ID (recoverable from URL`/#/detector/v2/abc123/edit`, e.g.
|