signalfx.SingleValueChart
Explore with Pulumi AI
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
resource "signalfx_single_value_chart" "mysvchart0" {
name = "CPU Total Idle - Single Value"
program_text = <<-EOF
myfilters = filter("cluster_name", "prod") and filter("role", "search")
data("cpu.total.idle", filter=myfilters).publish()
EOF
description = "Very cool Single Value Chart"
color_by = "Dimension"
max_delay = 2
refresh_interval = 1
max_precision = 2
is_timestamp_hidden = true
}
Create SingleValueChart Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new SingleValueChart(name: string, args: SingleValueChartArgs, opts?: CustomResourceOptions);
@overload
def SingleValueChart(resource_name: str,
args: SingleValueChartArgs,
opts: Optional[ResourceOptions] = None)
@overload
def SingleValueChart(resource_name: str,
opts: Optional[ResourceOptions] = None,
program_text: Optional[str] = None,
name: Optional[str] = None,
description: Optional[str] = None,
is_timestamp_hidden: Optional[bool] = None,
max_delay: Optional[int] = None,
max_precision: Optional[int] = None,
color_by: Optional[str] = None,
color_scales: Optional[Sequence[SingleValueChartColorScaleArgs]] = 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)
public SingleValueChart(String name, SingleValueChartArgs args)
public SingleValueChart(String name, SingleValueChartArgs args, CustomResourceOptions options)
type: signalfx:SingleValueChart
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args 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.
- args SingleValueChartArgs
- 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 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.
- name String
- The unique name of the resource.
- args SingleValueChartArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var singleValueChartResource = new SignalFx.SingleValueChart("singleValueChartResource", new()
{
ProgramText = "string",
Name = "string",
Description = "string",
IsTimestampHidden = false,
MaxDelay = 0,
MaxPrecision = 0,
ColorBy = "string",
ColorScales = new[]
{
new SignalFx.Inputs.SingleValueChartColorScaleArgs
{
Color = "string",
Gt = 0,
Gte = 0,
Lt = 0,
Lte = 0,
},
},
RefreshInterval = 0,
SecondaryVisualization = "string",
ShowSparkLine = false,
Timezone = "string",
UnitPrefix = "string",
VizOptions = new[]
{
new SignalFx.Inputs.SingleValueChartVizOptionArgs
{
Label = "string",
Color = "string",
DisplayName = "string",
ValuePrefix = "string",
ValueSuffix = "string",
ValueUnit = "string",
},
},
});
example, err := signalfx.NewSingleValueChart(ctx, "singleValueChartResource", &signalfx.SingleValueChartArgs{
ProgramText: pulumi.String("string"),
Name: pulumi.String("string"),
Description: pulumi.String("string"),
IsTimestampHidden: pulumi.Bool(false),
MaxDelay: pulumi.Int(0),
MaxPrecision: pulumi.Int(0),
ColorBy: pulumi.String("string"),
ColorScales: signalfx.SingleValueChartColorScaleArray{
&signalfx.SingleValueChartColorScaleArgs{
Color: pulumi.String("string"),
Gt: pulumi.Float64(0),
Gte: pulumi.Float64(0),
Lt: pulumi.Float64(0),
Lte: pulumi.Float64(0),
},
},
RefreshInterval: pulumi.Int(0),
SecondaryVisualization: pulumi.String("string"),
ShowSparkLine: pulumi.Bool(false),
Timezone: pulumi.String("string"),
UnitPrefix: pulumi.String("string"),
VizOptions: signalfx.SingleValueChartVizOptionArray{
&signalfx.SingleValueChartVizOptionArgs{
Label: pulumi.String("string"),
Color: pulumi.String("string"),
DisplayName: pulumi.String("string"),
ValuePrefix: pulumi.String("string"),
ValueSuffix: pulumi.String("string"),
ValueUnit: pulumi.String("string"),
},
},
})
var singleValueChartResource = new SingleValueChart("singleValueChartResource", SingleValueChartArgs.builder()
.programText("string")
.name("string")
.description("string")
.isTimestampHidden(false)
.maxDelay(0)
.maxPrecision(0)
.colorBy("string")
.colorScales(SingleValueChartColorScaleArgs.builder()
.color("string")
.gt(0)
.gte(0)
.lt(0)
.lte(0)
.build())
.refreshInterval(0)
.secondaryVisualization("string")
.showSparkLine(false)
.timezone("string")
.unitPrefix("string")
.vizOptions(SingleValueChartVizOptionArgs.builder()
.label("string")
.color("string")
.displayName("string")
.valuePrefix("string")
.valueSuffix("string")
.valueUnit("string")
.build())
.build());
single_value_chart_resource = signalfx.SingleValueChart("singleValueChartResource",
program_text="string",
name="string",
description="string",
is_timestamp_hidden=False,
max_delay=0,
max_precision=0,
color_by="string",
color_scales=[signalfx.SingleValueChartColorScaleArgs(
color="string",
gt=0,
gte=0,
lt=0,
lte=0,
)],
refresh_interval=0,
secondary_visualization="string",
show_spark_line=False,
timezone="string",
unit_prefix="string",
viz_options=[signalfx.SingleValueChartVizOptionArgs(
label="string",
color="string",
display_name="string",
value_prefix="string",
value_suffix="string",
value_unit="string",
)])
const singleValueChartResource = new signalfx.SingleValueChart("singleValueChartResource", {
programText: "string",
name: "string",
description: "string",
isTimestampHidden: false,
maxDelay: 0,
maxPrecision: 0,
colorBy: "string",
colorScales: [{
color: "string",
gt: 0,
gte: 0,
lt: 0,
lte: 0,
}],
refreshInterval: 0,
secondaryVisualization: "string",
showSparkLine: false,
timezone: "string",
unitPrefix: "string",
vizOptions: [{
label: "string",
color: "string",
displayName: "string",
valuePrefix: "string",
valueSuffix: "string",
valueUnit: "string",
}],
});
type: signalfx:SingleValueChart
properties:
colorBy: string
colorScales:
- color: string
gt: 0
gte: 0
lt: 0
lte: 0
description: string
isTimestampHidden: false
maxDelay: 0
maxPrecision: 0
name: string
programText: string
refreshInterval: 0
secondaryVisualization: string
showSparkLine: false
timezone: string
unitPrefix: string
vizOptions:
- color: string
displayName: string
label: string
valuePrefix: string
valueSuffix: string
valueUnit: string
SingleValueChart 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 SingleValueChart resource accepts the following input properties:
- Program
Text string - Signalflow program text for the chart. More info in the Splunk Observability Cloud docs.
- Color
By string - Must be
"Dimension"
,"Scale"
or"Metric"
."Dimension"
by default. - Color
Scales List<Pulumi.Signal Fx. Inputs. Single Value Chart Color 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. - Description string
- Description of the chart.
- 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 string
- Name of the chart.
- Refresh
Interval int - How often (in seconds) to refresh the value.
- Secondary
Visualization string - The type of secondary visualization. Can be
None
,Radial
,Linear
, orSparkline
. If unset, the Splunk Observability Cloud default is used (None
). - Show
Spark boolLine - 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)
- Unit
Prefix string - Must be
"Metric"
or"Binary"
."Metric"
by default. - Viz
Options List<Pulumi.Signal Fx. Inputs. Single Value Chart Viz Option> - Plot-level customization options, associated with a publish statement.
- Program
Text string - Signalflow program text for the chart. More info in the Splunk Observability Cloud docs.
- Color
By string - Must be
"Dimension"
,"Scale"
or"Metric"
."Dimension"
by default. - Color
Scales []SingleValue Chart Color Scale Args - 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.
- 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 string
- Name of the chart.
- Refresh
Interval int - How often (in seconds) to refresh the value.
- Secondary
Visualization string - The type of secondary visualization. Can be
None
,Radial
,Linear
, orSparkline
. If unset, the Splunk Observability Cloud default is used (None
). - Show
Spark boolLine - 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)
- Unit
Prefix string - Must be
"Metric"
or"Binary"
."Metric"
by default. - Viz
Options []SingleValue Chart Viz Option Args - Plot-level customization options, associated with a publish statement.
- program
Text String - Signalflow program text for the chart. More info in the Splunk Observability Cloud docs.
- color
By String - Must be
"Dimension"
,"Scale"
or"Metric"
."Dimension"
by default. - color
Scales List<SingleValue Chart Color 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. - description String
- Description of the chart.
- Boolean
- Whether to hide the timestamp in the chart.
false
by default. - max
Delay Integer - How long (in seconds) to wait for late datapoints
- max
Precision Integer - The maximum precision to for value displayed.
- name String
- Name of the chart.
- refresh
Interval Integer - How often (in seconds) to refresh the value.
- secondary
Visualization String - The type of secondary visualization. Can be
None
,Radial
,Linear
, orSparkline
. If unset, the Splunk Observability Cloud default is used (None
). - show
Spark BooleanLine - 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)
- unit
Prefix String - Must be
"Metric"
or"Binary"
."Metric"
by default. - viz
Options List<SingleValue Chart Viz Option> - Plot-level customization options, associated with a publish statement.
- program
Text string - Signalflow program text for the chart. More info in the Splunk Observability Cloud docs.
- color
By string - Must be
"Dimension"
,"Scale"
or"Metric"
."Dimension"
by default. - color
Scales SingleValue Chart Color 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. - description string
- Description of the chart.
- boolean
- Whether to hide the timestamp in the chart.
false
by default. - max
Delay number - How long (in seconds) to wait for late datapoints
- max
Precision number - The maximum precision to for value displayed.
- name string
- Name of the chart.
- refresh
Interval number - How often (in seconds) to refresh the value.
- secondary
Visualization string - The type of secondary visualization. Can be
None
,Radial
,Linear
, orSparkline
. If unset, the Splunk Observability Cloud default is used (None
). - show
Spark booleanLine - 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)
- unit
Prefix string - Must be
"Metric"
or"Binary"
."Metric"
by default. - viz
Options SingleValue Chart Viz Option[] - Plot-level customization options, associated with a publish statement.
- program_
text str - Signalflow program text for the chart. More info in the Splunk Observability Cloud docs.
- color_
by str - Must be
"Dimension"
,"Scale"
or"Metric"
."Dimension"
by default. - color_
scales Sequence[SingleValue Chart Color Scale Args] - 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.
- 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
, orSparkline
. If unset, the Splunk Observability Cloud default is used (None
). - show_
spark_ boolline - 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[SingleValue Chart Viz Option Args] - Plot-level customization options, associated with a publish statement.
- program
Text String - Signalflow program text for the chart. More info in the Splunk Observability Cloud docs.
- color
By String - Must be
"Dimension"
,"Scale"
or"Metric"
."Dimension"
by default. - color
Scales List<Property Map> - 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.
- Boolean
- Whether to hide the timestamp in the chart.
false
by default. - max
Delay Number - How long (in seconds) to wait for late datapoints
- max
Precision Number - The maximum precision to for value displayed.
- name String
- Name of the chart.
- refresh
Interval Number - How often (in seconds) to refresh the value.
- secondary
Visualization String - The type of secondary visualization. Can be
None
,Radial
,Linear
, orSparkline
. If unset, the Splunk Observability Cloud default is used (None
). - show
Spark BooleanLine - 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)
- unit
Prefix String - Must be
"Metric"
or"Binary"
."Metric"
by default. - viz
Options List<Property Map> - Plot-level customization options, associated with a publish statement.
Outputs
All input properties are implicitly available as output properties. Additionally, the SingleValueChart resource produces the following output properties:
Look up 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)
public static SingleValueChart get(String name, Output<String> id, SingleValueChartState 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.
- Color
By string - Must be
"Dimension"
,"Scale"
or"Metric"
."Dimension"
by default. - Color
Scales List<Pulumi.Signal Fx. Inputs. Single Value Chart Color 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. - Description string
- Description of the chart.
- 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 string
- Name of the chart.
- Program
Text string - Signalflow program text for the chart. More info in the Splunk Observability Cloud docs.
- Refresh
Interval int - How often (in seconds) to refresh the value.
- Secondary
Visualization string - The type of secondary visualization. Can be
None
,Radial
,Linear
, orSparkline
. If unset, the Splunk Observability Cloud default is used (None
). - Show
Spark boolLine - 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)
- Unit
Prefix string - Must be
"Metric"
or"Binary"
."Metric"
by default. - Url string
- The URL of the chart.
- Viz
Options List<Pulumi.Signal Fx. Inputs. Single Value Chart Viz Option> - Plot-level customization options, associated with a publish statement.
- Color
By string - Must be
"Dimension"
,"Scale"
or"Metric"
."Dimension"
by default. - Color
Scales []SingleValue Chart Color Scale Args - 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.
- 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 string
- Name of the chart.
- Program
Text string - Signalflow program text for the chart. More info in the Splunk Observability Cloud docs.
- Refresh
Interval int - How often (in seconds) to refresh the value.
- Secondary
Visualization string - The type of secondary visualization. Can be
None
,Radial
,Linear
, orSparkline
. If unset, the Splunk Observability Cloud default is used (None
). - Show
Spark boolLine - 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)
- Unit
Prefix string - Must be
"Metric"
or"Binary"
."Metric"
by default. - Url string
- The URL of the chart.
- Viz
Options []SingleValue Chart Viz Option Args - Plot-level customization options, associated with a publish statement.
- color
By String - Must be
"Dimension"
,"Scale"
or"Metric"
."Dimension"
by default. - color
Scales List<SingleValue Chart Color 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. - description String
- Description of the chart.
- Boolean
- Whether to hide the timestamp in the chart.
false
by default. - max
Delay Integer - How long (in seconds) to wait for late datapoints
- max
Precision Integer - The maximum precision to for value displayed.
- name String
- Name of the chart.
- program
Text String - Signalflow program text for the chart. More info in the Splunk Observability Cloud docs.
- refresh
Interval Integer - How often (in seconds) to refresh the value.
- secondary
Visualization String - The type of secondary visualization. Can be
None
,Radial
,Linear
, orSparkline
. If unset, the Splunk Observability Cloud default is used (None
). - show
Spark BooleanLine - 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)
- unit
Prefix String - Must be
"Metric"
or"Binary"
."Metric"
by default. - url String
- The URL of the chart.
- viz
Options List<SingleValue Chart Viz Option> - Plot-level customization options, associated with a publish statement.
- color
By string - Must be
"Dimension"
,"Scale"
or"Metric"
."Dimension"
by default. - color
Scales SingleValue Chart Color 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. - description string
- Description of the chart.
- boolean
- Whether to hide the timestamp in the chart.
false
by default. - max
Delay number - How long (in seconds) to wait for late datapoints
- max
Precision number - The maximum precision to for value displayed.
- name string
- Name of the chart.
- program
Text string - Signalflow program text for the chart. More info in the Splunk Observability Cloud docs.
- refresh
Interval number - How often (in seconds) to refresh the value.
- secondary
Visualization string - The type of secondary visualization. Can be
None
,Radial
,Linear
, orSparkline
. If unset, the Splunk Observability Cloud default is used (None
). - show
Spark booleanLine - 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)
- unit
Prefix string - Must be
"Metric"
or"Binary"
."Metric"
by default. - url string
- The URL of the chart.
- viz
Options SingleValue Chart Viz Option[] - Plot-level customization options, associated with a publish statement.
- color_
by str - Must be
"Dimension"
,"Scale"
or"Metric"
."Dimension"
by default. - color_
scales Sequence[SingleValue Chart Color Scale Args] - 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.
- 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 Splunk Observability Cloud 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
, orSparkline
. If unset, the Splunk Observability Cloud default is used (None
). - show_
spark_ boolline - 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[SingleValue Chart Viz Option Args] - Plot-level customization options, associated with a publish statement.
- color
By String - Must be
"Dimension"
,"Scale"
or"Metric"
."Dimension"
by default. - color
Scales List<Property Map> - 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.
- Boolean
- Whether to hide the timestamp in the chart.
false
by default. - max
Delay Number - How long (in seconds) to wait for late datapoints
- max
Precision Number - The maximum precision to for value displayed.
- name String
- Name of the chart.
- program
Text String - Signalflow program text for the chart. More info in the Splunk Observability Cloud docs.
- refresh
Interval Number - How often (in seconds) to refresh the value.
- secondary
Visualization String - The type of secondary visualization. Can be
None
,Radial
,Linear
, orSparkline
. If unset, the Splunk Observability Cloud default is used (None
). - show
Spark BooleanLine - 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)
- unit
Prefix String - Must be
"Metric"
or"Binary"
."Metric"
by default. - url String
- The URL of the chart.
- viz
Options List<Property Map> - Plot-level customization options, associated with a publish statement.
Supporting Types
SingleValueChartColorScale, SingleValueChartColorScaleArgs
- 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.
SingleValueChartVizOption, SingleValueChartVizOptionArgs
- 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.
- Display
Name string - Specifies an alternate value for the Plot Name column of the Data Table associated with the chart.
- Value
Prefix string - ,
value_suffix
- (Optional) Arbitrary prefix/suffix to display with the value of this plot. - Value
Suffix string - An arbitrary suffix to display with the value of this plot
- Value
Unit string - A unit to attach to this plot. Units support automatic scaling (eg thousands of bytes will be displayed as kilobytes). 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
.
- 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.
- Display
Name string - Specifies an alternate value for the Plot Name column of the Data Table associated with the chart.
- Value
Prefix string - ,
value_suffix
- (Optional) Arbitrary prefix/suffix to display with the value of this plot. - Value
Suffix string - An arbitrary suffix to display with the value of this plot
- Value
Unit string - A unit to attach to this plot. Units support automatic scaling (eg thousands of bytes will be displayed as kilobytes). 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
.
- 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.
- display
Name String - Specifies an alternate value for the Plot Name column of the Data Table associated with the chart.
- value
Prefix String - ,
value_suffix
- (Optional) Arbitrary prefix/suffix to display with the value of this plot. - value
Suffix String - An arbitrary suffix to display with the value of this plot
- value
Unit String - A unit to attach to this plot. Units support automatic scaling (eg thousands of bytes will be displayed as kilobytes). 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
.
- 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.
- display
Name string - Specifies an alternate value for the Plot Name column of the Data Table associated with the chart.
- value
Prefix string - ,
value_suffix
- (Optional) Arbitrary prefix/suffix to display with the value of this plot. - value
Suffix string - An arbitrary suffix to display with the value of this plot
- value
Unit string - A unit to attach to this plot. Units support automatic scaling (eg thousands of bytes will be displayed as kilobytes). 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
.
- 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
- (Optional) Arbitrary prefix/suffix 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). 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
.
- 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.
- display
Name String - Specifies an alternate value for the Plot Name column of the Data Table associated with the chart.
- value
Prefix String - ,
value_suffix
- (Optional) Arbitrary prefix/suffix to display with the value of this plot. - value
Suffix String - An arbitrary suffix to display with the value of this plot
- value
Unit String - A unit to attach to this plot. Units support automatic scaling (eg thousands of bytes will be displayed as kilobytes). 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
.
Package Details
- Repository
- SignalFx pulumi/pulumi-signalfx
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
signalfx
Terraform Provider.