pulumi-signalfx 7.2.0a1709367777__py3-none-any.whl → 7.6.0a1736835428__py3-none-any.whl
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.
- pulumi_signalfx/__init__.py +9 -0
- pulumi_signalfx/_inputs.py +1976 -339
- pulumi_signalfx/_utilities.py +41 -5
- pulumi_signalfx/alert_muting_rule.py +110 -86
- pulumi_signalfx/aws/_inputs.py +85 -16
- pulumi_signalfx/aws/external_integration.py +20 -275
- pulumi_signalfx/aws/integration.py +222 -367
- pulumi_signalfx/aws/outputs.py +21 -16
- pulumi_signalfx/aws/token_integration.py +46 -65
- pulumi_signalfx/azure/_inputs.py +41 -4
- pulumi_signalfx/azure/integration.py +144 -259
- pulumi_signalfx/azure/outputs.py +15 -4
- pulumi_signalfx/config/__init__.pyi +22 -0
- pulumi_signalfx/config/vars.py +28 -0
- pulumi_signalfx/dashboard.py +171 -186
- pulumi_signalfx/dashboard_group.py +131 -198
- pulumi_signalfx/data_link.py +76 -141
- pulumi_signalfx/detector.py +264 -369
- pulumi_signalfx/event_feed_chart.py +51 -82
- pulumi_signalfx/gcp/_inputs.py +51 -0
- pulumi_signalfx/gcp/integration.py +224 -192
- pulumi_signalfx/gcp/outputs.py +44 -0
- pulumi_signalfx/get_dimension_values.py +47 -24
- pulumi_signalfx/heatmap_chart.py +165 -228
- pulumi_signalfx/jira/integration.py +70 -119
- pulumi_signalfx/list_chart.py +219 -315
- pulumi_signalfx/log/_inputs.py +33 -2
- pulumi_signalfx/log/outputs.py +7 -2
- pulumi_signalfx/log/timeline.py +64 -99
- pulumi_signalfx/log/view.py +134 -173
- pulumi_signalfx/metric_ruleset.py +217 -70
- pulumi_signalfx/opsgenie/integration.py +41 -60
- pulumi_signalfx/org_token.py +97 -128
- pulumi_signalfx/outputs.py +661 -339
- pulumi_signalfx/pagerduty/get_integration.py +22 -21
- pulumi_signalfx/pagerduty/integration.py +34 -49
- pulumi_signalfx/provider.py +99 -0
- pulumi_signalfx/pulumi-plugin.json +2 -1
- pulumi_signalfx/servicenow/integration.py +52 -107
- pulumi_signalfx/single_value_chart.py +113 -178
- pulumi_signalfx/slack/integration.py +30 -47
- pulumi_signalfx/slo.py +99 -197
- pulumi_signalfx/slo_chart.py +197 -0
- pulumi_signalfx/table_chart.py +50 -75
- pulumi_signalfx/team.py +74 -109
- pulumi_signalfx/text_chart.py +64 -89
- pulumi_signalfx/time_chart.py +271 -400
- pulumi_signalfx/victorops/integration.py +30 -47
- pulumi_signalfx/webhook_integration.py +154 -75
- {pulumi_signalfx-7.2.0a1709367777.dist-info → pulumi_signalfx-7.6.0a1736835428.dist-info}/METADATA +7 -6
- pulumi_signalfx-7.6.0a1736835428.dist-info/RECORD +65 -0
- {pulumi_signalfx-7.2.0a1709367777.dist-info → pulumi_signalfx-7.6.0a1736835428.dist-info}/WHEEL +1 -1
- pulumi_signalfx-7.2.0a1709367777.dist-info/RECORD +0 -64
- {pulumi_signalfx-7.2.0a1709367777.dist-info → pulumi_signalfx-7.6.0a1736835428.dist-info}/top_level.txt +0 -0
pulumi_signalfx/time_chart.py
CHANGED
|
@@ -4,9 +4,14 @@
|
|
|
4
4
|
|
|
5
5
|
import copy
|
|
6
6
|
import warnings
|
|
7
|
+
import sys
|
|
7
8
|
import pulumi
|
|
8
9
|
import pulumi.runtime
|
|
9
10
|
from typing import Any, Mapping, Optional, Sequence, Union, overload
|
|
11
|
+
if sys.version_info >= (3, 11):
|
|
12
|
+
from typing import NotRequired, TypedDict, TypeAlias
|
|
13
|
+
else:
|
|
14
|
+
from typing_extensions import NotRequired, TypedDict, TypeAlias
|
|
10
15
|
from . import _utilities
|
|
11
16
|
from . import outputs
|
|
12
17
|
from ._inputs import *
|
|
@@ -45,33 +50,33 @@ class TimeChartArgs:
|
|
|
45
50
|
viz_options: Optional[pulumi.Input[Sequence[pulumi.Input['TimeChartVizOptionArgs']]]] = None):
|
|
46
51
|
"""
|
|
47
52
|
The set of arguments for constructing a TimeChart resource.
|
|
48
|
-
:param pulumi.Input[str] program_text: Signalflow program text for the chart. More info
|
|
49
|
-
:param pulumi.Input[bool] axes_include_zero: Force y-axes
|
|
50
|
-
:param pulumi.Input[int] axes_precision:
|
|
51
|
-
:param pulumi.Input[
|
|
52
|
-
:param pulumi.Input[
|
|
53
|
-
:param pulumi.Input[
|
|
54
|
-
:param pulumi.Input[
|
|
55
|
-
:param pulumi.Input[
|
|
56
|
-
:param pulumi.Input[
|
|
57
|
-
:param pulumi.Input[Sequence[pulumi.Input[
|
|
58
|
-
:param pulumi.Input[Sequence[pulumi.Input['
|
|
59
|
-
:param pulumi.Input[
|
|
60
|
-
:param pulumi.Input[
|
|
61
|
-
:param pulumi.Input[
|
|
62
|
-
:param pulumi.Input[
|
|
63
|
-
|
|
64
|
-
:param pulumi.Input[str]
|
|
65
|
-
|
|
66
|
-
:param pulumi.Input[bool] show_data_markers:
|
|
67
|
-
:param pulumi.Input[bool] show_event_lines:
|
|
68
|
-
:param pulumi.Input[bool] stacked:
|
|
69
|
-
:param pulumi.Input[int] start_time: Seconds since epoch
|
|
53
|
+
:param pulumi.Input[str] program_text: Signalflow program text for the chart. More info [in the Splunk Observability Cloud docs](https://dev.splunk.com/observability/docs/signalflow/).
|
|
54
|
+
:param pulumi.Input[bool] axes_include_zero: Force the chart to display zero on the y-axes, even if none of the data is near zero.
|
|
55
|
+
:param pulumi.Input[int] axes_precision: Specifies the digits Splunk Observability Cloud displays for values plotted on the chart. Defaults to `3`.
|
|
56
|
+
:param pulumi.Input['TimeChartAxisLeftArgs'] axis_left: Set of axis options.
|
|
57
|
+
:param pulumi.Input['TimeChartAxisRightArgs'] axis_right: Set of axis options.
|
|
58
|
+
:param pulumi.Input[str] color_by: Must be `"Dimension"` or `"Metric"`. `"Dimension"` by default.
|
|
59
|
+
:param pulumi.Input[str] description: Description of the chart.
|
|
60
|
+
:param pulumi.Input[bool] disable_sampling: If `false`, samples a subset of the output MTS, which improves UI performance. `false` by default
|
|
61
|
+
:param pulumi.Input[int] end_time: Seconds since epoch. Used for visualization. Conflicts with `time_range`.
|
|
62
|
+
:param pulumi.Input[Sequence[pulumi.Input['TimeChartEventOptionArgs']]] event_options: Event customization options, associated with a publish statement. You will need to use this to change settings for any `events(…)` statements you use.
|
|
63
|
+
:param pulumi.Input[Sequence[pulumi.Input['TimeChartHistogramOptionArgs']]] histogram_options: Only used when `plot_type` is `"Histogram"`. Histogram specific options.
|
|
64
|
+
:param pulumi.Input[Sequence[pulumi.Input[str]]] legend_fields_to_hides: 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 `legend_options_fields`.
|
|
65
|
+
:param pulumi.Input[Sequence[pulumi.Input['TimeChartLegendOptionsFieldArgs']]] legend_options_fields: 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 `legend_fields_to_hide`.
|
|
66
|
+
:param pulumi.Input[int] max_delay: How long (in seconds) to wait for late datapoints.
|
|
67
|
+
:param pulumi.Input[int] minimum_resolution: The minimum resolution (in seconds) to use for computing the underlying program.
|
|
68
|
+
:param pulumi.Input[str] name: Name of the chart.
|
|
69
|
+
:param pulumi.Input[str] on_chart_legend_dimension: Dimensions to show in the on-chart legend. On-chart legend is off unless a dimension is specified. Allowed: `"metric"`, `"plot_label"` and any dimension.
|
|
70
|
+
:param pulumi.Input[str] plot_type: The default plot display style for the visualization. Must be `"LineChart"`, `"AreaChart"`, `"ColumnChart"`, or `"Histogram"`. Default: `"LineChart"`.
|
|
71
|
+
:param pulumi.Input[bool] show_data_markers: Show markers (circles) for each datapoint used to draw line or area charts. `false` by default.
|
|
72
|
+
:param pulumi.Input[bool] show_event_lines: Whether vertical highlight lines should be drawn in the visualizations at times when events occurred. `false` by default.
|
|
73
|
+
:param pulumi.Input[bool] stacked: Whether area and bar charts in the visualization should be stacked. `false` by default.
|
|
74
|
+
:param pulumi.Input[int] start_time: Seconds since epoch. Used for visualization. Conflicts with `time_range`.
|
|
70
75
|
:param pulumi.Input[Sequence[pulumi.Input[str]]] tags: Tags associated with the chart
|
|
71
|
-
:param pulumi.Input[int] time_range:
|
|
72
|
-
:param pulumi.Input[str] timezone:
|
|
73
|
-
:param pulumi.Input[str] unit_prefix:
|
|
74
|
-
:param pulumi.Input[Sequence[pulumi.Input['TimeChartVizOptionArgs']]] viz_options: Plot-level customization options, associated with a publish statement
|
|
76
|
+
:param pulumi.Input[int] time_range: How many seconds ago from which to display data. For example, the last hour would be `3600`, etc. Conflicts with `start_time` and `end_time`.
|
|
77
|
+
:param pulumi.Input[str] timezone: 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.
|
|
78
|
+
:param pulumi.Input[str] unit_prefix: Must be `"Metric"` or `"Binary`". `"Metric"` by default.
|
|
79
|
+
:param pulumi.Input[Sequence[pulumi.Input['TimeChartVizOptionArgs']]] viz_options: Plot-level customization options, associated with a publish statement.
|
|
75
80
|
"""
|
|
76
81
|
pulumi.set(__self__, "program_text", program_text)
|
|
77
82
|
if axes_include_zero is not None:
|
|
@@ -137,7 +142,7 @@ class TimeChartArgs:
|
|
|
137
142
|
@pulumi.getter(name="programText")
|
|
138
143
|
def program_text(self) -> pulumi.Input[str]:
|
|
139
144
|
"""
|
|
140
|
-
Signalflow program text for the chart. More info
|
|
145
|
+
Signalflow program text for the chart. More info [in the Splunk Observability Cloud docs](https://dev.splunk.com/observability/docs/signalflow/).
|
|
141
146
|
"""
|
|
142
147
|
return pulumi.get(self, "program_text")
|
|
143
148
|
|
|
@@ -149,7 +154,7 @@ class TimeChartArgs:
|
|
|
149
154
|
@pulumi.getter(name="axesIncludeZero")
|
|
150
155
|
def axes_include_zero(self) -> Optional[pulumi.Input[bool]]:
|
|
151
156
|
"""
|
|
152
|
-
Force y-axes
|
|
157
|
+
Force the chart to display zero on the y-axes, even if none of the data is near zero.
|
|
153
158
|
"""
|
|
154
159
|
return pulumi.get(self, "axes_include_zero")
|
|
155
160
|
|
|
@@ -161,7 +166,7 @@ class TimeChartArgs:
|
|
|
161
166
|
@pulumi.getter(name="axesPrecision")
|
|
162
167
|
def axes_precision(self) -> Optional[pulumi.Input[int]]:
|
|
163
168
|
"""
|
|
164
|
-
|
|
169
|
+
Specifies the digits Splunk Observability Cloud displays for values plotted on the chart. Defaults to `3`.
|
|
165
170
|
"""
|
|
166
171
|
return pulumi.get(self, "axes_precision")
|
|
167
172
|
|
|
@@ -172,6 +177,9 @@ class TimeChartArgs:
|
|
|
172
177
|
@property
|
|
173
178
|
@pulumi.getter(name="axisLeft")
|
|
174
179
|
def axis_left(self) -> Optional[pulumi.Input['TimeChartAxisLeftArgs']]:
|
|
180
|
+
"""
|
|
181
|
+
Set of axis options.
|
|
182
|
+
"""
|
|
175
183
|
return pulumi.get(self, "axis_left")
|
|
176
184
|
|
|
177
185
|
@axis_left.setter
|
|
@@ -181,6 +189,9 @@ class TimeChartArgs:
|
|
|
181
189
|
@property
|
|
182
190
|
@pulumi.getter(name="axisRight")
|
|
183
191
|
def axis_right(self) -> Optional[pulumi.Input['TimeChartAxisRightArgs']]:
|
|
192
|
+
"""
|
|
193
|
+
Set of axis options.
|
|
194
|
+
"""
|
|
184
195
|
return pulumi.get(self, "axis_right")
|
|
185
196
|
|
|
186
197
|
@axis_right.setter
|
|
@@ -191,7 +202,7 @@ class TimeChartArgs:
|
|
|
191
202
|
@pulumi.getter(name="colorBy")
|
|
192
203
|
def color_by(self) -> Optional[pulumi.Input[str]]:
|
|
193
204
|
"""
|
|
194
|
-
|
|
205
|
+
Must be `"Dimension"` or `"Metric"`. `"Dimension"` by default.
|
|
195
206
|
"""
|
|
196
207
|
return pulumi.get(self, "color_by")
|
|
197
208
|
|
|
@@ -203,7 +214,7 @@ class TimeChartArgs:
|
|
|
203
214
|
@pulumi.getter
|
|
204
215
|
def description(self) -> Optional[pulumi.Input[str]]:
|
|
205
216
|
"""
|
|
206
|
-
Description of the chart
|
|
217
|
+
Description of the chart.
|
|
207
218
|
"""
|
|
208
219
|
return pulumi.get(self, "description")
|
|
209
220
|
|
|
@@ -215,7 +226,7 @@ class TimeChartArgs:
|
|
|
215
226
|
@pulumi.getter(name="disableSampling")
|
|
216
227
|
def disable_sampling(self) -> Optional[pulumi.Input[bool]]:
|
|
217
228
|
"""
|
|
218
|
-
|
|
229
|
+
If `false`, samples a subset of the output MTS, which improves UI performance. `false` by default
|
|
219
230
|
"""
|
|
220
231
|
return pulumi.get(self, "disable_sampling")
|
|
221
232
|
|
|
@@ -227,7 +238,7 @@ class TimeChartArgs:
|
|
|
227
238
|
@pulumi.getter(name="endTime")
|
|
228
239
|
def end_time(self) -> Optional[pulumi.Input[int]]:
|
|
229
240
|
"""
|
|
230
|
-
Seconds since epoch
|
|
241
|
+
Seconds since epoch. Used for visualization. Conflicts with `time_range`.
|
|
231
242
|
"""
|
|
232
243
|
return pulumi.get(self, "end_time")
|
|
233
244
|
|
|
@@ -239,7 +250,7 @@ class TimeChartArgs:
|
|
|
239
250
|
@pulumi.getter(name="eventOptions")
|
|
240
251
|
def event_options(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['TimeChartEventOptionArgs']]]]:
|
|
241
252
|
"""
|
|
242
|
-
Event
|
|
253
|
+
Event customization options, associated with a publish statement. You will need to use this to change settings for any `events(…)` statements you use.
|
|
243
254
|
"""
|
|
244
255
|
return pulumi.get(self, "event_options")
|
|
245
256
|
|
|
@@ -251,7 +262,7 @@ class TimeChartArgs:
|
|
|
251
262
|
@pulumi.getter(name="histogramOptions")
|
|
252
263
|
def histogram_options(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['TimeChartHistogramOptionArgs']]]]:
|
|
253
264
|
"""
|
|
254
|
-
|
|
265
|
+
Only used when `plot_type` is `"Histogram"`. Histogram specific options.
|
|
255
266
|
"""
|
|
256
267
|
return pulumi.get(self, "histogram_options")
|
|
257
268
|
|
|
@@ -261,13 +272,11 @@ class TimeChartArgs:
|
|
|
261
272
|
|
|
262
273
|
@property
|
|
263
274
|
@pulumi.getter(name="legendFieldsToHides")
|
|
275
|
+
@_utilities.deprecated("""Please use legend_options_fields""")
|
|
264
276
|
def legend_fields_to_hides(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
|
|
265
277
|
"""
|
|
266
|
-
List of properties that
|
|
278
|
+
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 `legend_options_fields`.
|
|
267
279
|
"""
|
|
268
|
-
warnings.warn("""Please use legend_options_fields""", DeprecationWarning)
|
|
269
|
-
pulumi.log.warn("""legend_fields_to_hides is deprecated: Please use legend_options_fields""")
|
|
270
|
-
|
|
271
280
|
return pulumi.get(self, "legend_fields_to_hides")
|
|
272
281
|
|
|
273
282
|
@legend_fields_to_hides.setter
|
|
@@ -278,7 +287,7 @@ class TimeChartArgs:
|
|
|
278
287
|
@pulumi.getter(name="legendOptionsFields")
|
|
279
288
|
def legend_options_fields(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['TimeChartLegendOptionsFieldArgs']]]]:
|
|
280
289
|
"""
|
|
281
|
-
List of property and enabled flags
|
|
290
|
+
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 `legend_fields_to_hide`.
|
|
282
291
|
"""
|
|
283
292
|
return pulumi.get(self, "legend_options_fields")
|
|
284
293
|
|
|
@@ -290,7 +299,7 @@ class TimeChartArgs:
|
|
|
290
299
|
@pulumi.getter(name="maxDelay")
|
|
291
300
|
def max_delay(self) -> Optional[pulumi.Input[int]]:
|
|
292
301
|
"""
|
|
293
|
-
How long (in seconds) to wait for late datapoints
|
|
302
|
+
How long (in seconds) to wait for late datapoints.
|
|
294
303
|
"""
|
|
295
304
|
return pulumi.get(self, "max_delay")
|
|
296
305
|
|
|
@@ -302,7 +311,7 @@ class TimeChartArgs:
|
|
|
302
311
|
@pulumi.getter(name="minimumResolution")
|
|
303
312
|
def minimum_resolution(self) -> Optional[pulumi.Input[int]]:
|
|
304
313
|
"""
|
|
305
|
-
The minimum resolution (in seconds) to use for computing the underlying program
|
|
314
|
+
The minimum resolution (in seconds) to use for computing the underlying program.
|
|
306
315
|
"""
|
|
307
316
|
return pulumi.get(self, "minimum_resolution")
|
|
308
317
|
|
|
@@ -314,7 +323,7 @@ class TimeChartArgs:
|
|
|
314
323
|
@pulumi.getter
|
|
315
324
|
def name(self) -> Optional[pulumi.Input[str]]:
|
|
316
325
|
"""
|
|
317
|
-
Name of the chart
|
|
326
|
+
Name of the chart.
|
|
318
327
|
"""
|
|
319
328
|
return pulumi.get(self, "name")
|
|
320
329
|
|
|
@@ -326,8 +335,7 @@ class TimeChartArgs:
|
|
|
326
335
|
@pulumi.getter(name="onChartLegendDimension")
|
|
327
336
|
def on_chart_legend_dimension(self) -> Optional[pulumi.Input[str]]:
|
|
328
337
|
"""
|
|
329
|
-
|
|
330
|
-
'plot_label' and any dimension.
|
|
338
|
+
Dimensions to show in the on-chart legend. On-chart legend is off unless a dimension is specified. Allowed: `"metric"`, `"plot_label"` and any dimension.
|
|
331
339
|
"""
|
|
332
340
|
return pulumi.get(self, "on_chart_legend_dimension")
|
|
333
341
|
|
|
@@ -339,8 +347,7 @@ class TimeChartArgs:
|
|
|
339
347
|
@pulumi.getter(name="plotType")
|
|
340
348
|
def plot_type(self) -> Optional[pulumi.Input[str]]:
|
|
341
349
|
"""
|
|
342
|
-
|
|
343
|
-
"ColumnChart", or "Histogram"
|
|
350
|
+
The default plot display style for the visualization. Must be `"LineChart"`, `"AreaChart"`, `"ColumnChart"`, or `"Histogram"`. Default: `"LineChart"`.
|
|
344
351
|
"""
|
|
345
352
|
return pulumi.get(self, "plot_type")
|
|
346
353
|
|
|
@@ -352,7 +359,7 @@ class TimeChartArgs:
|
|
|
352
359
|
@pulumi.getter(name="showDataMarkers")
|
|
353
360
|
def show_data_markers(self) -> Optional[pulumi.Input[bool]]:
|
|
354
361
|
"""
|
|
355
|
-
|
|
362
|
+
Show markers (circles) for each datapoint used to draw line or area charts. `false` by default.
|
|
356
363
|
"""
|
|
357
364
|
return pulumi.get(self, "show_data_markers")
|
|
358
365
|
|
|
@@ -364,7 +371,7 @@ class TimeChartArgs:
|
|
|
364
371
|
@pulumi.getter(name="showEventLines")
|
|
365
372
|
def show_event_lines(self) -> Optional[pulumi.Input[bool]]:
|
|
366
373
|
"""
|
|
367
|
-
|
|
374
|
+
Whether vertical highlight lines should be drawn in the visualizations at times when events occurred. `false` by default.
|
|
368
375
|
"""
|
|
369
376
|
return pulumi.get(self, "show_event_lines")
|
|
370
377
|
|
|
@@ -376,7 +383,7 @@ class TimeChartArgs:
|
|
|
376
383
|
@pulumi.getter
|
|
377
384
|
def stacked(self) -> Optional[pulumi.Input[bool]]:
|
|
378
385
|
"""
|
|
379
|
-
|
|
386
|
+
Whether area and bar charts in the visualization should be stacked. `false` by default.
|
|
380
387
|
"""
|
|
381
388
|
return pulumi.get(self, "stacked")
|
|
382
389
|
|
|
@@ -388,7 +395,7 @@ class TimeChartArgs:
|
|
|
388
395
|
@pulumi.getter(name="startTime")
|
|
389
396
|
def start_time(self) -> Optional[pulumi.Input[int]]:
|
|
390
397
|
"""
|
|
391
|
-
Seconds since epoch
|
|
398
|
+
Seconds since epoch. Used for visualization. Conflicts with `time_range`.
|
|
392
399
|
"""
|
|
393
400
|
return pulumi.get(self, "start_time")
|
|
394
401
|
|
|
@@ -398,13 +405,11 @@ class TimeChartArgs:
|
|
|
398
405
|
|
|
399
406
|
@property
|
|
400
407
|
@pulumi.getter
|
|
408
|
+
@_utilities.deprecated("""signalfx_time_chart.tags is being removed in the next release""")
|
|
401
409
|
def tags(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
|
|
402
410
|
"""
|
|
403
411
|
Tags associated with the chart
|
|
404
412
|
"""
|
|
405
|
-
warnings.warn("""signalfx_time_chart.tags is being removed in the next release""", DeprecationWarning)
|
|
406
|
-
pulumi.log.warn("""tags is deprecated: signalfx_time_chart.tags is being removed in the next release""")
|
|
407
|
-
|
|
408
413
|
return pulumi.get(self, "tags")
|
|
409
414
|
|
|
410
415
|
@tags.setter
|
|
@@ -415,7 +420,7 @@ class TimeChartArgs:
|
|
|
415
420
|
@pulumi.getter(name="timeRange")
|
|
416
421
|
def time_range(self) -> Optional[pulumi.Input[int]]:
|
|
417
422
|
"""
|
|
418
|
-
|
|
423
|
+
How many seconds ago from which to display data. For example, the last hour would be `3600`, etc. Conflicts with `start_time` and `end_time`.
|
|
419
424
|
"""
|
|
420
425
|
return pulumi.get(self, "time_range")
|
|
421
426
|
|
|
@@ -427,7 +432,7 @@ class TimeChartArgs:
|
|
|
427
432
|
@pulumi.getter
|
|
428
433
|
def timezone(self) -> Optional[pulumi.Input[str]]:
|
|
429
434
|
"""
|
|
430
|
-
|
|
435
|
+
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.
|
|
431
436
|
"""
|
|
432
437
|
return pulumi.get(self, "timezone")
|
|
433
438
|
|
|
@@ -439,7 +444,7 @@ class TimeChartArgs:
|
|
|
439
444
|
@pulumi.getter(name="unitPrefix")
|
|
440
445
|
def unit_prefix(self) -> Optional[pulumi.Input[str]]:
|
|
441
446
|
"""
|
|
442
|
-
|
|
447
|
+
Must be `"Metric"` or `"Binary`". `"Metric"` by default.
|
|
443
448
|
"""
|
|
444
449
|
return pulumi.get(self, "unit_prefix")
|
|
445
450
|
|
|
@@ -451,7 +456,7 @@ class TimeChartArgs:
|
|
|
451
456
|
@pulumi.getter(name="vizOptions")
|
|
452
457
|
def viz_options(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['TimeChartVizOptionArgs']]]]:
|
|
453
458
|
"""
|
|
454
|
-
Plot-level customization options, associated with a publish statement
|
|
459
|
+
Plot-level customization options, associated with a publish statement.
|
|
455
460
|
"""
|
|
456
461
|
return pulumi.get(self, "viz_options")
|
|
457
462
|
|
|
@@ -493,34 +498,34 @@ class _TimeChartState:
|
|
|
493
498
|
viz_options: Optional[pulumi.Input[Sequence[pulumi.Input['TimeChartVizOptionArgs']]]] = None):
|
|
494
499
|
"""
|
|
495
500
|
Input properties used for looking up and filtering TimeChart resources.
|
|
496
|
-
:param pulumi.Input[bool] axes_include_zero: Force y-axes
|
|
497
|
-
:param pulumi.Input[int] axes_precision:
|
|
498
|
-
:param pulumi.Input[
|
|
499
|
-
:param pulumi.Input[
|
|
500
|
-
:param pulumi.Input[
|
|
501
|
-
:param pulumi.Input[
|
|
502
|
-
:param pulumi.Input[
|
|
503
|
-
:param pulumi.Input[
|
|
504
|
-
:param pulumi.Input[Sequence[pulumi.Input[
|
|
505
|
-
:param pulumi.Input[Sequence[pulumi.Input['
|
|
506
|
-
:param pulumi.Input[
|
|
507
|
-
:param pulumi.Input[
|
|
508
|
-
:param pulumi.Input[
|
|
509
|
-
:param pulumi.Input[
|
|
510
|
-
|
|
511
|
-
:param pulumi.Input[str]
|
|
512
|
-
|
|
513
|
-
:param pulumi.Input[str] program_text: Signalflow program text for the chart. More info
|
|
514
|
-
:param pulumi.Input[bool] show_data_markers:
|
|
515
|
-
:param pulumi.Input[bool] show_event_lines:
|
|
516
|
-
:param pulumi.Input[bool] stacked:
|
|
517
|
-
:param pulumi.Input[int] start_time: Seconds since epoch
|
|
501
|
+
:param pulumi.Input[bool] axes_include_zero: Force the chart to display zero on the y-axes, even if none of the data is near zero.
|
|
502
|
+
:param pulumi.Input[int] axes_precision: Specifies the digits Splunk Observability Cloud displays for values plotted on the chart. Defaults to `3`.
|
|
503
|
+
:param pulumi.Input['TimeChartAxisLeftArgs'] axis_left: Set of axis options.
|
|
504
|
+
:param pulumi.Input['TimeChartAxisRightArgs'] axis_right: Set of axis options.
|
|
505
|
+
:param pulumi.Input[str] color_by: Must be `"Dimension"` or `"Metric"`. `"Dimension"` by default.
|
|
506
|
+
:param pulumi.Input[str] description: Description of the chart.
|
|
507
|
+
:param pulumi.Input[bool] disable_sampling: If `false`, samples a subset of the output MTS, which improves UI performance. `false` by default
|
|
508
|
+
:param pulumi.Input[int] end_time: Seconds since epoch. Used for visualization. Conflicts with `time_range`.
|
|
509
|
+
:param pulumi.Input[Sequence[pulumi.Input['TimeChartEventOptionArgs']]] event_options: Event customization options, associated with a publish statement. You will need to use this to change settings for any `events(…)` statements you use.
|
|
510
|
+
:param pulumi.Input[Sequence[pulumi.Input['TimeChartHistogramOptionArgs']]] histogram_options: Only used when `plot_type` is `"Histogram"`. Histogram specific options.
|
|
511
|
+
:param pulumi.Input[Sequence[pulumi.Input[str]]] legend_fields_to_hides: 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 `legend_options_fields`.
|
|
512
|
+
:param pulumi.Input[Sequence[pulumi.Input['TimeChartLegendOptionsFieldArgs']]] legend_options_fields: 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 `legend_fields_to_hide`.
|
|
513
|
+
:param pulumi.Input[int] max_delay: How long (in seconds) to wait for late datapoints.
|
|
514
|
+
:param pulumi.Input[int] minimum_resolution: The minimum resolution (in seconds) to use for computing the underlying program.
|
|
515
|
+
:param pulumi.Input[str] name: Name of the chart.
|
|
516
|
+
:param pulumi.Input[str] on_chart_legend_dimension: Dimensions to show in the on-chart legend. On-chart legend is off unless a dimension is specified. Allowed: `"metric"`, `"plot_label"` and any dimension.
|
|
517
|
+
:param pulumi.Input[str] plot_type: The default plot display style for the visualization. Must be `"LineChart"`, `"AreaChart"`, `"ColumnChart"`, or `"Histogram"`. Default: `"LineChart"`.
|
|
518
|
+
:param pulumi.Input[str] program_text: Signalflow program text for the chart. More info [in the Splunk Observability Cloud docs](https://dev.splunk.com/observability/docs/signalflow/).
|
|
519
|
+
:param pulumi.Input[bool] show_data_markers: Show markers (circles) for each datapoint used to draw line or area charts. `false` by default.
|
|
520
|
+
:param pulumi.Input[bool] show_event_lines: Whether vertical highlight lines should be drawn in the visualizations at times when events occurred. `false` by default.
|
|
521
|
+
:param pulumi.Input[bool] stacked: Whether area and bar charts in the visualization should be stacked. `false` by default.
|
|
522
|
+
:param pulumi.Input[int] start_time: Seconds since epoch. Used for visualization. Conflicts with `time_range`.
|
|
518
523
|
:param pulumi.Input[Sequence[pulumi.Input[str]]] tags: Tags associated with the chart
|
|
519
|
-
:param pulumi.Input[int] time_range:
|
|
520
|
-
:param pulumi.Input[str] timezone:
|
|
521
|
-
:param pulumi.Input[str] unit_prefix:
|
|
522
|
-
:param pulumi.Input[str] url: URL of the chart
|
|
523
|
-
:param pulumi.Input[Sequence[pulumi.Input['TimeChartVizOptionArgs']]] viz_options: Plot-level customization options, associated with a publish statement
|
|
524
|
+
:param pulumi.Input[int] time_range: How many seconds ago from which to display data. For example, the last hour would be `3600`, etc. Conflicts with `start_time` and `end_time`.
|
|
525
|
+
:param pulumi.Input[str] timezone: 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.
|
|
526
|
+
:param pulumi.Input[str] unit_prefix: Must be `"Metric"` or `"Binary`". `"Metric"` by default.
|
|
527
|
+
:param pulumi.Input[str] url: The URL of the chart.
|
|
528
|
+
:param pulumi.Input[Sequence[pulumi.Input['TimeChartVizOptionArgs']]] viz_options: Plot-level customization options, associated with a publish statement.
|
|
524
529
|
"""
|
|
525
530
|
if axes_include_zero is not None:
|
|
526
531
|
pulumi.set(__self__, "axes_include_zero", axes_include_zero)
|
|
@@ -589,7 +594,7 @@ class _TimeChartState:
|
|
|
589
594
|
@pulumi.getter(name="axesIncludeZero")
|
|
590
595
|
def axes_include_zero(self) -> Optional[pulumi.Input[bool]]:
|
|
591
596
|
"""
|
|
592
|
-
Force y-axes
|
|
597
|
+
Force the chart to display zero on the y-axes, even if none of the data is near zero.
|
|
593
598
|
"""
|
|
594
599
|
return pulumi.get(self, "axes_include_zero")
|
|
595
600
|
|
|
@@ -601,7 +606,7 @@ class _TimeChartState:
|
|
|
601
606
|
@pulumi.getter(name="axesPrecision")
|
|
602
607
|
def axes_precision(self) -> Optional[pulumi.Input[int]]:
|
|
603
608
|
"""
|
|
604
|
-
|
|
609
|
+
Specifies the digits Splunk Observability Cloud displays for values plotted on the chart. Defaults to `3`.
|
|
605
610
|
"""
|
|
606
611
|
return pulumi.get(self, "axes_precision")
|
|
607
612
|
|
|
@@ -612,6 +617,9 @@ class _TimeChartState:
|
|
|
612
617
|
@property
|
|
613
618
|
@pulumi.getter(name="axisLeft")
|
|
614
619
|
def axis_left(self) -> Optional[pulumi.Input['TimeChartAxisLeftArgs']]:
|
|
620
|
+
"""
|
|
621
|
+
Set of axis options.
|
|
622
|
+
"""
|
|
615
623
|
return pulumi.get(self, "axis_left")
|
|
616
624
|
|
|
617
625
|
@axis_left.setter
|
|
@@ -621,6 +629,9 @@ class _TimeChartState:
|
|
|
621
629
|
@property
|
|
622
630
|
@pulumi.getter(name="axisRight")
|
|
623
631
|
def axis_right(self) -> Optional[pulumi.Input['TimeChartAxisRightArgs']]:
|
|
632
|
+
"""
|
|
633
|
+
Set of axis options.
|
|
634
|
+
"""
|
|
624
635
|
return pulumi.get(self, "axis_right")
|
|
625
636
|
|
|
626
637
|
@axis_right.setter
|
|
@@ -631,7 +642,7 @@ class _TimeChartState:
|
|
|
631
642
|
@pulumi.getter(name="colorBy")
|
|
632
643
|
def color_by(self) -> Optional[pulumi.Input[str]]:
|
|
633
644
|
"""
|
|
634
|
-
|
|
645
|
+
Must be `"Dimension"` or `"Metric"`. `"Dimension"` by default.
|
|
635
646
|
"""
|
|
636
647
|
return pulumi.get(self, "color_by")
|
|
637
648
|
|
|
@@ -643,7 +654,7 @@ class _TimeChartState:
|
|
|
643
654
|
@pulumi.getter
|
|
644
655
|
def description(self) -> Optional[pulumi.Input[str]]:
|
|
645
656
|
"""
|
|
646
|
-
Description of the chart
|
|
657
|
+
Description of the chart.
|
|
647
658
|
"""
|
|
648
659
|
return pulumi.get(self, "description")
|
|
649
660
|
|
|
@@ -655,7 +666,7 @@ class _TimeChartState:
|
|
|
655
666
|
@pulumi.getter(name="disableSampling")
|
|
656
667
|
def disable_sampling(self) -> Optional[pulumi.Input[bool]]:
|
|
657
668
|
"""
|
|
658
|
-
|
|
669
|
+
If `false`, samples a subset of the output MTS, which improves UI performance. `false` by default
|
|
659
670
|
"""
|
|
660
671
|
return pulumi.get(self, "disable_sampling")
|
|
661
672
|
|
|
@@ -667,7 +678,7 @@ class _TimeChartState:
|
|
|
667
678
|
@pulumi.getter(name="endTime")
|
|
668
679
|
def end_time(self) -> Optional[pulumi.Input[int]]:
|
|
669
680
|
"""
|
|
670
|
-
Seconds since epoch
|
|
681
|
+
Seconds since epoch. Used for visualization. Conflicts with `time_range`.
|
|
671
682
|
"""
|
|
672
683
|
return pulumi.get(self, "end_time")
|
|
673
684
|
|
|
@@ -679,7 +690,7 @@ class _TimeChartState:
|
|
|
679
690
|
@pulumi.getter(name="eventOptions")
|
|
680
691
|
def event_options(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['TimeChartEventOptionArgs']]]]:
|
|
681
692
|
"""
|
|
682
|
-
Event
|
|
693
|
+
Event customization options, associated with a publish statement. You will need to use this to change settings for any `events(…)` statements you use.
|
|
683
694
|
"""
|
|
684
695
|
return pulumi.get(self, "event_options")
|
|
685
696
|
|
|
@@ -691,7 +702,7 @@ class _TimeChartState:
|
|
|
691
702
|
@pulumi.getter(name="histogramOptions")
|
|
692
703
|
def histogram_options(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['TimeChartHistogramOptionArgs']]]]:
|
|
693
704
|
"""
|
|
694
|
-
|
|
705
|
+
Only used when `plot_type` is `"Histogram"`. Histogram specific options.
|
|
695
706
|
"""
|
|
696
707
|
return pulumi.get(self, "histogram_options")
|
|
697
708
|
|
|
@@ -701,13 +712,11 @@ class _TimeChartState:
|
|
|
701
712
|
|
|
702
713
|
@property
|
|
703
714
|
@pulumi.getter(name="legendFieldsToHides")
|
|
715
|
+
@_utilities.deprecated("""Please use legend_options_fields""")
|
|
704
716
|
def legend_fields_to_hides(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
|
|
705
717
|
"""
|
|
706
|
-
List of properties that
|
|
718
|
+
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 `legend_options_fields`.
|
|
707
719
|
"""
|
|
708
|
-
warnings.warn("""Please use legend_options_fields""", DeprecationWarning)
|
|
709
|
-
pulumi.log.warn("""legend_fields_to_hides is deprecated: Please use legend_options_fields""")
|
|
710
|
-
|
|
711
720
|
return pulumi.get(self, "legend_fields_to_hides")
|
|
712
721
|
|
|
713
722
|
@legend_fields_to_hides.setter
|
|
@@ -718,7 +727,7 @@ class _TimeChartState:
|
|
|
718
727
|
@pulumi.getter(name="legendOptionsFields")
|
|
719
728
|
def legend_options_fields(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['TimeChartLegendOptionsFieldArgs']]]]:
|
|
720
729
|
"""
|
|
721
|
-
List of property and enabled flags
|
|
730
|
+
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 `legend_fields_to_hide`.
|
|
722
731
|
"""
|
|
723
732
|
return pulumi.get(self, "legend_options_fields")
|
|
724
733
|
|
|
@@ -730,7 +739,7 @@ class _TimeChartState:
|
|
|
730
739
|
@pulumi.getter(name="maxDelay")
|
|
731
740
|
def max_delay(self) -> Optional[pulumi.Input[int]]:
|
|
732
741
|
"""
|
|
733
|
-
How long (in seconds) to wait for late datapoints
|
|
742
|
+
How long (in seconds) to wait for late datapoints.
|
|
734
743
|
"""
|
|
735
744
|
return pulumi.get(self, "max_delay")
|
|
736
745
|
|
|
@@ -742,7 +751,7 @@ class _TimeChartState:
|
|
|
742
751
|
@pulumi.getter(name="minimumResolution")
|
|
743
752
|
def minimum_resolution(self) -> Optional[pulumi.Input[int]]:
|
|
744
753
|
"""
|
|
745
|
-
The minimum resolution (in seconds) to use for computing the underlying program
|
|
754
|
+
The minimum resolution (in seconds) to use for computing the underlying program.
|
|
746
755
|
"""
|
|
747
756
|
return pulumi.get(self, "minimum_resolution")
|
|
748
757
|
|
|
@@ -754,7 +763,7 @@ class _TimeChartState:
|
|
|
754
763
|
@pulumi.getter
|
|
755
764
|
def name(self) -> Optional[pulumi.Input[str]]:
|
|
756
765
|
"""
|
|
757
|
-
Name of the chart
|
|
766
|
+
Name of the chart.
|
|
758
767
|
"""
|
|
759
768
|
return pulumi.get(self, "name")
|
|
760
769
|
|
|
@@ -766,8 +775,7 @@ class _TimeChartState:
|
|
|
766
775
|
@pulumi.getter(name="onChartLegendDimension")
|
|
767
776
|
def on_chart_legend_dimension(self) -> Optional[pulumi.Input[str]]:
|
|
768
777
|
"""
|
|
769
|
-
|
|
770
|
-
'plot_label' and any dimension.
|
|
778
|
+
Dimensions to show in the on-chart legend. On-chart legend is off unless a dimension is specified. Allowed: `"metric"`, `"plot_label"` and any dimension.
|
|
771
779
|
"""
|
|
772
780
|
return pulumi.get(self, "on_chart_legend_dimension")
|
|
773
781
|
|
|
@@ -779,8 +787,7 @@ class _TimeChartState:
|
|
|
779
787
|
@pulumi.getter(name="plotType")
|
|
780
788
|
def plot_type(self) -> Optional[pulumi.Input[str]]:
|
|
781
789
|
"""
|
|
782
|
-
|
|
783
|
-
"ColumnChart", or "Histogram"
|
|
790
|
+
The default plot display style for the visualization. Must be `"LineChart"`, `"AreaChart"`, `"ColumnChart"`, or `"Histogram"`. Default: `"LineChart"`.
|
|
784
791
|
"""
|
|
785
792
|
return pulumi.get(self, "plot_type")
|
|
786
793
|
|
|
@@ -792,7 +799,7 @@ class _TimeChartState:
|
|
|
792
799
|
@pulumi.getter(name="programText")
|
|
793
800
|
def program_text(self) -> Optional[pulumi.Input[str]]:
|
|
794
801
|
"""
|
|
795
|
-
Signalflow program text for the chart. More info
|
|
802
|
+
Signalflow program text for the chart. More info [in the Splunk Observability Cloud docs](https://dev.splunk.com/observability/docs/signalflow/).
|
|
796
803
|
"""
|
|
797
804
|
return pulumi.get(self, "program_text")
|
|
798
805
|
|
|
@@ -804,7 +811,7 @@ class _TimeChartState:
|
|
|
804
811
|
@pulumi.getter(name="showDataMarkers")
|
|
805
812
|
def show_data_markers(self) -> Optional[pulumi.Input[bool]]:
|
|
806
813
|
"""
|
|
807
|
-
|
|
814
|
+
Show markers (circles) for each datapoint used to draw line or area charts. `false` by default.
|
|
808
815
|
"""
|
|
809
816
|
return pulumi.get(self, "show_data_markers")
|
|
810
817
|
|
|
@@ -816,7 +823,7 @@ class _TimeChartState:
|
|
|
816
823
|
@pulumi.getter(name="showEventLines")
|
|
817
824
|
def show_event_lines(self) -> Optional[pulumi.Input[bool]]:
|
|
818
825
|
"""
|
|
819
|
-
|
|
826
|
+
Whether vertical highlight lines should be drawn in the visualizations at times when events occurred. `false` by default.
|
|
820
827
|
"""
|
|
821
828
|
return pulumi.get(self, "show_event_lines")
|
|
822
829
|
|
|
@@ -828,7 +835,7 @@ class _TimeChartState:
|
|
|
828
835
|
@pulumi.getter
|
|
829
836
|
def stacked(self) -> Optional[pulumi.Input[bool]]:
|
|
830
837
|
"""
|
|
831
|
-
|
|
838
|
+
Whether area and bar charts in the visualization should be stacked. `false` by default.
|
|
832
839
|
"""
|
|
833
840
|
return pulumi.get(self, "stacked")
|
|
834
841
|
|
|
@@ -840,7 +847,7 @@ class _TimeChartState:
|
|
|
840
847
|
@pulumi.getter(name="startTime")
|
|
841
848
|
def start_time(self) -> Optional[pulumi.Input[int]]:
|
|
842
849
|
"""
|
|
843
|
-
Seconds since epoch
|
|
850
|
+
Seconds since epoch. Used for visualization. Conflicts with `time_range`.
|
|
844
851
|
"""
|
|
845
852
|
return pulumi.get(self, "start_time")
|
|
846
853
|
|
|
@@ -850,13 +857,11 @@ class _TimeChartState:
|
|
|
850
857
|
|
|
851
858
|
@property
|
|
852
859
|
@pulumi.getter
|
|
860
|
+
@_utilities.deprecated("""signalfx_time_chart.tags is being removed in the next release""")
|
|
853
861
|
def tags(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[str]]]]:
|
|
854
862
|
"""
|
|
855
863
|
Tags associated with the chart
|
|
856
864
|
"""
|
|
857
|
-
warnings.warn("""signalfx_time_chart.tags is being removed in the next release""", DeprecationWarning)
|
|
858
|
-
pulumi.log.warn("""tags is deprecated: signalfx_time_chart.tags is being removed in the next release""")
|
|
859
|
-
|
|
860
865
|
return pulumi.get(self, "tags")
|
|
861
866
|
|
|
862
867
|
@tags.setter
|
|
@@ -867,7 +872,7 @@ class _TimeChartState:
|
|
|
867
872
|
@pulumi.getter(name="timeRange")
|
|
868
873
|
def time_range(self) -> Optional[pulumi.Input[int]]:
|
|
869
874
|
"""
|
|
870
|
-
|
|
875
|
+
How many seconds ago from which to display data. For example, the last hour would be `3600`, etc. Conflicts with `start_time` and `end_time`.
|
|
871
876
|
"""
|
|
872
877
|
return pulumi.get(self, "time_range")
|
|
873
878
|
|
|
@@ -879,7 +884,7 @@ class _TimeChartState:
|
|
|
879
884
|
@pulumi.getter
|
|
880
885
|
def timezone(self) -> Optional[pulumi.Input[str]]:
|
|
881
886
|
"""
|
|
882
|
-
|
|
887
|
+
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.
|
|
883
888
|
"""
|
|
884
889
|
return pulumi.get(self, "timezone")
|
|
885
890
|
|
|
@@ -891,7 +896,7 @@ class _TimeChartState:
|
|
|
891
896
|
@pulumi.getter(name="unitPrefix")
|
|
892
897
|
def unit_prefix(self) -> Optional[pulumi.Input[str]]:
|
|
893
898
|
"""
|
|
894
|
-
|
|
899
|
+
Must be `"Metric"` or `"Binary`". `"Metric"` by default.
|
|
895
900
|
"""
|
|
896
901
|
return pulumi.get(self, "unit_prefix")
|
|
897
902
|
|
|
@@ -903,7 +908,7 @@ class _TimeChartState:
|
|
|
903
908
|
@pulumi.getter
|
|
904
909
|
def url(self) -> Optional[pulumi.Input[str]]:
|
|
905
910
|
"""
|
|
906
|
-
URL of the chart
|
|
911
|
+
The URL of the chart.
|
|
907
912
|
"""
|
|
908
913
|
return pulumi.get(self, "url")
|
|
909
914
|
|
|
@@ -915,7 +920,7 @@ class _TimeChartState:
|
|
|
915
920
|
@pulumi.getter(name="vizOptions")
|
|
916
921
|
def viz_options(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['TimeChartVizOptionArgs']]]]:
|
|
917
922
|
"""
|
|
918
|
-
Plot-level customization options, associated with a publish statement
|
|
923
|
+
Plot-level customization options, associated with a publish statement.
|
|
919
924
|
"""
|
|
920
925
|
return pulumi.get(self, "viz_options")
|
|
921
926
|
|
|
@@ -931,16 +936,16 @@ class TimeChart(pulumi.CustomResource):
|
|
|
931
936
|
opts: Optional[pulumi.ResourceOptions] = None,
|
|
932
937
|
axes_include_zero: Optional[pulumi.Input[bool]] = None,
|
|
933
938
|
axes_precision: Optional[pulumi.Input[int]] = None,
|
|
934
|
-
axis_left: Optional[pulumi.Input[
|
|
935
|
-
axis_right: Optional[pulumi.Input[
|
|
939
|
+
axis_left: Optional[pulumi.Input[Union['TimeChartAxisLeftArgs', 'TimeChartAxisLeftArgsDict']]] = None,
|
|
940
|
+
axis_right: Optional[pulumi.Input[Union['TimeChartAxisRightArgs', 'TimeChartAxisRightArgsDict']]] = None,
|
|
936
941
|
color_by: Optional[pulumi.Input[str]] = None,
|
|
937
942
|
description: Optional[pulumi.Input[str]] = None,
|
|
938
943
|
disable_sampling: Optional[pulumi.Input[bool]] = None,
|
|
939
944
|
end_time: Optional[pulumi.Input[int]] = None,
|
|
940
|
-
event_options: Optional[pulumi.Input[Sequence[pulumi.Input[
|
|
941
|
-
histogram_options: Optional[pulumi.Input[Sequence[pulumi.Input[
|
|
945
|
+
event_options: Optional[pulumi.Input[Sequence[pulumi.Input[Union['TimeChartEventOptionArgs', 'TimeChartEventOptionArgsDict']]]]] = None,
|
|
946
|
+
histogram_options: Optional[pulumi.Input[Sequence[pulumi.Input[Union['TimeChartHistogramOptionArgs', 'TimeChartHistogramOptionArgsDict']]]]] = None,
|
|
942
947
|
legend_fields_to_hides: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
|
|
943
|
-
legend_options_fields: Optional[pulumi.Input[Sequence[pulumi.Input[
|
|
948
|
+
legend_options_fields: Optional[pulumi.Input[Sequence[pulumi.Input[Union['TimeChartLegendOptionsFieldArgs', 'TimeChartLegendOptionsFieldArgsDict']]]]] = None,
|
|
944
949
|
max_delay: Optional[pulumi.Input[int]] = None,
|
|
945
950
|
minimum_resolution: Optional[pulumi.Input[int]] = None,
|
|
946
951
|
name: Optional[pulumi.Input[str]] = None,
|
|
@@ -955,7 +960,7 @@ class TimeChart(pulumi.CustomResource):
|
|
|
955
960
|
time_range: Optional[pulumi.Input[int]] = None,
|
|
956
961
|
timezone: Optional[pulumi.Input[str]] = None,
|
|
957
962
|
unit_prefix: Optional[pulumi.Input[str]] = None,
|
|
958
|
-
viz_options: Optional[pulumi.Input[Sequence[pulumi.Input[
|
|
963
|
+
viz_options: Optional[pulumi.Input[Sequence[pulumi.Input[Union['TimeChartVizOptionArgs', 'TimeChartVizOptionArgsDict']]]]] = None,
|
|
959
964
|
__props__=None):
|
|
960
965
|
"""
|
|
961
966
|
Provides a Splunk Observability Cloud time chart resource. This can be used to create and manage the different types of time charts.
|
|
@@ -969,128 +974,61 @@ class TimeChart(pulumi.CustomResource):
|
|
|
969
974
|
import pulumi_signalfx as signalfx
|
|
970
975
|
|
|
971
976
|
mychart0 = signalfx.TimeChart("mychart0",
|
|
972
|
-
|
|
973
|
-
|
|
974
|
-
|
|
975
|
-
),
|
|
976
|
-
legend_options_fields=[
|
|
977
|
-
signalfx.TimeChartLegendOptionsFieldArgs(
|
|
978
|
-
enabled=False,
|
|
979
|
-
property="collector",
|
|
980
|
-
),
|
|
981
|
-
signalfx.TimeChartLegendOptionsFieldArgs(
|
|
982
|
-
enabled=False,
|
|
983
|
-
property="hostname",
|
|
984
|
-
),
|
|
985
|
-
],
|
|
977
|
+
name="CPU Total Idle",
|
|
978
|
+
program_text="data(\\"cpu.total.idle\\").publish(label=\\"CPU Idle\\")\\n",
|
|
979
|
+
time_range=3600,
|
|
986
980
|
plot_type="LineChart",
|
|
987
|
-
program_text=\"\"\"data("cpu.total.idle").publish(label="CPU Idle")
|
|
988
|
-
|
|
989
|
-
\"\"\",
|
|
990
981
|
show_data_markers=True,
|
|
991
|
-
|
|
992
|
-
|
|
993
|
-
|
|
994
|
-
|
|
995
|
-
|
|
996
|
-
|
|
982
|
+
legend_options_fields=[
|
|
983
|
+
{
|
|
984
|
+
"property": "collector",
|
|
985
|
+
"enabled": False,
|
|
986
|
+
},
|
|
987
|
+
{
|
|
988
|
+
"property": "hostname",
|
|
989
|
+
"enabled": False,
|
|
990
|
+
},
|
|
991
|
+
],
|
|
992
|
+
viz_options=[{
|
|
993
|
+
"label": "CPU Idle",
|
|
994
|
+
"axis": "left",
|
|
995
|
+
"color": "orange",
|
|
996
|
+
}],
|
|
997
|
+
axis_left={
|
|
998
|
+
"label": "CPU Total Idle",
|
|
999
|
+
"low_watermark": 1000,
|
|
1000
|
+
})
|
|
997
1001
|
```
|
|
998
1002
|
|
|
999
|
-
## Arguments
|
|
1000
|
-
|
|
1001
|
-
The following arguments are supported in the resource block:
|
|
1002
|
-
|
|
1003
|
-
* `name` - (Required) Name of the chart.
|
|
1004
|
-
* `program_text` - (Required) Signalflow program text for the chart. More info [in the Splunk Observability Cloud docs](https://dev.splunk.com/observability/docs/signalflow/).
|
|
1005
|
-
* `plot_type` - (Optional) The default plot display style for the visualization. Must be `"LineChart"`, `"AreaChart"`, `"ColumnChart"`, or `"Histogram"`. Default: `"LineChart"`.
|
|
1006
|
-
* `description` - (Optional) Description of the chart.
|
|
1007
|
-
* `axes_precision` - (Optional) Specifies the digits Splunk Observability Cloud displays for values plotted on the chart. Defaults to `3`.
|
|
1008
|
-
* `unit_prefix` - (Optional) Must be `"Metric"` or `"Binary`". `"Metric"` by default.
|
|
1009
|
-
* `color_by` - (Optional) Must be `"Dimension"` or `"Metric"`. `"Dimension"` by default.
|
|
1010
|
-
* `minimum_resolution` - (Optional) The minimum resolution (in seconds) to use for computing the underlying program.
|
|
1011
|
-
* `max_delay` - (Optional) How long (in seconds) to wait for late datapoints.
|
|
1012
|
-
* `timezone` - (Optional) A string denotes the geographic region associated with the time zone.
|
|
1013
|
-
* `disable_sampling` - (Optional) If `false`, samples a subset of the output MTS, which improves UI performance. `false` by default
|
|
1014
|
-
* `time_range` - (Optional) How many seconds ago from which to display data. For example, the last hour would be `3600`, etc. Conflicts with `start_time` and `end_time`.
|
|
1015
|
-
* `start_time` - (Optional) Seconds since epoch. Used for visualization. Conflicts with `time_range`.
|
|
1016
|
-
* `end_time` - (Optional) Seconds since epoch. Used for visualization. Conflicts with `time_range`.
|
|
1017
|
-
* `axes_include_zero` - (Optional) Force the chart to display zero on the y-axes, even if none of the data is near zero.
|
|
1018
|
-
* `axis_left` - (Optional) Set of axis options.
|
|
1019
|
-
* `label` - (Optional) Label of the left axis.
|
|
1020
|
-
* `min_value` - (Optional) The minimum value for the left axis.
|
|
1021
|
-
* `max_value` - (Optional) The maximum value for the left axis.
|
|
1022
|
-
* `high_watermark` - (Optional) A line to draw as a high watermark.
|
|
1023
|
-
* `high_watermark_label` - (Optional) A label to attach to the high watermark line.
|
|
1024
|
-
* `low_watermark` - (Optional) A line to draw as a low watermark.
|
|
1025
|
-
* `low_watermark_label` - (Optional) A label to attach to the low watermark line.
|
|
1026
|
-
* `axis_right` - (Optional) Set of axis options.
|
|
1027
|
-
* `label` - (Optional) Label of the right axis.
|
|
1028
|
-
* `min_value` - (Optional) The minimum value for the right axis.
|
|
1029
|
-
* `max_value` - (Optional) The maximum value for the right axis.
|
|
1030
|
-
* `high_watermark` - (Optional) A line to draw as a high watermark.
|
|
1031
|
-
* `high_watermark_label` - (Optional) A label to attach to the high watermark line.
|
|
1032
|
-
* `low_watermark` - (Optional) A line to draw as a low watermark.
|
|
1033
|
-
* `low_watermark_label` - (Optional) A label to attach to the low watermark line.
|
|
1034
|
-
* `viz_options` - (Optional) Plot-level customization options, associated with a publish statement.
|
|
1035
|
-
* `label` - (Required) Label used in the publish statement that displays the plot (metric time series data) you want to customize.
|
|
1036
|
-
* `display_name` - (Optional) Specifies an alternate value for the Plot Name column of the Data Table associated with the chart.
|
|
1037
|
-
* `color` - (Optional) Color to use : gray, blue, azure, navy, brown, orange, yellow, iris, magenta, pink, purple, violet, lilac, emerald, green, aquamarine.
|
|
1038
|
-
* `axis` - (Optional) Y-axis associated with values for this plot. Must be either `right` or `left`.
|
|
1039
|
-
* `plot_type` - (Optional) The visualization style to use. Must be `"LineChart"`, `"AreaChart"`, `"ColumnChart"`, or `"Histogram"`. Chart level `plot_type` by default.
|
|
1040
|
-
* `value_unit` - (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`.
|
|
1041
|
-
* `value_prefix`, `value_suffix` - (Optional) Arbitrary prefix/suffix to display with the value of this plot.
|
|
1042
|
-
* `event_options` - (Optional) Event customization options, associated with a publish statement. You will need to use this to change settings for any `events(…)` statements you use.
|
|
1043
|
-
* `label` - (Required) Label used in the publish statement that displays the event query you want to customize.
|
|
1044
|
-
* `display_name` - (Optional) Specifies an alternate value for the Plot Name column of the Data Table associated with the chart.
|
|
1045
|
-
* `color` - (Optional) Color to use : gray, blue, azure, navy, brown, orange, yellow, iris, magenta, pink, purple, violet, lilac, emerald, green, aquamarine.
|
|
1046
|
-
* `histogram_options` - (Optional) Only used when `plot_type` is `"Histogram"`. Histogram specific options.
|
|
1047
|
-
* `color_theme` - (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
|
|
1048
|
-
* `legend_fields_to_hide` - (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 `legend_options_fields`.
|
|
1049
|
-
* `legend_options_fields` - (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 `legend_fields_to_hide`.
|
|
1050
|
-
* `property` The name of the property to display. Note the special values of `plot_label` (corresponding with the API's `sf_metric`) 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.
|
|
1051
|
-
* `enabled` True or False depending on if you want the property to be shown or hidden.
|
|
1052
|
-
* `on_chart_legend_dimension` - (Optional) Dimensions to show in the on-chart legend. On-chart legend is off unless a dimension is specified. Allowed: `"metric"`, `"plot_label"` and any dimension.
|
|
1053
|
-
* `show_event_lines` - (Optional) Whether vertical highlight lines should be drawn in the visualizations at times when events occurred. `false` by default.
|
|
1054
|
-
* `show_data_markers` - (Optional) Show markers (circles) for each datapoint used to draw line or area charts. `false` by default.
|
|
1055
|
-
* `stacked` - (Optional) Whether area and bar charts in the visualization should be stacked. `false` by default.
|
|
1056
|
-
* `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.
|
|
1057
|
-
|
|
1058
|
-
## Attributes
|
|
1059
|
-
|
|
1060
|
-
In a addition to all arguments above, the following attributes are exported:
|
|
1061
|
-
|
|
1062
|
-
* `id` - The ID of the chart.
|
|
1063
|
-
* `url` - The URL of the chart.
|
|
1064
|
-
|
|
1065
1003
|
:param str resource_name: The name of the resource.
|
|
1066
1004
|
:param pulumi.ResourceOptions opts: Options for the resource.
|
|
1067
|
-
:param pulumi.Input[bool] axes_include_zero: Force y-axes
|
|
1068
|
-
:param pulumi.Input[int] axes_precision:
|
|
1069
|
-
:param pulumi.Input[
|
|
1070
|
-
:param pulumi.Input[
|
|
1071
|
-
:param pulumi.Input[
|
|
1072
|
-
:param pulumi.Input[
|
|
1073
|
-
:param pulumi.Input[
|
|
1074
|
-
:param pulumi.Input[
|
|
1075
|
-
:param pulumi.Input[Sequence[pulumi.Input[
|
|
1076
|
-
:param pulumi.Input[Sequence[pulumi.Input[
|
|
1077
|
-
:param pulumi.Input[
|
|
1078
|
-
:param pulumi.Input[
|
|
1079
|
-
:param pulumi.Input[
|
|
1080
|
-
:param pulumi.Input[
|
|
1081
|
-
|
|
1082
|
-
:param pulumi.Input[str]
|
|
1083
|
-
|
|
1084
|
-
:param pulumi.Input[str] program_text: Signalflow program text for the chart. More info
|
|
1085
|
-
:param pulumi.Input[bool] show_data_markers:
|
|
1086
|
-
:param pulumi.Input[bool] show_event_lines:
|
|
1087
|
-
:param pulumi.Input[bool] stacked:
|
|
1088
|
-
:param pulumi.Input[int] start_time: Seconds since epoch
|
|
1005
|
+
:param pulumi.Input[bool] axes_include_zero: Force the chart to display zero on the y-axes, even if none of the data is near zero.
|
|
1006
|
+
:param pulumi.Input[int] axes_precision: Specifies the digits Splunk Observability Cloud displays for values plotted on the chart. Defaults to `3`.
|
|
1007
|
+
:param pulumi.Input[Union['TimeChartAxisLeftArgs', 'TimeChartAxisLeftArgsDict']] axis_left: Set of axis options.
|
|
1008
|
+
:param pulumi.Input[Union['TimeChartAxisRightArgs', 'TimeChartAxisRightArgsDict']] axis_right: Set of axis options.
|
|
1009
|
+
:param pulumi.Input[str] color_by: Must be `"Dimension"` or `"Metric"`. `"Dimension"` by default.
|
|
1010
|
+
:param pulumi.Input[str] description: Description of the chart.
|
|
1011
|
+
:param pulumi.Input[bool] disable_sampling: If `false`, samples a subset of the output MTS, which improves UI performance. `false` by default
|
|
1012
|
+
:param pulumi.Input[int] end_time: Seconds since epoch. Used for visualization. Conflicts with `time_range`.
|
|
1013
|
+
:param pulumi.Input[Sequence[pulumi.Input[Union['TimeChartEventOptionArgs', 'TimeChartEventOptionArgsDict']]]] event_options: Event customization options, associated with a publish statement. You will need to use this to change settings for any `events(…)` statements you use.
|
|
1014
|
+
:param pulumi.Input[Sequence[pulumi.Input[Union['TimeChartHistogramOptionArgs', 'TimeChartHistogramOptionArgsDict']]]] histogram_options: Only used when `plot_type` is `"Histogram"`. Histogram specific options.
|
|
1015
|
+
:param pulumi.Input[Sequence[pulumi.Input[str]]] legend_fields_to_hides: 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 `legend_options_fields`.
|
|
1016
|
+
:param pulumi.Input[Sequence[pulumi.Input[Union['TimeChartLegendOptionsFieldArgs', 'TimeChartLegendOptionsFieldArgsDict']]]] legend_options_fields: 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 `legend_fields_to_hide`.
|
|
1017
|
+
:param pulumi.Input[int] max_delay: How long (in seconds) to wait for late datapoints.
|
|
1018
|
+
:param pulumi.Input[int] minimum_resolution: The minimum resolution (in seconds) to use for computing the underlying program.
|
|
1019
|
+
:param pulumi.Input[str] name: Name of the chart.
|
|
1020
|
+
:param pulumi.Input[str] on_chart_legend_dimension: Dimensions to show in the on-chart legend. On-chart legend is off unless a dimension is specified. Allowed: `"metric"`, `"plot_label"` and any dimension.
|
|
1021
|
+
:param pulumi.Input[str] plot_type: The default plot display style for the visualization. Must be `"LineChart"`, `"AreaChart"`, `"ColumnChart"`, or `"Histogram"`. Default: `"LineChart"`.
|
|
1022
|
+
:param pulumi.Input[str] program_text: Signalflow program text for the chart. More info [in the Splunk Observability Cloud docs](https://dev.splunk.com/observability/docs/signalflow/).
|
|
1023
|
+
:param pulumi.Input[bool] show_data_markers: Show markers (circles) for each datapoint used to draw line or area charts. `false` by default.
|
|
1024
|
+
:param pulumi.Input[bool] show_event_lines: Whether vertical highlight lines should be drawn in the visualizations at times when events occurred. `false` by default.
|
|
1025
|
+
:param pulumi.Input[bool] stacked: Whether area and bar charts in the visualization should be stacked. `false` by default.
|
|
1026
|
+
:param pulumi.Input[int] start_time: Seconds since epoch. Used for visualization. Conflicts with `time_range`.
|
|
1089
1027
|
:param pulumi.Input[Sequence[pulumi.Input[str]]] tags: Tags associated with the chart
|
|
1090
|
-
:param pulumi.Input[int] time_range:
|
|
1091
|
-
:param pulumi.Input[str] timezone:
|
|
1092
|
-
:param pulumi.Input[str] unit_prefix:
|
|
1093
|
-
:param pulumi.Input[Sequence[pulumi.Input[
|
|
1028
|
+
:param pulumi.Input[int] time_range: How many seconds ago from which to display data. For example, the last hour would be `3600`, etc. Conflicts with `start_time` and `end_time`.
|
|
1029
|
+
:param pulumi.Input[str] timezone: 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.
|
|
1030
|
+
:param pulumi.Input[str] unit_prefix: Must be `"Metric"` or `"Binary`". `"Metric"` by default.
|
|
1031
|
+
:param pulumi.Input[Sequence[pulumi.Input[Union['TimeChartVizOptionArgs', 'TimeChartVizOptionArgsDict']]]] viz_options: Plot-level customization options, associated with a publish statement.
|
|
1094
1032
|
"""
|
|
1095
1033
|
...
|
|
1096
1034
|
@overload
|
|
@@ -1110,99 +1048,32 @@ class TimeChart(pulumi.CustomResource):
|
|
|
1110
1048
|
import pulumi_signalfx as signalfx
|
|
1111
1049
|
|
|
1112
1050
|
mychart0 = signalfx.TimeChart("mychart0",
|
|
1113
|
-
|
|
1114
|
-
|
|
1115
|
-
|
|
1116
|
-
),
|
|
1117
|
-
legend_options_fields=[
|
|
1118
|
-
signalfx.TimeChartLegendOptionsFieldArgs(
|
|
1119
|
-
enabled=False,
|
|
1120
|
-
property="collector",
|
|
1121
|
-
),
|
|
1122
|
-
signalfx.TimeChartLegendOptionsFieldArgs(
|
|
1123
|
-
enabled=False,
|
|
1124
|
-
property="hostname",
|
|
1125
|
-
),
|
|
1126
|
-
],
|
|
1051
|
+
name="CPU Total Idle",
|
|
1052
|
+
program_text="data(\\"cpu.total.idle\\").publish(label=\\"CPU Idle\\")\\n",
|
|
1053
|
+
time_range=3600,
|
|
1127
1054
|
plot_type="LineChart",
|
|
1128
|
-
program_text=\"\"\"data("cpu.total.idle").publish(label="CPU Idle")
|
|
1129
|
-
|
|
1130
|
-
\"\"\",
|
|
1131
1055
|
show_data_markers=True,
|
|
1132
|
-
|
|
1133
|
-
|
|
1134
|
-
|
|
1135
|
-
|
|
1136
|
-
|
|
1137
|
-
|
|
1056
|
+
legend_options_fields=[
|
|
1057
|
+
{
|
|
1058
|
+
"property": "collector",
|
|
1059
|
+
"enabled": False,
|
|
1060
|
+
},
|
|
1061
|
+
{
|
|
1062
|
+
"property": "hostname",
|
|
1063
|
+
"enabled": False,
|
|
1064
|
+
},
|
|
1065
|
+
],
|
|
1066
|
+
viz_options=[{
|
|
1067
|
+
"label": "CPU Idle",
|
|
1068
|
+
"axis": "left",
|
|
1069
|
+
"color": "orange",
|
|
1070
|
+
}],
|
|
1071
|
+
axis_left={
|
|
1072
|
+
"label": "CPU Total Idle",
|
|
1073
|
+
"low_watermark": 1000,
|
|
1074
|
+
})
|
|
1138
1075
|
```
|
|
1139
1076
|
|
|
1140
|
-
## Arguments
|
|
1141
|
-
|
|
1142
|
-
The following arguments are supported in the resource block:
|
|
1143
|
-
|
|
1144
|
-
* `name` - (Required) Name of the chart.
|
|
1145
|
-
* `program_text` - (Required) Signalflow program text for the chart. More info [in the Splunk Observability Cloud docs](https://dev.splunk.com/observability/docs/signalflow/).
|
|
1146
|
-
* `plot_type` - (Optional) The default plot display style for the visualization. Must be `"LineChart"`, `"AreaChart"`, `"ColumnChart"`, or `"Histogram"`. Default: `"LineChart"`.
|
|
1147
|
-
* `description` - (Optional) Description of the chart.
|
|
1148
|
-
* `axes_precision` - (Optional) Specifies the digits Splunk Observability Cloud displays for values plotted on the chart. Defaults to `3`.
|
|
1149
|
-
* `unit_prefix` - (Optional) Must be `"Metric"` or `"Binary`". `"Metric"` by default.
|
|
1150
|
-
* `color_by` - (Optional) Must be `"Dimension"` or `"Metric"`. `"Dimension"` by default.
|
|
1151
|
-
* `minimum_resolution` - (Optional) The minimum resolution (in seconds) to use for computing the underlying program.
|
|
1152
|
-
* `max_delay` - (Optional) How long (in seconds) to wait for late datapoints.
|
|
1153
|
-
* `timezone` - (Optional) A string denotes the geographic region associated with the time zone.
|
|
1154
|
-
* `disable_sampling` - (Optional) If `false`, samples a subset of the output MTS, which improves UI performance. `false` by default
|
|
1155
|
-
* `time_range` - (Optional) How many seconds ago from which to display data. For example, the last hour would be `3600`, etc. Conflicts with `start_time` and `end_time`.
|
|
1156
|
-
* `start_time` - (Optional) Seconds since epoch. Used for visualization. Conflicts with `time_range`.
|
|
1157
|
-
* `end_time` - (Optional) Seconds since epoch. Used for visualization. Conflicts with `time_range`.
|
|
1158
|
-
* `axes_include_zero` - (Optional) Force the chart to display zero on the y-axes, even if none of the data is near zero.
|
|
1159
|
-
* `axis_left` - (Optional) Set of axis options.
|
|
1160
|
-
* `label` - (Optional) Label of the left axis.
|
|
1161
|
-
* `min_value` - (Optional) The minimum value for the left axis.
|
|
1162
|
-
* `max_value` - (Optional) The maximum value for the left axis.
|
|
1163
|
-
* `high_watermark` - (Optional) A line to draw as a high watermark.
|
|
1164
|
-
* `high_watermark_label` - (Optional) A label to attach to the high watermark line.
|
|
1165
|
-
* `low_watermark` - (Optional) A line to draw as a low watermark.
|
|
1166
|
-
* `low_watermark_label` - (Optional) A label to attach to the low watermark line.
|
|
1167
|
-
* `axis_right` - (Optional) Set of axis options.
|
|
1168
|
-
* `label` - (Optional) Label of the right axis.
|
|
1169
|
-
* `min_value` - (Optional) The minimum value for the right axis.
|
|
1170
|
-
* `max_value` - (Optional) The maximum value for the right axis.
|
|
1171
|
-
* `high_watermark` - (Optional) A line to draw as a high watermark.
|
|
1172
|
-
* `high_watermark_label` - (Optional) A label to attach to the high watermark line.
|
|
1173
|
-
* `low_watermark` - (Optional) A line to draw as a low watermark.
|
|
1174
|
-
* `low_watermark_label` - (Optional) A label to attach to the low watermark line.
|
|
1175
|
-
* `viz_options` - (Optional) Plot-level customization options, associated with a publish statement.
|
|
1176
|
-
* `label` - (Required) Label used in the publish statement that displays the plot (metric time series data) you want to customize.
|
|
1177
|
-
* `display_name` - (Optional) Specifies an alternate value for the Plot Name column of the Data Table associated with the chart.
|
|
1178
|
-
* `color` - (Optional) Color to use : gray, blue, azure, navy, brown, orange, yellow, iris, magenta, pink, purple, violet, lilac, emerald, green, aquamarine.
|
|
1179
|
-
* `axis` - (Optional) Y-axis associated with values for this plot. Must be either `right` or `left`.
|
|
1180
|
-
* `plot_type` - (Optional) The visualization style to use. Must be `"LineChart"`, `"AreaChart"`, `"ColumnChart"`, or `"Histogram"`. Chart level `plot_type` by default.
|
|
1181
|
-
* `value_unit` - (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`.
|
|
1182
|
-
* `value_prefix`, `value_suffix` - (Optional) Arbitrary prefix/suffix to display with the value of this plot.
|
|
1183
|
-
* `event_options` - (Optional) Event customization options, associated with a publish statement. You will need to use this to change settings for any `events(…)` statements you use.
|
|
1184
|
-
* `label` - (Required) Label used in the publish statement that displays the event query you want to customize.
|
|
1185
|
-
* `display_name` - (Optional) Specifies an alternate value for the Plot Name column of the Data Table associated with the chart.
|
|
1186
|
-
* `color` - (Optional) Color to use : gray, blue, azure, navy, brown, orange, yellow, iris, magenta, pink, purple, violet, lilac, emerald, green, aquamarine.
|
|
1187
|
-
* `histogram_options` - (Optional) Only used when `plot_type` is `"Histogram"`. Histogram specific options.
|
|
1188
|
-
* `color_theme` - (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
|
|
1189
|
-
* `legend_fields_to_hide` - (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 `legend_options_fields`.
|
|
1190
|
-
* `legend_options_fields` - (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 `legend_fields_to_hide`.
|
|
1191
|
-
* `property` The name of the property to display. Note the special values of `plot_label` (corresponding with the API's `sf_metric`) 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.
|
|
1192
|
-
* `enabled` True or False depending on if you want the property to be shown or hidden.
|
|
1193
|
-
* `on_chart_legend_dimension` - (Optional) Dimensions to show in the on-chart legend. On-chart legend is off unless a dimension is specified. Allowed: `"metric"`, `"plot_label"` and any dimension.
|
|
1194
|
-
* `show_event_lines` - (Optional) Whether vertical highlight lines should be drawn in the visualizations at times when events occurred. `false` by default.
|
|
1195
|
-
* `show_data_markers` - (Optional) Show markers (circles) for each datapoint used to draw line or area charts. `false` by default.
|
|
1196
|
-
* `stacked` - (Optional) Whether area and bar charts in the visualization should be stacked. `false` by default.
|
|
1197
|
-
* `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.
|
|
1198
|
-
|
|
1199
|
-
## Attributes
|
|
1200
|
-
|
|
1201
|
-
In a addition to all arguments above, the following attributes are exported:
|
|
1202
|
-
|
|
1203
|
-
* `id` - The ID of the chart.
|
|
1204
|
-
* `url` - The URL of the chart.
|
|
1205
|
-
|
|
1206
1077
|
:param str resource_name: The name of the resource.
|
|
1207
1078
|
:param TimeChartArgs args: The arguments to use to populate this resource's properties.
|
|
1208
1079
|
:param pulumi.ResourceOptions opts: Options for the resource.
|
|
@@ -1220,16 +1091,16 @@ class TimeChart(pulumi.CustomResource):
|
|
|
1220
1091
|
opts: Optional[pulumi.ResourceOptions] = None,
|
|
1221
1092
|
axes_include_zero: Optional[pulumi.Input[bool]] = None,
|
|
1222
1093
|
axes_precision: Optional[pulumi.Input[int]] = None,
|
|
1223
|
-
axis_left: Optional[pulumi.Input[
|
|
1224
|
-
axis_right: Optional[pulumi.Input[
|
|
1094
|
+
axis_left: Optional[pulumi.Input[Union['TimeChartAxisLeftArgs', 'TimeChartAxisLeftArgsDict']]] = None,
|
|
1095
|
+
axis_right: Optional[pulumi.Input[Union['TimeChartAxisRightArgs', 'TimeChartAxisRightArgsDict']]] = None,
|
|
1225
1096
|
color_by: Optional[pulumi.Input[str]] = None,
|
|
1226
1097
|
description: Optional[pulumi.Input[str]] = None,
|
|
1227
1098
|
disable_sampling: Optional[pulumi.Input[bool]] = None,
|
|
1228
1099
|
end_time: Optional[pulumi.Input[int]] = None,
|
|
1229
|
-
event_options: Optional[pulumi.Input[Sequence[pulumi.Input[
|
|
1230
|
-
histogram_options: Optional[pulumi.Input[Sequence[pulumi.Input[
|
|
1100
|
+
event_options: Optional[pulumi.Input[Sequence[pulumi.Input[Union['TimeChartEventOptionArgs', 'TimeChartEventOptionArgsDict']]]]] = None,
|
|
1101
|
+
histogram_options: Optional[pulumi.Input[Sequence[pulumi.Input[Union['TimeChartHistogramOptionArgs', 'TimeChartHistogramOptionArgsDict']]]]] = None,
|
|
1231
1102
|
legend_fields_to_hides: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
|
|
1232
|
-
legend_options_fields: Optional[pulumi.Input[Sequence[pulumi.Input[
|
|
1103
|
+
legend_options_fields: Optional[pulumi.Input[Sequence[pulumi.Input[Union['TimeChartLegendOptionsFieldArgs', 'TimeChartLegendOptionsFieldArgsDict']]]]] = None,
|
|
1233
1104
|
max_delay: Optional[pulumi.Input[int]] = None,
|
|
1234
1105
|
minimum_resolution: Optional[pulumi.Input[int]] = None,
|
|
1235
1106
|
name: Optional[pulumi.Input[str]] = None,
|
|
@@ -1244,7 +1115,7 @@ class TimeChart(pulumi.CustomResource):
|
|
|
1244
1115
|
time_range: Optional[pulumi.Input[int]] = None,
|
|
1245
1116
|
timezone: Optional[pulumi.Input[str]] = None,
|
|
1246
1117
|
unit_prefix: Optional[pulumi.Input[str]] = None,
|
|
1247
|
-
viz_options: Optional[pulumi.Input[Sequence[pulumi.Input[
|
|
1118
|
+
viz_options: Optional[pulumi.Input[Sequence[pulumi.Input[Union['TimeChartVizOptionArgs', 'TimeChartVizOptionArgsDict']]]]] = None,
|
|
1248
1119
|
__props__=None):
|
|
1249
1120
|
opts = pulumi.ResourceOptions.merge(_utilities.get_resource_opts_defaults(), opts)
|
|
1250
1121
|
if not isinstance(opts, pulumi.ResourceOptions):
|
|
@@ -1296,16 +1167,16 @@ class TimeChart(pulumi.CustomResource):
|
|
|
1296
1167
|
opts: Optional[pulumi.ResourceOptions] = None,
|
|
1297
1168
|
axes_include_zero: Optional[pulumi.Input[bool]] = None,
|
|
1298
1169
|
axes_precision: Optional[pulumi.Input[int]] = None,
|
|
1299
|
-
axis_left: Optional[pulumi.Input[
|
|
1300
|
-
axis_right: Optional[pulumi.Input[
|
|
1170
|
+
axis_left: Optional[pulumi.Input[Union['TimeChartAxisLeftArgs', 'TimeChartAxisLeftArgsDict']]] = None,
|
|
1171
|
+
axis_right: Optional[pulumi.Input[Union['TimeChartAxisRightArgs', 'TimeChartAxisRightArgsDict']]] = None,
|
|
1301
1172
|
color_by: Optional[pulumi.Input[str]] = None,
|
|
1302
1173
|
description: Optional[pulumi.Input[str]] = None,
|
|
1303
1174
|
disable_sampling: Optional[pulumi.Input[bool]] = None,
|
|
1304
1175
|
end_time: Optional[pulumi.Input[int]] = None,
|
|
1305
|
-
event_options: Optional[pulumi.Input[Sequence[pulumi.Input[
|
|
1306
|
-
histogram_options: Optional[pulumi.Input[Sequence[pulumi.Input[
|
|
1176
|
+
event_options: Optional[pulumi.Input[Sequence[pulumi.Input[Union['TimeChartEventOptionArgs', 'TimeChartEventOptionArgsDict']]]]] = None,
|
|
1177
|
+
histogram_options: Optional[pulumi.Input[Sequence[pulumi.Input[Union['TimeChartHistogramOptionArgs', 'TimeChartHistogramOptionArgsDict']]]]] = None,
|
|
1307
1178
|
legend_fields_to_hides: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
|
|
1308
|
-
legend_options_fields: Optional[pulumi.Input[Sequence[pulumi.Input[
|
|
1179
|
+
legend_options_fields: Optional[pulumi.Input[Sequence[pulumi.Input[Union['TimeChartLegendOptionsFieldArgs', 'TimeChartLegendOptionsFieldArgsDict']]]]] = None,
|
|
1309
1180
|
max_delay: Optional[pulumi.Input[int]] = None,
|
|
1310
1181
|
minimum_resolution: Optional[pulumi.Input[int]] = None,
|
|
1311
1182
|
name: Optional[pulumi.Input[str]] = None,
|
|
@@ -1321,7 +1192,7 @@ class TimeChart(pulumi.CustomResource):
|
|
|
1321
1192
|
timezone: Optional[pulumi.Input[str]] = None,
|
|
1322
1193
|
unit_prefix: Optional[pulumi.Input[str]] = None,
|
|
1323
1194
|
url: Optional[pulumi.Input[str]] = None,
|
|
1324
|
-
viz_options: Optional[pulumi.Input[Sequence[pulumi.Input[
|
|
1195
|
+
viz_options: Optional[pulumi.Input[Sequence[pulumi.Input[Union['TimeChartVizOptionArgs', 'TimeChartVizOptionArgsDict']]]]] = None) -> 'TimeChart':
|
|
1325
1196
|
"""
|
|
1326
1197
|
Get an existing TimeChart resource's state with the given name, id, and optional extra
|
|
1327
1198
|
properties used to qualify the lookup.
|
|
@@ -1329,34 +1200,34 @@ class TimeChart(pulumi.CustomResource):
|
|
|
1329
1200
|
:param str resource_name: The unique name of the resulting resource.
|
|
1330
1201
|
:param pulumi.Input[str] id: The unique provider ID of the resource to lookup.
|
|
1331
1202
|
:param pulumi.ResourceOptions opts: Options for the resource.
|
|
1332
|
-
:param pulumi.Input[bool] axes_include_zero: Force y-axes
|
|
1333
|
-
:param pulumi.Input[int] axes_precision:
|
|
1334
|
-
:param pulumi.Input[
|
|
1335
|
-
:param pulumi.Input[
|
|
1336
|
-
:param pulumi.Input[
|
|
1337
|
-
:param pulumi.Input[
|
|
1338
|
-
:param pulumi.Input[
|
|
1339
|
-
:param pulumi.Input[
|
|
1340
|
-
:param pulumi.Input[Sequence[pulumi.Input[
|
|
1341
|
-
:param pulumi.Input[Sequence[pulumi.Input[
|
|
1342
|
-
:param pulumi.Input[
|
|
1343
|
-
:param pulumi.Input[
|
|
1344
|
-
:param pulumi.Input[
|
|
1345
|
-
:param pulumi.Input[
|
|
1346
|
-
|
|
1347
|
-
:param pulumi.Input[str]
|
|
1348
|
-
|
|
1349
|
-
:param pulumi.Input[str] program_text: Signalflow program text for the chart. More info
|
|
1350
|
-
:param pulumi.Input[bool] show_data_markers:
|
|
1351
|
-
:param pulumi.Input[bool] show_event_lines:
|
|
1352
|
-
:param pulumi.Input[bool] stacked:
|
|
1353
|
-
:param pulumi.Input[int] start_time: Seconds since epoch
|
|
1203
|
+
:param pulumi.Input[bool] axes_include_zero: Force the chart to display zero on the y-axes, even if none of the data is near zero.
|
|
1204
|
+
:param pulumi.Input[int] axes_precision: Specifies the digits Splunk Observability Cloud displays for values plotted on the chart. Defaults to `3`.
|
|
1205
|
+
:param pulumi.Input[Union['TimeChartAxisLeftArgs', 'TimeChartAxisLeftArgsDict']] axis_left: Set of axis options.
|
|
1206
|
+
:param pulumi.Input[Union['TimeChartAxisRightArgs', 'TimeChartAxisRightArgsDict']] axis_right: Set of axis options.
|
|
1207
|
+
:param pulumi.Input[str] color_by: Must be `"Dimension"` or `"Metric"`. `"Dimension"` by default.
|
|
1208
|
+
:param pulumi.Input[str] description: Description of the chart.
|
|
1209
|
+
:param pulumi.Input[bool] disable_sampling: If `false`, samples a subset of the output MTS, which improves UI performance. `false` by default
|
|
1210
|
+
:param pulumi.Input[int] end_time: Seconds since epoch. Used for visualization. Conflicts with `time_range`.
|
|
1211
|
+
:param pulumi.Input[Sequence[pulumi.Input[Union['TimeChartEventOptionArgs', 'TimeChartEventOptionArgsDict']]]] event_options: Event customization options, associated with a publish statement. You will need to use this to change settings for any `events(…)` statements you use.
|
|
1212
|
+
:param pulumi.Input[Sequence[pulumi.Input[Union['TimeChartHistogramOptionArgs', 'TimeChartHistogramOptionArgsDict']]]] histogram_options: Only used when `plot_type` is `"Histogram"`. Histogram specific options.
|
|
1213
|
+
:param pulumi.Input[Sequence[pulumi.Input[str]]] legend_fields_to_hides: 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 `legend_options_fields`.
|
|
1214
|
+
:param pulumi.Input[Sequence[pulumi.Input[Union['TimeChartLegendOptionsFieldArgs', 'TimeChartLegendOptionsFieldArgsDict']]]] legend_options_fields: 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 `legend_fields_to_hide`.
|
|
1215
|
+
:param pulumi.Input[int] max_delay: How long (in seconds) to wait for late datapoints.
|
|
1216
|
+
:param pulumi.Input[int] minimum_resolution: The minimum resolution (in seconds) to use for computing the underlying program.
|
|
1217
|
+
:param pulumi.Input[str] name: Name of the chart.
|
|
1218
|
+
:param pulumi.Input[str] on_chart_legend_dimension: Dimensions to show in the on-chart legend. On-chart legend is off unless a dimension is specified. Allowed: `"metric"`, `"plot_label"` and any dimension.
|
|
1219
|
+
:param pulumi.Input[str] plot_type: The default plot display style for the visualization. Must be `"LineChart"`, `"AreaChart"`, `"ColumnChart"`, or `"Histogram"`. Default: `"LineChart"`.
|
|
1220
|
+
:param pulumi.Input[str] program_text: Signalflow program text for the chart. More info [in the Splunk Observability Cloud docs](https://dev.splunk.com/observability/docs/signalflow/).
|
|
1221
|
+
:param pulumi.Input[bool] show_data_markers: Show markers (circles) for each datapoint used to draw line or area charts. `false` by default.
|
|
1222
|
+
:param pulumi.Input[bool] show_event_lines: Whether vertical highlight lines should be drawn in the visualizations at times when events occurred. `false` by default.
|
|
1223
|
+
:param pulumi.Input[bool] stacked: Whether area and bar charts in the visualization should be stacked. `false` by default.
|
|
1224
|
+
:param pulumi.Input[int] start_time: Seconds since epoch. Used for visualization. Conflicts with `time_range`.
|
|
1354
1225
|
:param pulumi.Input[Sequence[pulumi.Input[str]]] tags: Tags associated with the chart
|
|
1355
|
-
:param pulumi.Input[int] time_range:
|
|
1356
|
-
:param pulumi.Input[str] timezone:
|
|
1357
|
-
:param pulumi.Input[str] unit_prefix:
|
|
1358
|
-
:param pulumi.Input[str] url: URL of the chart
|
|
1359
|
-
:param pulumi.Input[Sequence[pulumi.Input[
|
|
1226
|
+
:param pulumi.Input[int] time_range: How many seconds ago from which to display data. For example, the last hour would be `3600`, etc. Conflicts with `start_time` and `end_time`.
|
|
1227
|
+
:param pulumi.Input[str] timezone: 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.
|
|
1228
|
+
:param pulumi.Input[str] unit_prefix: Must be `"Metric"` or `"Binary`". `"Metric"` by default.
|
|
1229
|
+
:param pulumi.Input[str] url: The URL of the chart.
|
|
1230
|
+
:param pulumi.Input[Sequence[pulumi.Input[Union['TimeChartVizOptionArgs', 'TimeChartVizOptionArgsDict']]]] viz_options: Plot-level customization options, associated with a publish statement.
|
|
1360
1231
|
"""
|
|
1361
1232
|
opts = pulumi.ResourceOptions.merge(opts, pulumi.ResourceOptions(id=id))
|
|
1362
1233
|
|
|
@@ -1396,7 +1267,7 @@ class TimeChart(pulumi.CustomResource):
|
|
|
1396
1267
|
@pulumi.getter(name="axesIncludeZero")
|
|
1397
1268
|
def axes_include_zero(self) -> pulumi.Output[Optional[bool]]:
|
|
1398
1269
|
"""
|
|
1399
|
-
Force y-axes
|
|
1270
|
+
Force the chart to display zero on the y-axes, even if none of the data is near zero.
|
|
1400
1271
|
"""
|
|
1401
1272
|
return pulumi.get(self, "axes_include_zero")
|
|
1402
1273
|
|
|
@@ -1404,25 +1275,31 @@ class TimeChart(pulumi.CustomResource):
|
|
|
1404
1275
|
@pulumi.getter(name="axesPrecision")
|
|
1405
1276
|
def axes_precision(self) -> pulumi.Output[Optional[int]]:
|
|
1406
1277
|
"""
|
|
1407
|
-
|
|
1278
|
+
Specifies the digits Splunk Observability Cloud displays for values plotted on the chart. Defaults to `3`.
|
|
1408
1279
|
"""
|
|
1409
1280
|
return pulumi.get(self, "axes_precision")
|
|
1410
1281
|
|
|
1411
1282
|
@property
|
|
1412
1283
|
@pulumi.getter(name="axisLeft")
|
|
1413
1284
|
def axis_left(self) -> pulumi.Output[Optional['outputs.TimeChartAxisLeft']]:
|
|
1285
|
+
"""
|
|
1286
|
+
Set of axis options.
|
|
1287
|
+
"""
|
|
1414
1288
|
return pulumi.get(self, "axis_left")
|
|
1415
1289
|
|
|
1416
1290
|
@property
|
|
1417
1291
|
@pulumi.getter(name="axisRight")
|
|
1418
1292
|
def axis_right(self) -> pulumi.Output[Optional['outputs.TimeChartAxisRight']]:
|
|
1293
|
+
"""
|
|
1294
|
+
Set of axis options.
|
|
1295
|
+
"""
|
|
1419
1296
|
return pulumi.get(self, "axis_right")
|
|
1420
1297
|
|
|
1421
1298
|
@property
|
|
1422
1299
|
@pulumi.getter(name="colorBy")
|
|
1423
1300
|
def color_by(self) -> pulumi.Output[Optional[str]]:
|
|
1424
1301
|
"""
|
|
1425
|
-
|
|
1302
|
+
Must be `"Dimension"` or `"Metric"`. `"Dimension"` by default.
|
|
1426
1303
|
"""
|
|
1427
1304
|
return pulumi.get(self, "color_by")
|
|
1428
1305
|
|
|
@@ -1430,7 +1307,7 @@ class TimeChart(pulumi.CustomResource):
|
|
|
1430
1307
|
@pulumi.getter
|
|
1431
1308
|
def description(self) -> pulumi.Output[Optional[str]]:
|
|
1432
1309
|
"""
|
|
1433
|
-
Description of the chart
|
|
1310
|
+
Description of the chart.
|
|
1434
1311
|
"""
|
|
1435
1312
|
return pulumi.get(self, "description")
|
|
1436
1313
|
|
|
@@ -1438,7 +1315,7 @@ class TimeChart(pulumi.CustomResource):
|
|
|
1438
1315
|
@pulumi.getter(name="disableSampling")
|
|
1439
1316
|
def disable_sampling(self) -> pulumi.Output[Optional[bool]]:
|
|
1440
1317
|
"""
|
|
1441
|
-
|
|
1318
|
+
If `false`, samples a subset of the output MTS, which improves UI performance. `false` by default
|
|
1442
1319
|
"""
|
|
1443
1320
|
return pulumi.get(self, "disable_sampling")
|
|
1444
1321
|
|
|
@@ -1446,7 +1323,7 @@ class TimeChart(pulumi.CustomResource):
|
|
|
1446
1323
|
@pulumi.getter(name="endTime")
|
|
1447
1324
|
def end_time(self) -> pulumi.Output[Optional[int]]:
|
|
1448
1325
|
"""
|
|
1449
|
-
Seconds since epoch
|
|
1326
|
+
Seconds since epoch. Used for visualization. Conflicts with `time_range`.
|
|
1450
1327
|
"""
|
|
1451
1328
|
return pulumi.get(self, "end_time")
|
|
1452
1329
|
|
|
@@ -1454,7 +1331,7 @@ class TimeChart(pulumi.CustomResource):
|
|
|
1454
1331
|
@pulumi.getter(name="eventOptions")
|
|
1455
1332
|
def event_options(self) -> pulumi.Output[Optional[Sequence['outputs.TimeChartEventOption']]]:
|
|
1456
1333
|
"""
|
|
1457
|
-
Event
|
|
1334
|
+
Event customization options, associated with a publish statement. You will need to use this to change settings for any `events(…)` statements you use.
|
|
1458
1335
|
"""
|
|
1459
1336
|
return pulumi.get(self, "event_options")
|
|
1460
1337
|
|
|
@@ -1462,26 +1339,24 @@ class TimeChart(pulumi.CustomResource):
|
|
|
1462
1339
|
@pulumi.getter(name="histogramOptions")
|
|
1463
1340
|
def histogram_options(self) -> pulumi.Output[Optional[Sequence['outputs.TimeChartHistogramOption']]]:
|
|
1464
1341
|
"""
|
|
1465
|
-
|
|
1342
|
+
Only used when `plot_type` is `"Histogram"`. Histogram specific options.
|
|
1466
1343
|
"""
|
|
1467
1344
|
return pulumi.get(self, "histogram_options")
|
|
1468
1345
|
|
|
1469
1346
|
@property
|
|
1470
1347
|
@pulumi.getter(name="legendFieldsToHides")
|
|
1348
|
+
@_utilities.deprecated("""Please use legend_options_fields""")
|
|
1471
1349
|
def legend_fields_to_hides(self) -> pulumi.Output[Optional[Sequence[str]]]:
|
|
1472
1350
|
"""
|
|
1473
|
-
List of properties that
|
|
1351
|
+
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 `legend_options_fields`.
|
|
1474
1352
|
"""
|
|
1475
|
-
warnings.warn("""Please use legend_options_fields""", DeprecationWarning)
|
|
1476
|
-
pulumi.log.warn("""legend_fields_to_hides is deprecated: Please use legend_options_fields""")
|
|
1477
|
-
|
|
1478
1353
|
return pulumi.get(self, "legend_fields_to_hides")
|
|
1479
1354
|
|
|
1480
1355
|
@property
|
|
1481
1356
|
@pulumi.getter(name="legendOptionsFields")
|
|
1482
1357
|
def legend_options_fields(self) -> pulumi.Output[Optional[Sequence['outputs.TimeChartLegendOptionsField']]]:
|
|
1483
1358
|
"""
|
|
1484
|
-
List of property and enabled flags
|
|
1359
|
+
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 `legend_fields_to_hide`.
|
|
1485
1360
|
"""
|
|
1486
1361
|
return pulumi.get(self, "legend_options_fields")
|
|
1487
1362
|
|
|
@@ -1489,7 +1364,7 @@ class TimeChart(pulumi.CustomResource):
|
|
|
1489
1364
|
@pulumi.getter(name="maxDelay")
|
|
1490
1365
|
def max_delay(self) -> pulumi.Output[Optional[int]]:
|
|
1491
1366
|
"""
|
|
1492
|
-
How long (in seconds) to wait for late datapoints
|
|
1367
|
+
How long (in seconds) to wait for late datapoints.
|
|
1493
1368
|
"""
|
|
1494
1369
|
return pulumi.get(self, "max_delay")
|
|
1495
1370
|
|
|
@@ -1497,7 +1372,7 @@ class TimeChart(pulumi.CustomResource):
|
|
|
1497
1372
|
@pulumi.getter(name="minimumResolution")
|
|
1498
1373
|
def minimum_resolution(self) -> pulumi.Output[Optional[int]]:
|
|
1499
1374
|
"""
|
|
1500
|
-
The minimum resolution (in seconds) to use for computing the underlying program
|
|
1375
|
+
The minimum resolution (in seconds) to use for computing the underlying program.
|
|
1501
1376
|
"""
|
|
1502
1377
|
return pulumi.get(self, "minimum_resolution")
|
|
1503
1378
|
|
|
@@ -1505,7 +1380,7 @@ class TimeChart(pulumi.CustomResource):
|
|
|
1505
1380
|
@pulumi.getter
|
|
1506
1381
|
def name(self) -> pulumi.Output[str]:
|
|
1507
1382
|
"""
|
|
1508
|
-
Name of the chart
|
|
1383
|
+
Name of the chart.
|
|
1509
1384
|
"""
|
|
1510
1385
|
return pulumi.get(self, "name")
|
|
1511
1386
|
|
|
@@ -1513,8 +1388,7 @@ class TimeChart(pulumi.CustomResource):
|
|
|
1513
1388
|
@pulumi.getter(name="onChartLegendDimension")
|
|
1514
1389
|
def on_chart_legend_dimension(self) -> pulumi.Output[Optional[str]]:
|
|
1515
1390
|
"""
|
|
1516
|
-
|
|
1517
|
-
'plot_label' and any dimension.
|
|
1391
|
+
Dimensions to show in the on-chart legend. On-chart legend is off unless a dimension is specified. Allowed: `"metric"`, `"plot_label"` and any dimension.
|
|
1518
1392
|
"""
|
|
1519
1393
|
return pulumi.get(self, "on_chart_legend_dimension")
|
|
1520
1394
|
|
|
@@ -1522,8 +1396,7 @@ class TimeChart(pulumi.CustomResource):
|
|
|
1522
1396
|
@pulumi.getter(name="plotType")
|
|
1523
1397
|
def plot_type(self) -> pulumi.Output[Optional[str]]:
|
|
1524
1398
|
"""
|
|
1525
|
-
|
|
1526
|
-
"ColumnChart", or "Histogram"
|
|
1399
|
+
The default plot display style for the visualization. Must be `"LineChart"`, `"AreaChart"`, `"ColumnChart"`, or `"Histogram"`. Default: `"LineChart"`.
|
|
1527
1400
|
"""
|
|
1528
1401
|
return pulumi.get(self, "plot_type")
|
|
1529
1402
|
|
|
@@ -1531,7 +1404,7 @@ class TimeChart(pulumi.CustomResource):
|
|
|
1531
1404
|
@pulumi.getter(name="programText")
|
|
1532
1405
|
def program_text(self) -> pulumi.Output[str]:
|
|
1533
1406
|
"""
|
|
1534
|
-
Signalflow program text for the chart. More info
|
|
1407
|
+
Signalflow program text for the chart. More info [in the Splunk Observability Cloud docs](https://dev.splunk.com/observability/docs/signalflow/).
|
|
1535
1408
|
"""
|
|
1536
1409
|
return pulumi.get(self, "program_text")
|
|
1537
1410
|
|
|
@@ -1539,7 +1412,7 @@ class TimeChart(pulumi.CustomResource):
|
|
|
1539
1412
|
@pulumi.getter(name="showDataMarkers")
|
|
1540
1413
|
def show_data_markers(self) -> pulumi.Output[Optional[bool]]:
|
|
1541
1414
|
"""
|
|
1542
|
-
|
|
1415
|
+
Show markers (circles) for each datapoint used to draw line or area charts. `false` by default.
|
|
1543
1416
|
"""
|
|
1544
1417
|
return pulumi.get(self, "show_data_markers")
|
|
1545
1418
|
|
|
@@ -1547,7 +1420,7 @@ class TimeChart(pulumi.CustomResource):
|
|
|
1547
1420
|
@pulumi.getter(name="showEventLines")
|
|
1548
1421
|
def show_event_lines(self) -> pulumi.Output[Optional[bool]]:
|
|
1549
1422
|
"""
|
|
1550
|
-
|
|
1423
|
+
Whether vertical highlight lines should be drawn in the visualizations at times when events occurred. `false` by default.
|
|
1551
1424
|
"""
|
|
1552
1425
|
return pulumi.get(self, "show_event_lines")
|
|
1553
1426
|
|
|
@@ -1555,7 +1428,7 @@ class TimeChart(pulumi.CustomResource):
|
|
|
1555
1428
|
@pulumi.getter
|
|
1556
1429
|
def stacked(self) -> pulumi.Output[Optional[bool]]:
|
|
1557
1430
|
"""
|
|
1558
|
-
|
|
1431
|
+
Whether area and bar charts in the visualization should be stacked. `false` by default.
|
|
1559
1432
|
"""
|
|
1560
1433
|
return pulumi.get(self, "stacked")
|
|
1561
1434
|
|
|
@@ -1563,26 +1436,24 @@ class TimeChart(pulumi.CustomResource):
|
|
|
1563
1436
|
@pulumi.getter(name="startTime")
|
|
1564
1437
|
def start_time(self) -> pulumi.Output[Optional[int]]:
|
|
1565
1438
|
"""
|
|
1566
|
-
Seconds since epoch
|
|
1439
|
+
Seconds since epoch. Used for visualization. Conflicts with `time_range`.
|
|
1567
1440
|
"""
|
|
1568
1441
|
return pulumi.get(self, "start_time")
|
|
1569
1442
|
|
|
1570
1443
|
@property
|
|
1571
1444
|
@pulumi.getter
|
|
1445
|
+
@_utilities.deprecated("""signalfx_time_chart.tags is being removed in the next release""")
|
|
1572
1446
|
def tags(self) -> pulumi.Output[Optional[Sequence[str]]]:
|
|
1573
1447
|
"""
|
|
1574
1448
|
Tags associated with the chart
|
|
1575
1449
|
"""
|
|
1576
|
-
warnings.warn("""signalfx_time_chart.tags is being removed in the next release""", DeprecationWarning)
|
|
1577
|
-
pulumi.log.warn("""tags is deprecated: signalfx_time_chart.tags is being removed in the next release""")
|
|
1578
|
-
|
|
1579
1450
|
return pulumi.get(self, "tags")
|
|
1580
1451
|
|
|
1581
1452
|
@property
|
|
1582
1453
|
@pulumi.getter(name="timeRange")
|
|
1583
1454
|
def time_range(self) -> pulumi.Output[Optional[int]]:
|
|
1584
1455
|
"""
|
|
1585
|
-
|
|
1456
|
+
How many seconds ago from which to display data. For example, the last hour would be `3600`, etc. Conflicts with `start_time` and `end_time`.
|
|
1586
1457
|
"""
|
|
1587
1458
|
return pulumi.get(self, "time_range")
|
|
1588
1459
|
|
|
@@ -1590,7 +1461,7 @@ class TimeChart(pulumi.CustomResource):
|
|
|
1590
1461
|
@pulumi.getter
|
|
1591
1462
|
def timezone(self) -> pulumi.Output[Optional[str]]:
|
|
1592
1463
|
"""
|
|
1593
|
-
|
|
1464
|
+
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.
|
|
1594
1465
|
"""
|
|
1595
1466
|
return pulumi.get(self, "timezone")
|
|
1596
1467
|
|
|
@@ -1598,7 +1469,7 @@ class TimeChart(pulumi.CustomResource):
|
|
|
1598
1469
|
@pulumi.getter(name="unitPrefix")
|
|
1599
1470
|
def unit_prefix(self) -> pulumi.Output[Optional[str]]:
|
|
1600
1471
|
"""
|
|
1601
|
-
|
|
1472
|
+
Must be `"Metric"` or `"Binary`". `"Metric"` by default.
|
|
1602
1473
|
"""
|
|
1603
1474
|
return pulumi.get(self, "unit_prefix")
|
|
1604
1475
|
|
|
@@ -1606,7 +1477,7 @@ class TimeChart(pulumi.CustomResource):
|
|
|
1606
1477
|
@pulumi.getter
|
|
1607
1478
|
def url(self) -> pulumi.Output[str]:
|
|
1608
1479
|
"""
|
|
1609
|
-
URL of the chart
|
|
1480
|
+
The URL of the chart.
|
|
1610
1481
|
"""
|
|
1611
1482
|
return pulumi.get(self, "url")
|
|
1612
1483
|
|
|
@@ -1614,7 +1485,7 @@ class TimeChart(pulumi.CustomResource):
|
|
|
1614
1485
|
@pulumi.getter(name="vizOptions")
|
|
1615
1486
|
def viz_options(self) -> pulumi.Output[Optional[Sequence['outputs.TimeChartVizOption']]]:
|
|
1616
1487
|
"""
|
|
1617
|
-
Plot-level customization options, associated with a publish statement
|
|
1488
|
+
Plot-level customization options, associated with a publish statement.
|
|
1618
1489
|
"""
|
|
1619
1490
|
return pulumi.get(self, "viz_options")
|
|
1620
1491
|
|