@pulumi/signalfx 7.0.0 → 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 +66 -35
- package/gcp/integration.js +24 -5
- 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 +2 -3
- package/package.json.bak +1 -2
- 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/utilities.d.ts +4 -0
- package/utilities.js +33 -1
- package/utilities.js.map +1 -1
- 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/scripts/install-pulumi-plugin.js +0 -21
package/timeChart.d.ts
CHANGED
|
@@ -2,11 +2,11 @@ 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 time chart resource. This can be used to create and manage the different types of time charts.
|
|
6
6
|
*
|
|
7
7
|
* Time charts display data points over a period of time.
|
|
8
8
|
*
|
|
9
|
-
* ## Example
|
|
9
|
+
* ## Example
|
|
10
10
|
*
|
|
11
11
|
* ```typescript
|
|
12
12
|
* import * as pulumi from "@pulumi/pulumi";
|
|
@@ -40,6 +40,72 @@ import * as outputs from "./types/output";
|
|
|
40
40
|
* }],
|
|
41
41
|
* });
|
|
42
42
|
* ```
|
|
43
|
+
*
|
|
44
|
+
* ## Arguments
|
|
45
|
+
*
|
|
46
|
+
* The following arguments are supported in the resource block:
|
|
47
|
+
*
|
|
48
|
+
* * `name` - (Required) Name of the chart.
|
|
49
|
+
* * `programText` - (Required) Signalflow program text for the chart. More info [in the Splunk Observability Cloud docs](https://dev.splunk.com/observability/docs/signalflow/).
|
|
50
|
+
* * `plotType` - (Optional) The default plot display style for the visualization. Must be `"LineChart"`, `"AreaChart"`, `"ColumnChart"`, or `"Histogram"`. Default: `"LineChart"`.
|
|
51
|
+
* * `description` - (Optional) Description of the chart.
|
|
52
|
+
* * `axesPrecision` - (Optional) Specifies the digits Splunk Observability Cloud displays for values plotted on the chart. Defaults to `3`.
|
|
53
|
+
* * `unitPrefix` - (Optional) Must be `"Metric"` or `"Binary`". `"Metric"` by default.
|
|
54
|
+
* * `colorBy` - (Optional) Must be `"Dimension"` or `"Metric"`. `"Dimension"` by default.
|
|
55
|
+
* * `minimumResolution` - (Optional) The minimum resolution (in seconds) to use for computing the underlying program.
|
|
56
|
+
* * `maxDelay` - (Optional) How long (in seconds) to wait for late datapoints.
|
|
57
|
+
* * `timezone` - (Optional) A string denotes the geographic region associated with the time zone.
|
|
58
|
+
* * `disableSampling` - (Optional) If `false`, samples a subset of the output MTS, which improves UI performance. `false` by default
|
|
59
|
+
* * `timeRange` - (Optional) How many seconds ago from which to display data. For example, the last hour would be `3600`, etc. Conflicts with `startTime` and `endTime`.
|
|
60
|
+
* * `startTime` - (Optional) Seconds since epoch. Used for visualization. Conflicts with `timeRange`.
|
|
61
|
+
* * `endTime` - (Optional) Seconds since epoch. Used for visualization. Conflicts with `timeRange`.
|
|
62
|
+
* * `axesIncludeZero` - (Optional) Force the chart to display zero on the y-axes, even if none of the data is near zero.
|
|
63
|
+
* * `axisLeft` - (Optional) Set of axis options.
|
|
64
|
+
* * `label` - (Optional) Label of the left axis.
|
|
65
|
+
* * `minValue` - (Optional) The minimum value for the left axis.
|
|
66
|
+
* * `maxValue` - (Optional) The maximum value for the left axis.
|
|
67
|
+
* * `highWatermark` - (Optional) A line to draw as a high watermark.
|
|
68
|
+
* * `highWatermarkLabel` - (Optional) A label to attach to the high watermark line.
|
|
69
|
+
* * `lowWatermark` - (Optional) A line to draw as a low watermark.
|
|
70
|
+
* * `lowWatermarkLabel` - (Optional) A label to attach to the low watermark line.
|
|
71
|
+
* * `axisRight` - (Optional) Set of axis options.
|
|
72
|
+
* * `label` - (Optional) Label of the right axis.
|
|
73
|
+
* * `minValue` - (Optional) The minimum value for the right axis.
|
|
74
|
+
* * `maxValue` - (Optional) The maximum value for the right axis.
|
|
75
|
+
* * `highWatermark` - (Optional) A line to draw as a high watermark.
|
|
76
|
+
* * `highWatermarkLabel` - (Optional) A label to attach to the high watermark line.
|
|
77
|
+
* * `lowWatermark` - (Optional) A line to draw as a low watermark.
|
|
78
|
+
* * `lowWatermarkLabel` - (Optional) A label to attach to the low watermark line.
|
|
79
|
+
* * `vizOptions` - (Optional) Plot-level customization options, associated with a publish statement.
|
|
80
|
+
* * `label` - (Required) Label used in the publish statement that displays the plot (metric time series data) you want to customize.
|
|
81
|
+
* * `displayName` - (Optional) Specifies an alternate value for the Plot Name column of the Data Table associated with the chart.
|
|
82
|
+
* * `color` - (Optional) Color to use : gray, blue, azure, navy, brown, orange, yellow, iris, magenta, pink, purple, violet, lilac, emerald, green, aquamarine.
|
|
83
|
+
* * `axis` - (Optional) Y-axis associated with values for this plot. Must be either `right` or `left`.
|
|
84
|
+
* * `plotType` - (Optional) The visualization style to use. Must be `"LineChart"`, `"AreaChart"`, `"ColumnChart"`, or `"Histogram"`. Chart level `plotType` by default.
|
|
85
|
+
* * `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`.
|
|
86
|
+
* * `valuePrefix`, `valueSuffix` - (Optional) Arbitrary prefix/suffix to display with the value of this plot.
|
|
87
|
+
* * `eventOptions` - (Optional) Event customization options, associated with a publish statement. You will need to use this to change settings for any `events(…)` statements you use.
|
|
88
|
+
* * `label` - (Required) Label used in the publish statement that displays the event query you want to customize.
|
|
89
|
+
* * `displayName` - (Optional) Specifies an alternate value for the Plot Name column of the Data Table associated with the chart.
|
|
90
|
+
* * `color` - (Optional) Color to use : gray, blue, azure, navy, brown, orange, yellow, iris, magenta, pink, purple, violet, lilac, emerald, green, aquamarine.
|
|
91
|
+
* * `histogramOptions` - (Optional) Only used when `plotType` is `"Histogram"`. Histogram specific options.
|
|
92
|
+
* * `colorTheme` - (Optional) Color to use : gray, blue, azure, navy, brown, orange, yellow, iris, magenta, pink, purple, violet, lilac, emerald, green, aquamarine, red, gold, greenyellow, chartreuse, jade
|
|
93
|
+
* * `legendFieldsToHide` - (Optional) List of properties that should not be displayed in the chart legend (i.e. dimension names). All the properties are visible by default. Deprecated, please use `legendOptionsFields`.
|
|
94
|
+
* * `legendOptionsFields` - (Optional) List of property names and enabled flags that should be displayed in the data table for the chart, in the order provided. This option cannot be used with `legendFieldsToHide`.
|
|
95
|
+
* * `property` The name of the property to display. Note the special values of `plotLabel` (corresponding with the API's `sfMetric`) which shows the label of the time series `publish()` and `metric` (corresponding with the API's `sf_originatingMetric`) that shows the name of the metric for the time series being displayed.
|
|
96
|
+
* * `enabled` True or False depending on if you want the property to be shown or hidden.
|
|
97
|
+
* * `onChartLegendDimension` - (Optional) Dimensions to show in the on-chart legend. On-chart legend is off unless a dimension is specified. Allowed: `"metric"`, `"plotLabel"` and any dimension.
|
|
98
|
+
* * `showEventLines` - (Optional) Whether vertical highlight lines should be drawn in the visualizations at times when events occurred. `false` by default.
|
|
99
|
+
* * `showDataMarkers` - (Optional) Show markers (circles) for each datapoint used to draw line or area charts. `false` by default.
|
|
100
|
+
* * `stacked` - (Optional) Whether area and bar charts in the visualization should be stacked. `false` by default.
|
|
101
|
+
* * `timezone` - (Optional) Time zone that SignalFlow uses as the basis of calendar window transformation methods. For example, if you set "timezone": "Europe/Paris" and then use the transformation sum(cycle="week", cycle_start="Monday") in your chart's SignalFlow program, the calendar window starts on Monday, Paris time. See the [full list of timezones for more](https://dev.splunk.com/observability/docs/signalflow/). `"UTC"` by default.
|
|
102
|
+
*
|
|
103
|
+
* ## Attributes
|
|
104
|
+
*
|
|
105
|
+
* In a addition to all arguments above, the following attributes are exported:
|
|
106
|
+
*
|
|
107
|
+
* * `id` - The ID of the chart.
|
|
108
|
+
* * `url` - The URL of the chart.
|
|
43
109
|
*/
|
|
44
110
|
export declare class TimeChart extends pulumi.CustomResource {
|
|
45
111
|
/**
|
|
@@ -58,93 +124,89 @@ export declare class TimeChart extends pulumi.CustomResource {
|
|
|
58
124
|
*/
|
|
59
125
|
static isInstance(obj: any): obj is TimeChart;
|
|
60
126
|
/**
|
|
61
|
-
* Force
|
|
127
|
+
* Force y-axes to always show zero
|
|
62
128
|
*/
|
|
63
129
|
readonly axesIncludeZero: pulumi.Output<boolean | undefined>;
|
|
64
130
|
/**
|
|
65
|
-
*
|
|
131
|
+
* Force a specific number of significant digits in the y-axis
|
|
66
132
|
*/
|
|
67
133
|
readonly axesPrecision: pulumi.Output<number | undefined>;
|
|
68
|
-
/**
|
|
69
|
-
* Set of axis options.
|
|
70
|
-
*/
|
|
71
134
|
readonly axisLeft: pulumi.Output<outputs.TimeChartAxisLeft | undefined>;
|
|
72
|
-
/**
|
|
73
|
-
* Set of axis options.
|
|
74
|
-
*/
|
|
75
135
|
readonly axisRight: pulumi.Output<outputs.TimeChartAxisRight | undefined>;
|
|
76
136
|
/**
|
|
77
|
-
* Must be
|
|
137
|
+
* (Dimension by default) Must be "Dimension" or "Metric"
|
|
78
138
|
*/
|
|
79
139
|
readonly colorBy: pulumi.Output<string | undefined>;
|
|
80
140
|
/**
|
|
81
|
-
* Description of the chart
|
|
141
|
+
* Description of the chart
|
|
82
142
|
*/
|
|
83
143
|
readonly description: pulumi.Output<string | undefined>;
|
|
84
144
|
/**
|
|
85
|
-
* If
|
|
145
|
+
* (false by default) If false, samples a subset of the output MTS, which improves UI performance
|
|
86
146
|
*/
|
|
87
147
|
readonly disableSampling: pulumi.Output<boolean | undefined>;
|
|
88
148
|
/**
|
|
89
|
-
* Seconds since epoch
|
|
149
|
+
* Seconds since epoch to end the visualization
|
|
90
150
|
*/
|
|
91
151
|
readonly endTime: pulumi.Output<number | undefined>;
|
|
92
152
|
/**
|
|
93
|
-
* Event customization options, associated with a publish statement
|
|
153
|
+
* Event display customization options, associated with a publish statement
|
|
94
154
|
*/
|
|
95
155
|
readonly eventOptions: pulumi.Output<outputs.TimeChartEventOption[] | undefined>;
|
|
96
156
|
/**
|
|
97
|
-
*
|
|
157
|
+
* Options specific to Histogram charts
|
|
98
158
|
*/
|
|
99
159
|
readonly histogramOptions: pulumi.Output<outputs.TimeChartHistogramOption[] | undefined>;
|
|
100
160
|
/**
|
|
101
|
-
* List of properties that
|
|
161
|
+
* List of properties that shouldn't be displayed in the chart legend (i.e. dimension names)
|
|
102
162
|
*
|
|
103
163
|
* @deprecated Please use legend_options_fields
|
|
104
164
|
*/
|
|
105
165
|
readonly legendFieldsToHides: pulumi.Output<string[] | undefined>;
|
|
106
166
|
/**
|
|
107
|
-
* List of property
|
|
167
|
+
* List of property and enabled flags to control the order and presence of datatable labels in a chart.
|
|
108
168
|
*/
|
|
109
169
|
readonly legendOptionsFields: pulumi.Output<outputs.TimeChartLegendOptionsField[] | undefined>;
|
|
110
170
|
/**
|
|
111
|
-
* How long (in seconds) to wait for late datapoints
|
|
171
|
+
* How long (in seconds) to wait for late datapoints
|
|
112
172
|
*/
|
|
113
173
|
readonly maxDelay: pulumi.Output<number | undefined>;
|
|
114
174
|
/**
|
|
115
|
-
* The minimum resolution (in seconds) to use for computing the underlying program
|
|
175
|
+
* The minimum resolution (in seconds) to use for computing the underlying program
|
|
116
176
|
*/
|
|
117
177
|
readonly minimumResolution: pulumi.Output<number | undefined>;
|
|
118
178
|
/**
|
|
119
|
-
* Name of the chart
|
|
179
|
+
* Name of the chart
|
|
120
180
|
*/
|
|
121
181
|
readonly name: pulumi.Output<string>;
|
|
122
182
|
/**
|
|
123
|
-
*
|
|
183
|
+
* Dimension to show in the on-chart legend. On-chart legend is off unless a dimension is specified. Allowed: 'metric',
|
|
184
|
+
* 'plot_label' and any dimension.
|
|
124
185
|
*/
|
|
125
186
|
readonly onChartLegendDimension: pulumi.Output<string | undefined>;
|
|
126
187
|
/**
|
|
127
|
-
* The
|
|
188
|
+
* (LineChart by default) The default plot display style for the visualization. Must be "LineChart", "AreaChart",
|
|
189
|
+
* "ColumnChart", or "Histogram"
|
|
128
190
|
*/
|
|
129
191
|
readonly plotType: pulumi.Output<string | undefined>;
|
|
130
192
|
/**
|
|
131
|
-
* Signalflow program text for the chart. More info
|
|
193
|
+
* Signalflow program text for the chart. More info at "https://developers.signalfx.com/docs/signalflow-overview"
|
|
132
194
|
*/
|
|
133
195
|
readonly programText: pulumi.Output<string>;
|
|
134
196
|
/**
|
|
135
|
-
* Show markers (circles) for each datapoint used to draw line or area charts
|
|
197
|
+
* (false by default) Show markers (circles) for each datapoint used to draw line or area charts
|
|
136
198
|
*/
|
|
137
199
|
readonly showDataMarkers: pulumi.Output<boolean | undefined>;
|
|
138
200
|
/**
|
|
139
|
-
* Whether vertical highlight lines should be drawn in the visualizations at times when events occurred
|
|
201
|
+
* (false by default) Whether vertical highlight lines should be drawn in the visualizations at times when events occurred
|
|
140
202
|
*/
|
|
141
203
|
readonly showEventLines: pulumi.Output<boolean | undefined>;
|
|
142
204
|
/**
|
|
143
|
-
* Whether area and bar charts in the visualization should be stacked
|
|
205
|
+
* (false by default) Whether area and bar charts in the visualization should be stacked
|
|
144
206
|
*/
|
|
145
207
|
readonly stacked: pulumi.Output<boolean | undefined>;
|
|
146
208
|
/**
|
|
147
|
-
* Seconds since epoch
|
|
209
|
+
* Seconds since epoch to start the visualization
|
|
148
210
|
*/
|
|
149
211
|
readonly startTime: pulumi.Output<number | undefined>;
|
|
150
212
|
/**
|
|
@@ -154,23 +216,23 @@ export declare class TimeChart extends pulumi.CustomResource {
|
|
|
154
216
|
*/
|
|
155
217
|
readonly tags: pulumi.Output<string[] | undefined>;
|
|
156
218
|
/**
|
|
157
|
-
*
|
|
219
|
+
* Seconds to display in the visualization. This is a rolling range from the current time. Example: 3600 = `-1h`
|
|
158
220
|
*/
|
|
159
221
|
readonly timeRange: pulumi.Output<number | undefined>;
|
|
160
222
|
/**
|
|
161
|
-
*
|
|
223
|
+
* The property value is a string that denotes the geographic region associated with the time zone, (e.g. Australia/Sydney)
|
|
162
224
|
*/
|
|
163
225
|
readonly timezone: pulumi.Output<string | undefined>;
|
|
164
226
|
/**
|
|
165
|
-
* Must be
|
|
227
|
+
* (Metric by default) Must be "Metric" or "Binary"
|
|
166
228
|
*/
|
|
167
229
|
readonly unitPrefix: pulumi.Output<string | undefined>;
|
|
168
230
|
/**
|
|
169
|
-
*
|
|
231
|
+
* URL of the chart
|
|
170
232
|
*/
|
|
171
233
|
readonly url: pulumi.Output<string>;
|
|
172
234
|
/**
|
|
173
|
-
* Plot-level customization options, associated with a publish statement
|
|
235
|
+
* Plot-level customization options, associated with a publish statement
|
|
174
236
|
*/
|
|
175
237
|
readonly vizOptions: pulumi.Output<outputs.TimeChartVizOption[] | undefined>;
|
|
176
238
|
/**
|
|
@@ -187,93 +249,89 @@ export declare class TimeChart extends pulumi.CustomResource {
|
|
|
187
249
|
*/
|
|
188
250
|
export interface TimeChartState {
|
|
189
251
|
/**
|
|
190
|
-
* Force
|
|
252
|
+
* Force y-axes to always show zero
|
|
191
253
|
*/
|
|
192
254
|
axesIncludeZero?: pulumi.Input<boolean>;
|
|
193
255
|
/**
|
|
194
|
-
*
|
|
256
|
+
* Force a specific number of significant digits in the y-axis
|
|
195
257
|
*/
|
|
196
258
|
axesPrecision?: pulumi.Input<number>;
|
|
197
|
-
/**
|
|
198
|
-
* Set of axis options.
|
|
199
|
-
*/
|
|
200
259
|
axisLeft?: pulumi.Input<inputs.TimeChartAxisLeft>;
|
|
201
|
-
/**
|
|
202
|
-
* Set of axis options.
|
|
203
|
-
*/
|
|
204
260
|
axisRight?: pulumi.Input<inputs.TimeChartAxisRight>;
|
|
205
261
|
/**
|
|
206
|
-
* Must be
|
|
262
|
+
* (Dimension by default) Must be "Dimension" or "Metric"
|
|
207
263
|
*/
|
|
208
264
|
colorBy?: pulumi.Input<string>;
|
|
209
265
|
/**
|
|
210
|
-
* Description of the chart
|
|
266
|
+
* Description of the chart
|
|
211
267
|
*/
|
|
212
268
|
description?: pulumi.Input<string>;
|
|
213
269
|
/**
|
|
214
|
-
* If
|
|
270
|
+
* (false by default) If false, samples a subset of the output MTS, which improves UI performance
|
|
215
271
|
*/
|
|
216
272
|
disableSampling?: pulumi.Input<boolean>;
|
|
217
273
|
/**
|
|
218
|
-
* Seconds since epoch
|
|
274
|
+
* Seconds since epoch to end the visualization
|
|
219
275
|
*/
|
|
220
276
|
endTime?: pulumi.Input<number>;
|
|
221
277
|
/**
|
|
222
|
-
* Event customization options, associated with a publish statement
|
|
278
|
+
* Event display customization options, associated with a publish statement
|
|
223
279
|
*/
|
|
224
280
|
eventOptions?: pulumi.Input<pulumi.Input<inputs.TimeChartEventOption>[]>;
|
|
225
281
|
/**
|
|
226
|
-
*
|
|
282
|
+
* Options specific to Histogram charts
|
|
227
283
|
*/
|
|
228
284
|
histogramOptions?: pulumi.Input<pulumi.Input<inputs.TimeChartHistogramOption>[]>;
|
|
229
285
|
/**
|
|
230
|
-
* List of properties that
|
|
286
|
+
* List of properties that shouldn't be displayed in the chart legend (i.e. dimension names)
|
|
231
287
|
*
|
|
232
288
|
* @deprecated Please use legend_options_fields
|
|
233
289
|
*/
|
|
234
290
|
legendFieldsToHides?: pulumi.Input<pulumi.Input<string>[]>;
|
|
235
291
|
/**
|
|
236
|
-
* List of property
|
|
292
|
+
* List of property and enabled flags to control the order and presence of datatable labels in a chart.
|
|
237
293
|
*/
|
|
238
294
|
legendOptionsFields?: pulumi.Input<pulumi.Input<inputs.TimeChartLegendOptionsField>[]>;
|
|
239
295
|
/**
|
|
240
|
-
* How long (in seconds) to wait for late datapoints
|
|
296
|
+
* How long (in seconds) to wait for late datapoints
|
|
241
297
|
*/
|
|
242
298
|
maxDelay?: pulumi.Input<number>;
|
|
243
299
|
/**
|
|
244
|
-
* The minimum resolution (in seconds) to use for computing the underlying program
|
|
300
|
+
* The minimum resolution (in seconds) to use for computing the underlying program
|
|
245
301
|
*/
|
|
246
302
|
minimumResolution?: pulumi.Input<number>;
|
|
247
303
|
/**
|
|
248
|
-
* Name of the chart
|
|
304
|
+
* Name of the chart
|
|
249
305
|
*/
|
|
250
306
|
name?: pulumi.Input<string>;
|
|
251
307
|
/**
|
|
252
|
-
*
|
|
308
|
+
* Dimension to show in the on-chart legend. On-chart legend is off unless a dimension is specified. Allowed: 'metric',
|
|
309
|
+
* 'plot_label' and any dimension.
|
|
253
310
|
*/
|
|
254
311
|
onChartLegendDimension?: pulumi.Input<string>;
|
|
255
312
|
/**
|
|
256
|
-
* The
|
|
313
|
+
* (LineChart by default) The default plot display style for the visualization. Must be "LineChart", "AreaChart",
|
|
314
|
+
* "ColumnChart", or "Histogram"
|
|
257
315
|
*/
|
|
258
316
|
plotType?: pulumi.Input<string>;
|
|
259
317
|
/**
|
|
260
|
-
* Signalflow program text for the chart. More info
|
|
318
|
+
* Signalflow program text for the chart. More info at "https://developers.signalfx.com/docs/signalflow-overview"
|
|
261
319
|
*/
|
|
262
320
|
programText?: pulumi.Input<string>;
|
|
263
321
|
/**
|
|
264
|
-
* Show markers (circles) for each datapoint used to draw line or area charts
|
|
322
|
+
* (false by default) Show markers (circles) for each datapoint used to draw line or area charts
|
|
265
323
|
*/
|
|
266
324
|
showDataMarkers?: pulumi.Input<boolean>;
|
|
267
325
|
/**
|
|
268
|
-
* Whether vertical highlight lines should be drawn in the visualizations at times when events occurred
|
|
326
|
+
* (false by default) Whether vertical highlight lines should be drawn in the visualizations at times when events occurred
|
|
269
327
|
*/
|
|
270
328
|
showEventLines?: pulumi.Input<boolean>;
|
|
271
329
|
/**
|
|
272
|
-
* Whether area and bar charts in the visualization should be stacked
|
|
330
|
+
* (false by default) Whether area and bar charts in the visualization should be stacked
|
|
273
331
|
*/
|
|
274
332
|
stacked?: pulumi.Input<boolean>;
|
|
275
333
|
/**
|
|
276
|
-
* Seconds since epoch
|
|
334
|
+
* Seconds since epoch to start the visualization
|
|
277
335
|
*/
|
|
278
336
|
startTime?: pulumi.Input<number>;
|
|
279
337
|
/**
|
|
@@ -283,23 +341,23 @@ export interface TimeChartState {
|
|
|
283
341
|
*/
|
|
284
342
|
tags?: pulumi.Input<pulumi.Input<string>[]>;
|
|
285
343
|
/**
|
|
286
|
-
*
|
|
344
|
+
* Seconds to display in the visualization. This is a rolling range from the current time. Example: 3600 = `-1h`
|
|
287
345
|
*/
|
|
288
346
|
timeRange?: pulumi.Input<number>;
|
|
289
347
|
/**
|
|
290
|
-
*
|
|
348
|
+
* The property value is a string that denotes the geographic region associated with the time zone, (e.g. Australia/Sydney)
|
|
291
349
|
*/
|
|
292
350
|
timezone?: pulumi.Input<string>;
|
|
293
351
|
/**
|
|
294
|
-
* Must be
|
|
352
|
+
* (Metric by default) Must be "Metric" or "Binary"
|
|
295
353
|
*/
|
|
296
354
|
unitPrefix?: pulumi.Input<string>;
|
|
297
355
|
/**
|
|
298
|
-
*
|
|
356
|
+
* URL of the chart
|
|
299
357
|
*/
|
|
300
358
|
url?: pulumi.Input<string>;
|
|
301
359
|
/**
|
|
302
|
-
* Plot-level customization options, associated with a publish statement
|
|
360
|
+
* Plot-level customization options, associated with a publish statement
|
|
303
361
|
*/
|
|
304
362
|
vizOptions?: pulumi.Input<pulumi.Input<inputs.TimeChartVizOption>[]>;
|
|
305
363
|
}
|
|
@@ -308,93 +366,89 @@ export interface TimeChartState {
|
|
|
308
366
|
*/
|
|
309
367
|
export interface TimeChartArgs {
|
|
310
368
|
/**
|
|
311
|
-
* Force
|
|
369
|
+
* Force y-axes to always show zero
|
|
312
370
|
*/
|
|
313
371
|
axesIncludeZero?: pulumi.Input<boolean>;
|
|
314
372
|
/**
|
|
315
|
-
*
|
|
373
|
+
* Force a specific number of significant digits in the y-axis
|
|
316
374
|
*/
|
|
317
375
|
axesPrecision?: pulumi.Input<number>;
|
|
318
|
-
/**
|
|
319
|
-
* Set of axis options.
|
|
320
|
-
*/
|
|
321
376
|
axisLeft?: pulumi.Input<inputs.TimeChartAxisLeft>;
|
|
322
|
-
/**
|
|
323
|
-
* Set of axis options.
|
|
324
|
-
*/
|
|
325
377
|
axisRight?: pulumi.Input<inputs.TimeChartAxisRight>;
|
|
326
378
|
/**
|
|
327
|
-
* Must be
|
|
379
|
+
* (Dimension by default) Must be "Dimension" or "Metric"
|
|
328
380
|
*/
|
|
329
381
|
colorBy?: pulumi.Input<string>;
|
|
330
382
|
/**
|
|
331
|
-
* Description of the chart
|
|
383
|
+
* Description of the chart
|
|
332
384
|
*/
|
|
333
385
|
description?: pulumi.Input<string>;
|
|
334
386
|
/**
|
|
335
|
-
* If
|
|
387
|
+
* (false by default) If false, samples a subset of the output MTS, which improves UI performance
|
|
336
388
|
*/
|
|
337
389
|
disableSampling?: pulumi.Input<boolean>;
|
|
338
390
|
/**
|
|
339
|
-
* Seconds since epoch
|
|
391
|
+
* Seconds since epoch to end the visualization
|
|
340
392
|
*/
|
|
341
393
|
endTime?: pulumi.Input<number>;
|
|
342
394
|
/**
|
|
343
|
-
* Event customization options, associated with a publish statement
|
|
395
|
+
* Event display customization options, associated with a publish statement
|
|
344
396
|
*/
|
|
345
397
|
eventOptions?: pulumi.Input<pulumi.Input<inputs.TimeChartEventOption>[]>;
|
|
346
398
|
/**
|
|
347
|
-
*
|
|
399
|
+
* Options specific to Histogram charts
|
|
348
400
|
*/
|
|
349
401
|
histogramOptions?: pulumi.Input<pulumi.Input<inputs.TimeChartHistogramOption>[]>;
|
|
350
402
|
/**
|
|
351
|
-
* List of properties that
|
|
403
|
+
* List of properties that shouldn't be displayed in the chart legend (i.e. dimension names)
|
|
352
404
|
*
|
|
353
405
|
* @deprecated Please use legend_options_fields
|
|
354
406
|
*/
|
|
355
407
|
legendFieldsToHides?: pulumi.Input<pulumi.Input<string>[]>;
|
|
356
408
|
/**
|
|
357
|
-
* List of property
|
|
409
|
+
* List of property and enabled flags to control the order and presence of datatable labels in a chart.
|
|
358
410
|
*/
|
|
359
411
|
legendOptionsFields?: pulumi.Input<pulumi.Input<inputs.TimeChartLegendOptionsField>[]>;
|
|
360
412
|
/**
|
|
361
|
-
* How long (in seconds) to wait for late datapoints
|
|
413
|
+
* How long (in seconds) to wait for late datapoints
|
|
362
414
|
*/
|
|
363
415
|
maxDelay?: pulumi.Input<number>;
|
|
364
416
|
/**
|
|
365
|
-
* The minimum resolution (in seconds) to use for computing the underlying program
|
|
417
|
+
* The minimum resolution (in seconds) to use for computing the underlying program
|
|
366
418
|
*/
|
|
367
419
|
minimumResolution?: pulumi.Input<number>;
|
|
368
420
|
/**
|
|
369
|
-
* Name of the chart
|
|
421
|
+
* Name of the chart
|
|
370
422
|
*/
|
|
371
423
|
name?: pulumi.Input<string>;
|
|
372
424
|
/**
|
|
373
|
-
*
|
|
425
|
+
* Dimension to show in the on-chart legend. On-chart legend is off unless a dimension is specified. Allowed: 'metric',
|
|
426
|
+
* 'plot_label' and any dimension.
|
|
374
427
|
*/
|
|
375
428
|
onChartLegendDimension?: pulumi.Input<string>;
|
|
376
429
|
/**
|
|
377
|
-
* The
|
|
430
|
+
* (LineChart by default) The default plot display style for the visualization. Must be "LineChart", "AreaChart",
|
|
431
|
+
* "ColumnChart", or "Histogram"
|
|
378
432
|
*/
|
|
379
433
|
plotType?: pulumi.Input<string>;
|
|
380
434
|
/**
|
|
381
|
-
* Signalflow program text for the chart. More info
|
|
435
|
+
* Signalflow program text for the chart. More info at "https://developers.signalfx.com/docs/signalflow-overview"
|
|
382
436
|
*/
|
|
383
437
|
programText: pulumi.Input<string>;
|
|
384
438
|
/**
|
|
385
|
-
* Show markers (circles) for each datapoint used to draw line or area charts
|
|
439
|
+
* (false by default) Show markers (circles) for each datapoint used to draw line or area charts
|
|
386
440
|
*/
|
|
387
441
|
showDataMarkers?: pulumi.Input<boolean>;
|
|
388
442
|
/**
|
|
389
|
-
* Whether vertical highlight lines should be drawn in the visualizations at times when events occurred
|
|
443
|
+
* (false by default) Whether vertical highlight lines should be drawn in the visualizations at times when events occurred
|
|
390
444
|
*/
|
|
391
445
|
showEventLines?: pulumi.Input<boolean>;
|
|
392
446
|
/**
|
|
393
|
-
* Whether area and bar charts in the visualization should be stacked
|
|
447
|
+
* (false by default) Whether area and bar charts in the visualization should be stacked
|
|
394
448
|
*/
|
|
395
449
|
stacked?: pulumi.Input<boolean>;
|
|
396
450
|
/**
|
|
397
|
-
* Seconds since epoch
|
|
451
|
+
* Seconds since epoch to start the visualization
|
|
398
452
|
*/
|
|
399
453
|
startTime?: pulumi.Input<number>;
|
|
400
454
|
/**
|
|
@@ -404,19 +458,19 @@ export interface TimeChartArgs {
|
|
|
404
458
|
*/
|
|
405
459
|
tags?: pulumi.Input<pulumi.Input<string>[]>;
|
|
406
460
|
/**
|
|
407
|
-
*
|
|
461
|
+
* Seconds to display in the visualization. This is a rolling range from the current time. Example: 3600 = `-1h`
|
|
408
462
|
*/
|
|
409
463
|
timeRange?: pulumi.Input<number>;
|
|
410
464
|
/**
|
|
411
|
-
*
|
|
465
|
+
* The property value is a string that denotes the geographic region associated with the time zone, (e.g. Australia/Sydney)
|
|
412
466
|
*/
|
|
413
467
|
timezone?: pulumi.Input<string>;
|
|
414
468
|
/**
|
|
415
|
-
* Must be
|
|
469
|
+
* (Metric by default) Must be "Metric" or "Binary"
|
|
416
470
|
*/
|
|
417
471
|
unitPrefix?: pulumi.Input<string>;
|
|
418
472
|
/**
|
|
419
|
-
* Plot-level customization options, associated with a publish statement
|
|
473
|
+
* Plot-level customization options, associated with a publish statement
|
|
420
474
|
*/
|
|
421
475
|
vizOptions?: pulumi.Input<pulumi.Input<inputs.TimeChartVizOption>[]>;
|
|
422
476
|
}
|
package/timeChart.js
CHANGED
|
@@ -6,11 +6,11 @@ exports.TimeChart = 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 time chart resource. This can be used to create and manage the different types of time charts.
|
|
10
10
|
*
|
|
11
11
|
* Time charts display data points over a period of time.
|
|
12
12
|
*
|
|
13
|
-
* ## Example
|
|
13
|
+
* ## Example
|
|
14
14
|
*
|
|
15
15
|
* ```typescript
|
|
16
16
|
* import * as pulumi from "@pulumi/pulumi";
|
|
@@ -44,6 +44,72 @@ const utilities = require("./utilities");
|
|
|
44
44
|
* }],
|
|
45
45
|
* });
|
|
46
46
|
* ```
|
|
47
|
+
*
|
|
48
|
+
* ## Arguments
|
|
49
|
+
*
|
|
50
|
+
* The following arguments are supported in the resource block:
|
|
51
|
+
*
|
|
52
|
+
* * `name` - (Required) Name of the chart.
|
|
53
|
+
* * `programText` - (Required) Signalflow program text for the chart. More info [in the Splunk Observability Cloud docs](https://dev.splunk.com/observability/docs/signalflow/).
|
|
54
|
+
* * `plotType` - (Optional) The default plot display style for the visualization. Must be `"LineChart"`, `"AreaChart"`, `"ColumnChart"`, or `"Histogram"`. Default: `"LineChart"`.
|
|
55
|
+
* * `description` - (Optional) Description of the chart.
|
|
56
|
+
* * `axesPrecision` - (Optional) Specifies the digits Splunk Observability Cloud displays for values plotted on the chart. Defaults to `3`.
|
|
57
|
+
* * `unitPrefix` - (Optional) Must be `"Metric"` or `"Binary`". `"Metric"` by default.
|
|
58
|
+
* * `colorBy` - (Optional) Must be `"Dimension"` or `"Metric"`. `"Dimension"` by default.
|
|
59
|
+
* * `minimumResolution` - (Optional) The minimum resolution (in seconds) to use for computing the underlying program.
|
|
60
|
+
* * `maxDelay` - (Optional) How long (in seconds) to wait for late datapoints.
|
|
61
|
+
* * `timezone` - (Optional) A string denotes the geographic region associated with the time zone.
|
|
62
|
+
* * `disableSampling` - (Optional) If `false`, samples a subset of the output MTS, which improves UI performance. `false` by default
|
|
63
|
+
* * `timeRange` - (Optional) How many seconds ago from which to display data. For example, the last hour would be `3600`, etc. Conflicts with `startTime` and `endTime`.
|
|
64
|
+
* * `startTime` - (Optional) Seconds since epoch. Used for visualization. Conflicts with `timeRange`.
|
|
65
|
+
* * `endTime` - (Optional) Seconds since epoch. Used for visualization. Conflicts with `timeRange`.
|
|
66
|
+
* * `axesIncludeZero` - (Optional) Force the chart to display zero on the y-axes, even if none of the data is near zero.
|
|
67
|
+
* * `axisLeft` - (Optional) Set of axis options.
|
|
68
|
+
* * `label` - (Optional) Label of the left axis.
|
|
69
|
+
* * `minValue` - (Optional) The minimum value for the left axis.
|
|
70
|
+
* * `maxValue` - (Optional) The maximum value for the left axis.
|
|
71
|
+
* * `highWatermark` - (Optional) A line to draw as a high watermark.
|
|
72
|
+
* * `highWatermarkLabel` - (Optional) A label to attach to the high watermark line.
|
|
73
|
+
* * `lowWatermark` - (Optional) A line to draw as a low watermark.
|
|
74
|
+
* * `lowWatermarkLabel` - (Optional) A label to attach to the low watermark line.
|
|
75
|
+
* * `axisRight` - (Optional) Set of axis options.
|
|
76
|
+
* * `label` - (Optional) Label of the right axis.
|
|
77
|
+
* * `minValue` - (Optional) The minimum value for the right axis.
|
|
78
|
+
* * `maxValue` - (Optional) The maximum value for the right axis.
|
|
79
|
+
* * `highWatermark` - (Optional) A line to draw as a high watermark.
|
|
80
|
+
* * `highWatermarkLabel` - (Optional) A label to attach to the high watermark line.
|
|
81
|
+
* * `lowWatermark` - (Optional) A line to draw as a low watermark.
|
|
82
|
+
* * `lowWatermarkLabel` - (Optional) A label to attach to the low watermark line.
|
|
83
|
+
* * `vizOptions` - (Optional) Plot-level customization options, associated with a publish statement.
|
|
84
|
+
* * `label` - (Required) Label used in the publish statement that displays the plot (metric time series data) you want to customize.
|
|
85
|
+
* * `displayName` - (Optional) Specifies an alternate value for the Plot Name column of the Data Table associated with the chart.
|
|
86
|
+
* * `color` - (Optional) Color to use : gray, blue, azure, navy, brown, orange, yellow, iris, magenta, pink, purple, violet, lilac, emerald, green, aquamarine.
|
|
87
|
+
* * `axis` - (Optional) Y-axis associated with values for this plot. Must be either `right` or `left`.
|
|
88
|
+
* * `plotType` - (Optional) The visualization style to use. Must be `"LineChart"`, `"AreaChart"`, `"ColumnChart"`, or `"Histogram"`. Chart level `plotType` by default.
|
|
89
|
+
* * `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`.
|
|
90
|
+
* * `valuePrefix`, `valueSuffix` - (Optional) Arbitrary prefix/suffix to display with the value of this plot.
|
|
91
|
+
* * `eventOptions` - (Optional) Event customization options, associated with a publish statement. You will need to use this to change settings for any `events(…)` statements you use.
|
|
92
|
+
* * `label` - (Required) Label used in the publish statement that displays the event query you want to customize.
|
|
93
|
+
* * `displayName` - (Optional) Specifies an alternate value for the Plot Name column of the Data Table associated with the chart.
|
|
94
|
+
* * `color` - (Optional) Color to use : gray, blue, azure, navy, brown, orange, yellow, iris, magenta, pink, purple, violet, lilac, emerald, green, aquamarine.
|
|
95
|
+
* * `histogramOptions` - (Optional) Only used when `plotType` is `"Histogram"`. Histogram specific options.
|
|
96
|
+
* * `colorTheme` - (Optional) Color to use : gray, blue, azure, navy, brown, orange, yellow, iris, magenta, pink, purple, violet, lilac, emerald, green, aquamarine, red, gold, greenyellow, chartreuse, jade
|
|
97
|
+
* * `legendFieldsToHide` - (Optional) List of properties that should not be displayed in the chart legend (i.e. dimension names). All the properties are visible by default. Deprecated, please use `legendOptionsFields`.
|
|
98
|
+
* * `legendOptionsFields` - (Optional) List of property names and enabled flags that should be displayed in the data table for the chart, in the order provided. This option cannot be used with `legendFieldsToHide`.
|
|
99
|
+
* * `property` The name of the property to display. Note the special values of `plotLabel` (corresponding with the API's `sfMetric`) which shows the label of the time series `publish()` and `metric` (corresponding with the API's `sf_originatingMetric`) that shows the name of the metric for the time series being displayed.
|
|
100
|
+
* * `enabled` True or False depending on if you want the property to be shown or hidden.
|
|
101
|
+
* * `onChartLegendDimension` - (Optional) Dimensions to show in the on-chart legend. On-chart legend is off unless a dimension is specified. Allowed: `"metric"`, `"plotLabel"` and any dimension.
|
|
102
|
+
* * `showEventLines` - (Optional) Whether vertical highlight lines should be drawn in the visualizations at times when events occurred. `false` by default.
|
|
103
|
+
* * `showDataMarkers` - (Optional) Show markers (circles) for each datapoint used to draw line or area charts. `false` by default.
|
|
104
|
+
* * `stacked` - (Optional) Whether area and bar charts in the visualization should be stacked. `false` by default.
|
|
105
|
+
* * `timezone` - (Optional) Time zone that SignalFlow uses as the basis of calendar window transformation methods. For example, if you set "timezone": "Europe/Paris" and then use the transformation sum(cycle="week", cycle_start="Monday") in your chart's SignalFlow program, the calendar window starts on Monday, Paris time. See the [full list of timezones for more](https://dev.splunk.com/observability/docs/signalflow/). `"UTC"` by default.
|
|
106
|
+
*
|
|
107
|
+
* ## Attributes
|
|
108
|
+
*
|
|
109
|
+
* In a addition to all arguments above, the following attributes are exported:
|
|
110
|
+
*
|
|
111
|
+
* * `id` - The ID of the chart.
|
|
112
|
+
* * `url` - The URL of the chart.
|
|
47
113
|
*/
|
|
48
114
|
class TimeChart extends pulumi.CustomResource {
|
|
49
115
|
/**
|