TimeChart

Provides a SignalFx 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 Usage

using Pulumi;
using SignalFx = Pulumi.SignalFx;

class MyStack : Stack
{
    public MyStack()
    {
        var mychart0 = new SignalFx.TimeChart("mychart0", new SignalFx.TimeChartArgs
        {
            AxisLeft = new SignalFx.Inputs.TimeChartAxisLeftArgs
            {
                Label = "CPU Total Idle",
                LowWatermark = 1000,
            },
            LegendOptionsFields = 
            {
                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 SignalFx.Inputs.TimeChartVizOptionArgs
                {
                    Axis = "left",
                    Color = "orange",
                    Label = "CPU Idle",
                },
            },
        });
    }

}

Coming soon!

import pulumi
import pulumi_signalfx as signalfx

mychart0 = signalfx.TimeChart("mychart0",
    axis_left={
        "label": "CPU Total Idle",
        "lowWatermark": 1000,
    },
    legend_options_fields=[
        {
            "enabled": False,
            "property": "collector",
        },
        {
            "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=[{
        "axis": "left",
        "color": "orange",
        "label": "CPU Idle",
    }])

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\")\n",
    showDataMarkers: true,
    timeRange: 3600,
    vizOptions: [{
        axis: "left",
        color: "orange",
        label: "CPU Idle",
    }],
});

Create a TimeChart Resource

new TimeChart(name: string, args: TimeChartArgs, opts?: CustomResourceOptions);

def TimeChart(resource_name, opts=None, axes_include_zero=None, axes_precision=None, axis_left=None, axis_right=None, color_by=None, description=None, disable_sampling=None, end_time=None, event_options=None, histogram_options=None, legend_fields_to_hides=None, legend_options_fields=None, max_delay=None, minimum_resolution=None, name=None, on_chart_legend_dimension=None, plot_type=None, program_text=None, show_data_markers=None, show_event_lines=None, stacked=None, start_time=None, tags=None, time_range=None, timezone=None, unit_prefix=None, viz_options=None, __props__=None);

func NewTimeChart(ctx *Context, name string, args TimeChartArgs, opts ...ResourceOption) (*TimeChart, error)

public TimeChart(string name, TimeChartArgs args, CustomResourceOptions? opts = null)

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.
opts ResourceOptions: A bag of options that control this 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.

TimeChart Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The TimeChart resource accepts the following input properties:

ProgramText string

Signalflow program text for the chart. More info in the SignalFx docs.

AxesIncludeZero bool

Force the chart to display zero on the y-axes, even if none of the data is near zero.

AxesPrecision int

Specifies the digits SignalFx displays for values plotted on the chart. Defaults to 3.

AxisLeft Pulumi.SignalFx.Inputs.TimeChartAxisLeftArgs

Set of axis options.

AxisRight Pulumi.SignalFx.Inputs.TimeChartAxisRightArgs

Set of axis options.

ColorBy string

Must be "Dimension" or "Metric". "Dimension" by default.

Description string

Description of the chart.

DisableSampling bool

If false, samples a subset of the output MTS, which improves UI performance. false by default

EndTime int

Seconds since epoch. Used for visualization. Conflicts with time_range.

EventOptions List<Pulumi.SignalFx.Inputs.TimeChartEventOptionArgs>

Event customization options, associated with a publish statement. You will need to use this to change settings for any events(…) statements you use.

HistogramOptions List<Pulumi.SignalFx.Inputs.TimeChartHistogramOptionArgs>

Only used when plot_type is "Histogram". Histogram specific options.

LegendFieldsToHides List<string>

List of properties that should not be displayed in the chart legend (i.e. dimension names). All the properties are visible by default. Deprecated, please use legend_options_fields.

Deprecated: Please use legend_options_fields

LegendOptionsFields List<Pulumi.SignalFx.Inputs.TimeChartLegendOptionsFieldArgs>

List of property names and enabled flags that should be displayed in the data table for the chart, in the order provided. This option cannot be used with legend_fields_to_hide.

MaxDelay int

How long (in seconds) to wait for late datapoints.

MinimumResolution int

The minimum resolution (in seconds) to use for computing the underlying program.

Name string

Name of the chart.

OnChartLegendDimension string

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.

PlotType string

The visualization style to use. Must be "LineChart", "AreaChart", "ColumnChart", or "Histogram". Chart level plot_type by default.

ShowDataMarkers bool

Show markers (circles) for each datapoint used to draw line or area charts. false by default.

ShowEventLines bool

Whether vertical highlight lines should be drawn in the visualizations at times when events occurred. false by default.

Stacked bool

Whether area and bar charts in the visualization should be stacked. false by default.

StartTime int

Seconds since epoch. Used for visualization. Conflicts with time_range.

Tags List<string>

Tags associated with the chart

Deprecated: signalfx_time_chart.tags is being removed in the next release

TimeRange int

How many seconds ago from which to display data. For example, the last hour would be 3600, etc. Conflicts with start_time and end_time.

Timezone string

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.

UnitPrefix string

Must be "Metric" or "Binary”. "Metric" by default.

VizOptions List<Pulumi.SignalFx.Inputs.TimeChartVizOptionArgs>

Plot-level customization options, associated with a publish statement.

ProgramText string

Signalflow program text for the chart. More info in the SignalFx docs.

AxesIncludeZero bool

Force the chart to display zero on the y-axes, even if none of the data is near zero.

AxesPrecision int

Specifies the digits SignalFx displays for values plotted on the chart. Defaults to 3.

AxisLeft TimeChartAxisLeft

Set of axis options.

AxisRight TimeChartAxisRight

Set of axis options.

ColorBy string

Must be "Dimension" or "Metric". "Dimension" by default.

Description string

Description of the chart.

DisableSampling bool

If false, samples a subset of the output MTS, which improves UI performance. false by default

EndTime int

Seconds since epoch. Used for visualization. Conflicts with time_range.

EventOptions []TimeChartEventOption

Event customization options, associated with a publish statement. You will need to use this to change settings for any events(…) statements you use.

HistogramOptions []TimeChartHistogramOption

Only used when plot_type is "Histogram". Histogram specific options.

LegendFieldsToHides []string

List of properties that should not be displayed in the chart legend (i.e. dimension names). All the properties are visible by default. Deprecated, please use legend_options_fields.

Deprecated: Please use legend_options_fields

LegendOptionsFields []TimeChartLegendOptionsField

List of property names and enabled flags that should be displayed in the data table for the chart, in the order provided. This option cannot be used with legend_fields_to_hide.

MaxDelay int

How long (in seconds) to wait for late datapoints.

MinimumResolution int

The minimum resolution (in seconds) to use for computing the underlying program.

Name string

Name of the chart.

OnChartLegendDimension string

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.

PlotType string

The visualization style to use. Must be "LineChart", "AreaChart", "ColumnChart", or "Histogram". Chart level plot_type by default.

ShowDataMarkers bool

Show markers (circles) for each datapoint used to draw line or area charts. false by default.

ShowEventLines bool

Whether vertical highlight lines should be drawn in the visualizations at times when events occurred. false by default.

Stacked bool

Whether area and bar charts in the visualization should be stacked. false by default.

StartTime int

Seconds since epoch. Used for visualization. Conflicts with time_range.

Tags []string

Tags associated with the chart

Deprecated: signalfx_time_chart.tags is being removed in the next release

TimeRange int

How many seconds ago from which to display data. For example, the last hour would be 3600, etc. Conflicts with start_time and end_time.

Timezone string

UnitPrefix string

Must be "Metric" or "Binary”. "Metric" by default.

VizOptions []TimeChartVizOption

Plot-level customization options, associated with a publish statement.

programText string

Signalflow program text for the chart. More info in the SignalFx docs.

axesIncludeZero boolean

Force the chart to display zero on the y-axes, even if none of the data is near zero.

axesPrecision number

Specifies the digits SignalFx displays for values plotted on the chart. Defaults to 3.

axisLeft TimeChartAxisLeft

Set of axis options.

axisRight TimeChartAxisRight

Set of axis options.

colorBy string

Must be "Dimension" or "Metric". "Dimension" by default.

description string

Description of the chart.

disableSampling boolean

If false, samples a subset of the output MTS, which improves UI performance. false by default

endTime number

Seconds since epoch. Used for visualization. Conflicts with time_range.

eventOptions TimeChartEventOption[]

Event customization options, associated with a publish statement. You will need to use this to change settings for any events(…) statements you use.

histogramOptions TimeChartHistogramOption[]

Only used when plot_type is "Histogram". Histogram specific options.

legendFieldsToHides string[]

List of properties that should not be displayed in the chart legend (i.e. dimension names). All the properties are visible by default. Deprecated, please use legend_options_fields.

Deprecated: Please use legend_options_fields

legendOptionsFields TimeChartLegendOptionsField[]

List of property names and enabled flags that should be displayed in the data table for the chart, in the order provided. This option cannot be used with legend_fields_to_hide.

maxDelay number

How long (in seconds) to wait for late datapoints.

minimumResolution number

The minimum resolution (in seconds) to use for computing the underlying program.

name string

Name of the chart.

onChartLegendDimension string

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.

plotType string

The visualization style to use. Must be "LineChart", "AreaChart", "ColumnChart", or "Histogram". Chart level plot_type by default.

showDataMarkers boolean

Show markers (circles) for each datapoint used to draw line or area charts. false by default.

showEventLines boolean

Whether vertical highlight lines should be drawn in the visualizations at times when events occurred. false by default.

stacked boolean

Whether area and bar charts in the visualization should be stacked. false by default.

startTime number

Seconds since epoch. Used for visualization. Conflicts with time_range.

tags string[]

Tags associated with the chart

Deprecated: signalfx_time_chart.tags is being removed in the next release

timeRange number

How many seconds ago from which to display data. For example, the last hour would be 3600, etc. Conflicts with start_time and end_time.

timezone string

unitPrefix string

Must be "Metric" or "Binary”. "Metric" by default.

vizOptions TimeChartVizOption[]

Plot-level customization options, associated with a publish statement.

program_text str

Signalflow program text for the chart. More info in the SignalFx docs.

axes_include_zero bool

Force the chart to display zero on the y-axes, even if none of the data is near zero.

axes_precision float

Specifies the digits SignalFx displays for values plotted on the chart. Defaults to 3.

axis_left Dict[TimeChartAxisLeft]

Set of axis options.

axis_right Dict[TimeChartAxisRight]

Set of axis options.

color_by str

Must be "Dimension" or "Metric". "Dimension" by default.

description str

Description of the chart.

disable_sampling bool

If false, samples a subset of the output MTS, which improves UI performance. false by default

end_time float

Seconds since epoch. Used for visualization. Conflicts with time_range.

event_options List[TimeChartEventOption]

Event customization options, associated with a publish statement. You will need to use this to change settings for any events(…) statements you use.

histogram_options List[TimeChartHistogramOption]

Only used when plot_type is "Histogram". Histogram specific options.

legend_fields_to_hides List[str]

List of properties that should not be displayed in the chart legend (i.e. dimension names). All the properties are visible by default. Deprecated, please use legend_options_fields.

Deprecated: Please use legend_options_fields

legend_options_fields List[TimeChartLegendOptionsField]

List of property names and enabled flags that should be displayed in the data table for the chart, in the order provided. This option cannot be used with legend_fields_to_hide.

max_delay float

How long (in seconds) to wait for late datapoints.

minimum_resolution float

The minimum resolution (in seconds) to use for computing the underlying program.

name str

Name of the chart.

on_chart_legend_dimension str

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.

plot_type str

The visualization style to use. Must be "LineChart", "AreaChart", "ColumnChart", or "Histogram". Chart level plot_type by default.

show_data_markers bool

Show markers (circles) for each datapoint used to draw line or area charts. false by default.

show_event_lines bool

Whether vertical highlight lines should be drawn in the visualizations at times when events occurred. false by default.

stacked bool

Whether area and bar charts in the visualization should be stacked. false by default.

start_time float

Seconds since epoch. Used for visualization. Conflicts with time_range.

tags List[str]

Tags associated with the chart

Deprecated: signalfx_time_chart.tags is being removed in the next release

time_range float

How many seconds ago from which to display data. For example, the last hour would be 3600, etc. Conflicts with start_time and end_time.

timezone str

unit_prefix str

Must be "Metric" or "Binary”. "Metric" by default.

viz_options List[TimeChartVizOption]

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:

Id string: The provider-assigned unique ID for this managed resource.
Url string: URL of the chart

Id string: The provider-assigned unique ID for this managed resource.
Url string: URL of the chart

id string: The provider-assigned unique ID for this managed resource.
url string: URL of the chart

id str: The provider-assigned unique ID for this managed resource.
url str: URL of the chart

Look up an 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

static get(resource_name, id, opts=None, axes_include_zero=None, axes_precision=None, axis_left=None, axis_right=None, color_by=None, description=None, disable_sampling=None, end_time=None, event_options=None, histogram_options=None, legend_fields_to_hides=None, legend_options_fields=None, max_delay=None, minimum_resolution=None, name=None, on_chart_legend_dimension=None, plot_type=None, program_text=None, show_data_markers=None, show_event_lines=None, stacked=None, start_time=None, tags=None, time_range=None, timezone=None, unit_prefix=None, url=None, viz_options=None, __props__=None);

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)

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.

The following state arguments are supported:

AxesIncludeZero bool

Force the chart to display zero on the y-axes, even if none of the data is near zero.

AxesPrecision int

Specifies the digits SignalFx displays for values plotted on the chart. Defaults to 3.

AxisLeft Pulumi.SignalFx.Inputs.TimeChartAxisLeftArgs

Set of axis options.

AxisRight Pulumi.SignalFx.Inputs.TimeChartAxisRightArgs

Set of axis options.

ColorBy string

Must be "Dimension" or "Metric". "Dimension" by default.

Description string

Description of the chart.

DisableSampling bool

If false, samples a subset of the output MTS, which improves UI performance. false by default

EndTime int

Seconds since epoch. Used for visualization. Conflicts with time_range.

EventOptions List<Pulumi.SignalFx.Inputs.TimeChartEventOptionArgs>

Event customization options, associated with a publish statement. You will need to use this to change settings for any events(…) statements you use.

HistogramOptions List<Pulumi.SignalFx.Inputs.TimeChartHistogramOptionArgs>

Only used when plot_type is "Histogram". Histogram specific options.

LegendFieldsToHides List<string>

List of properties that should not be displayed in the chart legend (i.e. dimension names). All the properties are visible by default. Deprecated, please use legend_options_fields.

Deprecated: Please use legend_options_fields

LegendOptionsFields List<Pulumi.SignalFx.Inputs.TimeChartLegendOptionsFieldArgs>

List of property names and enabled flags that should be displayed in the data table for the chart, in the order provided. This option cannot be used with legend_fields_to_hide.

MaxDelay int

How long (in seconds) to wait for late datapoints.

MinimumResolution int

The minimum resolution (in seconds) to use for computing the underlying program.

Name string

Name of the chart.

OnChartLegendDimension string

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.

PlotType string

The visualization style to use. Must be "LineChart", "AreaChart", "ColumnChart", or "Histogram". Chart level plot_type by default.

ProgramText string

Signalflow program text for the chart. More info in the SignalFx docs.

ShowDataMarkers bool

Show markers (circles) for each datapoint used to draw line or area charts. false by default.

ShowEventLines bool

Whether vertical highlight lines should be drawn in the visualizations at times when events occurred. false by default.

Stacked bool

Whether area and bar charts in the visualization should be stacked. false by default.

StartTime int

Seconds since epoch. Used for visualization. Conflicts with time_range.

Tags List<string>

Tags associated with the chart

Deprecated: signalfx_time_chart.tags is being removed in the next release

TimeRange int

How many seconds ago from which to display data. For example, the last hour would be 3600, etc. Conflicts with start_time and end_time.

Timezone string

UnitPrefix string

Must be "Metric" or "Binary”. "Metric" by default.

Url string

URL of the chart

VizOptions List<Pulumi.SignalFx.Inputs.TimeChartVizOptionArgs>

Plot-level customization options, associated with a publish statement.

AxesIncludeZero bool

Force the chart to display zero on the y-axes, even if none of the data is near zero.

AxesPrecision int

Specifies the digits SignalFx displays for values plotted on the chart. Defaults to 3.

AxisLeft TimeChartAxisLeft

Set of axis options.

AxisRight TimeChartAxisRight

Set of axis options.

ColorBy string

Must be "Dimension" or "Metric". "Dimension" by default.

Description string

Description of the chart.

DisableSampling bool

If false, samples a subset of the output MTS, which improves UI performance. false by default

EndTime int

Seconds since epoch. Used for visualization. Conflicts with time_range.

EventOptions []TimeChartEventOption

Event customization options, associated with a publish statement. You will need to use this to change settings for any events(…) statements you use.

HistogramOptions []TimeChartHistogramOption

Only used when plot_type is "Histogram". Histogram specific options.

LegendFieldsToHides []string

List of properties that should not be displayed in the chart legend (i.e. dimension names). All the properties are visible by default. Deprecated, please use legend_options_fields.

Deprecated: Please use legend_options_fields

LegendOptionsFields []TimeChartLegendOptionsField

List of property names and enabled flags that should be displayed in the data table for the chart, in the order provided. This option cannot be used with legend_fields_to_hide.

MaxDelay int

How long (in seconds) to wait for late datapoints.

MinimumResolution int

The minimum resolution (in seconds) to use for computing the underlying program.

Name string

Name of the chart.

OnChartLegendDimension string

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.

PlotType string

The visualization style to use. Must be "LineChart", "AreaChart", "ColumnChart", or "Histogram". Chart level plot_type by default.

ProgramText string

Signalflow program text for the chart. More info in the SignalFx docs.

ShowDataMarkers bool

Show markers (circles) for each datapoint used to draw line or area charts. false by default.

ShowEventLines bool

Whether vertical highlight lines should be drawn in the visualizations at times when events occurred. false by default.

Stacked bool

Whether area and bar charts in the visualization should be stacked. false by default.

StartTime int

Seconds since epoch. Used for visualization. Conflicts with time_range.

Tags []string

Tags associated with the chart

Deprecated: signalfx_time_chart.tags is being removed in the next release

TimeRange int

How many seconds ago from which to display data. For example, the last hour would be 3600, etc. Conflicts with start_time and end_time.

Timezone string

UnitPrefix string

Must be "Metric" or "Binary”. "Metric" by default.

Url string

URL of the chart

VizOptions []TimeChartVizOption

Plot-level customization options, associated with a publish statement.

axesIncludeZero boolean

Force the chart to display zero on the y-axes, even if none of the data is near zero.

axesPrecision number

Specifies the digits SignalFx displays for values plotted on the chart. Defaults to 3.

axisLeft TimeChartAxisLeft

Set of axis options.

axisRight TimeChartAxisRight

Set of axis options.

colorBy string

Must be "Dimension" or "Metric". "Dimension" by default.

description string

Description of the chart.

disableSampling boolean

If false, samples a subset of the output MTS, which improves UI performance. false by default

endTime number

Seconds since epoch. Used for visualization. Conflicts with time_range.

eventOptions TimeChartEventOption[]

Event customization options, associated with a publish statement. You will need to use this to change settings for any events(…) statements you use.

histogramOptions TimeChartHistogramOption[]

Only used when plot_type is "Histogram". Histogram specific options.

legendFieldsToHides string[]

List of properties that should not be displayed in the chart legend (i.e. dimension names). All the properties are visible by default. Deprecated, please use legend_options_fields.

Deprecated: Please use legend_options_fields

legendOptionsFields TimeChartLegendOptionsField[]

List of property names and enabled flags that should be displayed in the data table for the chart, in the order provided. This option cannot be used with legend_fields_to_hide.

maxDelay number

How long (in seconds) to wait for late datapoints.

minimumResolution number

The minimum resolution (in seconds) to use for computing the underlying program.

name string

Name of the chart.

onChartLegendDimension string

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.

plotType string

The visualization style to use. Must be "LineChart", "AreaChart", "ColumnChart", or "Histogram". Chart level plot_type by default.

programText string

Signalflow program text for the chart. More info in the SignalFx docs.

showDataMarkers boolean

Show markers (circles) for each datapoint used to draw line or area charts. false by default.

showEventLines boolean

Whether vertical highlight lines should be drawn in the visualizations at times when events occurred. false by default.

stacked boolean

Whether area and bar charts in the visualization should be stacked. false by default.

startTime number

Seconds since epoch. Used for visualization. Conflicts with time_range.

tags string[]

Tags associated with the chart

Deprecated: signalfx_time_chart.tags is being removed in the next release

timeRange number

How many seconds ago from which to display data. For example, the last hour would be 3600, etc. Conflicts with start_time and end_time.

timezone string

unitPrefix string

Must be "Metric" or "Binary”. "Metric" by default.

url string

URL of the chart

vizOptions TimeChartVizOption[]

Plot-level customization options, associated with a publish statement.

axes_include_zero bool

Force the chart to display zero on the y-axes, even if none of the data is near zero.

axes_precision float

Specifies the digits SignalFx displays for values plotted on the chart. Defaults to 3.

axis_left Dict[TimeChartAxisLeft]

Set of axis options.

axis_right Dict[TimeChartAxisRight]

Set of axis options.

color_by str

Must be "Dimension" or "Metric". "Dimension" by default.

description str

Description of the chart.

disable_sampling bool

If false, samples a subset of the output MTS, which improves UI performance. false by default

end_time float

Seconds since epoch. Used for visualization. Conflicts with time_range.

event_options List[TimeChartEventOption]

Event customization options, associated with a publish statement. You will need to use this to change settings for any events(…) statements you use.

histogram_options List[TimeChartHistogramOption]

Only used when plot_type is "Histogram". Histogram specific options.

legend_fields_to_hides List[str]

List of properties that should not be displayed in the chart legend (i.e. dimension names). All the properties are visible by default. Deprecated, please use legend_options_fields.

Deprecated: Please use legend_options_fields

legend_options_fields List[TimeChartLegendOptionsField]

List of property names and enabled flags that should be displayed in the data table for the chart, in the order provided. This option cannot be used with legend_fields_to_hide.

max_delay float

How long (in seconds) to wait for late datapoints.

minimum_resolution float

The minimum resolution (in seconds) to use for computing the underlying program.

name str

Name of the chart.

on_chart_legend_dimension str

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.

plot_type str

The visualization style to use. Must be "LineChart", "AreaChart", "ColumnChart", or "Histogram". Chart level plot_type by default.

program_text str

Signalflow program text for the chart. More info in the SignalFx docs.

show_data_markers bool

Show markers (circles) for each datapoint used to draw line or area charts. false by default.

show_event_lines bool

Whether vertical highlight lines should be drawn in the visualizations at times when events occurred. false by default.

stacked bool

Whether area and bar charts in the visualization should be stacked. false by default.

start_time float

Seconds since epoch. Used for visualization. Conflicts with time_range.

tags List[str]

Tags associated with the chart

Deprecated: signalfx_time_chart.tags is being removed in the next release

time_range float

How many seconds ago from which to display data. For example, the last hour would be 3600, etc. Conflicts with start_time and end_time.

timezone str

unit_prefix str

Must be "Metric" or "Binary”. "Metric" by default.

url str

URL of the chart

viz_options List[TimeChartVizOption]

Plot-level customization options, associated with a publish statement.

Supporting Types

TimeChartAxisLeft

See the input and output API doc for this type.

HighWatermark double: A line to draw as a high watermark.
HighWatermarkLabel string: A label to attach to the high watermark line.
Label string: Label used in the publish statement that displays the event query you want to customize.
LowWatermark double: A line to draw as a low watermark.
LowWatermarkLabel string: A label to attach to the low watermark line.
MaxValue double: The maximum value for the right axis.
MinValue double: The minimum value for the right axis.
Watermarks List<Pulumi.SignalFx.Inputs.TimeChartAxisLeftWatermarkArgs>

HighWatermark float64: A line to draw as a high watermark.
HighWatermarkLabel string: A label to attach to the high watermark line.
Label string: Label used in the publish statement that displays the event query you want to customize.
LowWatermark float64: A line to draw as a low watermark.
LowWatermarkLabel string: A label to attach to the low watermark line.
MaxValue float64: The maximum value for the right axis.
MinValue float64: The minimum value for the right axis.
Watermarks []TimeChartAxisLeftWatermark

highWatermark number: A line to draw as a high watermark.
highWatermarkLabel string: A label to attach to the high watermark line.
label string: Label used in the publish statement that displays the event query you want to customize.
lowWatermark number: A line to draw as a low watermark.
lowWatermarkLabel string: A label to attach to the low watermark line.
maxValue number: The maximum value for the right axis.
minValue number: The minimum value for the right axis.
watermarks TimeChartAxisLeftWatermark[]

highWatermark float: A line to draw as a high watermark.
highWatermarkLabel str: A label to attach to the high watermark line.
label str: Label used in the publish statement that displays the event query you want to customize.
lowWatermark float: A line to draw as a low watermark.
lowWatermarkLabel str: A label to attach to the low watermark line.
maxValue float: The maximum value for the right axis.
minValue float: The minimum value for the right axis.
watermarks List[TimeChartAxisLeftWatermark]

TimeChartAxisLeftWatermark

See the input and output API doc for this type.

Value double
Label string: Label used in the publish statement that displays the event query you want to customize.

Value float64
Label string: Label used in the publish statement that displays the event query you want to customize.

value number
label string: Label used in the publish statement that displays the event query you want to customize.

value float
label str: Label used in the publish statement that displays the event query you want to customize.

TimeChartAxisRight

See the input and output API doc for this type.

HighWatermark double: A line to draw as a high watermark.
HighWatermarkLabel string: A label to attach to the high watermark line.
Label string: Label used in the publish statement that displays the event query you want to customize.
LowWatermark double: A line to draw as a low watermark.
LowWatermarkLabel string: A label to attach to the low watermark line.
MaxValue double: The maximum value for the right axis.
MinValue double: The minimum value for the right axis.
Watermarks List<Pulumi.SignalFx.Inputs.TimeChartAxisRightWatermarkArgs>

HighWatermark float64: A line to draw as a high watermark.
HighWatermarkLabel string: A label to attach to the high watermark line.
Label string: Label used in the publish statement that displays the event query you want to customize.
LowWatermark float64: A line to draw as a low watermark.
LowWatermarkLabel string: A label to attach to the low watermark line.
MaxValue float64: The maximum value for the right axis.
MinValue float64: The minimum value for the right axis.
Watermarks []TimeChartAxisRightWatermark

highWatermark number: A line to draw as a high watermark.
highWatermarkLabel string: A label to attach to the high watermark line.
label string: Label used in the publish statement that displays the event query you want to customize.
lowWatermark number: A line to draw as a low watermark.
lowWatermarkLabel string: A label to attach to the low watermark line.
maxValue number: The maximum value for the right axis.
minValue number: The minimum value for the right axis.
watermarks TimeChartAxisRightWatermark[]

highWatermark float: A line to draw as a high watermark.
highWatermarkLabel str: A label to attach to the high watermark line.
label str: Label used in the publish statement that displays the event query you want to customize.
lowWatermark float: A line to draw as a low watermark.
lowWatermarkLabel str: A label to attach to the low watermark line.
maxValue float: The maximum value for the right axis.
minValue float: The minimum value for the right axis.
watermarks List[TimeChartAxisRightWatermark]

TimeChartAxisRightWatermark

See the input and output API doc for this type.

Value double
Label string: Label used in the publish statement that displays the event query you want to customize.

Value float64
Label string: Label used in the publish statement that displays the event query you want to customize.

value number
label string: Label used in the publish statement that displays the event query you want to customize.

value float
label str: Label used in the publish statement that displays the event query you want to customize.

TimeChartEventOption

See the input and output API doc for this type.

Label string: Label used in the publish statement that displays the event query you want to customize.
Color string: Color to use : gray, blue, azure, navy, brown, orange, yellow, iris, magenta, pink, purple, violet, lilac, emerald, green, aquamarine.
DisplayName string: Specifies an alternate value for the Plot Name column of the Data Table associated with the chart.

Label string: Label used in the publish statement that displays the event query you want to customize.
Color string: Color to use : gray, blue, azure, navy, brown, orange, yellow, iris, magenta, pink, purple, violet, lilac, emerald, green, aquamarine.
DisplayName string: Specifies an alternate value for the Plot Name column of the Data Table associated with the chart.

label string: Label used in the publish statement that displays the event query you want to customize.
color string: Color to use : gray, blue, azure, navy, brown, orange, yellow, iris, magenta, pink, purple, violet, lilac, emerald, green, aquamarine.
displayName string: Specifies an alternate value for the Plot Name column of the Data Table associated with the chart.

label str: Label used in the publish statement that displays the event query you want to customize.
color str: Color to use : gray, blue, azure, navy, brown, orange, yellow, iris, magenta, pink, purple, violet, lilac, emerald, green, aquamarine.
displayName str: Specifies an alternate value for the Plot Name column of the Data Table associated with the chart.

TimeChartHistogramOption

See the input and output API doc for this type.

ColorTheme string: Color to use : gray, blue, azure, navy, brown, orange, yellow, iris, magenta, pink, purple, violet, lilac, emerald, green, aquamarine, red, gold, greenyellow, chartreuse, jade

ColorTheme string: Color to use : gray, blue, azure, navy, brown, orange, yellow, iris, magenta, pink, purple, violet, lilac, emerald, green, aquamarine, red, gold, greenyellow, chartreuse, jade

colorTheme string: Color to use : gray, blue, azure, navy, brown, orange, yellow, iris, magenta, pink, purple, violet, lilac, emerald, green, aquamarine, red, gold, greenyellow, chartreuse, jade

colorTheme str: Color to use : gray, blue, azure, navy, brown, orange, yellow, iris, magenta, pink, purple, violet, lilac, emerald, green, aquamarine, red, gold, greenyellow, chartreuse, jade

TimeChartLegendOptionsField

See the input and output API doc for this type.

Property string: The name of the property to display. Note the special values of plot_label (corresponding with the API’s sf_metric) which shows the label of the time series publish() and metric (corresponding with the API’s sf_originatingMetric) that shows the name of the metric for the time series being displayed.
Enabled bool: True or False depending on if you want the property to be shown or hidden.

Property string: The name of the property to display. Note the special values of plot_label (corresponding with the API’s sf_metric) which shows the label of the time series publish() and metric (corresponding with the API’s sf_originatingMetric) that shows the name of the metric for the time series being displayed.
Enabled bool: True or False depending on if you want the property to be shown or hidden.

property string: The name of the property to display. Note the special values of plot_label (corresponding with the API’s sf_metric) which shows the label of the time series publish() and metric (corresponding with the API’s sf_originatingMetric) that shows the name of the metric for the time series being displayed.
enabled boolean: True or False depending on if you want the property to be shown or hidden.

property str: The name of the property to display. Note the special values of plot_label (corresponding with the API’s sf_metric) which shows the label of the time series publish() and metric (corresponding with the API’s sf_originatingMetric) that shows the name of the metric for the time series being displayed.
enabled bool: True or False depending on if you want the property to be shown or hidden.

TimeChartVizOption

See the input and output API doc for this type.

Label string: Label used in the publish statement that displays the event query you want to customize.
Axis string: Y-axis associated with values for this plot. Must be either right or left.
Color string: Color to use : gray, blue, azure, navy, brown, orange, yellow, iris, magenta, pink, purple, violet, lilac, emerald, green, aquamarine.
DisplayName string: Specifies an alternate value for the Plot Name column of the Data Table associated with the chart.
PlotType string: The visualization style to use. Must be "LineChart", "AreaChart", "ColumnChart", or "Histogram". Chart level plot_type by default.
ValuePrefix string
ValueSuffix string
ValueUnit string: A unit to attach to this plot. Units support automatic scaling (eg thousands of bytes will be displayed as kilobytes). Values values are Bit, Kilobit, Megabit, Gigabit, Terabit, Petabit, Exabit, Zettabit, Yottabit, Byte, Kibibyte, Mebibyte, 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.

Label string: Label used in the publish statement that displays the event query you want to customize.
Axis string: Y-axis associated with values for this plot. Must be either right or left.
Color string: Color to use : gray, blue, azure, navy, brown, orange, yellow, iris, magenta, pink, purple, violet, lilac, emerald, green, aquamarine.
DisplayName string: Specifies an alternate value for the Plot Name column of the Data Table associated with the chart.
PlotType string: The visualization style to use. Must be "LineChart", "AreaChart", "ColumnChart", or "Histogram". Chart level plot_type by default.
ValuePrefix string
ValueSuffix string
ValueUnit string: A unit to attach to this plot. Units support automatic scaling (eg thousands of bytes will be displayed as kilobytes). Values values are Bit, Kilobit, Megabit, Gigabit, Terabit, Petabit, Exabit, Zettabit, Yottabit, Byte, Kibibyte, Mebibyte, 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.

label string: Label used in the publish statement that displays the event query you want to customize.
axis string: Y-axis associated with values for this plot. Must be either right or left.
color string: Color to use : gray, blue, azure, navy, brown, orange, yellow, iris, magenta, pink, purple, violet, lilac, emerald, green, aquamarine.
displayName string: Specifies an alternate value for the Plot Name column of the Data Table associated with the chart.
plotType string: The visualization style to use. Must be "LineChart", "AreaChart", "ColumnChart", or "Histogram". Chart level plot_type by default.
valuePrefix string
valueSuffix string
valueUnit string: A unit to attach to this plot. Units support automatic scaling (eg thousands of bytes will be displayed as kilobytes). Values values are Bit, Kilobit, Megabit, Gigabit, Terabit, Petabit, Exabit, Zettabit, Yottabit, Byte, Kibibyte, Mebibyte, 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.

label str: Label used in the publish statement that displays the event query you want to customize.
axis str: Y-axis associated with values for this plot. Must be either right or left.
color str: Color to use : gray, blue, azure, navy, brown, orange, yellow, iris, magenta, pink, purple, violet, lilac, emerald, green, aquamarine.
displayName str: Specifies an alternate value for the Plot Name column of the Data Table associated with the chart.
plot_type str: The visualization style to use. Must be "LineChart", "AreaChart", "ColumnChart", or "Histogram". Chart level plot_type by default.
valuePrefix str
valueSuffix str
valueUnit str: A unit to attach to this plot. Units support automatic scaling (eg thousands of bytes will be displayed as kilobytes). Values values are Bit, Kilobit, Megabit, Gigabit, Terabit, Petabit, Exabit, Zettabit, Yottabit, Byte, Kibibyte, Mebibyte, 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.

Package Details

Repository: https://github.com/pulumi/pulumi-signalfx
License: Apache-2.0
Notes: This Pulumi package is based on the signalfx Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

TimeChart

Example Usage

Create a TimeChart Resource

TimeChart Resource Properties

Inputs

Outputs

Look up an Existing TimeChart Resource

Supporting Types

TimeChartAxisLeft

TimeChartAxisLeftWatermark

TimeChartAxisRight

TimeChartAxisRightWatermark

TimeChartEventOption

TimeChartHistogramOption

TimeChartLegendOptionsField

TimeChartVizOption

Package Details

On This Page