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

SingleValueChart

This chart type displays a single number in a large font, representing the current value of a single metric on a plot line.

If the time period is in the past, the number represents the value of the metric near the end of the time period.

Example Usage

using Pulumi;
using SignalFx = Pulumi.SignalFx;

class MyStack : Stack
{
    public MyStack()
    {
        var mysvchart0 = new SignalFx.SingleValueChart("mysvchart0", new SignalFx.SingleValueChartArgs
        {
            ColorBy = "Dimension",
            Description = "Very cool Single Value Chart",
            IsTimestampHidden = true,
            MaxDelay = 2,
            MaxPrecision = 2,
            ProgramText = @"myfilters = filter(""cluster_name"", ""prod"") and filter(""role"", ""search"")
data(""cpu.total.idle"", filter=myfilters).publish()

",
            RefreshInterval = 1,
        });
    }

}
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.NewSingleValueChart(ctx, "mysvchart0", &signalfx.SingleValueChartArgs{
            ColorBy:           pulumi.String("Dimension"),
            Description:       pulumi.String("Very cool Single Value Chart"),
            IsTimestampHidden: pulumi.Bool(true),
            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),
        })
        if err != nil {
            return err
        }
        return nil
    })
}
import pulumi
import pulumi_signalfx as signalfx

mysvchart0 = signalfx.SingleValueChart("mysvchart0",
    color_by="Dimension",
    description="Very cool Single Value Chart",
    is_timestamp_hidden=True,
    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)
import * as pulumi from "@pulumi/pulumi";
import * as signalfx from "@pulumi/signalfx";

const mysvchart0 = new signalfx.SingleValueChart("mysvchart0", {
    colorBy: "Dimension",
    description: "Very cool Single Value Chart",
    isTimestampHidden: true,
    maxDelay: 2,
    maxPrecision: 2,
    programText: `myfilters = filter("cluster_name", "prod") and filter("role", "search")
data("cpu.total.idle", filter=myfilters).publish()
`,
    refreshInterval: 1,
});

Create a SingleValueChart Resource

new SingleValueChart(name: string, args: SingleValueChartArgs, opts?: CustomResourceOptions);
def SingleValueChart(resource_name: str, opts: Optional[ResourceOptions] = None, color_by: Optional[str] = None, color_scales: Optional[Sequence[SingleValueChartColorScaleArgs]] = None, description: Optional[str] = None, is_timestamp_hidden: Optional[bool] = 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, show_spark_line: Optional[bool] = None, timezone: Optional[str] = None, unit_prefix: Optional[str] = None, viz_options: Optional[Sequence[SingleValueChartVizOptionArgs]] = None)
func NewSingleValueChart(ctx *Context, name string, args SingleValueChartArgs, opts ...ResourceOption) (*SingleValueChart, error)
public SingleValueChart(string name, SingleValueChartArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args SingleValueChartArgs
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 SingleValueChartArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args SingleValueChartArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

SingleValueChart Resource Properties

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

Inputs

The SingleValueChart resource accepts the following input properties:

ProgramText string

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

ColorBy string

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

ColorScales List<Pulumi.SignalFx.Inputs.SingleValueChartColorScaleArgs>

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.

IsTimestampHidden bool

Whether to hide the timestamp in the chart. false by default.

MaxDelay int

How long (in seconds) to wait for late datapoints

MaxPrecision int

The maximum precision to for value displayed.

Name string

Name of the chart.

RefreshInterval int

How often (in seconds) to refresh the value.

SecondaryVisualization string

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

ShowSparkLine bool

Whether to show a trend line below the current value. false by default.

Timezone string

The property value is a string that denotes the geographic region associated with the time zone, (e.g. Australia/Sydney)

UnitPrefix string

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

VizOptions List<Pulumi.SignalFx.Inputs.SingleValueChartVizOptionArgs>

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

ProgramText string

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

ColorBy string

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

ColorScales []SingleValueChartColorScale

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.

IsTimestampHidden bool

Whether to hide the timestamp in the chart. false by default.

MaxDelay int

How long (in seconds) to wait for late datapoints

MaxPrecision int

The maximum precision to for value displayed.

Name string

Name of the chart.

RefreshInterval int

How often (in seconds) to refresh the value.

SecondaryVisualization string

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

ShowSparkLine bool

Whether to show a trend line below the current value. false by default.

Timezone string

The property value is a string that denotes the geographic region associated with the time zone, (e.g. Australia/Sydney)

UnitPrefix string

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

VizOptions []SingleValueChartVizOption

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

programText string

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

colorBy string

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

colorScales SingleValueChartColorScale[]

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.

isTimestampHidden boolean

Whether to hide the timestamp in the chart. false by default.

maxDelay number

How long (in seconds) to wait for late datapoints

maxPrecision number

The maximum precision to for value displayed.

name string

Name of the chart.

refreshInterval number

How often (in seconds) to refresh the value.

secondaryVisualization string

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

showSparkLine boolean

Whether to show a trend line below the current value. false by default.

timezone string

The property value is a string that denotes the geographic region associated with the time zone, (e.g. Australia/Sydney)

unitPrefix string

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

vizOptions SingleValueChartVizOption[]

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

program_text str

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

color_by str

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

color_scales Sequence[SingleValueChartColorScaleArgs]

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.

is_timestamp_hidden bool

Whether to hide the timestamp in the chart. false by default.

max_delay int

How long (in seconds) to wait for late datapoints

max_precision int

The maximum precision to for value displayed.

name str

Name of the chart.

refresh_interval int

How often (in seconds) to refresh the value.

secondary_visualization str

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

show_spark_line bool

Whether to show a trend line below the current value. false by default.

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

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

viz_options Sequence[SingleValueChartVizOptionArgs]

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

Outputs

All input properties are implicitly available as output properties. Additionally, the SingleValueChart 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 SingleValueChart Resource

Get an existing SingleValueChart 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?: SingleValueChartState, opts?: CustomResourceOptions): SingleValueChart
@staticmethod
def get(resource_name: str, id: str, opts: Optional[ResourceOptions] = None, color_by: Optional[str] = None, color_scales: Optional[Sequence[SingleValueChartColorScaleArgs]] = None, description: Optional[str] = None, is_timestamp_hidden: Optional[bool] = 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, show_spark_line: Optional[bool] = None, timezone: Optional[str] = None, unit_prefix: Optional[str] = None, url: Optional[str] = None, viz_options: Optional[Sequence[SingleValueChartVizOptionArgs]] = None) -> SingleValueChart
func GetSingleValueChart(ctx *Context, name string, id IDInput, state *SingleValueChartState, opts ...ResourceOption) (*SingleValueChart, error)
public static SingleValueChart Get(string name, Input<string> id, SingleValueChartState? 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 "Dimension", "Scale" or "Metric". "Dimension" by default.

ColorScales List<Pulumi.SignalFx.Inputs.SingleValueChartColorScaleArgs>

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.

IsTimestampHidden bool

Whether to hide the timestamp in the chart. false by default.

MaxDelay int

How long (in seconds) to wait for late datapoints

MaxPrecision int

The maximum precision to for value displayed.

Name string

Name of the chart.

ProgramText string

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

RefreshInterval int

How often (in seconds) to refresh the value.

SecondaryVisualization string

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

ShowSparkLine bool

Whether to show a trend line below the current value. false by default.

Timezone string

The property value is a string that denotes the geographic region associated with the time zone, (e.g. Australia/Sydney)

UnitPrefix string

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

Url string

The URL of the chart.

VizOptions List<Pulumi.SignalFx.Inputs.SingleValueChartVizOptionArgs>

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

ColorBy string

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

ColorScales []SingleValueChartColorScale

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.

IsTimestampHidden bool

Whether to hide the timestamp in the chart. false by default.

MaxDelay int

How long (in seconds) to wait for late datapoints

MaxPrecision int

The maximum precision to for value displayed.

Name string

Name of the chart.

ProgramText string

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

RefreshInterval int

How often (in seconds) to refresh the value.

SecondaryVisualization string

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

ShowSparkLine bool

Whether to show a trend line below the current value. false by default.

Timezone string

The property value is a string that denotes the geographic region associated with the time zone, (e.g. Australia/Sydney)

UnitPrefix string

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

Url string

The URL of the chart.

VizOptions []SingleValueChartVizOption

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

colorBy string

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

colorScales SingleValueChartColorScale[]

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.

isTimestampHidden boolean

Whether to hide the timestamp in the chart. false by default.

maxDelay number

How long (in seconds) to wait for late datapoints

maxPrecision number

The maximum precision to for value displayed.

name string

Name of the chart.

programText string

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

refreshInterval number

How often (in seconds) to refresh the value.

secondaryVisualization string

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

showSparkLine boolean

Whether to show a trend line below the current value. false by default.

timezone string

The property value is a string that denotes the geographic region associated with the time zone, (e.g. Australia/Sydney)

unitPrefix string

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

url string

The URL of the chart.

vizOptions SingleValueChartVizOption[]

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

color_by str

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

color_scales Sequence[SingleValueChartColorScaleArgs]

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.

is_timestamp_hidden bool

Whether to hide the timestamp in the chart. false by default.

max_delay int

How long (in seconds) to wait for late datapoints

max_precision int

The maximum precision to for value displayed.

name str

Name of the chart.

program_text str

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

refresh_interval int

How often (in seconds) to refresh the value.

secondary_visualization str

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

show_spark_line bool

Whether to show a trend line below the current value. false by default.

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

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

url str

The URL of the chart.

viz_options Sequence[SingleValueChartVizOptionArgs]

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

Supporting Types

SingleValueChartColorScale

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.

SingleValueChartVizOption

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.