Ready to level-up your engineering skills? Join a Pulumi Workshop. Register Now

ListChart

This chart type displays current data values in a list format.

The name of each value in the chart reflects the name of the plot and any associated dimensions. We recommend you click the Pencil icon and give the plot a meaningful name, as in plot B below. Otherwise, just the raw metric name will be displayed on the chart, as in plot A below.

Example Usage

using Pulumi;
using SignalFx = Pulumi.SignalFx;

class MyStack : Stack
{
    public MyStack()
    {
        var mylistchart0 = new SignalFx.ListChart("mylistchart0", new SignalFx.ListChartArgs
        {
            ColorBy = "Metric",
            Description = "Very cool List Chart",
            DisableSampling = true,
            HideMissingValues = true,
            LegendOptionsFields = 
            {
                new SignalFx.Inputs.ListChartLegendOptionsFieldArgs
                {
                    Enabled = false,
                    Property = "collector",
                },
                new SignalFx.Inputs.ListChartLegendOptionsFieldArgs
                {
                    Enabled = true,
                    Property = "cluster_name",
                },
                new SignalFx.Inputs.ListChartLegendOptionsFieldArgs
                {
                    Enabled = true,
                    Property = "role",
                },
                new SignalFx.Inputs.ListChartLegendOptionsFieldArgs
                {
                    Enabled = false,
                    Property = "collector",
                },
                new SignalFx.Inputs.ListChartLegendOptionsFieldArgs
                {
                    Enabled = false,
                    Property = "host",
                },
            },
            MaxDelay = 2,
            MaxPrecision = 2,
            ProgramText = @"myfilters = filter(""cluster_name"", ""prod"") and filter(""role"", ""search"")
data(""cpu.total.idle"", filter=myfilters).publish()

",
            RefreshInterval = 1,
            SortBy = "-value",
            Timezone = "Europe/Paris",
        });
    }

}
package main

import (
    "fmt"

    "github.com/pulumi/pulumi-signalfx/sdk/v4/go/signalfx"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        _, err := signalfx.NewListChart(ctx, "mylistchart0", &signalfx.ListChartArgs{
            ColorBy:           pulumi.String("Metric"),
            Description:       pulumi.String("Very cool List Chart"),
            DisableSampling:   pulumi.Bool(true),
            HideMissingValues: pulumi.Bool(true),
            LegendOptionsFields: signalfx.ListChartLegendOptionsFieldArray{
                &signalfx.ListChartLegendOptionsFieldArgs{
                    Enabled:  pulumi.Bool(false),
                    Property: pulumi.String("collector"),
                },
                &signalfx.ListChartLegendOptionsFieldArgs{
                    Enabled:  pulumi.Bool(true),
                    Property: pulumi.String("cluster_name"),
                },
                &signalfx.ListChartLegendOptionsFieldArgs{
                    Enabled:  pulumi.Bool(true),
                    Property: pulumi.String("role"),
                },
                &signalfx.ListChartLegendOptionsFieldArgs{
                    Enabled:  pulumi.Bool(false),
                    Property: pulumi.String("collector"),
                },
                &signalfx.ListChartLegendOptionsFieldArgs{
                    Enabled:  pulumi.Bool(false),
                    Property: pulumi.String("host"),
                },
            },
            MaxDelay:        pulumi.Int(2),
            MaxPrecision:    pulumi.Int(2),
            ProgramText:     pulumi.String(fmt.Sprintf("%v%v%v", "myfilters = filter(\"cluster_name\", \"prod\") and filter(\"role\", \"search\")\n", "data(\"cpu.total.idle\", filter=myfilters).publish()\n", "\n")),
            RefreshInterval: pulumi.Int(1),
            SortBy:          pulumi.String("-value"),
            Timezone:        pulumi.String("Europe/Paris"),
        })
        if err != nil {
            return err
        }
        return nil
    })
}
import pulumi
import pulumi_signalfx as signalfx

mylistchart0 = signalfx.ListChart("mylistchart0",
    color_by="Metric",
    description="Very cool List Chart",
    disable_sampling=True,
    hide_missing_values=True,
    legend_options_fields=[
        signalfx.ListChartLegendOptionsFieldArgs(
            enabled=False,
            property="collector",
        ),
        signalfx.ListChartLegendOptionsFieldArgs(
            enabled=True,
            property="cluster_name",
        ),
        signalfx.ListChartLegendOptionsFieldArgs(
            enabled=True,
            property="role",
        ),
        signalfx.ListChartLegendOptionsFieldArgs(
            enabled=False,
            property="collector",
        ),
        signalfx.ListChartLegendOptionsFieldArgs(
            enabled=False,
            property="host",
        ),
    ],
    max_delay=2,
    max_precision=2,
    program_text="""myfilters = filter("cluster_name", "prod") and filter("role", "search")
data("cpu.total.idle", filter=myfilters).publish()

""",
    refresh_interval=1,
    sort_by="-value",
    timezone="Europe/Paris")
import * as pulumi from "@pulumi/pulumi";
import * as signalfx from "@pulumi/signalfx";

const mylistchart0 = new signalfx.ListChart("mylistchart0", {
    colorBy: "Metric",
    description: "Very cool List Chart",
    disableSampling: true,
    hideMissingValues: true,
    legendOptionsFields: [
        {
            enabled: false,
            property: "collector",
        },
        {
            enabled: true,
            property: "cluster_name",
        },
        {
            enabled: true,
            property: "role",
        },
        {
            enabled: false,
            property: "collector",
        },
        {
            enabled: false,
            property: "host",
        },
    ],
    maxDelay: 2,
    maxPrecision: 2,
    programText: `myfilters = filter("cluster_name", "prod") and filter("role", "search")
data("cpu.total.idle", filter=myfilters).publish()
`,
    refreshInterval: 1,
    sortBy: "-value",
    timezone: "Europe/Paris",
});

Create a ListChart Resource

new ListChart(name: string, args: ListChartArgs, opts?: CustomResourceOptions);
def ListChart(resource_name: str, opts: Optional[ResourceOptions] = None, color_by: Optional[str] = None, color_scales: Optional[Sequence[ListChartColorScaleArgs]] = None, description: Optional[str] = None, disable_sampling: Optional[bool] = None, end_time: Optional[int] = None, hide_missing_values: Optional[bool] = None, legend_fields_to_hides: Optional[Sequence[str]] = None, legend_options_fields: Optional[Sequence[ListChartLegendOptionsFieldArgs]] = None, max_delay: Optional[int] = None, max_precision: Optional[int] = None, name: Optional[str] = None, program_text: Optional[str] = None, refresh_interval: Optional[int] = None, secondary_visualization: Optional[str] = None, sort_by: Optional[str] = None, start_time: Optional[int] = None, time_range: Optional[int] = None, timezone: Optional[str] = None, unit_prefix: Optional[str] = None, viz_options: Optional[Sequence[ListChartVizOptionArgs]] = None)
func NewListChart(ctx *Context, name string, args ListChartArgs, opts ...ResourceOption) (*ListChart, error)
public ListChart(string name, ListChartArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args ListChartArgs
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 ListChartArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args ListChartArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

ListChart Resource Properties

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

Inputs

The ListChart resource accepts the following input properties:

ProgramText string

Signalflow program text for the chart. More infoin the SignalFx docs.

ColorBy string

Must be one of "Scale", "Dimension" or "Metric". "Dimension" by default.

ColorScales List<Pulumi.SignalFx.Inputs.ListChartColorScaleArgs>

Single color range including both the color to display for that range and the borders of the range. Example: [{ gt = 60, color = "blue" }, { lte = 60, color = "yellow" }]. Look at this link.

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.

HideMissingValues bool

Determines whether to hide missing data points in the chart. If true, missing data points in the chart would be hidden. false by default.

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.ListChartLegendOptionsFieldArgs>

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.

MaxPrecision int

Maximum number of digits to display when rounding values up or down.

Name string

Name of the chart.

RefreshInterval int

How often (in seconds) to refresh the values of the list.

SecondaryVisualization string

The type of secondary visualization. Can be None, Radial, Linear, or Sparkline. If unset, the SignalFx default is used (Sparkline).

SortBy string

The property to use when sorting the elements. Use value if you want to sort by value. Must be prepended with + for ascending or - for descending (e.g. -foo). Note there are some special values for some of the options provided in the UX: "value" for Value, "sf_originatingMetric" for Metric, and "sf_metric" for plot.

StartTime int

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

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

The property value is a string that denotes the geographic region associated with the time zone, (default UTC).

UnitPrefix string

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

VizOptions List<Pulumi.SignalFx.Inputs.ListChartVizOptionArgs>

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

ProgramText string

Signalflow program text for the chart. More infoin the SignalFx docs.

ColorBy string

Must be one of "Scale", "Dimension" or "Metric". "Dimension" by default.

ColorScales []ListChartColorScale

Single color range including both the color to display for that range and the borders of the range. Example: [{ gt = 60, color = "blue" }, { lte = 60, color = "yellow" }]. Look at this link.

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.

HideMissingValues bool

Determines whether to hide missing data points in the chart. If true, missing data points in the chart would be hidden. false by default.

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 []ListChartLegendOptionsField

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.

MaxPrecision int

Maximum number of digits to display when rounding values up or down.

Name string

Name of the chart.

RefreshInterval int

How often (in seconds) to refresh the values of the list.

SecondaryVisualization string

The type of secondary visualization. Can be None, Radial, Linear, or Sparkline. If unset, the SignalFx default is used (Sparkline).

SortBy string

The property to use when sorting the elements. Use value if you want to sort by value. Must be prepended with + for ascending or - for descending (e.g. -foo). Note there are some special values for some of the options provided in the UX: "value" for Value, "sf_originatingMetric" for Metric, and "sf_metric" for plot.

StartTime int

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

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

The property value is a string that denotes the geographic region associated with the time zone, (default UTC).

UnitPrefix string

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

VizOptions []ListChartVizOption

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

programText string

Signalflow program text for the chart. More infoin the SignalFx docs.

colorBy string

Must be one of "Scale", "Dimension" or "Metric". "Dimension" by default.

colorScales ListChartColorScale[]

Single color range including both the color to display for that range and the borders of the range. Example: [{ gt = 60, color = "blue" }, { lte = 60, color = "yellow" }]. Look at this link.

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.

hideMissingValues boolean

Determines whether to hide missing data points in the chart. If true, missing data points in the chart would be hidden. false by default.

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 ListChartLegendOptionsField[]

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.

maxPrecision number

Maximum number of digits to display when rounding values up or down.

name string

Name of the chart.

refreshInterval number

How often (in seconds) to refresh the values of the list.

secondaryVisualization string

The type of secondary visualization. Can be None, Radial, Linear, or Sparkline. If unset, the SignalFx default is used (Sparkline).

sortBy string

The property to use when sorting the elements. Use value if you want to sort by value. Must be prepended with + for ascending or - for descending (e.g. -foo). Note there are some special values for some of the options provided in the UX: "value" for Value, "sf_originatingMetric" for Metric, and "sf_metric" for plot.

startTime number

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

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

The property value is a string that denotes the geographic region associated with the time zone, (default UTC).

unitPrefix string

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

vizOptions ListChartVizOption[]

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

program_text str

Signalflow program text for the chart. More infoin the SignalFx docs.

color_by str

Must be one of "Scale", "Dimension" or "Metric". "Dimension" by default.

color_scales Sequence[ListChartColorScaleArgs]

Single color range including both the color to display for that range and the borders of the range. Example: [{ gt = 60, color = "blue" }, { lte = 60, color = "yellow" }]. Look at this link.

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 int

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

hide_missing_values bool

Determines whether to hide missing data points in the chart. If true, missing data points in the chart would be hidden. false by default.

legend_fields_to_hides Sequence[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 Sequence[ListChartLegendOptionsFieldArgs]

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 int

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

max_precision int

Maximum number of digits to display when rounding values up or down.

name str

Name of the chart.

refresh_interval int

How often (in seconds) to refresh the values of the list.

secondary_visualization str

The type of secondary visualization. Can be None, Radial, Linear, or Sparkline. If unset, the SignalFx default is used (Sparkline).

sort_by str

The property to use when sorting the elements. Use value if you want to sort by value. Must be prepended with + for ascending or - for descending (e.g. -foo). Note there are some special values for some of the options provided in the UX: "value" for Value, "sf_originatingMetric" for Metric, and "sf_metric" for plot.

start_time int

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

time_range 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 str

The property value is a string that denotes the geographic region associated with the time zone, (default UTC).

unit_prefix str

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

viz_options Sequence[ListChartVizOptionArgs]

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

Outputs

All input properties are implicitly available as output properties. Additionally, the ListChart resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Url string

The URL of the chart.

Id string
The provider-assigned unique ID for this managed resource.
Url string

The URL of the chart.

id string
The provider-assigned unique ID for this managed resource.
url string

The URL of the chart.

id str
The provider-assigned unique ID for this managed resource.
url str

The URL of the chart.

Look up an Existing ListChart Resource

Get an existing ListChart 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?: ListChartState, opts?: CustomResourceOptions): ListChart
@staticmethod
def get(resource_name: str, id: str, opts: Optional[ResourceOptions] = None, color_by: Optional[str] = None, color_scales: Optional[Sequence[ListChartColorScaleArgs]] = None, description: Optional[str] = None, disable_sampling: Optional[bool] = None, end_time: Optional[int] = None, hide_missing_values: Optional[bool] = None, legend_fields_to_hides: Optional[Sequence[str]] = None, legend_options_fields: Optional[Sequence[ListChartLegendOptionsFieldArgs]] = None, max_delay: Optional[int] = None, max_precision: Optional[int] = None, name: Optional[str] = None, program_text: Optional[str] = None, refresh_interval: Optional[int] = None, secondary_visualization: Optional[str] = None, sort_by: Optional[str] = None, start_time: Optional[int] = None, time_range: Optional[int] = None, timezone: Optional[str] = None, unit_prefix: Optional[str] = None, url: Optional[str] = None, viz_options: Optional[Sequence[ListChartVizOptionArgs]] = None) -> ListChart
func GetListChart(ctx *Context, name string, id IDInput, state *ListChartState, opts ...ResourceOption) (*ListChart, error)
public static ListChart Get(string name, Input<string> id, ListChartState? 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:

ColorBy string

Must be one of "Scale", "Dimension" or "Metric". "Dimension" by default.

ColorScales List<Pulumi.SignalFx.Inputs.ListChartColorScaleArgs>

Single color range including both the color to display for that range and the borders of the range. Example: [{ gt = 60, color = "blue" }, { lte = 60, color = "yellow" }]. Look at this link.

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.

HideMissingValues bool

Determines whether to hide missing data points in the chart. If true, missing data points in the chart would be hidden. false by default.

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.ListChartLegendOptionsFieldArgs>

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.

MaxPrecision int

Maximum number of digits to display when rounding values up or down.

Name string

Name of the chart.

ProgramText string

Signalflow program text for the chart. More infoin the SignalFx docs.

RefreshInterval int

How often (in seconds) to refresh the values of the list.

SecondaryVisualization string

The type of secondary visualization. Can be None, Radial, Linear, or Sparkline. If unset, the SignalFx default is used (Sparkline).

SortBy string

The property to use when sorting the elements. Use value if you want to sort by value. Must be prepended with + for ascending or - for descending (e.g. -foo). Note there are some special values for some of the options provided in the UX: "value" for Value, "sf_originatingMetric" for Metric, and "sf_metric" for plot.

StartTime int

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

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

The property value is a string that denotes the geographic region associated with the time zone, (default UTC).

UnitPrefix string

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

Url string

The URL of the chart.

VizOptions List<Pulumi.SignalFx.Inputs.ListChartVizOptionArgs>

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

ColorBy string

Must be one of "Scale", "Dimension" or "Metric". "Dimension" by default.

ColorScales []ListChartColorScale

Single color range including both the color to display for that range and the borders of the range. Example: [{ gt = 60, color = "blue" }, { lte = 60, color = "yellow" }]. Look at this link.

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.

HideMissingValues bool

Determines whether to hide missing data points in the chart. If true, missing data points in the chart would be hidden. false by default.

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 []ListChartLegendOptionsField

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.

MaxPrecision int

Maximum number of digits to display when rounding values up or down.

Name string

Name of the chart.

ProgramText string

Signalflow program text for the chart. More infoin the SignalFx docs.

RefreshInterval int

How often (in seconds) to refresh the values of the list.

SecondaryVisualization string

The type of secondary visualization. Can be None, Radial, Linear, or Sparkline. If unset, the SignalFx default is used (Sparkline).

SortBy string

The property to use when sorting the elements. Use value if you want to sort by value. Must be prepended with + for ascending or - for descending (e.g. -foo). Note there are some special values for some of the options provided in the UX: "value" for Value, "sf_originatingMetric" for Metric, and "sf_metric" for plot.

StartTime int

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

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

The property value is a string that denotes the geographic region associated with the time zone, (default UTC).

UnitPrefix string

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

Url string

The URL of the chart.

VizOptions []ListChartVizOption

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

colorBy string

Must be one of "Scale", "Dimension" or "Metric". "Dimension" by default.

colorScales ListChartColorScale[]

Single color range including both the color to display for that range and the borders of the range. Example: [{ gt = 60, color = "blue" }, { lte = 60, color = "yellow" }]. Look at this link.

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.

hideMissingValues boolean

Determines whether to hide missing data points in the chart. If true, missing data points in the chart would be hidden. false by default.

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 ListChartLegendOptionsField[]

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.

maxPrecision number

Maximum number of digits to display when rounding values up or down.

name string

Name of the chart.

programText string

Signalflow program text for the chart. More infoin the SignalFx docs.

refreshInterval number

How often (in seconds) to refresh the values of the list.

secondaryVisualization string

The type of secondary visualization. Can be None, Radial, Linear, or Sparkline. If unset, the SignalFx default is used (Sparkline).

sortBy string

The property to use when sorting the elements. Use value if you want to sort by value. Must be prepended with + for ascending or - for descending (e.g. -foo). Note there are some special values for some of the options provided in the UX: "value" for Value, "sf_originatingMetric" for Metric, and "sf_metric" for plot.

startTime number

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

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

The property value is a string that denotes the geographic region associated with the time zone, (default UTC).

unitPrefix string

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

url string

The URL of the chart.

vizOptions ListChartVizOption[]

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

color_by str

Must be one of "Scale", "Dimension" or "Metric". "Dimension" by default.

color_scales Sequence[ListChartColorScaleArgs]

Single color range including both the color to display for that range and the borders of the range. Example: [{ gt = 60, color = "blue" }, { lte = 60, color = "yellow" }]. Look at this link.

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 int

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

hide_missing_values bool

Determines whether to hide missing data points in the chart. If true, missing data points in the chart would be hidden. false by default.

legend_fields_to_hides Sequence[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 Sequence[ListChartLegendOptionsFieldArgs]

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 int

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

max_precision int

Maximum number of digits to display when rounding values up or down.

name str

Name of the chart.

program_text str

Signalflow program text for the chart. More infoin the SignalFx docs.

refresh_interval int

How often (in seconds) to refresh the values of the list.

secondary_visualization str

The type of secondary visualization. Can be None, Radial, Linear, or Sparkline. If unset, the SignalFx default is used (Sparkline).

sort_by str

The property to use when sorting the elements. Use value if you want to sort by value. Must be prepended with + for ascending or - for descending (e.g. -foo). Note there are some special values for some of the options provided in the UX: "value" for Value, "sf_originatingMetric" for Metric, and "sf_metric" for plot.

start_time int

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

time_range 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 str

The property value is a string that denotes the geographic region associated with the time zone, (default UTC).

unit_prefix str

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

url str

The URL of the chart.

viz_options Sequence[ListChartVizOptionArgs]

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

Supporting Types

ListChartColorScale

Color string

The color to use. Must be one of gray, blue, light_blue, navy, dark_orange, orange, dark_yellow, magenta, cerise, pink, violet, purple, gray_blue, dark_green, green, aquamarine, red, yellow, vivid_yellow, light_green, or lime_green.

Gt double

Indicates the lower threshold non-inclusive value for this range.

Gte double

Indicates the lower threshold inclusive value for this range.

Lt double

Indicates the upper threshold non-inculsive value for this range.

Lte double

Indicates the upper threshold inclusive value for this range.

Color string

The color to use. Must be one of gray, blue, light_blue, navy, dark_orange, orange, dark_yellow, magenta, cerise, pink, violet, purple, gray_blue, dark_green, green, aquamarine, red, yellow, vivid_yellow, light_green, or lime_green.

Gt float64

Indicates the lower threshold non-inclusive value for this range.

Gte float64

Indicates the lower threshold inclusive value for this range.

Lt float64

Indicates the upper threshold non-inculsive value for this range.

Lte float64

Indicates the upper threshold inclusive value for this range.

color string

The color to use. Must be one of gray, blue, light_blue, navy, dark_orange, orange, dark_yellow, magenta, cerise, pink, violet, purple, gray_blue, dark_green, green, aquamarine, red, yellow, vivid_yellow, light_green, or lime_green.

gt number

Indicates the lower threshold non-inclusive value for this range.

gte number

Indicates the lower threshold inclusive value for this range.

lt number

Indicates the upper threshold non-inculsive value for this range.

lte number

Indicates the upper threshold inclusive value for this range.

color str

The color to use. Must be one of gray, blue, light_blue, navy, dark_orange, orange, dark_yellow, magenta, cerise, pink, violet, purple, gray_blue, dark_green, green, aquamarine, red, yellow, vivid_yellow, light_green, or lime_green.

gt float

Indicates the lower threshold non-inclusive value for this range.

gte float

Indicates the lower threshold inclusive value for this range.

lt float

Indicates the upper threshold non-inculsive value for this range.

lte float

Indicates the upper threshold inclusive value for this range.

ListChartLegendOptionsField

Property string

The name of the property to display. Note the special values of sf_metric (corresponding with the API’s Plot Name) which shows the label of the time series publish() and sf_originatingMetric (corresponding with the API’s metric (sf metric)) 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 sf_metric (corresponding with the API’s Plot Name) which shows the label of the time series publish() and sf_originatingMetric (corresponding with the API’s metric (sf metric)) 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 sf_metric (corresponding with the API’s Plot Name) which shows the label of the time series publish() and sf_originatingMetric (corresponding with the API’s metric (sf metric)) 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 sf_metric (corresponding with the API’s Plot Name) which shows the label of the time series publish() and sf_originatingMetric (corresponding with the API’s metric (sf metric)) 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.

ListChartVizOption

Label string

Label used in the publish statement that displays the plot (metric time series data) you want to customize.

Color string

The color to use. Must be one of gray, blue, light_blue, navy, dark_orange, orange, dark_yellow, magenta, cerise, pink, violet, purple, gray_blue, dark_green, green, aquamarine, red, yellow, vivid_yellow, light_green, or lime_green.

DisplayName string

Specifies an alternate value for the Plot Name column of the Data Table associated with the chart.

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 plot (metric time series data) you want to customize.

Color string

The color to use. Must be one of gray, blue, light_blue, navy, dark_orange, orange, dark_yellow, magenta, cerise, pink, violet, purple, gray_blue, dark_green, green, aquamarine, red, yellow, vivid_yellow, light_green, or lime_green.

DisplayName string

Specifies an alternate value for the Plot Name column of the Data Table associated with the chart.

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 plot (metric time series data) you want to customize.

color string

The color to use. Must be one of gray, blue, light_blue, navy, dark_orange, orange, dark_yellow, magenta, cerise, pink, violet, purple, gray_blue, dark_green, green, aquamarine, red, yellow, vivid_yellow, light_green, or lime_green.

displayName string

Specifies an alternate value for the Plot Name column of the Data Table associated with the chart.

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 plot (metric time series data) you want to customize.

color str

The color to use. Must be one of gray, blue, light_blue, navy, dark_orange, orange, dark_yellow, magenta, cerise, pink, violet, purple, gray_blue, dark_green, green, aquamarine, red, yellow, vivid_yellow, light_green, or lime_green.

display_name str

Specifies an alternate value for the Plot Name column of the Data Table associated with the chart.

value_prefix str
value_suffix str
value_unit 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.