@pulumi/signalfx
Version:
A Pulumi package for creating and managing SignalFx resources.
422 lines (421 loc) • 17.9 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
/**
* Provides a Splunk Observability Cloud time chart resource. This can be used to create and manage the different types of time charts.
*
* Time charts display data points over a period of time.
*
* ## Example
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as signalfx from "@pulumi/signalfx";
*
* const mychart0 = new signalfx.TimeChart("mychart0", {
* name: "CPU Total Idle",
* programText: "data(\"cpu.total.idle\").publish(label=\"CPU Idle\")\n",
* timeRange: 3600,
* plotType: "LineChart",
* showDataMarkers: true,
* legendOptionsFields: [
* {
* property: "collector",
* enabled: false,
* },
* {
* property: "hostname",
* enabled: false,
* },
* ],
* vizOptions: [{
* label: "CPU Idle",
* axis: "left",
* color: "orange",
* }],
* axisLeft: {
* label: "CPU Total Idle",
* lowWatermark: 1000,
* },
* });
* ```
*/
export declare class TimeChart extends pulumi.CustomResource {
/**
* Get an existing TimeChart resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: TimeChartState, opts?: pulumi.CustomResourceOptions): TimeChart;
/**
* Returns true if the given object is an instance of TimeChart. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is TimeChart;
/**
* Force the chart to display zero on the y-axes, even if none of the data is near zero.
*/
readonly axesIncludeZero: pulumi.Output<boolean | undefined>;
/**
* Specifies the digits Splunk Observability Cloud displays for values plotted on the chart. Defaults to `3`.
*/
readonly axesPrecision: pulumi.Output<number | undefined>;
/**
* Set of axis options.
*/
readonly axisLeft: pulumi.Output<outputs.TimeChartAxisLeft | undefined>;
/**
* Set of axis options.
*/
readonly axisRight: pulumi.Output<outputs.TimeChartAxisRight | undefined>;
/**
* Must be `"Dimension"` or `"Metric"`. `"Dimension"` by default.
*/
readonly colorBy: pulumi.Output<string | undefined>;
/**
* Description of the chart.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* If `false`, samples a subset of the output MTS, which improves UI performance. `false` by default
*/
readonly disableSampling: pulumi.Output<boolean | undefined>;
/**
* Seconds since epoch. Used for visualization. Conflicts with `timeRange`.
*/
readonly endTime: pulumi.Output<number | undefined>;
/**
* Event customization options, associated with a publish statement. You will need to use this to change settings for any `events(…)` statements you use.
*/
readonly eventOptions: pulumi.Output<outputs.TimeChartEventOption[] | undefined>;
/**
* Only used when `plotType` is `"Histogram"`. Histogram specific options.
*/
readonly histogramOptions: pulumi.Output<outputs.TimeChartHistogramOption[] | undefined>;
/**
* List of properties that should not be displayed in the chart legend (i.e. dimension names). All the properties are visible by default. Deprecated, please use `legendOptionsFields`.
*
* @deprecated Please use legend_options_fields
*/
readonly legendFieldsToHides: pulumi.Output<string[] | undefined>;
/**
* List of property names and enabled flags that should be displayed in the data table for the chart, in the order provided. This option cannot be used with `legendFieldsToHide`.
*/
readonly legendOptionsFields: pulumi.Output<outputs.TimeChartLegendOptionsField[] | undefined>;
/**
* How long (in seconds) to wait for late datapoints.
*/
readonly maxDelay: pulumi.Output<number | undefined>;
/**
* The minimum resolution (in seconds) to use for computing the underlying program.
*/
readonly minimumResolution: pulumi.Output<number | undefined>;
/**
* Name of the chart.
*/
readonly name: pulumi.Output<string>;
/**
* Dimensions to show in the on-chart legend. On-chart legend is off unless a dimension is specified. Allowed: `"metric"`, `"plotLabel"` and any dimension.
*/
readonly onChartLegendDimension: pulumi.Output<string | undefined>;
/**
* The default plot display style for the visualization. Must be `"LineChart"`, `"AreaChart"`, `"ColumnChart"`, or `"Histogram"`. Default: `"LineChart"`.
*/
readonly plotType: pulumi.Output<string | undefined>;
/**
* Signalflow program text for the chart. More info [in the Splunk Observability Cloud docs](https://dev.splunk.com/observability/docs/signalflow/).
*/
readonly programText: pulumi.Output<string>;
/**
* Show markers (circles) for each datapoint used to draw line or area charts. `false` by default.
*/
readonly showDataMarkers: pulumi.Output<boolean | undefined>;
/**
* Whether vertical highlight lines should be drawn in the visualizations at times when events occurred. `false` by default.
*/
readonly showEventLines: pulumi.Output<boolean | undefined>;
/**
* Whether area and bar charts in the visualization should be stacked. `false` by default.
*/
readonly stacked: pulumi.Output<boolean | undefined>;
/**
* Seconds since epoch. Used for visualization. Conflicts with `timeRange`.
*/
readonly startTime: pulumi.Output<number | undefined>;
/**
* Tags associated with the chart
*
* @deprecated signalfx_time_chart.tags is being removed in the next release
*/
readonly tags: pulumi.Output<string[] | undefined>;
/**
* How many seconds ago from which to display data. For example, the last hour would be `3600`, etc. Conflicts with `startTime` and `endTime`.
*/
readonly timeRange: pulumi.Output<number | undefined>;
/**
* 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.
*/
readonly timezone: pulumi.Output<string | undefined>;
/**
* Must be `"Metric"` or `"Binary`". `"Metric"` by default.
*/
readonly unitPrefix: pulumi.Output<string | undefined>;
/**
* The URL of the chart.
*/
readonly url: pulumi.Output<string>;
/**
* Plot-level customization options, associated with a publish statement.
*/
readonly vizOptions: pulumi.Output<outputs.TimeChartVizOption[] | undefined>;
/**
* Create a TimeChart resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: TimeChartArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering TimeChart resources.
*/
export interface TimeChartState {
/**
* Force the chart to display zero on the y-axes, even if none of the data is near zero.
*/
axesIncludeZero?: pulumi.Input<boolean>;
/**
* Specifies the digits Splunk Observability Cloud displays for values plotted on the chart. Defaults to `3`.
*/
axesPrecision?: pulumi.Input<number>;
/**
* Set of axis options.
*/
axisLeft?: pulumi.Input<inputs.TimeChartAxisLeft>;
/**
* Set of axis options.
*/
axisRight?: pulumi.Input<inputs.TimeChartAxisRight>;
/**
* Must be `"Dimension"` or `"Metric"`. `"Dimension"` by default.
*/
colorBy?: pulumi.Input<string>;
/**
* Description of the chart.
*/
description?: pulumi.Input<string>;
/**
* If `false`, samples a subset of the output MTS, which improves UI performance. `false` by default
*/
disableSampling?: pulumi.Input<boolean>;
/**
* Seconds since epoch. Used for visualization. Conflicts with `timeRange`.
*/
endTime?: pulumi.Input<number>;
/**
* Event customization options, associated with a publish statement. You will need to use this to change settings for any `events(…)` statements you use.
*/
eventOptions?: pulumi.Input<pulumi.Input<inputs.TimeChartEventOption>[]>;
/**
* Only used when `plotType` is `"Histogram"`. Histogram specific options.
*/
histogramOptions?: pulumi.Input<pulumi.Input<inputs.TimeChartHistogramOption>[]>;
/**
* List of properties that should not be displayed in the chart legend (i.e. dimension names). All the properties are visible by default. Deprecated, please use `legendOptionsFields`.
*
* @deprecated Please use legend_options_fields
*/
legendFieldsToHides?: pulumi.Input<pulumi.Input<string>[]>;
/**
* List of property names and enabled flags that should be displayed in the data table for the chart, in the order provided. This option cannot be used with `legendFieldsToHide`.
*/
legendOptionsFields?: pulumi.Input<pulumi.Input<inputs.TimeChartLegendOptionsField>[]>;
/**
* How long (in seconds) to wait for late datapoints.
*/
maxDelay?: pulumi.Input<number>;
/**
* The minimum resolution (in seconds) to use for computing the underlying program.
*/
minimumResolution?: pulumi.Input<number>;
/**
* Name of the chart.
*/
name?: pulumi.Input<string>;
/**
* Dimensions to show in the on-chart legend. On-chart legend is off unless a dimension is specified. Allowed: `"metric"`, `"plotLabel"` and any dimension.
*/
onChartLegendDimension?: pulumi.Input<string>;
/**
* The default plot display style for the visualization. Must be `"LineChart"`, `"AreaChart"`, `"ColumnChart"`, or `"Histogram"`. Default: `"LineChart"`.
*/
plotType?: pulumi.Input<string>;
/**
* Signalflow program text for the chart. More info [in the Splunk Observability Cloud docs](https://dev.splunk.com/observability/docs/signalflow/).
*/
programText?: pulumi.Input<string>;
/**
* Show markers (circles) for each datapoint used to draw line or area charts. `false` by default.
*/
showDataMarkers?: pulumi.Input<boolean>;
/**
* Whether vertical highlight lines should be drawn in the visualizations at times when events occurred. `false` by default.
*/
showEventLines?: pulumi.Input<boolean>;
/**
* Whether area and bar charts in the visualization should be stacked. `false` by default.
*/
stacked?: pulumi.Input<boolean>;
/**
* Seconds since epoch. Used for visualization. Conflicts with `timeRange`.
*/
startTime?: pulumi.Input<number>;
/**
* Tags associated with the chart
*
* @deprecated signalfx_time_chart.tags is being removed in the next release
*/
tags?: pulumi.Input<pulumi.Input<string>[]>;
/**
* How many seconds ago from which to display data. For example, the last hour would be `3600`, etc. Conflicts with `startTime` and `endTime`.
*/
timeRange?: pulumi.Input<number>;
/**
* 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.
*/
timezone?: pulumi.Input<string>;
/**
* Must be `"Metric"` or `"Binary`". `"Metric"` by default.
*/
unitPrefix?: pulumi.Input<string>;
/**
* The URL of the chart.
*/
url?: pulumi.Input<string>;
/**
* Plot-level customization options, associated with a publish statement.
*/
vizOptions?: pulumi.Input<pulumi.Input<inputs.TimeChartVizOption>[]>;
}
/**
* The set of arguments for constructing a TimeChart resource.
*/
export interface TimeChartArgs {
/**
* Force the chart to display zero on the y-axes, even if none of the data is near zero.
*/
axesIncludeZero?: pulumi.Input<boolean>;
/**
* Specifies the digits Splunk Observability Cloud displays for values plotted on the chart. Defaults to `3`.
*/
axesPrecision?: pulumi.Input<number>;
/**
* Set of axis options.
*/
axisLeft?: pulumi.Input<inputs.TimeChartAxisLeft>;
/**
* Set of axis options.
*/
axisRight?: pulumi.Input<inputs.TimeChartAxisRight>;
/**
* Must be `"Dimension"` or `"Metric"`. `"Dimension"` by default.
*/
colorBy?: pulumi.Input<string>;
/**
* Description of the chart.
*/
description?: pulumi.Input<string>;
/**
* If `false`, samples a subset of the output MTS, which improves UI performance. `false` by default
*/
disableSampling?: pulumi.Input<boolean>;
/**
* Seconds since epoch. Used for visualization. Conflicts with `timeRange`.
*/
endTime?: pulumi.Input<number>;
/**
* Event customization options, associated with a publish statement. You will need to use this to change settings for any `events(…)` statements you use.
*/
eventOptions?: pulumi.Input<pulumi.Input<inputs.TimeChartEventOption>[]>;
/**
* Only used when `plotType` is `"Histogram"`. Histogram specific options.
*/
histogramOptions?: pulumi.Input<pulumi.Input<inputs.TimeChartHistogramOption>[]>;
/**
* List of properties that should not be displayed in the chart legend (i.e. dimension names). All the properties are visible by default. Deprecated, please use `legendOptionsFields`.
*
* @deprecated Please use legend_options_fields
*/
legendFieldsToHides?: pulumi.Input<pulumi.Input<string>[]>;
/**
* List of property names and enabled flags that should be displayed in the data table for the chart, in the order provided. This option cannot be used with `legendFieldsToHide`.
*/
legendOptionsFields?: pulumi.Input<pulumi.Input<inputs.TimeChartLegendOptionsField>[]>;
/**
* How long (in seconds) to wait for late datapoints.
*/
maxDelay?: pulumi.Input<number>;
/**
* The minimum resolution (in seconds) to use for computing the underlying program.
*/
minimumResolution?: pulumi.Input<number>;
/**
* Name of the chart.
*/
name?: pulumi.Input<string>;
/**
* Dimensions to show in the on-chart legend. On-chart legend is off unless a dimension is specified. Allowed: `"metric"`, `"plotLabel"` and any dimension.
*/
onChartLegendDimension?: pulumi.Input<string>;
/**
* The default plot display style for the visualization. Must be `"LineChart"`, `"AreaChart"`, `"ColumnChart"`, or `"Histogram"`. Default: `"LineChart"`.
*/
plotType?: pulumi.Input<string>;
/**
* Signalflow program text for the chart. More info [in the Splunk Observability Cloud docs](https://dev.splunk.com/observability/docs/signalflow/).
*/
programText: pulumi.Input<string>;
/**
* Show markers (circles) for each datapoint used to draw line or area charts. `false` by default.
*/
showDataMarkers?: pulumi.Input<boolean>;
/**
* Whether vertical highlight lines should be drawn in the visualizations at times when events occurred. `false` by default.
*/
showEventLines?: pulumi.Input<boolean>;
/**
* Whether area and bar charts in the visualization should be stacked. `false` by default.
*/
stacked?: pulumi.Input<boolean>;
/**
* Seconds since epoch. Used for visualization. Conflicts with `timeRange`.
*/
startTime?: pulumi.Input<number>;
/**
* Tags associated with the chart
*
* @deprecated signalfx_time_chart.tags is being removed in the next release
*/
tags?: pulumi.Input<pulumi.Input<string>[]>;
/**
* How many seconds ago from which to display data. For example, the last hour would be `3600`, etc. Conflicts with `startTime` and `endTime`.
*/
timeRange?: pulumi.Input<number>;
/**
* 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.
*/
timezone?: pulumi.Input<string>;
/**
* Must be `"Metric"` or `"Binary`". `"Metric"` by default.
*/
unitPrefix?: pulumi.Input<string>;
/**
* Plot-level customization options, associated with a publish statement.
*/
vizOptions?: pulumi.Input<pulumi.Input<inputs.TimeChartVizOption>[]>;
}