1. Packages
  2. SignalFx
  3. API Docs
  4. ListChart
SignalFx v7.1.1 published on Tuesday, Feb 27, 2024 by Pulumi

signalfx.ListChart

Explore with Pulumi AI

signalfx logo
SignalFx v7.1.1 published on Tuesday, Feb 27, 2024 by Pulumi

    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 from the example. Otherwise, just the raw metric name will be displayed on the chart, as in plot A from the example.

    Example

    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",
    });
    
    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")
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using SignalFx = Pulumi.SignalFx;
    
    return await Deployment.RunAsync(() => 
    {
        var mylistchart0 = new SignalFx.ListChart("mylistchart0", new()
        {
            ColorBy = "Metric",
            Description = "Very cool List Chart",
            DisableSampling = true,
            HideMissingValues = true,
            LegendOptionsFields = new[]
            {
                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 (
    	"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.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("myfilters = filter(\"cluster_name\", \"prod\") and filter(\"role\", \"search\")\ndata(\"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
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.signalfx.ListChart;
    import com.pulumi.signalfx.ListChartArgs;
    import com.pulumi.signalfx.inputs.ListChartLegendOptionsFieldArgs;
    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 mylistchart0 = new ListChart("mylistchart0", ListChartArgs.builder()        
                .colorBy("Metric")
                .description("Very cool List Chart")
                .disableSampling(true)
                .hideMissingValues(true)
                .legendOptionsFields(            
                    ListChartLegendOptionsFieldArgs.builder()
                        .enabled(false)
                        .property("collector")
                        .build(),
                    ListChartLegendOptionsFieldArgs.builder()
                        .enabled(true)
                        .property("cluster_name")
                        .build(),
                    ListChartLegendOptionsFieldArgs.builder()
                        .enabled(true)
                        .property("role")
                        .build(),
                    ListChartLegendOptionsFieldArgs.builder()
                        .enabled(false)
                        .property("collector")
                        .build(),
                    ListChartLegendOptionsFieldArgs.builder()
                        .enabled(false)
                        .property("host")
                        .build())
                .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")
                .build());
    
        }
    }
    
    resources:
      mylistchart0:
        type: signalfx:ListChart
        properties:
          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
    

    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 infoin the Splunk Observability Cloud docs.
    • description - (Optional) Description of the chart.
    • unit_prefix - (Optional) Must be "Metric" or "Binary". "Metric" by default.
    • color_by - (Optional) Must be one of "Scale", "Dimension" or "Metric". "Dimension" by default.
    • max_delay - (Optional) How long (in seconds) to wait for late datapoints.
    • timezone - (Optional) The property value is a string that denotes the geographic region associated with the time zone, (default UTC).
    • disable_sampling - (Optional) If false, samples a subset of the output MTS, which improves UI performance. false by default.
    • refresh_interval - (Optional) How often (in seconds) to refresh the values of the list.
    • hide_missing_values - (Optional) Determines whether to hide missing data points in the chart. If true, missing data points in the chart would be hidden. false by default.
    • 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) 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.
      • 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 are Bit, 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.
    • 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 use legend_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 with legend_fields_to_hide.
      • property 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 True or False depending on if you want the property to be shown or hidden.
    • max_precision - (Optional) Maximum number of digits to display when rounding values up or down.
    • secondary_visualization - (Optional) The type of secondary visualization. Can be None, Radial, Linear, or Sparkline. If unset, the Splunk Observability Cloud default is used (Sparkline).
    • color_scale - (Optional. color_by must be "Scale") 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.
      • gt - (Optional) Indicates the lower threshold non-inclusive value for this range.
      • gte - (Optional) Indicates the lower threshold inclusive value for this range.
      • lt - (Optional) Indicates the upper threshold non-inculsive value for this range.
      • lte - (Optional) Indicates the upper threshold inclusive value for this range.
      • color - (Required) 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.
    • sort_by - (Optional) 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.
    • time_range - (Optional) 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.
    • start_time - (Optional) Seconds since epoch. Used for visualization. Conflicts with time_range.
    • end_time - (Optional) Seconds since epoch. Used for visualization. Conflicts with time_range.

    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 ListChart Resource

    new ListChart(name: string, args: ListChartArgs, opts?: CustomResourceOptions);
    @overload
    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)
    @overload
    def ListChart(resource_name: str,
                  args: ListChartArgs,
                  opts: Optional[ResourceOptions] = None)
    func NewListChart(ctx *Context, name string, args ListChartArgs, opts ...ResourceOption) (*ListChart, error)
    public ListChart(string name, ListChartArgs args, CustomResourceOptions? opts = null)
    public ListChart(String name, ListChartArgs args)
    public ListChart(String name, ListChartArgs args, CustomResourceOptions options)
    
    type: signalfx:ListChart
    properties: # The arguments to resource properties.
    options: # 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.
    resource_name str
    The unique name of the resource.
    args ListChartArgs
    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 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.
    name String
    The unique name of the resource.
    args ListChartArgs
    The arguments to resource properties.
    options 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 Architecture and Concepts docs.

    Inputs

    The ListChart resource accepts the following input properties:

    ProgramText string
    Signalflow program text for the chart. More info at "https://developers.signalfx.com/docs/signalflow-overview"
    ColorBy string
    (Metric by default) Must be "Scale", "Metric" or "Dimension"
    ColorScales List<Pulumi.SignalFx.Inputs.ListChartColorScale>
    Single color range including both the color to display for that range and the borders of the range
    Description string
    Description of the chart (Optional)
    DisableSampling bool
    (false by default) If false, samples a subset of the output MTS, which improves UI performance
    EndTime int
    Seconds since epoch to end the visualization
    HideMissingValues bool
    (false by default) If true, missing data points in the chart would be hidden
    LegendFieldsToHides List<string>
    List of properties that shouldn't be displayed in the chart legend (i.e. dimension names)

    Deprecated:Please use legend_options_fields

    LegendOptionsFields List<Pulumi.SignalFx.Inputs.ListChartLegendOptionsField>
    List of property and enabled flags to control the order and presence of datatable labels in a chart.
    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
    (false by default) What kind of secondary visualization to show (None, Radial, Linear, 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)
    StartTime int
    Seconds since epoch to start the visualization
    TimeRange 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)
    UnitPrefix string
    (Metric by default) Must be "Metric" or "Binary"
    VizOptions List<Pulumi.SignalFx.Inputs.ListChartVizOption>
    Plot-level customization options, associated with a publish statement
    ProgramText string
    Signalflow program text for the chart. More info at "https://developers.signalfx.com/docs/signalflow-overview"
    ColorBy string
    (Metric by default) Must be "Scale", "Metric" or "Dimension"
    ColorScales []ListChartColorScaleArgs
    Single color range including both the color to display for that range and the borders of the range
    Description string
    Description of the chart (Optional)
    DisableSampling bool
    (false by default) If false, samples a subset of the output MTS, which improves UI performance
    EndTime int
    Seconds since epoch to end the visualization
    HideMissingValues bool
    (false by default) If true, missing data points in the chart would be hidden
    LegendFieldsToHides []string
    List of properties that shouldn't be displayed in the chart legend (i.e. dimension names)

    Deprecated:Please use legend_options_fields

    LegendOptionsFields []ListChartLegendOptionsFieldArgs
    List of property and enabled flags to control the order and presence of datatable labels in a chart.
    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
    (false by default) What kind of secondary visualization to show (None, Radial, Linear, 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)
    StartTime int
    Seconds since epoch to start the visualization
    TimeRange 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)
    UnitPrefix string
    (Metric by default) Must be "Metric" or "Binary"
    VizOptions []ListChartVizOptionArgs
    Plot-level customization options, associated with a publish statement
    programText String
    Signalflow program text for the chart. More info at "https://developers.signalfx.com/docs/signalflow-overview"
    colorBy String
    (Metric by default) Must be "Scale", "Metric" or "Dimension"
    colorScales List<ListChartColorScale>
    Single color range including both the color to display for that range and the borders of the range
    description String
    Description of the chart (Optional)
    disableSampling Boolean
    (false by default) If false, samples a subset of the output MTS, which improves UI performance
    endTime Integer
    Seconds since epoch to end the visualization
    hideMissingValues Boolean
    (false by default) If true, missing data points in the chart would be hidden
    legendFieldsToHides List<String>
    List of properties that shouldn't be displayed in the chart legend (i.e. dimension names)

    Deprecated:Please use legend_options_fields

    legendOptionsFields List<ListChartLegendOptionsField>
    List of property and enabled flags to control the order and presence of datatable labels in a chart.
    maxDelay Integer
    How long (in seconds) to wait for late datapoints
    maxPrecision Integer
    Maximum number of digits to display when rounding values up or down
    name String
    Name of the chart
    refreshInterval Integer
    How often (in seconds) to refresh the values of the list
    secondaryVisualization String
    (false by default) What kind of secondary visualization to show (None, Radial, Linear, 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)
    startTime Integer
    Seconds since epoch to start the visualization
    timeRange 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)
    unitPrefix String
    (Metric by default) Must be "Metric" or "Binary"
    vizOptions List<ListChartVizOption>
    Plot-level customization options, associated with a publish statement
    programText string
    Signalflow program text for the chart. More info at "https://developers.signalfx.com/docs/signalflow-overview"
    colorBy string
    (Metric by default) Must be "Scale", "Metric" or "Dimension"
    colorScales ListChartColorScale[]
    Single color range including both the color to display for that range and the borders of the range
    description string
    Description of the chart (Optional)
    disableSampling boolean
    (false by default) If false, samples a subset of the output MTS, which improves UI performance
    endTime number
    Seconds since epoch to end the visualization
    hideMissingValues boolean
    (false by default) If true, missing data points in the chart would be hidden
    legendFieldsToHides string[]
    List of properties that shouldn't be displayed in the chart legend (i.e. dimension names)

    Deprecated:Please use legend_options_fields

    legendOptionsFields ListChartLegendOptionsField[]
    List of property and enabled flags to control the order and presence of datatable labels in a chart.
    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
    (false by default) What kind of secondary visualization to show (None, Radial, Linear, 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)
    startTime number
    Seconds since epoch to start the visualization
    timeRange 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)
    unitPrefix string
    (Metric by default) Must be "Metric" or "Binary"
    vizOptions ListChartVizOption[]
    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"
    color_by str
    (Metric by default) Must be "Scale", "Metric" or "Dimension"
    color_scales Sequence[ListChartColorScaleArgs]
    Single color range including both the color to display for that range and the borders of the range
    description str
    Description of the chart (Optional)
    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
    hide_missing_values bool
    (false by default) If true, missing data points in the chart would be hidden
    legend_fields_to_hides Sequence[str]
    List of properties that shouldn't be displayed in the chart legend (i.e. dimension names)

    Deprecated:Please use legend_options_fields

    legend_options_fields Sequence[ListChartLegendOptionsFieldArgs]
    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
    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
    (false by default) What kind of secondary visualization to show (None, Radial, Linear, 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)
    start_time int
    Seconds since epoch to start the visualization
    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[ListChartVizOptionArgs]
    Plot-level customization options, associated with a publish statement
    programText String
    Signalflow program text for the chart. More info at "https://developers.signalfx.com/docs/signalflow-overview"
    colorBy String
    (Metric by default) Must be "Scale", "Metric" or "Dimension"
    colorScales List<Property Map>
    Single color range including both the color to display for that range and the borders of the range
    description String
    Description of the chart (Optional)
    disableSampling Boolean
    (false by default) If false, samples a subset of the output MTS, which improves UI performance
    endTime Number
    Seconds since epoch to end the visualization
    hideMissingValues Boolean
    (false by default) If true, missing data points in the chart would be hidden
    legendFieldsToHides List<String>
    List of properties that shouldn't be displayed in the chart legend (i.e. dimension names)

    Deprecated:Please use legend_options_fields

    legendOptionsFields List<Property Map>
    List of property and enabled flags to control the order and presence of datatable labels in a chart.
    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
    (false by default) What kind of secondary visualization to show (None, Radial, Linear, 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)
    startTime Number
    Seconds since epoch to start the visualization
    timeRange 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)
    unitPrefix String
    (Metric by default) Must be "Metric" or "Binary"
    vizOptions List<Property Map>
    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
    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 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
    id String
    The provider-assigned unique ID for this managed resource.
    url String
    URL of the chart

    Look up 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)
    public static ListChart get(String name, Output<String> id, ListChartState 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.
    The following state arguments are supported:
    ColorBy string
    (Metric by default) Must be "Scale", "Metric" or "Dimension"
    ColorScales List<Pulumi.SignalFx.Inputs.ListChartColorScale>
    Single color range including both the color to display for that range and the borders of the range
    Description string
    Description of the chart (Optional)
    DisableSampling bool
    (false by default) If false, samples a subset of the output MTS, which improves UI performance
    EndTime int
    Seconds since epoch to end the visualization
    HideMissingValues bool
    (false by default) If true, missing data points in the chart would be hidden
    LegendFieldsToHides List<string>
    List of properties that shouldn't be displayed in the chart legend (i.e. dimension names)

    Deprecated:Please use legend_options_fields

    LegendOptionsFields List<Pulumi.SignalFx.Inputs.ListChartLegendOptionsField>
    List of property and enabled flags to control the order and presence of datatable labels in a chart.
    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 info at "https://developers.signalfx.com/docs/signalflow-overview"
    RefreshInterval int
    How often (in seconds) to refresh the values of the list
    SecondaryVisualization string
    (false by default) What kind of secondary visualization to show (None, Radial, Linear, 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)
    StartTime int
    Seconds since epoch to start the visualization
    TimeRange 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)
    UnitPrefix string
    (Metric by default) Must be "Metric" or "Binary"
    Url string
    URL of the chart
    VizOptions List<Pulumi.SignalFx.Inputs.ListChartVizOption>
    Plot-level customization options, associated with a publish statement
    ColorBy string
    (Metric by default) Must be "Scale", "Metric" or "Dimension"
    ColorScales []ListChartColorScaleArgs
    Single color range including both the color to display for that range and the borders of the range
    Description string
    Description of the chart (Optional)
    DisableSampling bool
    (false by default) If false, samples a subset of the output MTS, which improves UI performance
    EndTime int
    Seconds since epoch to end the visualization
    HideMissingValues bool
    (false by default) If true, missing data points in the chart would be hidden
    LegendFieldsToHides []string
    List of properties that shouldn't be displayed in the chart legend (i.e. dimension names)

    Deprecated:Please use legend_options_fields

    LegendOptionsFields []ListChartLegendOptionsFieldArgs
    List of property and enabled flags to control the order and presence of datatable labels in a chart.
    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 info at "https://developers.signalfx.com/docs/signalflow-overview"
    RefreshInterval int
    How often (in seconds) to refresh the values of the list
    SecondaryVisualization string
    (false by default) What kind of secondary visualization to show (None, Radial, Linear, 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)
    StartTime int
    Seconds since epoch to start the visualization
    TimeRange 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)
    UnitPrefix string
    (Metric by default) Must be "Metric" or "Binary"
    Url string
    URL of the chart
    VizOptions []ListChartVizOptionArgs
    Plot-level customization options, associated with a publish statement
    colorBy String
    (Metric by default) Must be "Scale", "Metric" or "Dimension"
    colorScales List<ListChartColorScale>
    Single color range including both the color to display for that range and the borders of the range
    description String
    Description of the chart (Optional)
    disableSampling Boolean
    (false by default) If false, samples a subset of the output MTS, which improves UI performance
    endTime Integer
    Seconds since epoch to end the visualization
    hideMissingValues Boolean
    (false by default) If true, missing data points in the chart would be hidden
    legendFieldsToHides List<String>
    List of properties that shouldn't be displayed in the chart legend (i.e. dimension names)

    Deprecated:Please use legend_options_fields

    legendOptionsFields List<ListChartLegendOptionsField>
    List of property and enabled flags to control the order and presence of datatable labels in a chart.
    maxDelay Integer
    How long (in seconds) to wait for late datapoints
    maxPrecision Integer
    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 info at "https://developers.signalfx.com/docs/signalflow-overview"
    refreshInterval Integer
    How often (in seconds) to refresh the values of the list
    secondaryVisualization String
    (false by default) What kind of secondary visualization to show (None, Radial, Linear, 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)
    startTime Integer
    Seconds since epoch to start the visualization
    timeRange 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)
    unitPrefix String
    (Metric by default) Must be "Metric" or "Binary"
    url String
    URL of the chart
    vizOptions List<ListChartVizOption>
    Plot-level customization options, associated with a publish statement
    colorBy string
    (Metric by default) Must be "Scale", "Metric" or "Dimension"
    colorScales ListChartColorScale[]
    Single color range including both the color to display for that range and the borders of the range
    description string
    Description of the chart (Optional)
    disableSampling boolean
    (false by default) If false, samples a subset of the output MTS, which improves UI performance
    endTime number
    Seconds since epoch to end the visualization
    hideMissingValues boolean
    (false by default) If true, missing data points in the chart would be hidden
    legendFieldsToHides string[]
    List of properties that shouldn't be displayed in the chart legend (i.e. dimension names)

    Deprecated:Please use legend_options_fields

    legendOptionsFields ListChartLegendOptionsField[]
    List of property and enabled flags to control the order and presence of datatable labels in a chart.
    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 info at "https://developers.signalfx.com/docs/signalflow-overview"
    refreshInterval number
    How often (in seconds) to refresh the values of the list
    secondaryVisualization string
    (false by default) What kind of secondary visualization to show (None, Radial, Linear, 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)
    startTime number
    Seconds since epoch to start the visualization
    timeRange 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)
    unitPrefix string
    (Metric by default) Must be "Metric" or "Binary"
    url string
    URL of the chart
    vizOptions ListChartVizOption[]
    Plot-level customization options, associated with a publish statement
    color_by str
    (Metric by default) Must be "Scale", "Metric" or "Dimension"
    color_scales Sequence[ListChartColorScaleArgs]
    Single color range including both the color to display for that range and the borders of the range
    description str
    Description of the chart (Optional)
    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
    hide_missing_values bool
    (false by default) If true, missing data points in the chart would be hidden
    legend_fields_to_hides Sequence[str]
    List of properties that shouldn't be displayed in the chart legend (i.e. dimension names)

    Deprecated:Please use legend_options_fields

    legend_options_fields Sequence[ListChartLegendOptionsFieldArgs]
    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
    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 info at "https://developers.signalfx.com/docs/signalflow-overview"
    refresh_interval int
    How often (in seconds) to refresh the values of the list
    secondary_visualization str
    (false by default) What kind of secondary visualization to show (None, Radial, Linear, 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)
    start_time int
    Seconds since epoch to start the visualization
    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[ListChartVizOptionArgs]
    Plot-level customization options, associated with a publish statement
    colorBy String
    (Metric by default) Must be "Scale", "Metric" or "Dimension"
    colorScales List<Property Map>
    Single color range including both the color to display for that range and the borders of the range
    description String
    Description of the chart (Optional)
    disableSampling Boolean
    (false by default) If false, samples a subset of the output MTS, which improves UI performance
    endTime Number
    Seconds since epoch to end the visualization
    hideMissingValues Boolean
    (false by default) If true, missing data points in the chart would be hidden
    legendFieldsToHides List<String>
    List of properties that shouldn't be displayed in the chart legend (i.e. dimension names)

    Deprecated:Please use legend_options_fields

    legendOptionsFields List<Property Map>
    List of property and enabled flags to control the order and presence of datatable labels in a chart.
    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 info at "https://developers.signalfx.com/docs/signalflow-overview"
    refreshInterval Number
    How often (in seconds) to refresh the values of the list
    secondaryVisualization String
    (false by default) What kind of secondary visualization to show (None, Radial, Linear, 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)
    startTime Number
    Seconds since epoch to start the visualization
    timeRange 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)
    unitPrefix String
    (Metric by default) Must be "Metric" or "Binary"
    url String
    URL of the chart
    vizOptions List<Property Map>
    Plot-level customization options, associated with a publish statement

    Supporting Types

    ListChartColorScale, ListChartColorScaleArgs

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

    ListChartLegendOptionsField, ListChartLegendOptionsFieldArgs

    Property string
    The name of a property to hide or show in the data table.
    Enabled bool
    (true by default) Determines if this property is displayed in the data table.
    Property string
    The name of a property to hide or show in the data table.
    Enabled bool
    (true by default) Determines if this property is displayed in the data table.
    property String
    The name of a property to hide or show in the data table.
    enabled Boolean
    (true by default) Determines if this property is displayed in the data table.
    property string
    The name of a property to hide or show in the data table.
    enabled boolean
    (true by default) Determines if this property is displayed in the data table.
    property str
    The name of a property to hide or show in the data table.
    enabled bool
    (true by default) Determines if this property is displayed in the data table.
    property String
    The name of a property to hide or show in the data table.
    enabled Boolean
    (true by default) Determines if this property is displayed in the data table.

    ListChartVizOption, ListChartVizOptionArgs

    Label string
    The label used in the publish statement that displays the plot (metric time series data) you want to customize
    Color string
    Color to use
    DisplayName string
    Specifies an alternate value for the Plot Name column of the Data Table associated with the chart.
    ValuePrefix string
    An arbitrary prefix to display with the value of this plot
    ValueSuffix string
    An arbitrary suffix to display with the value of this plot
    ValueUnit 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
    Color string
    Color to use
    DisplayName string
    Specifies an alternate value for the Plot Name column of the Data Table associated with the chart.
    ValuePrefix string
    An arbitrary prefix to display with the value of this plot
    ValueSuffix string
    An arbitrary suffix to display with the value of this plot
    ValueUnit 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
    color String
    Color to use
    displayName String
    Specifies an alternate value for the Plot Name column of the Data Table associated with the chart.
    valuePrefix String
    An arbitrary prefix to display with the value of this plot
    valueSuffix String
    An arbitrary suffix to display with the value of this plot
    valueUnit 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
    color string
    Color to use
    displayName string
    Specifies an alternate value for the Plot Name column of the Data Table associated with the chart.
    valuePrefix string
    An arbitrary prefix to display with the value of this plot
    valueSuffix string
    An arbitrary suffix to display with the value of this plot
    valueUnit 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
    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.
    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
    color String
    Color to use
    displayName String
    Specifies an alternate value for the Plot Name column of the Data Table associated with the chart.
    valuePrefix String
    An arbitrary prefix to display with the value of this plot
    valueSuffix String
    An arbitrary suffix to display with the value of this plot
    valueUnit 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.
    signalfx logo
    SignalFx v7.1.1 published on Tuesday, Feb 27, 2024 by Pulumi