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, 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; /** * Specifies the digits Splunk Observability Cloud displays for values plotted on the chart. Defaults to `3`. */ readonly axesPrecision: pulumi.Output; /** * Set of axis options. */ readonly axisLeft: pulumi.Output; /** * Set of axis options. */ readonly axisRight: pulumi.Output; /** * Must be `"Dimension"` or `"Metric"`. `"Dimension"` by default. */ readonly colorBy: pulumi.Output; /** * Description of the chart. */ readonly description: pulumi.Output; /** * If `false`, samples a subset of the output MTS, which improves UI performance. `false` by default */ readonly disableSampling: pulumi.Output; /** * Seconds since epoch. Used for visualization. Conflicts with `timeRange`. */ readonly endTime: pulumi.Output; /** * 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; /** * Only used when `plotType` is `"Histogram"`. Histogram specific options. */ readonly histogramOptions: pulumi.Output; /** * 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; /** * 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; /** * How long (in seconds) to wait for late datapoints. */ readonly maxDelay: pulumi.Output; /** * The minimum resolution (in seconds) to use for computing the underlying program. */ readonly minimumResolution: pulumi.Output; /** * Name of the chart. */ readonly name: pulumi.Output; /** * 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; /** * The default plot display style for the visualization. Must be `"LineChart"`, `"AreaChart"`, `"ColumnChart"`, or `"Histogram"`. Default: `"LineChart"`. */ readonly plotType: pulumi.Output; /** * 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; /** * Show markers (circles) for each datapoint used to draw line or area charts. `false` by default. */ readonly showDataMarkers: pulumi.Output; /** * Whether vertical highlight lines should be drawn in the visualizations at times when events occurred. `false` by default. */ readonly showEventLines: pulumi.Output; /** * Whether area and bar charts in the visualization should be stacked. `false` by default. */ readonly stacked: pulumi.Output; /** * Seconds since epoch. Used for visualization. Conflicts with `timeRange`. */ readonly startTime: pulumi.Output; /** * Tags associated with the chart * * @deprecated signalfx_time_chart.tags is being removed in the next release */ readonly tags: pulumi.Output; /** * 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; /** * 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; /** * Must be `"Metric"` or `"Binary`". `"Metric"` by default. */ readonly unitPrefix: pulumi.Output; /** * The URL of the chart. */ readonly url: pulumi.Output; /** * Plot-level customization options, associated with a publish statement. */ readonly vizOptions: pulumi.Output; /** * 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; /** * Specifies the digits Splunk Observability Cloud displays for values plotted on the chart. Defaults to `3`. */ axesPrecision?: pulumi.Input; /** * Set of axis options. */ axisLeft?: pulumi.Input; /** * Set of axis options. */ axisRight?: pulumi.Input; /** * Must be `"Dimension"` or `"Metric"`. `"Dimension"` by default. */ colorBy?: pulumi.Input; /** * Description of the chart. */ description?: pulumi.Input; /** * If `false`, samples a subset of the output MTS, which improves UI performance. `false` by default */ disableSampling?: pulumi.Input; /** * Seconds since epoch. Used for visualization. Conflicts with `timeRange`. */ endTime?: pulumi.Input; /** * 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[]>; /** * Only used when `plotType` is `"Histogram"`. Histogram specific options. */ histogramOptions?: pulumi.Input[]>; /** * 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[]>; /** * 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[]>; /** * How long (in seconds) to wait for late datapoints. */ maxDelay?: pulumi.Input; /** * The minimum resolution (in seconds) to use for computing the underlying program. */ minimumResolution?: pulumi.Input; /** * Name of the chart. */ name?: pulumi.Input; /** * 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; /** * The default plot display style for the visualization. Must be `"LineChart"`, `"AreaChart"`, `"ColumnChart"`, or `"Histogram"`. Default: `"LineChart"`. */ plotType?: pulumi.Input; /** * Signalflow program text for the chart. More info [in the Splunk Observability Cloud docs](https://dev.splunk.com/observability/docs/signalflow/). */ programText?: pulumi.Input; /** * Show markers (circles) for each datapoint used to draw line or area charts. `false` by default. */ showDataMarkers?: pulumi.Input; /** * Whether vertical highlight lines should be drawn in the visualizations at times when events occurred. `false` by default. */ showEventLines?: pulumi.Input; /** * Whether area and bar charts in the visualization should be stacked. `false` by default. */ stacked?: pulumi.Input; /** * Seconds since epoch. Used for visualization. Conflicts with `timeRange`. */ startTime?: pulumi.Input; /** * Tags associated with the chart * * @deprecated signalfx_time_chart.tags is being removed in the next release */ tags?: pulumi.Input[]>; /** * 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; /** * 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; /** * Must be `"Metric"` or `"Binary`". `"Metric"` by default. */ unitPrefix?: pulumi.Input; /** * The URL of the chart. */ url?: pulumi.Input; /** * Plot-level customization options, associated with a publish statement. */ vizOptions?: pulumi.Input[]>; } /** * 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; /** * Specifies the digits Splunk Observability Cloud displays for values plotted on the chart. Defaults to `3`. */ axesPrecision?: pulumi.Input; /** * Set of axis options. */ axisLeft?: pulumi.Input; /** * Set of axis options. */ axisRight?: pulumi.Input; /** * Must be `"Dimension"` or `"Metric"`. `"Dimension"` by default. */ colorBy?: pulumi.Input; /** * Description of the chart. */ description?: pulumi.Input; /** * If `false`, samples a subset of the output MTS, which improves UI performance. `false` by default */ disableSampling?: pulumi.Input; /** * Seconds since epoch. Used for visualization. Conflicts with `timeRange`. */ endTime?: pulumi.Input; /** * 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[]>; /** * Only used when `plotType` is `"Histogram"`. Histogram specific options. */ histogramOptions?: pulumi.Input[]>; /** * 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[]>; /** * 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[]>; /** * How long (in seconds) to wait for late datapoints. */ maxDelay?: pulumi.Input; /** * The minimum resolution (in seconds) to use for computing the underlying program. */ minimumResolution?: pulumi.Input; /** * Name of the chart. */ name?: pulumi.Input; /** * 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; /** * The default plot display style for the visualization. Must be `"LineChart"`, `"AreaChart"`, `"ColumnChart"`, or `"Histogram"`. Default: `"LineChart"`. */ plotType?: pulumi.Input; /** * Signalflow program text for the chart. More info [in the Splunk Observability Cloud docs](https://dev.splunk.com/observability/docs/signalflow/). */ programText: pulumi.Input; /** * Show markers (circles) for each datapoint used to draw line or area charts. `false` by default. */ showDataMarkers?: pulumi.Input; /** * Whether vertical highlight lines should be drawn in the visualizations at times when events occurred. `false` by default. */ showEventLines?: pulumi.Input; /** * Whether area and bar charts in the visualization should be stacked. `false` by default. */ stacked?: pulumi.Input; /** * Seconds since epoch. Used for visualization. Conflicts with `timeRange`. */ startTime?: pulumi.Input; /** * Tags associated with the chart * * @deprecated signalfx_time_chart.tags is being removed in the next release */ tags?: pulumi.Input[]>; /** * 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; /** * 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; /** * Must be `"Metric"` or `"Binary`". `"Metric"` by default. */ unitPrefix?: pulumi.Input; /** * Plot-level customization options, associated with a publish statement. */ vizOptions?: pulumi.Input[]>; }