signalfx.TimeChart
Explore with Pulumi AI
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
import * as pulumi from "@pulumi/pulumi";
import * as signalfx from "@pulumi/signalfx";
const mychart0 = new signalfx.TimeChart("mychart0", {
axisLeft: {
label: "CPU Total Idle",
lowWatermark: 1000,
},
legendOptionsFields: [
{
enabled: false,
property: "collector",
},
{
enabled: false,
property: "hostname",
},
],
plotType: "LineChart",
programText: `data("cpu.total.idle").publish(label="CPU Idle")
`,
showDataMarkers: true,
timeRange: 3600,
vizOptions: [{
axis: "left",
color: "orange",
label: "CPU Idle",
}],
});
import pulumi
import pulumi_signalfx as signalfx
mychart0 = signalfx.TimeChart("mychart0",
axis_left=signalfx.TimeChartAxisLeftArgs(
label="CPU Total Idle",
low_watermark=1000,
),
legend_options_fields=[
signalfx.TimeChartLegendOptionsFieldArgs(
enabled=False,
property="collector",
),
signalfx.TimeChartLegendOptionsFieldArgs(
enabled=False,
property="hostname",
),
],
plot_type="LineChart",
program_text="""data("cpu.total.idle").publish(label="CPU Idle")
""",
show_data_markers=True,
time_range=3600,
viz_options=[signalfx.TimeChartVizOptionArgs(
axis="left",
color="orange",
label="CPU Idle",
)])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using SignalFx = Pulumi.SignalFx;
return await Deployment.RunAsync(() =>
{
var mychart0 = new SignalFx.TimeChart("mychart0", new()
{
AxisLeft = new SignalFx.Inputs.TimeChartAxisLeftArgs
{
Label = "CPU Total Idle",
LowWatermark = 1000,
},
LegendOptionsFields = new[]
{
new SignalFx.Inputs.TimeChartLegendOptionsFieldArgs
{
Enabled = false,
Property = "collector",
},
new SignalFx.Inputs.TimeChartLegendOptionsFieldArgs
{
Enabled = false,
Property = "hostname",
},
},
PlotType = "LineChart",
ProgramText = @"data(""cpu.total.idle"").publish(label=""CPU Idle"")
",
ShowDataMarkers = true,
TimeRange = 3600,
VizOptions = new[]
{
new SignalFx.Inputs.TimeChartVizOptionArgs
{
Axis = "left",
Color = "orange",
Label = "CPU Idle",
},
},
});
});
package main
import (
"github.com/pulumi/pulumi-signalfx/sdk/v7/go/signalfx"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := signalfx.NewTimeChart(ctx, "mychart0", &signalfx.TimeChartArgs{
AxisLeft: &signalfx.TimeChartAxisLeftArgs{
Label: pulumi.String("CPU Total Idle"),
LowWatermark: pulumi.Float64(1000),
},
LegendOptionsFields: signalfx.TimeChartLegendOptionsFieldArray{
&signalfx.TimeChartLegendOptionsFieldArgs{
Enabled: pulumi.Bool(false),
Property: pulumi.String("collector"),
},
&signalfx.TimeChartLegendOptionsFieldArgs{
Enabled: pulumi.Bool(false),
Property: pulumi.String("hostname"),
},
},
PlotType: pulumi.String("LineChart"),
ProgramText: pulumi.String("data(\"cpu.total.idle\").publish(label=\"CPU Idle\")\n\n"),
ShowDataMarkers: pulumi.Bool(true),
TimeRange: pulumi.Int(3600),
VizOptions: signalfx.TimeChartVizOptionArray{
&signalfx.TimeChartVizOptionArgs{
Axis: pulumi.String("left"),
Color: pulumi.String("orange"),
Label: pulumi.String("CPU Idle"),
},
},
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.signalfx.TimeChart;
import com.pulumi.signalfx.TimeChartArgs;
import com.pulumi.signalfx.inputs.TimeChartAxisLeftArgs;
import com.pulumi.signalfx.inputs.TimeChartLegendOptionsFieldArgs;
import com.pulumi.signalfx.inputs.TimeChartVizOptionArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var mychart0 = new TimeChart("mychart0", TimeChartArgs.builder()
.axisLeft(TimeChartAxisLeftArgs.builder()
.label("CPU Total Idle")
.lowWatermark(1000)
.build())
.legendOptionsFields(
TimeChartLegendOptionsFieldArgs.builder()
.enabled(false)
.property("collector")
.build(),
TimeChartLegendOptionsFieldArgs.builder()
.enabled(false)
.property("hostname")
.build())
.plotType("LineChart")
.programText("""
data("cpu.total.idle").publish(label="CPU Idle")
""")
.showDataMarkers(true)
.timeRange(3600)
.vizOptions(TimeChartVizOptionArgs.builder()
.axis("left")
.color("orange")
.label("CPU Idle")
.build())
.build());
}
}
resources:
mychart0:
type: signalfx:TimeChart
properties:
axisLeft:
label: CPU Total Idle
lowWatermark: 1000
legendOptionsFields:
- enabled: false
property: collector
- enabled: false
property: hostname
plotType: LineChart
programText: |+
data("cpu.total.idle").publish(label="CPU Idle")
showDataMarkers: true
timeRange: 3600
vizOptions:
- axis: left
color: orange
label: CPU Idle
Arguments
The following arguments are supported in the resource block:
name
- (Required) Name of the chart.program_text
- (Required) Signalflow program text for the chart. More info in the Splunk Observability Cloud docs.plot_type
- (Optional) The default plot display style for the visualization. Must be"LineChart"
,"AreaChart"
,"ColumnChart"
, or"Histogram"
. Default:"LineChart"
.description
- (Optional) Description of the chart.axes_precision
- (Optional) Specifies the digits Splunk Observability Cloud displays for values plotted on the chart. Defaults to3
.unit_prefix
- (Optional) Must be"Metric"
or"Binary
"."Metric"
by default.color_by
- (Optional) Must be"Dimension"
or"Metric"
."Dimension"
by default.minimum_resolution
- (Optional) The minimum resolution (in seconds) to use for computing the underlying program.max_delay
- (Optional) How long (in seconds) to wait for late datapoints.timezone
- (Optional) A string denotes the geographic region associated with the time zone.disable_sampling
- (Optional) Iffalse
, samples a subset of the output MTS, which improves UI performance.false
by defaulttime_range
- (Optional) How many seconds ago from which to display data. For example, the last hour would be3600
, etc. Conflicts withstart_time
andend_time
.start_time
- (Optional) Seconds since epoch. Used for visualization. Conflicts withtime_range
.end_time
- (Optional) Seconds since epoch. Used for visualization. Conflicts withtime_range
.axes_include_zero
- (Optional) Force the chart to display zero on the y-axes, even if none of the data is near zero.axis_left
- (Optional) Set of axis options.label
- (Optional) Label of the left axis.min_value
- (Optional) The minimum value for the left axis.max_value
- (Optional) The maximum value for the left axis.high_watermark
- (Optional) A line to draw as a high watermark.high_watermark_label
- (Optional) A label to attach to the high watermark line.low_watermark
- (Optional) A line to draw as a low watermark.low_watermark_label
- (Optional) A label to attach to the low watermark line.
axis_right
- (Optional) Set of axis options.label
- (Optional) Label of the right axis.min_value
- (Optional) The minimum value for the right axis.max_value
- (Optional) The maximum value for the right axis.high_watermark
- (Optional) A line to draw as a high watermark.high_watermark_label
- (Optional) A label to attach to the high watermark line.low_watermark
- (Optional) A line to draw as a low watermark.low_watermark_label
- (Optional) A label to attach to the low watermark line.
viz_options
- (Optional) Plot-level customization options, associated with a publish statement.label
- (Required) Label used in the publish statement that displays the plot (metric time series data) you want to customize.display_name
- (Optional) Specifies an alternate value for the Plot Name column of the Data Table associated with the chart.color
- (Optional) Color to use : gray, blue, azure, navy, brown, orange, yellow, iris, magenta, pink, purple, violet, lilac, emerald, green, aquamarine.axis
- (Optional) Y-axis associated with values for this plot. Must be eitherright
orleft
.plot_type
- (Optional) The visualization style to use. Must be"LineChart"
,"AreaChart"
,"ColumnChart"
, or"Histogram"
. Chart levelplot_type
by default.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 areBit, 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
.value_prefix
,value_suffix
- (Optional) Arbitrary prefix/suffix to display with the value of this plot.
event_options
- (Optional) Event customization options, associated with a publish statement. You will need to use this to change settings for anyevents(…)
statements you use.label
- (Required) Label used in the publish statement that displays the event query you want to customize.display_name
- (Optional) Specifies an alternate value for the Plot Name column of the Data Table associated with the chart.color
- (Optional) Color to use : gray, blue, azure, navy, brown, orange, yellow, iris, magenta, pink, purple, violet, lilac, emerald, green, aquamarine.
histogram_options
- (Optional) Only used whenplot_type
is"Histogram"
. Histogram specific options.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
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 uselegend_options_fields
.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 withlegend_fields_to_hide
.property
The name of the property to display. Note the special values ofplot_label
(corresponding with the API’ssf_metric
) which shows the label of the time seriespublish()
andmetric
(corresponding with the API’ssf_originatingMetric
) that shows the name of the metric for the time series being displayed.enabled
True or False depending on if you want the property to be shown or hidden.
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.show_event_lines
- (Optional) Whether vertical highlight lines should be drawn in the visualizations at times when events occurred.false
by default.show_data_markers
- (Optional) Show markers (circles) for each datapoint used to draw line or area charts.false
by default.stacked
- (Optional) Whether area and bar charts in the visualization should be stacked.false
by default.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."UTC"
by default.
Attributes
In a addition to all arguments above, the following attributes are exported:
id
- The ID of the chart.url
- The URL of the chart.
Create TimeChart Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new TimeChart(name: string, args: TimeChartArgs, opts?: CustomResourceOptions);
@overload
def TimeChart(resource_name: str,
args: TimeChartArgs,
opts: Optional[ResourceOptions] = None)
@overload
def TimeChart(resource_name: str,
opts: Optional[ResourceOptions] = None,
program_text: Optional[str] = None,
max_delay: Optional[int] = None,
axis_right: Optional[TimeChartAxisRightArgs] = None,
name: Optional[str] = None,
on_chart_legend_dimension: Optional[str] = None,
description: Optional[str] = None,
disable_sampling: Optional[bool] = None,
end_time: Optional[int] = None,
event_options: Optional[Sequence[TimeChartEventOptionArgs]] = None,
histogram_options: Optional[Sequence[TimeChartHistogramOptionArgs]] = None,
legend_fields_to_hides: Optional[Sequence[str]] = None,
legend_options_fields: Optional[Sequence[TimeChartLegendOptionsFieldArgs]] = None,
axes_include_zero: Optional[bool] = None,
viz_options: Optional[Sequence[TimeChartVizOptionArgs]] = None,
axis_left: Optional[TimeChartAxisLeftArgs] = None,
color_by: Optional[str] = None,
plot_type: Optional[str] = None,
axes_precision: Optional[int] = None,
show_data_markers: Optional[bool] = None,
show_event_lines: Optional[bool] = None,
stacked: Optional[bool] = None,
start_time: Optional[int] = None,
tags: Optional[Sequence[str]] = None,
time_range: Optional[int] = None,
timezone: Optional[str] = None,
unit_prefix: Optional[str] = None,
minimum_resolution: Optional[int] = None)
func NewTimeChart(ctx *Context, name string, args TimeChartArgs, opts ...ResourceOption) (*TimeChart, error)
public TimeChart(string name, TimeChartArgs args, CustomResourceOptions? opts = null)
public TimeChart(String name, TimeChartArgs args)
public TimeChart(String name, TimeChartArgs args, CustomResourceOptions options)
type: signalfx:TimeChart
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args TimeChartArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args TimeChartArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args TimeChartArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args TimeChartArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args TimeChartArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Example
The following reference example uses placeholder values for all input properties.
var timeChartResource = new SignalFx.TimeChart("timeChartResource", new()
{
ProgramText = "string",
MaxDelay = 0,
AxisRight = new SignalFx.Inputs.TimeChartAxisRightArgs
{
HighWatermark = 0,
HighWatermarkLabel = "string",
Label = "string",
LowWatermark = 0,
LowWatermarkLabel = "string",
MaxValue = 0,
MinValue = 0,
Watermarks = new[]
{
new SignalFx.Inputs.TimeChartAxisRightWatermarkArgs
{
Value = 0,
Label = "string",
},
},
},
Name = "string",
OnChartLegendDimension = "string",
Description = "string",
DisableSampling = false,
EndTime = 0,
EventOptions = new[]
{
new SignalFx.Inputs.TimeChartEventOptionArgs
{
Label = "string",
Color = "string",
DisplayName = "string",
},
},
HistogramOptions = new[]
{
new SignalFx.Inputs.TimeChartHistogramOptionArgs
{
ColorTheme = "string",
},
},
LegendOptionsFields = new[]
{
new SignalFx.Inputs.TimeChartLegendOptionsFieldArgs
{
Property = "string",
Enabled = false,
},
},
AxesIncludeZero = false,
VizOptions = new[]
{
new SignalFx.Inputs.TimeChartVizOptionArgs
{
Label = "string",
Axis = "string",
Color = "string",
DisplayName = "string",
PlotType = "string",
ValuePrefix = "string",
ValueSuffix = "string",
ValueUnit = "string",
},
},
AxisLeft = new SignalFx.Inputs.TimeChartAxisLeftArgs
{
HighWatermark = 0,
HighWatermarkLabel = "string",
Label = "string",
LowWatermark = 0,
LowWatermarkLabel = "string",
MaxValue = 0,
MinValue = 0,
Watermarks = new[]
{
new SignalFx.Inputs.TimeChartAxisLeftWatermarkArgs
{
Value = 0,
Label = "string",
},
},
},
ColorBy = "string",
PlotType = "string",
AxesPrecision = 0,
ShowDataMarkers = false,
ShowEventLines = false,
Stacked = false,
StartTime = 0,
TimeRange = 0,
Timezone = "string",
UnitPrefix = "string",
MinimumResolution = 0,
});
example, err := signalfx.NewTimeChart(ctx, "timeChartResource", &signalfx.TimeChartArgs{
ProgramText: pulumi.String("string"),
MaxDelay: pulumi.Int(0),
AxisRight: &signalfx.TimeChartAxisRightArgs{
HighWatermark: pulumi.Float64(0),
HighWatermarkLabel: pulumi.String("string"),
Label: pulumi.String("string"),
LowWatermark: pulumi.Float64(0),
LowWatermarkLabel: pulumi.String("string"),
MaxValue: pulumi.Float64(0),
MinValue: pulumi.Float64(0),
Watermarks: signalfx.TimeChartAxisRightWatermarkArray{
&signalfx.TimeChartAxisRightWatermarkArgs{
Value: pulumi.Float64(0),
Label: pulumi.String("string"),
},
},
},
Name: pulumi.String("string"),
OnChartLegendDimension: pulumi.String("string"),
Description: pulumi.String("string"),
DisableSampling: pulumi.Bool(false),
EndTime: pulumi.Int(0),
EventOptions: signalfx.TimeChartEventOptionArray{
&signalfx.TimeChartEventOptionArgs{
Label: pulumi.String("string"),
Color: pulumi.String("string"),
DisplayName: pulumi.String("string"),
},
},
HistogramOptions: signalfx.TimeChartHistogramOptionArray{
&signalfx.TimeChartHistogramOptionArgs{
ColorTheme: pulumi.String("string"),
},
},
LegendOptionsFields: signalfx.TimeChartLegendOptionsFieldArray{
&signalfx.TimeChartLegendOptionsFieldArgs{
Property: pulumi.String("string"),
Enabled: pulumi.Bool(false),
},
},
AxesIncludeZero: pulumi.Bool(false),
VizOptions: signalfx.TimeChartVizOptionArray{
&signalfx.TimeChartVizOptionArgs{
Label: pulumi.String("string"),
Axis: pulumi.String("string"),
Color: pulumi.String("string"),
DisplayName: pulumi.String("string"),
PlotType: pulumi.String("string"),
ValuePrefix: pulumi.String("string"),
ValueSuffix: pulumi.String("string"),
ValueUnit: pulumi.String("string"),
},
},
AxisLeft: &signalfx.TimeChartAxisLeftArgs{
HighWatermark: pulumi.Float64(0),
HighWatermarkLabel: pulumi.String("string"),
Label: pulumi.String("string"),
LowWatermark: pulumi.Float64(0),
LowWatermarkLabel: pulumi.String("string"),
MaxValue: pulumi.Float64(0),
MinValue: pulumi.Float64(0),
Watermarks: signalfx.TimeChartAxisLeftWatermarkArray{
&signalfx.TimeChartAxisLeftWatermarkArgs{
Value: pulumi.Float64(0),
Label: pulumi.String("string"),
},
},
},
ColorBy: pulumi.String("string"),
PlotType: pulumi.String("string"),
AxesPrecision: pulumi.Int(0),
ShowDataMarkers: pulumi.Bool(false),
ShowEventLines: pulumi.Bool(false),
Stacked: pulumi.Bool(false),
StartTime: pulumi.Int(0),
TimeRange: pulumi.Int(0),
Timezone: pulumi.String("string"),
UnitPrefix: pulumi.String("string"),
MinimumResolution: pulumi.Int(0),
})
var timeChartResource = new TimeChart("timeChartResource", TimeChartArgs.builder()
.programText("string")
.maxDelay(0)
.axisRight(TimeChartAxisRightArgs.builder()
.highWatermark(0)
.highWatermarkLabel("string")
.label("string")
.lowWatermark(0)
.lowWatermarkLabel("string")
.maxValue(0)
.minValue(0)
.watermarks(TimeChartAxisRightWatermarkArgs.builder()
.value(0)
.label("string")
.build())
.build())
.name("string")
.onChartLegendDimension("string")
.description("string")
.disableSampling(false)
.endTime(0)
.eventOptions(TimeChartEventOptionArgs.builder()
.label("string")
.color("string")
.displayName("string")
.build())
.histogramOptions(TimeChartHistogramOptionArgs.builder()
.colorTheme("string")
.build())
.legendOptionsFields(TimeChartLegendOptionsFieldArgs.builder()
.property("string")
.enabled(false)
.build())
.axesIncludeZero(false)
.vizOptions(TimeChartVizOptionArgs.builder()
.label("string")
.axis("string")
.color("string")
.displayName("string")
.plotType("string")
.valuePrefix("string")
.valueSuffix("string")
.valueUnit("string")
.build())
.axisLeft(TimeChartAxisLeftArgs.builder()
.highWatermark(0)
.highWatermarkLabel("string")
.label("string")
.lowWatermark(0)
.lowWatermarkLabel("string")
.maxValue(0)
.minValue(0)
.watermarks(TimeChartAxisLeftWatermarkArgs.builder()
.value(0)
.label("string")
.build())
.build())
.colorBy("string")
.plotType("string")
.axesPrecision(0)
.showDataMarkers(false)
.showEventLines(false)
.stacked(false)
.startTime(0)
.timeRange(0)
.timezone("string")
.unitPrefix("string")
.minimumResolution(0)
.build());
time_chart_resource = signalfx.TimeChart("timeChartResource",
program_text="string",
max_delay=0,
axis_right=signalfx.TimeChartAxisRightArgs(
high_watermark=0,
high_watermark_label="string",
label="string",
low_watermark=0,
low_watermark_label="string",
max_value=0,
min_value=0,
watermarks=[signalfx.TimeChartAxisRightWatermarkArgs(
value=0,
label="string",
)],
),
name="string",
on_chart_legend_dimension="string",
description="string",
disable_sampling=False,
end_time=0,
event_options=[signalfx.TimeChartEventOptionArgs(
label="string",
color="string",
display_name="string",
)],
histogram_options=[signalfx.TimeChartHistogramOptionArgs(
color_theme="string",
)],
legend_options_fields=[signalfx.TimeChartLegendOptionsFieldArgs(
property="string",
enabled=False,
)],
axes_include_zero=False,
viz_options=[signalfx.TimeChartVizOptionArgs(
label="string",
axis="string",
color="string",
display_name="string",
plot_type="string",
value_prefix="string",
value_suffix="string",
value_unit="string",
)],
axis_left=signalfx.TimeChartAxisLeftArgs(
high_watermark=0,
high_watermark_label="string",
label="string",
low_watermark=0,
low_watermark_label="string",
max_value=0,
min_value=0,
watermarks=[signalfx.TimeChartAxisLeftWatermarkArgs(
value=0,
label="string",
)],
),
color_by="string",
plot_type="string",
axes_precision=0,
show_data_markers=False,
show_event_lines=False,
stacked=False,
start_time=0,
time_range=0,
timezone="string",
unit_prefix="string",
minimum_resolution=0)
const timeChartResource = new signalfx.TimeChart("timeChartResource", {
programText: "string",
maxDelay: 0,
axisRight: {
highWatermark: 0,
highWatermarkLabel: "string",
label: "string",
lowWatermark: 0,
lowWatermarkLabel: "string",
maxValue: 0,
minValue: 0,
watermarks: [{
value: 0,
label: "string",
}],
},
name: "string",
onChartLegendDimension: "string",
description: "string",
disableSampling: false,
endTime: 0,
eventOptions: [{
label: "string",
color: "string",
displayName: "string",
}],
histogramOptions: [{
colorTheme: "string",
}],
legendOptionsFields: [{
property: "string",
enabled: false,
}],
axesIncludeZero: false,
vizOptions: [{
label: "string",
axis: "string",
color: "string",
displayName: "string",
plotType: "string",
valuePrefix: "string",
valueSuffix: "string",
valueUnit: "string",
}],
axisLeft: {
highWatermark: 0,
highWatermarkLabel: "string",
label: "string",
lowWatermark: 0,
lowWatermarkLabel: "string",
maxValue: 0,
minValue: 0,
watermarks: [{
value: 0,
label: "string",
}],
},
colorBy: "string",
plotType: "string",
axesPrecision: 0,
showDataMarkers: false,
showEventLines: false,
stacked: false,
startTime: 0,
timeRange: 0,
timezone: "string",
unitPrefix: "string",
minimumResolution: 0,
});
type: signalfx:TimeChart
properties:
axesIncludeZero: false
axesPrecision: 0
axisLeft:
highWatermark: 0
highWatermarkLabel: string
label: string
lowWatermark: 0
lowWatermarkLabel: string
maxValue: 0
minValue: 0
watermarks:
- label: string
value: 0
axisRight:
highWatermark: 0
highWatermarkLabel: string
label: string
lowWatermark: 0
lowWatermarkLabel: string
maxValue: 0
minValue: 0
watermarks:
- label: string
value: 0
colorBy: string
description: string
disableSampling: false
endTime: 0
eventOptions:
- color: string
displayName: string
label: string
histogramOptions:
- colorTheme: string
legendOptionsFields:
- enabled: false
property: string
maxDelay: 0
minimumResolution: 0
name: string
onChartLegendDimension: string
plotType: string
programText: string
showDataMarkers: false
showEventLines: false
stacked: false
startTime: 0
timeRange: 0
timezone: string
unitPrefix: string
vizOptions:
- axis: string
color: string
displayName: string
label: string
plotType: string
valuePrefix: string
valueSuffix: string
valueUnit: string
TimeChart Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The TimeChart resource accepts the following input properties:
- Program
Text string - Signalflow program text for the chart. More info at "https://developers.signalfx.com/docs/signalflow-overview"
- Axes
Include boolZero - Force y-axes to always show zero
- Axes
Precision int - Force a specific number of significant digits in the y-axis
- Axis
Left Pulumi.Signal Fx. Inputs. Time Chart Axis Left - Axis
Right Pulumi.Signal Fx. Inputs. Time Chart Axis Right - Color
By string - (Dimension by default) Must be "Dimension" or "Metric"
- Description string
- Description of the chart
- Disable
Sampling bool - (false by default) If false, samples a subset of the output MTS, which improves UI performance
- End
Time int - Seconds since epoch to end the visualization
- Event
Options List<Pulumi.Signal Fx. Inputs. Time Chart Event Option> - Event display customization options, associated with a publish statement
- Histogram
Options List<Pulumi.Signal Fx. Inputs. Time Chart Histogram Option> - Options specific to Histogram charts
- Legend
Fields List<string>To Hides - List of properties that shouldn't be displayed in the chart legend (i.e. dimension names)
- Legend
Options List<Pulumi.Fields Signal Fx. Inputs. Time Chart Legend Options Field> - List of property and enabled flags to control the order and presence of datatable labels in a chart.
- Max
Delay int - How long (in seconds) to wait for late datapoints
- Minimum
Resolution int - The minimum resolution (in seconds) to use for computing the underlying program
- Name string
- Name of the chart
- On
Chart stringLegend Dimension - Dimension to show in the on-chart legend. On-chart legend is off unless a dimension is specified. Allowed: 'metric', 'plot_label' and any dimension.
- Plot
Type string - (LineChart by default) The default plot display style for the visualization. Must be "LineChart", "AreaChart", "ColumnChart", or "Histogram"
- Show
Data boolMarkers - (false by default) Show markers (circles) for each datapoint used to draw line or area charts
- Show
Event boolLines - (false by default) Whether vertical highlight lines should be drawn in the visualizations at times when events occurred
- Stacked bool
- (false by default) Whether area and bar charts in the visualization should be stacked
- Start
Time int - Seconds since epoch to start the visualization
- List<string>
- Tags associated with the chart
- Time
Range int - Seconds to display in the visualization. This is a rolling range from the current time. Example: 3600 =
-1h
- Timezone string
- The property value is a string that denotes the geographic region associated with the time zone, (e.g. Australia/Sydney)
- Unit
Prefix string - (Metric by default) Must be "Metric" or "Binary"
- Viz
Options List<Pulumi.Signal Fx. Inputs. Time Chart Viz Option> - Plot-level customization options, associated with a publish statement
- Program
Text string - Signalflow program text for the chart. More info at "https://developers.signalfx.com/docs/signalflow-overview"
- Axes
Include boolZero - Force y-axes to always show zero
- Axes
Precision int - Force a specific number of significant digits in the y-axis
- Axis
Left TimeChart Axis Left Args - Axis
Right TimeChart Axis Right Args - Color
By string - (Dimension by default) Must be "Dimension" or "Metric"
- Description string
- Description of the chart
- Disable
Sampling bool - (false by default) If false, samples a subset of the output MTS, which improves UI performance
- End
Time int - Seconds since epoch to end the visualization
- Event
Options []TimeChart Event Option Args - Event display customization options, associated with a publish statement
- Histogram
Options []TimeChart Histogram Option Args - Options specific to Histogram charts
- Legend
Fields []stringTo Hides - List of properties that shouldn't be displayed in the chart legend (i.e. dimension names)
- Legend
Options []TimeFields Chart Legend Options Field Args - List of property and enabled flags to control the order and presence of datatable labels in a chart.
- Max
Delay int - How long (in seconds) to wait for late datapoints
- Minimum
Resolution int - The minimum resolution (in seconds) to use for computing the underlying program
- Name string
- Name of the chart
- On
Chart stringLegend Dimension - Dimension to show in the on-chart legend. On-chart legend is off unless a dimension is specified. Allowed: 'metric', 'plot_label' and any dimension.
- Plot
Type string - (LineChart by default) The default plot display style for the visualization. Must be "LineChart", "AreaChart", "ColumnChart", or "Histogram"
- Show
Data boolMarkers - (false by default) Show markers (circles) for each datapoint used to draw line or area charts
- Show
Event boolLines - (false by default) Whether vertical highlight lines should be drawn in the visualizations at times when events occurred
- Stacked bool
- (false by default) Whether area and bar charts in the visualization should be stacked
- Start
Time int - Seconds since epoch to start the visualization
- []string
- Tags associated with the chart
- Time
Range int - Seconds to display in the visualization. This is a rolling range from the current time. Example: 3600 =
-1h
- Timezone string
- The property value is a string that denotes the geographic region associated with the time zone, (e.g. Australia/Sydney)
- Unit
Prefix string - (Metric by default) Must be "Metric" or "Binary"
- Viz
Options []TimeChart Viz Option Args - Plot-level customization options, associated with a publish statement
- program
Text String - Signalflow program text for the chart. More info at "https://developers.signalfx.com/docs/signalflow-overview"
- axes
Include BooleanZero - Force y-axes to always show zero
- axes
Precision Integer - Force a specific number of significant digits in the y-axis
- axis
Left TimeChart Axis Left - axis
Right TimeChart Axis Right - color
By String - (Dimension by default) Must be "Dimension" or "Metric"
- description String
- Description of the chart
- disable
Sampling Boolean - (false by default) If false, samples a subset of the output MTS, which improves UI performance
- end
Time Integer - Seconds since epoch to end the visualization
- event
Options List<TimeChart Event Option> - Event display customization options, associated with a publish statement
- histogram
Options List<TimeChart Histogram Option> - Options specific to Histogram charts
- legend
Fields List<String>To Hides - List of properties that shouldn't be displayed in the chart legend (i.e. dimension names)
- legend
Options List<TimeFields Chart Legend Options Field> - List of property and enabled flags to control the order and presence of datatable labels in a chart.
- max
Delay Integer - How long (in seconds) to wait for late datapoints
- minimum
Resolution Integer - The minimum resolution (in seconds) to use for computing the underlying program
- name String
- Name of the chart
- on
Chart StringLegend Dimension - Dimension to show in the on-chart legend. On-chart legend is off unless a dimension is specified. Allowed: 'metric', 'plot_label' and any dimension.
- plot
Type String - (LineChart by default) The default plot display style for the visualization. Must be "LineChart", "AreaChart", "ColumnChart", or "Histogram"
- show
Data BooleanMarkers - (false by default) Show markers (circles) for each datapoint used to draw line or area charts
- show
Event BooleanLines - (false by default) Whether vertical highlight lines should be drawn in the visualizations at times when events occurred
- stacked Boolean
- (false by default) Whether area and bar charts in the visualization should be stacked
- start
Time Integer - Seconds since epoch to start the visualization
- List<String>
- Tags associated with the chart
- time
Range Integer - Seconds to display in the visualization. This is a rolling range from the current time. Example: 3600 =
-1h
- timezone String
- The property value is a string that denotes the geographic region associated with the time zone, (e.g. Australia/Sydney)
- unit
Prefix String - (Metric by default) Must be "Metric" or "Binary"
- viz
Options List<TimeChart Viz Option> - Plot-level customization options, associated with a publish statement
- program
Text string - Signalflow program text for the chart. More info at "https://developers.signalfx.com/docs/signalflow-overview"
- axes
Include booleanZero - Force y-axes to always show zero
- axes
Precision number - Force a specific number of significant digits in the y-axis
- axis
Left TimeChart Axis Left - axis
Right TimeChart Axis Right - color
By string - (Dimension by default) Must be "Dimension" or "Metric"
- description string
- Description of the chart
- disable
Sampling boolean - (false by default) If false, samples a subset of the output MTS, which improves UI performance
- end
Time number - Seconds since epoch to end the visualization
- event
Options TimeChart Event Option[] - Event display customization options, associated with a publish statement
- histogram
Options TimeChart Histogram Option[] - Options specific to Histogram charts
- legend
Fields string[]To Hides - List of properties that shouldn't be displayed in the chart legend (i.e. dimension names)
- legend
Options TimeFields Chart Legend Options Field[] - List of property and enabled flags to control the order and presence of datatable labels in a chart.
- max
Delay number - How long (in seconds) to wait for late datapoints
- minimum
Resolution number - The minimum resolution (in seconds) to use for computing the underlying program
- name string
- Name of the chart
- on
Chart stringLegend Dimension - Dimension to show in the on-chart legend. On-chart legend is off unless a dimension is specified. Allowed: 'metric', 'plot_label' and any dimension.
- plot
Type string - (LineChart by default) The default plot display style for the visualization. Must be "LineChart", "AreaChart", "ColumnChart", or "Histogram"
- show
Data booleanMarkers - (false by default) Show markers (circles) for each datapoint used to draw line or area charts
- show
Event booleanLines - (false by default) Whether vertical highlight lines should be drawn in the visualizations at times when events occurred
- stacked boolean
- (false by default) Whether area and bar charts in the visualization should be stacked
- start
Time number - Seconds since epoch to start the visualization
- string[]
- Tags associated with the chart
- time
Range number - Seconds to display in the visualization. This is a rolling range from the current time. Example: 3600 =
-1h
- timezone string
- The property value is a string that denotes the geographic region associated with the time zone, (e.g. Australia/Sydney)
- unit
Prefix string - (Metric by default) Must be "Metric" or "Binary"
- viz
Options TimeChart Viz Option[] - Plot-level customization options, associated with a publish statement
- program_
text str - Signalflow program text for the chart. More info at "https://developers.signalfx.com/docs/signalflow-overview"
- axes_
include_ boolzero - Force y-axes to always show zero
- axes_
precision int - Force a specific number of significant digits in the y-axis
- axis_
left TimeChart Axis Left Args - axis_
right TimeChart Axis Right Args - color_
by str - (Dimension by default) Must be "Dimension" or "Metric"
- description str
- Description of the chart
- disable_
sampling bool - (false by default) If false, samples a subset of the output MTS, which improves UI performance
- end_
time int - Seconds since epoch to end the visualization
- event_
options Sequence[TimeChart Event Option Args] - Event display customization options, associated with a publish statement
- histogram_
options Sequence[TimeChart Histogram Option Args] - Options specific to Histogram charts
- legend_
fields_ Sequence[str]to_ hides - List of properties that shouldn't be displayed in the chart legend (i.e. dimension names)
- legend_
options_ Sequence[Timefields Chart Legend Options Field Args] - List of property and enabled flags to control the order and presence of datatable labels in a chart.
- max_
delay int - How long (in seconds) to wait for late datapoints
- minimum_
resolution int - The minimum resolution (in seconds) to use for computing the underlying program
- name str
- Name of the chart
- on_
chart_ strlegend_ dimension - Dimension to show in the on-chart legend. On-chart legend is off unless a dimension is specified. Allowed: 'metric', 'plot_label' and any dimension.
- plot_
type str - (LineChart by default) The default plot display style for the visualization. Must be "LineChart", "AreaChart", "ColumnChart", or "Histogram"
- show_
data_ boolmarkers - (false by default) Show markers (circles) for each datapoint used to draw line or area charts
- show_
event_ boollines - (false by default) Whether vertical highlight lines should be drawn in the visualizations at times when events occurred
- stacked bool
- (false by default) Whether area and bar charts in the visualization should be stacked
- start_
time int - Seconds since epoch to start the visualization
- Sequence[str]
- Tags associated with the chart
- time_
range int - Seconds to display in the visualization. This is a rolling range from the current time. Example: 3600 =
-1h
- timezone str
- The property value is a string that denotes the geographic region associated with the time zone, (e.g. Australia/Sydney)
- unit_
prefix str - (Metric by default) Must be "Metric" or "Binary"
- viz_
options Sequence[TimeChart Viz Option Args] - Plot-level customization options, associated with a publish statement
- program
Text String - Signalflow program text for the chart. More info at "https://developers.signalfx.com/docs/signalflow-overview"
- axes
Include BooleanZero - Force y-axes to always show zero
- axes
Precision Number - Force a specific number of significant digits in the y-axis
- axis
Left Property Map - axis
Right Property Map - color
By String - (Dimension by default) Must be "Dimension" or "Metric"
- description String
- Description of the chart
- disable
Sampling Boolean - (false by default) If false, samples a subset of the output MTS, which improves UI performance
- end
Time Number - Seconds since epoch to end the visualization
- event
Options List<Property Map> - Event display customization options, associated with a publish statement
- histogram
Options List<Property Map> - Options specific to Histogram charts
- legend
Fields List<String>To Hides - List of properties that shouldn't be displayed in the chart legend (i.e. dimension names)
- legend
Options List<Property Map>Fields - List of property and enabled flags to control the order and presence of datatable labels in a chart.
- max
Delay Number - How long (in seconds) to wait for late datapoints
- minimum
Resolution Number - The minimum resolution (in seconds) to use for computing the underlying program
- name String
- Name of the chart
- on
Chart StringLegend Dimension - Dimension to show in the on-chart legend. On-chart legend is off unless a dimension is specified. Allowed: 'metric', 'plot_label' and any dimension.
- plot
Type String - (LineChart by default) The default plot display style for the visualization. Must be "LineChart", "AreaChart", "ColumnChart", or "Histogram"
- show
Data BooleanMarkers - (false by default) Show markers (circles) for each datapoint used to draw line or area charts
- show
Event BooleanLines - (false by default) Whether vertical highlight lines should be drawn in the visualizations at times when events occurred
- stacked Boolean
- (false by default) Whether area and bar charts in the visualization should be stacked
- start
Time Number - Seconds since epoch to start the visualization
- List<String>
- Tags associated with the chart
- time
Range Number - Seconds to display in the visualization. This is a rolling range from the current time. Example: 3600 =
-1h
- timezone String
- The property value is a string that denotes the geographic region associated with the time zone, (e.g. Australia/Sydney)
- unit
Prefix String - (Metric by default) Must be "Metric" or "Binary"
- viz
Options List<Property Map> - Plot-level customization options, associated with a publish statement
Outputs
All input properties are implicitly available as output properties. Additionally, the TimeChart resource produces the following output properties:
Look up Existing TimeChart Resource
Get an existing TimeChart resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: TimeChartState, opts?: CustomResourceOptions): TimeChart
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
axes_include_zero: Optional[bool] = None,
axes_precision: Optional[int] = None,
axis_left: Optional[TimeChartAxisLeftArgs] = None,
axis_right: Optional[TimeChartAxisRightArgs] = None,
color_by: Optional[str] = None,
description: Optional[str] = None,
disable_sampling: Optional[bool] = None,
end_time: Optional[int] = None,
event_options: Optional[Sequence[TimeChartEventOptionArgs]] = None,
histogram_options: Optional[Sequence[TimeChartHistogramOptionArgs]] = None,
legend_fields_to_hides: Optional[Sequence[str]] = None,
legend_options_fields: Optional[Sequence[TimeChartLegendOptionsFieldArgs]] = None,
max_delay: Optional[int] = None,
minimum_resolution: Optional[int] = None,
name: Optional[str] = None,
on_chart_legend_dimension: Optional[str] = None,
plot_type: Optional[str] = None,
program_text: Optional[str] = None,
show_data_markers: Optional[bool] = None,
show_event_lines: Optional[bool] = None,
stacked: Optional[bool] = None,
start_time: Optional[int] = None,
tags: Optional[Sequence[str]] = None,
time_range: Optional[int] = None,
timezone: Optional[str] = None,
unit_prefix: Optional[str] = None,
url: Optional[str] = None,
viz_options: Optional[Sequence[TimeChartVizOptionArgs]] = None) -> TimeChart
func GetTimeChart(ctx *Context, name string, id IDInput, state *TimeChartState, opts ...ResourceOption) (*TimeChart, error)
public static TimeChart Get(string name, Input<string> id, TimeChartState? state, CustomResourceOptions? opts = null)
public static TimeChart get(String name, Output<String> id, TimeChartState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Axes
Include boolZero - Force y-axes to always show zero
- Axes
Precision int - Force a specific number of significant digits in the y-axis
- Axis
Left Pulumi.Signal Fx. Inputs. Time Chart Axis Left - Axis
Right Pulumi.Signal Fx. Inputs. Time Chart Axis Right - Color
By string - (Dimension by default) Must be "Dimension" or "Metric"
- Description string
- Description of the chart
- Disable
Sampling bool - (false by default) If false, samples a subset of the output MTS, which improves UI performance
- End
Time int - Seconds since epoch to end the visualization
- Event
Options List<Pulumi.Signal Fx. Inputs. Time Chart Event Option> - Event display customization options, associated with a publish statement
- Histogram
Options List<Pulumi.Signal Fx. Inputs. Time Chart Histogram Option> - Options specific to Histogram charts
- Legend
Fields List<string>To Hides - List of properties that shouldn't be displayed in the chart legend (i.e. dimension names)
- Legend
Options List<Pulumi.Fields Signal Fx. Inputs. Time Chart Legend Options Field> - List of property and enabled flags to control the order and presence of datatable labels in a chart.
- Max
Delay int - How long (in seconds) to wait for late datapoints
- Minimum
Resolution int - The minimum resolution (in seconds) to use for computing the underlying program
- Name string
- Name of the chart
- On
Chart stringLegend Dimension - Dimension to show in the on-chart legend. On-chart legend is off unless a dimension is specified. Allowed: 'metric', 'plot_label' and any dimension.
- Plot
Type string - (LineChart by default) The default plot display style for the visualization. Must be "LineChart", "AreaChart", "ColumnChart", or "Histogram"
- Program
Text string - Signalflow program text for the chart. More info at "https://developers.signalfx.com/docs/signalflow-overview"
- Show
Data boolMarkers - (false by default) Show markers (circles) for each datapoint used to draw line or area charts
- Show
Event boolLines - (false by default) Whether vertical highlight lines should be drawn in the visualizations at times when events occurred
- Stacked bool
- (false by default) Whether area and bar charts in the visualization should be stacked
- Start
Time int - Seconds since epoch to start the visualization
- List<string>
- Tags associated with the chart
- Time
Range int - Seconds to display in the visualization. This is a rolling range from the current time. Example: 3600 =
-1h
- Timezone string
- The property value is a string that denotes the geographic region associated with the time zone, (e.g. Australia/Sydney)
- Unit
Prefix string - (Metric by default) Must be "Metric" or "Binary"
- Url string
- URL of the chart
- Viz
Options List<Pulumi.Signal Fx. Inputs. Time Chart Viz Option> - Plot-level customization options, associated with a publish statement
- Axes
Include boolZero - Force y-axes to always show zero
- Axes
Precision int - Force a specific number of significant digits in the y-axis
- Axis
Left TimeChart Axis Left Args - Axis
Right TimeChart Axis Right Args - Color
By string - (Dimension by default) Must be "Dimension" or "Metric"
- Description string
- Description of the chart
- Disable
Sampling bool - (false by default) If false, samples a subset of the output MTS, which improves UI performance
- End
Time int - Seconds since epoch to end the visualization
- Event
Options []TimeChart Event Option Args - Event display customization options, associated with a publish statement
- Histogram
Options []TimeChart Histogram Option Args - Options specific to Histogram charts
- Legend
Fields []stringTo Hides - List of properties that shouldn't be displayed in the chart legend (i.e. dimension names)
- Legend
Options []TimeFields Chart Legend Options Field Args - List of property and enabled flags to control the order and presence of datatable labels in a chart.
- Max
Delay int - How long (in seconds) to wait for late datapoints
- Minimum
Resolution int - The minimum resolution (in seconds) to use for computing the underlying program
- Name string
- Name of the chart
- On
Chart stringLegend Dimension - Dimension to show in the on-chart legend. On-chart legend is off unless a dimension is specified. Allowed: 'metric', 'plot_label' and any dimension.
- Plot
Type string - (LineChart by default) The default plot display style for the visualization. Must be "LineChart", "AreaChart", "ColumnChart", or "Histogram"
- Program
Text string - Signalflow program text for the chart. More info at "https://developers.signalfx.com/docs/signalflow-overview"
- Show
Data boolMarkers - (false by default) Show markers (circles) for each datapoint used to draw line or area charts
- Show
Event boolLines - (false by default) Whether vertical highlight lines should be drawn in the visualizations at times when events occurred
- Stacked bool
- (false by default) Whether area and bar charts in the visualization should be stacked
- Start
Time int - Seconds since epoch to start the visualization
- []string
- Tags associated with the chart
- Time
Range int - Seconds to display in the visualization. This is a rolling range from the current time. Example: 3600 =
-1h
- Timezone string
- The property value is a string that denotes the geographic region associated with the time zone, (e.g. Australia/Sydney)
- Unit
Prefix string - (Metric by default) Must be "Metric" or "Binary"
- Url string
- URL of the chart
- Viz
Options []TimeChart Viz Option Args - Plot-level customization options, associated with a publish statement
- axes
Include BooleanZero - Force y-axes to always show zero
- axes
Precision Integer - Force a specific number of significant digits in the y-axis
- axis
Left TimeChart Axis Left - axis
Right TimeChart Axis Right - color
By String - (Dimension by default) Must be "Dimension" or "Metric"
- description String
- Description of the chart
- disable
Sampling Boolean - (false by default) If false, samples a subset of the output MTS, which improves UI performance
- end
Time Integer - Seconds since epoch to end the visualization
- event
Options List<TimeChart Event Option> - Event display customization options, associated with a publish statement
- histogram
Options List<TimeChart Histogram Option> - Options specific to Histogram charts
- legend
Fields List<String>To Hides - List of properties that shouldn't be displayed in the chart legend (i.e. dimension names)
- legend
Options List<TimeFields Chart Legend Options Field> - List of property and enabled flags to control the order and presence of datatable labels in a chart.
- max
Delay Integer - How long (in seconds) to wait for late datapoints
- minimum
Resolution Integer - The minimum resolution (in seconds) to use for computing the underlying program
- name String
- Name of the chart
- on
Chart StringLegend Dimension - Dimension to show in the on-chart legend. On-chart legend is off unless a dimension is specified. Allowed: 'metric', 'plot_label' and any dimension.
- plot
Type String - (LineChart by default) The default plot display style for the visualization. Must be "LineChart", "AreaChart", "ColumnChart", or "Histogram"
- program
Text String - Signalflow program text for the chart. More info at "https://developers.signalfx.com/docs/signalflow-overview"
- show
Data BooleanMarkers - (false by default) Show markers (circles) for each datapoint used to draw line or area charts
- show
Event BooleanLines - (false by default) Whether vertical highlight lines should be drawn in the visualizations at times when events occurred
- stacked Boolean
- (false by default) Whether area and bar charts in the visualization should be stacked
- start
Time Integer - Seconds since epoch to start the visualization
- List<String>
- Tags associated with the chart
- time
Range Integer - Seconds to display in the visualization. This is a rolling range from the current time. Example: 3600 =
-1h
- timezone String
- The property value is a string that denotes the geographic region associated with the time zone, (e.g. Australia/Sydney)
- unit
Prefix String - (Metric by default) Must be "Metric" or "Binary"
- url String
- URL of the chart
- viz
Options List<TimeChart Viz Option> - Plot-level customization options, associated with a publish statement
- axes
Include booleanZero - Force y-axes to always show zero
- axes
Precision number - Force a specific number of significant digits in the y-axis
- axis
Left TimeChart Axis Left - axis
Right TimeChart Axis Right - color
By string - (Dimension by default) Must be "Dimension" or "Metric"
- description string
- Description of the chart
- disable
Sampling boolean - (false by default) If false, samples a subset of the output MTS, which improves UI performance
- end
Time number - Seconds since epoch to end the visualization
- event
Options TimeChart Event Option[] - Event display customization options, associated with a publish statement
- histogram
Options TimeChart Histogram Option[] - Options specific to Histogram charts
- legend
Fields string[]To Hides - List of properties that shouldn't be displayed in the chart legend (i.e. dimension names)
- legend
Options TimeFields Chart Legend Options Field[] - List of property and enabled flags to control the order and presence of datatable labels in a chart.
- max
Delay number - How long (in seconds) to wait for late datapoints
- minimum
Resolution number - The minimum resolution (in seconds) to use for computing the underlying program
- name string
- Name of the chart
- on
Chart stringLegend Dimension - Dimension to show in the on-chart legend. On-chart legend is off unless a dimension is specified. Allowed: 'metric', 'plot_label' and any dimension.
- plot
Type string - (LineChart by default) The default plot display style for the visualization. Must be "LineChart", "AreaChart", "ColumnChart", or "Histogram"
- program
Text string - Signalflow program text for the chart. More info at "https://developers.signalfx.com/docs/signalflow-overview"
- show
Data booleanMarkers - (false by default) Show markers (circles) for each datapoint used to draw line or area charts
- show
Event booleanLines - (false by default) Whether vertical highlight lines should be drawn in the visualizations at times when events occurred
- stacked boolean
- (false by default) Whether area and bar charts in the visualization should be stacked
- start
Time number - Seconds since epoch to start the visualization
- string[]
- Tags associated with the chart
- time
Range number - Seconds to display in the visualization. This is a rolling range from the current time. Example: 3600 =
-1h
- timezone string
- The property value is a string that denotes the geographic region associated with the time zone, (e.g. Australia/Sydney)
- unit
Prefix string - (Metric by default) Must be "Metric" or "Binary"
- url string
- URL of the chart
- viz
Options TimeChart Viz Option[] - Plot-level customization options, associated with a publish statement
- axes_
include_ boolzero - Force y-axes to always show zero
- axes_
precision int - Force a specific number of significant digits in the y-axis
- axis_
left TimeChart Axis Left Args - axis_
right TimeChart Axis Right Args - color_
by str - (Dimension by default) Must be "Dimension" or "Metric"
- description str
- Description of the chart
- disable_
sampling bool - (false by default) If false, samples a subset of the output MTS, which improves UI performance
- end_
time int - Seconds since epoch to end the visualization
- event_
options Sequence[TimeChart Event Option Args] - Event display customization options, associated with a publish statement
- histogram_
options Sequence[TimeChart Histogram Option Args] - Options specific to Histogram charts
- legend_
fields_ Sequence[str]to_ hides - List of properties that shouldn't be displayed in the chart legend (i.e. dimension names)
- legend_
options_ Sequence[Timefields Chart Legend Options Field Args] - List of property and enabled flags to control the order and presence of datatable labels in a chart.
- max_
delay int - How long (in seconds) to wait for late datapoints
- minimum_
resolution int - The minimum resolution (in seconds) to use for computing the underlying program
- name str
- Name of the chart
- on_
chart_ strlegend_ dimension - Dimension to show in the on-chart legend. On-chart legend is off unless a dimension is specified. Allowed: 'metric', 'plot_label' and any dimension.
- plot_
type str - (LineChart by default) The default plot display style for the visualization. Must be "LineChart", "AreaChart", "ColumnChart", or "Histogram"
- program_
text str - Signalflow program text for the chart. More info at "https://developers.signalfx.com/docs/signalflow-overview"
- show_
data_ boolmarkers - (false by default) Show markers (circles) for each datapoint used to draw line or area charts
- show_
event_ boollines - (false by default) Whether vertical highlight lines should be drawn in the visualizations at times when events occurred
- stacked bool
- (false by default) Whether area and bar charts in the visualization should be stacked
- start_
time int - Seconds since epoch to start the visualization
- Sequence[str]
- Tags associated with the chart
- time_
range int - Seconds to display in the visualization. This is a rolling range from the current time. Example: 3600 =
-1h
- timezone str
- The property value is a string that denotes the geographic region associated with the time zone, (e.g. Australia/Sydney)
- unit_
prefix str - (Metric by default) Must be "Metric" or "Binary"
- url str
- URL of the chart
- viz_
options Sequence[TimeChart Viz Option Args] - Plot-level customization options, associated with a publish statement
- axes
Include BooleanZero - Force y-axes to always show zero
- axes
Precision Number - Force a specific number of significant digits in the y-axis
- axis
Left Property Map - axis
Right Property Map - color
By String - (Dimension by default) Must be "Dimension" or "Metric"
- description String
- Description of the chart
- disable
Sampling Boolean - (false by default) If false, samples a subset of the output MTS, which improves UI performance
- end
Time Number - Seconds since epoch to end the visualization
- event
Options List<Property Map> - Event display customization options, associated with a publish statement
- histogram
Options List<Property Map> - Options specific to Histogram charts
- legend
Fields List<String>To Hides - List of properties that shouldn't be displayed in the chart legend (i.e. dimension names)
- legend
Options List<Property Map>Fields - List of property and enabled flags to control the order and presence of datatable labels in a chart.
- max
Delay Number - How long (in seconds) to wait for late datapoints
- minimum
Resolution Number - The minimum resolution (in seconds) to use for computing the underlying program
- name String
- Name of the chart
- on
Chart StringLegend Dimension - Dimension to show in the on-chart legend. On-chart legend is off unless a dimension is specified. Allowed: 'metric', 'plot_label' and any dimension.
- plot
Type String - (LineChart by default) The default plot display style for the visualization. Must be "LineChart", "AreaChart", "ColumnChart", or "Histogram"
- program
Text String - Signalflow program text for the chart. More info at "https://developers.signalfx.com/docs/signalflow-overview"
- show
Data BooleanMarkers - (false by default) Show markers (circles) for each datapoint used to draw line or area charts
- show
Event BooleanLines - (false by default) Whether vertical highlight lines should be drawn in the visualizations at times when events occurred
- stacked Boolean
- (false by default) Whether area and bar charts in the visualization should be stacked
- start
Time Number - Seconds since epoch to start the visualization
- List<String>
- Tags associated with the chart
- time
Range Number - Seconds to display in the visualization. This is a rolling range from the current time. Example: 3600 =
-1h
- timezone String
- The property value is a string that denotes the geographic region associated with the time zone, (e.g. Australia/Sydney)
- unit
Prefix String - (Metric by default) Must be "Metric" or "Binary"
- url String
- URL of the chart
- viz
Options List<Property Map> - Plot-level customization options, associated with a publish statement
Supporting Types
TimeChartAxisLeft, TimeChartAxisLeftArgs
- High
Watermark double - A line to draw as a high watermark
- High
Watermark stringLabel - A label to attach to the high watermark line
- Label string
- Label of the left axis
- Low
Watermark double - A line to draw as a low watermark
- Low
Watermark stringLabel - A label to attach to the low watermark line
- Max
Value double - The maximum value for the left axis
- Min
Value double - The minimum value for the left axis
- Watermarks
List<Pulumi.
Signal Fx. Inputs. Time Chart Axis Left Watermark>
- High
Watermark float64 - A line to draw as a high watermark
- High
Watermark stringLabel - A label to attach to the high watermark line
- Label string
- Label of the left axis
- Low
Watermark float64 - A line to draw as a low watermark
- Low
Watermark stringLabel - A label to attach to the low watermark line
- Max
Value float64 - The maximum value for the left axis
- Min
Value float64 - The minimum value for the left axis
- Watermarks
[]Time
Chart Axis Left Watermark
- high
Watermark Double - A line to draw as a high watermark
- high
Watermark StringLabel - A label to attach to the high watermark line
- label String
- Label of the left axis
- low
Watermark Double - A line to draw as a low watermark
- low
Watermark StringLabel - A label to attach to the low watermark line
- max
Value Double - The maximum value for the left axis
- min
Value Double - The minimum value for the left axis
- watermarks
List<Time
Chart Axis Left Watermark>
- high
Watermark number - A line to draw as a high watermark
- high
Watermark stringLabel - A label to attach to the high watermark line
- label string
- Label of the left axis
- low
Watermark number - A line to draw as a low watermark
- low
Watermark stringLabel - A label to attach to the low watermark line
- max
Value number - The maximum value for the left axis
- min
Value number - The minimum value for the left axis
- watermarks
Time
Chart Axis Left Watermark[]
- high_
watermark float - A line to draw as a high watermark
- high_
watermark_ strlabel - A label to attach to the high watermark line
- label str
- Label of the left axis
- low_
watermark float - A line to draw as a low watermark
- low_
watermark_ strlabel - A label to attach to the low watermark line
- max_
value float - The maximum value for the left axis
- min_
value float - The minimum value for the left axis
- watermarks
Sequence[Time
Chart Axis Left Watermark]
- high
Watermark Number - A line to draw as a high watermark
- high
Watermark StringLabel - A label to attach to the high watermark line
- label String
- Label of the left axis
- low
Watermark Number - A line to draw as a low watermark
- low
Watermark StringLabel - A label to attach to the low watermark line
- max
Value Number - The maximum value for the left axis
- min
Value Number - The minimum value for the left axis
- watermarks List<Property Map>
TimeChartAxisLeftWatermark, TimeChartAxisLeftWatermarkArgs
TimeChartAxisRight, TimeChartAxisRightArgs
- High
Watermark double - A line to draw as a high watermark
- High
Watermark stringLabel - A label to attach to the high watermark line
- Label string
- Label of the right axis
- Low
Watermark double - A line to draw as a low watermark
- Low
Watermark stringLabel - A label to attach to the low watermark line
- Max
Value double - The maximum value for the right axis
- Min
Value double - The minimum value for the right axis
- Watermarks
List<Pulumi.
Signal Fx. Inputs. Time Chart Axis Right Watermark>
- High
Watermark float64 - A line to draw as a high watermark
- High
Watermark stringLabel - A label to attach to the high watermark line
- Label string
- Label of the right axis
- Low
Watermark float64 - A line to draw as a low watermark
- Low
Watermark stringLabel - A label to attach to the low watermark line
- Max
Value float64 - The maximum value for the right axis
- Min
Value float64 - The minimum value for the right axis
- Watermarks
[]Time
Chart Axis Right Watermark
- high
Watermark Double - A line to draw as a high watermark
- high
Watermark StringLabel - A label to attach to the high watermark line
- label String
- Label of the right axis
- low
Watermark Double - A line to draw as a low watermark
- low
Watermark StringLabel - A label to attach to the low watermark line
- max
Value Double - The maximum value for the right axis
- min
Value Double - The minimum value for the right axis
- watermarks
List<Time
Chart Axis Right Watermark>
- high
Watermark number - A line to draw as a high watermark
- high
Watermark stringLabel - A label to attach to the high watermark line
- label string
- Label of the right axis
- low
Watermark number - A line to draw as a low watermark
- low
Watermark stringLabel - A label to attach to the low watermark line
- max
Value number - The maximum value for the right axis
- min
Value number - The minimum value for the right axis
- watermarks
Time
Chart Axis Right Watermark[]
- high_
watermark float - A line to draw as a high watermark
- high_
watermark_ strlabel - A label to attach to the high watermark line
- label str
- Label of the right axis
- low_
watermark float - A line to draw as a low watermark
- low_
watermark_ strlabel - A label to attach to the low watermark line
- max_
value float - The maximum value for the right axis
- min_
value float - The minimum value for the right axis
- watermarks
Sequence[Time
Chart Axis Right Watermark]
- high
Watermark Number - A line to draw as a high watermark
- high
Watermark StringLabel - A label to attach to the high watermark line
- label String
- Label of the right axis
- low
Watermark Number - A line to draw as a low watermark
- low
Watermark StringLabel - A label to attach to the low watermark line
- max
Value Number - The maximum value for the right axis
- min
Value Number - The minimum value for the right axis
- watermarks List<Property Map>
TimeChartAxisRightWatermark, TimeChartAxisRightWatermarkArgs
TimeChartEventOption, TimeChartEventOptionArgs
- Label string
- The label used in the publish statement that displays the events you want to customize
- Color string
- Color to use
- Display
Name string - Specifies an alternate value for the Plot Name column of the Data Table associated with the chart.
- Label string
- The label used in the publish statement that displays the events you want to customize
- Color string
- Color to use
- Display
Name string - Specifies an alternate value for the Plot Name column of the Data Table associated with the chart.
- label String
- The label used in the publish statement that displays the events you want to customize
- color String
- Color to use
- display
Name String - Specifies an alternate value for the Plot Name column of the Data Table associated with the chart.
- label string
- The label used in the publish statement that displays the events you want to customize
- color string
- Color to use
- display
Name string - Specifies an alternate value for the Plot Name column of the Data Table associated with the chart.
- label str
- The label used in the publish statement that displays the events you want to customize
- color str
- Color to use
- display_
name str - Specifies an alternate value for the Plot Name column of the Data Table associated with the chart.
- label String
- The label used in the publish statement that displays the events you want to customize
- color String
- Color to use
- display
Name String - Specifies an alternate value for the Plot Name column of the Data Table associated with the chart.
TimeChartHistogramOption, TimeChartHistogramOptionArgs
- Color
Theme string - Base color theme to use for the graph.
- Color
Theme string - Base color theme to use for the graph.
- color
Theme String - Base color theme to use for the graph.
- color
Theme string - Base color theme to use for the graph.
- color_
theme str - Base color theme to use for the graph.
- color
Theme String - Base color theme to use for the graph.
TimeChartLegendOptionsField, TimeChartLegendOptionsFieldArgs
TimeChartVizOption, TimeChartVizOptionArgs
- Label string
- The label used in the publish statement that displays the plot (metric time series data) you want to customize
- Axis string
- The Y-axis associated with values for this plot. Must be either "right" or "left". Defaults to "left".
- Color string
- Color to use
- Display
Name string - Specifies an alternate value for the Plot Name column of the Data Table associated with the chart.
- Plot
Type string - (Chart plot_type by default) The visualization style to use. Must be "LineChart", "AreaChart", "ColumnChart", or "Histogram"
- Value
Prefix string - An arbitrary prefix to display with the value of this plot
- Value
Suffix string - An arbitrary suffix to display with the value of this plot
- Value
Unit string - A unit to attach to this plot. Units support automatic scaling (eg thousands of bytes will be displayed as kilobytes)
- Label string
- The label used in the publish statement that displays the plot (metric time series data) you want to customize
- Axis string
- The Y-axis associated with values for this plot. Must be either "right" or "left". Defaults to "left".
- Color string
- Color to use
- Display
Name string - Specifies an alternate value for the Plot Name column of the Data Table associated with the chart.
- Plot
Type string - (Chart plot_type by default) The visualization style to use. Must be "LineChart", "AreaChart", "ColumnChart", or "Histogram"
- Value
Prefix string - An arbitrary prefix to display with the value of this plot
- Value
Suffix string - An arbitrary suffix to display with the value of this plot
- Value
Unit string - A unit to attach to this plot. Units support automatic scaling (eg thousands of bytes will be displayed as kilobytes)
- label String
- The label used in the publish statement that displays the plot (metric time series data) you want to customize
- axis String
- The Y-axis associated with values for this plot. Must be either "right" or "left". Defaults to "left".
- color String
- Color to use
- display
Name String - Specifies an alternate value for the Plot Name column of the Data Table associated with the chart.
- plot
Type String - (Chart plot_type by default) The visualization style to use. Must be "LineChart", "AreaChart", "ColumnChart", or "Histogram"
- value
Prefix String - An arbitrary prefix to display with the value of this plot
- value
Suffix String - An arbitrary suffix to display with the value of this plot
- value
Unit String - A unit to attach to this plot. Units support automatic scaling (eg thousands of bytes will be displayed as kilobytes)
- label string
- The label used in the publish statement that displays the plot (metric time series data) you want to customize
- axis string
- The Y-axis associated with values for this plot. Must be either "right" or "left". Defaults to "left".
- color string
- Color to use
- display
Name string - Specifies an alternate value for the Plot Name column of the Data Table associated with the chart.
- plot
Type string - (Chart plot_type by default) The visualization style to use. Must be "LineChart", "AreaChart", "ColumnChart", or "Histogram"
- value
Prefix string - An arbitrary prefix to display with the value of this plot
- value
Suffix string - An arbitrary suffix to display with the value of this plot
- value
Unit string - A unit to attach to this plot. Units support automatic scaling (eg thousands of bytes will be displayed as kilobytes)
- label str
- The label used in the publish statement that displays the plot (metric time series data) you want to customize
- axis str
- The Y-axis associated with values for this plot. Must be either "right" or "left". Defaults to "left".
- color str
- Color to use
- display_
name str - Specifies an alternate value for the Plot Name column of the Data Table associated with the chart.
- plot_
type str - (Chart plot_type by default) The visualization style to use. Must be "LineChart", "AreaChart", "ColumnChart", or "Histogram"
- value_
prefix str - An arbitrary prefix to display with the value of this plot
- value_
suffix str - An arbitrary suffix to display with the value of this plot
- value_
unit str - A unit to attach to this plot. Units support automatic scaling (eg thousands of bytes will be displayed as kilobytes)
- label String
- The label used in the publish statement that displays the plot (metric time series data) you want to customize
- axis String
- The Y-axis associated with values for this plot. Must be either "right" or "left". Defaults to "left".
- color String
- Color to use
- display
Name String - Specifies an alternate value for the Plot Name column of the Data Table associated with the chart.
- plot
Type String - (Chart plot_type by default) The visualization style to use. Must be "LineChart", "AreaChart", "ColumnChart", or "Histogram"
- value
Prefix String - An arbitrary prefix to display with the value of this plot
- value
Suffix String - An arbitrary suffix to display with the value of this plot
- value
Unit String - A unit to attach to this plot. Units support automatic scaling (eg thousands of bytes will be displayed as kilobytes)
Package Details
- Repository
- SignalFx pulumi/pulumi-signalfx
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
signalfx
Terraform Provider.