signalfx.HeatmapChart
This chart type displays the specified plot in a heatmap fashion. This format is similar to the Infrastructure Navigator, with squares representing each source for the selected metric, and the color of each square representing the value range of the metric.
Example Usage
using System.Collections.Generic;
using Pulumi;
using SignalFx = Pulumi.SignalFx;
return await Deployment.RunAsync(() =>
{
var myheatmapchart0 = new SignalFx.HeatmapChart("myheatmapchart0", new()
{
ColorRange = new SignalFx.Inputs.HeatmapChartColorRangeArgs
{
Color = "#ff0000",
MaxValue = 100,
MinValue = 0,
},
ColorScales = new[]
{
new SignalFx.Inputs.HeatmapChartColorScaleArgs
{
Color = "green",
Gte = 99,
},
new SignalFx.Inputs.HeatmapChartColorScaleArgs
{
Color = "yellow",
Gte = 95,
Lt = 99,
},
new SignalFx.Inputs.HeatmapChartColorScaleArgs
{
Color = "red",
Lt = 95,
},
},
Description = "Very cool Heatmap",
DisableSampling = true,
GroupBies = new[]
{
"hostname",
"host",
},
HideTimestamp = true,
ProgramText = @"myfilters = filter(""cluster_name"", ""prod"") and filter(""role"", ""search"")
data(""cpu.total.idle"", filter=myfilters).publish()
",
SortBy = "+host",
Timezone = "Europe/Paris",
});
});
package main
import (
"fmt"
"github.com/pulumi/pulumi-signalfx/sdk/v5/go/signalfx"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := signalfx.NewHeatmapChart(ctx, "myheatmapchart0", &signalfx.HeatmapChartArgs{
ColorRange: &signalfx.HeatmapChartColorRangeArgs{
Color: pulumi.String("#ff0000"),
MaxValue: pulumi.Float64(100),
MinValue: pulumi.Float64(0),
},
ColorScales: signalfx.HeatmapChartColorScaleArray{
&signalfx.HeatmapChartColorScaleArgs{
Color: pulumi.String("green"),
Gte: pulumi.Float64(99),
},
&signalfx.HeatmapChartColorScaleArgs{
Color: pulumi.String("yellow"),
Gte: pulumi.Float64(95),
Lt: pulumi.Float64(99),
},
&signalfx.HeatmapChartColorScaleArgs{
Color: pulumi.String("red"),
Lt: pulumi.Float64(95),
},
},
Description: pulumi.String("Very cool Heatmap"),
DisableSampling: pulumi.Bool(true),
GroupBies: pulumi.StringArray{
pulumi.String("hostname"),
pulumi.String("host"),
},
HideTimestamp: pulumi.Bool(true),
ProgramText: pulumi.String(fmt.Sprintf("myfilters = filter(\"cluster_name\", \"prod\") and filter(\"role\", \"search\")\ndata(\"cpu.total.idle\", filter=myfilters).publish()\n\n")),
SortBy: pulumi.String("+host"),
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.HeatmapChart;
import com.pulumi.signalfx.HeatmapChartArgs;
import com.pulumi.signalfx.inputs.HeatmapChartColorRangeArgs;
import com.pulumi.signalfx.inputs.HeatmapChartColorScaleArgs;
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 myheatmapchart0 = new HeatmapChart("myheatmapchart0", HeatmapChartArgs.builder()
.colorRange(HeatmapChartColorRangeArgs.builder()
.color("#ff0000")
.maxValue(100)
.minValue(0)
.build())
.colorScales(
HeatmapChartColorScaleArgs.builder()
.color("green")
.gte(99)
.build(),
HeatmapChartColorScaleArgs.builder()
.color("yellow")
.gte(95)
.lt(99)
.build(),
HeatmapChartColorScaleArgs.builder()
.color("red")
.lt(95)
.build())
.description("Very cool Heatmap")
.disableSampling(true)
.groupBies(
"hostname",
"host")
.hideTimestamp(true)
.programText("""
myfilters = filter("cluster_name", "prod") and filter("role", "search")
data("cpu.total.idle", filter=myfilters).publish()
""")
.sortBy("+host")
.timezone("Europe/Paris")
.build());
}
}
import pulumi
import pulumi_signalfx as signalfx
myheatmapchart0 = signalfx.HeatmapChart("myheatmapchart0",
color_range=signalfx.HeatmapChartColorRangeArgs(
color="#ff0000",
max_value=100,
min_value=0,
),
color_scales=[
signalfx.HeatmapChartColorScaleArgs(
color="green",
gte=99,
),
signalfx.HeatmapChartColorScaleArgs(
color="yellow",
gte=95,
lt=99,
),
signalfx.HeatmapChartColorScaleArgs(
color="red",
lt=95,
),
],
description="Very cool Heatmap",
disable_sampling=True,
group_bies=[
"hostname",
"host",
],
hide_timestamp=True,
program_text="""myfilters = filter("cluster_name", "prod") and filter("role", "search")
data("cpu.total.idle", filter=myfilters).publish()
""",
sort_by="+host",
timezone="Europe/Paris")
import * as pulumi from "@pulumi/pulumi";
import * as signalfx from "@pulumi/signalfx";
const myheatmapchart0 = new signalfx.HeatmapChart("myheatmapchart0", {
colorRange: {
color: "#ff0000",
maxValue: 100,
minValue: 0,
},
colorScales: [
{
color: "green",
gte: 99,
},
{
color: "yellow",
gte: 95,
lt: 99,
},
{
color: "red",
lt: 95,
},
],
description: "Very cool Heatmap",
disableSampling: true,
groupBies: [
"hostname",
"host",
],
hideTimestamp: true,
programText: `myfilters = filter("cluster_name", "prod") and filter("role", "search")
data("cpu.total.idle", filter=myfilters).publish()
`,
sortBy: "+host",
timezone: "Europe/Paris",
});
resources:
myheatmapchart0:
type: signalfx:HeatmapChart
properties:
colorRange:
color: '#ff0000'
maxValue: 100
minValue: 0
colorScales:
- color: green
gte: 99
- color: yellow
gte: 95
lt: 99
- color: red
lt: 95
description: Very cool Heatmap
disableSampling: true
groupBies:
- hostname
- host
hideTimestamp: true
programText: |+
myfilters = filter("cluster_name", "prod") and filter("role", "search")
data("cpu.total.idle", filter=myfilters).publish()
sortBy: +host
timezone: Europe/Paris
Create HeatmapChart Resource
new HeatmapChart(name: string, args: HeatmapChartArgs, opts?: CustomResourceOptions);
@overload
def HeatmapChart(resource_name: str,
opts: Optional[ResourceOptions] = None,
color_range: Optional[HeatmapChartColorRangeArgs] = None,
color_scales: Optional[Sequence[HeatmapChartColorScaleArgs]] = None,
description: Optional[str] = None,
disable_sampling: Optional[bool] = None,
group_bies: Optional[Sequence[str]] = None,
hide_timestamp: Optional[bool] = None,
max_delay: Optional[int] = None,
minimum_resolution: Optional[int] = None,
name: Optional[str] = None,
program_text: Optional[str] = None,
refresh_interval: Optional[int] = None,
sort_by: Optional[str] = None,
timezone: Optional[str] = None,
unit_prefix: Optional[str] = None)
@overload
def HeatmapChart(resource_name: str,
args: HeatmapChartArgs,
opts: Optional[ResourceOptions] = None)
func NewHeatmapChart(ctx *Context, name string, args HeatmapChartArgs, opts ...ResourceOption) (*HeatmapChart, error)
public HeatmapChart(string name, HeatmapChartArgs args, CustomResourceOptions? opts = null)
public HeatmapChart(String name, HeatmapChartArgs args)
public HeatmapChart(String name, HeatmapChartArgs args, CustomResourceOptions options)
type: signalfx:HeatmapChart
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args HeatmapChartArgs
- 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 HeatmapChartArgs
- 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 HeatmapChartArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args HeatmapChartArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args HeatmapChartArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
HeatmapChart 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 HeatmapChart resource accepts the following input properties:
- Program
Text string Signalflow program text for the chart. More info at https://developers.signalfx.com/docs/signalflow-overview.
- Color
Range Pulumi.Signal Fx. Inputs. Heatmap Chart Color Range Args Values and color for the color range. Example:
color_range : { min : 0, max : 100, color : "#0000ff" }
. Look at this link.- Color
Scales List<Pulumi.Signal Fx. Inputs. Heatmap Chart Color Scale Args> One to N blocks, each defining a single color range including both the color to display for that range and the borders of the range. Example:
color_scale { gt = 60, color = "blue" } color_scale { lte = 60, color = "yellow" }
. Look at this link.- Description string
Description of the chart.
- Disable
Sampling bool If
false
, samples a subset of the output MTS, which improves UI performance.false
by default.- Group
Bies List<string> Properties to group by in the heatmap (in nesting order).
- Hide
Timestamp bool Whether to show the timestamp in the chart.
false
by default.- Max
Delay int How long (in seconds) to wait for late datapoints.
- Minimum
Resolution int The minimum resolution (in seconds) to use for computing the underlying program.
- Name string
Name of the chart.
- Refresh
Interval int How often (in seconds) to refresh the values of the heatmap.
- Sort
By string The property to use when sorting the elements. Must be prepended with
+
for ascending or-
for descending (e.g.-foo
).- Timezone string
The property value is a string that denotes the geographic region associated with the time zone, (default UTC).
- Unit
Prefix string Must be
"Metric"
or"Binary
"."Metric"
by default.
- Program
Text string Signalflow program text for the chart. More info at https://developers.signalfx.com/docs/signalflow-overview.
- Color
Range HeatmapChart Color Range Args Values and color for the color range. Example:
color_range : { min : 0, max : 100, color : "#0000ff" }
. Look at this link.- Color
Scales []HeatmapChart Color Scale Args One to N blocks, each defining a single color range including both the color to display for that range and the borders of the range. Example:
color_scale { gt = 60, color = "blue" } color_scale { lte = 60, color = "yellow" }
. Look at this link.- Description string
Description of the chart.
- Disable
Sampling bool If
false
, samples a subset of the output MTS, which improves UI performance.false
by default.- Group
Bies []string Properties to group by in the heatmap (in nesting order).
- Hide
Timestamp bool Whether to show the timestamp in the chart.
false
by default.- Max
Delay int How long (in seconds) to wait for late datapoints.
- Minimum
Resolution int The minimum resolution (in seconds) to use for computing the underlying program.
- Name string
Name of the chart.
- Refresh
Interval int How often (in seconds) to refresh the values of the heatmap.
- Sort
By string The property to use when sorting the elements. Must be prepended with
+
for ascending or-
for descending (e.g.-foo
).- Timezone string
The property value is a string that denotes the geographic region associated with the time zone, (default UTC).
- Unit
Prefix string Must be
"Metric"
or"Binary
"."Metric"
by default.
- program
Text String Signalflow program text for the chart. More info at https://developers.signalfx.com/docs/signalflow-overview.
- color
Range HeatmapChart Color Range Args Values and color for the color range. Example:
color_range : { min : 0, max : 100, color : "#0000ff" }
. Look at this link.- color
Scales List<HeatmapChart Color Scale Args> One to N blocks, each defining a single color range including both the color to display for that range and the borders of the range. Example:
color_scale { gt = 60, color = "blue" } color_scale { lte = 60, color = "yellow" }
. Look at this link.- description String
Description of the chart.
- disable
Sampling Boolean If
false
, samples a subset of the output MTS, which improves UI performance.false
by default.- group
Bies List<String> Properties to group by in the heatmap (in nesting order).
- hide
Timestamp Boolean Whether to show the timestamp in the chart.
false
by default.- max
Delay Integer How long (in seconds) to wait for late datapoints.
- minimum
Resolution Integer The minimum resolution (in seconds) to use for computing the underlying program.
- name String
Name of the chart.
- refresh
Interval Integer How often (in seconds) to refresh the values of the heatmap.
- sort
By String The property to use when sorting the elements. Must be prepended with
+
for ascending or-
for descending (e.g.-foo
).- timezone String
The property value is a string that denotes the geographic region associated with the time zone, (default UTC).
- unit
Prefix String Must be
"Metric"
or"Binary
"."Metric"
by default.
- program
Text string Signalflow program text for the chart. More info at https://developers.signalfx.com/docs/signalflow-overview.
- color
Range HeatmapChart Color Range Args Values and color for the color range. Example:
color_range : { min : 0, max : 100, color : "#0000ff" }
. Look at this link.- color
Scales HeatmapChart Color Scale Args[] One to N blocks, each defining a single color range including both the color to display for that range and the borders of the range. Example:
color_scale { gt = 60, color = "blue" } color_scale { lte = 60, color = "yellow" }
. Look at this link.- description string
Description of the chart.
- disable
Sampling boolean If
false
, samples a subset of the output MTS, which improves UI performance.false
by default.- group
Bies string[] Properties to group by in the heatmap (in nesting order).
- hide
Timestamp boolean Whether to show the timestamp in the chart.
false
by default.- max
Delay number How long (in seconds) to wait for late datapoints.
- minimum
Resolution number The minimum resolution (in seconds) to use for computing the underlying program.
- name string
Name of the chart.
- refresh
Interval number How often (in seconds) to refresh the values of the heatmap.
- sort
By string The property to use when sorting the elements. Must be prepended with
+
for ascending or-
for descending (e.g.-foo
).- timezone string
The property value is a string that denotes the geographic region associated with the time zone, (default UTC).
- unit
Prefix string Must be
"Metric"
or"Binary
"."Metric"
by default.
- program_
text str Signalflow program text for the chart. More info at https://developers.signalfx.com/docs/signalflow-overview.
- color_
range HeatmapChart Color Range Args Values and color for the color range. Example:
color_range : { min : 0, max : 100, color : "#0000ff" }
. Look at this link.- color_
scales Sequence[HeatmapChart Color Scale Args] One to N blocks, each defining a single color range including both the color to display for that range and the borders of the range. Example:
color_scale { gt = 60, color = "blue" } color_scale { lte = 60, color = "yellow" }
. Look at this link.- description str
Description of the chart.
- disable_
sampling bool If
false
, samples a subset of the output MTS, which improves UI performance.false
by default.- group_
bies Sequence[str] Properties to group by in the heatmap (in nesting order).
- hide_
timestamp bool Whether to show the timestamp in the chart.
false
by default.- max_
delay int How long (in seconds) to wait for late datapoints.
- minimum_
resolution int The minimum resolution (in seconds) to use for computing the underlying program.
- name str
Name of the chart.
- refresh_
interval int How often (in seconds) to refresh the values of the heatmap.
- sort_
by str The property to use when sorting the elements. Must be prepended with
+
for ascending or-
for descending (e.g.-foo
).- timezone str
The property value is a string that denotes the geographic region associated with the time zone, (default UTC).
- unit_
prefix str Must be
"Metric"
or"Binary
"."Metric"
by default.
- program
Text String Signalflow program text for the chart. More info at https://developers.signalfx.com/docs/signalflow-overview.
- color
Range Property Map Values and color for the color range. Example:
color_range : { min : 0, max : 100, color : "#0000ff" }
. Look at this link.- color
Scales List<Property Map> One to N blocks, each defining a single color range including both the color to display for that range and the borders of the range. Example:
color_scale { gt = 60, color = "blue" } color_scale { lte = 60, color = "yellow" }
. Look at this link.- description String
Description of the chart.
- disable
Sampling Boolean If
false
, samples a subset of the output MTS, which improves UI performance.false
by default.- group
Bies List<String> Properties to group by in the heatmap (in nesting order).
- hide
Timestamp Boolean Whether to show the timestamp in the chart.
false
by default.- max
Delay Number How long (in seconds) to wait for late datapoints.
- minimum
Resolution Number The minimum resolution (in seconds) to use for computing the underlying program.
- name String
Name of the chart.
- refresh
Interval Number How often (in seconds) to refresh the values of the heatmap.
- sort
By String The property to use when sorting the elements. Must be prepended with
+
for ascending or-
for descending (e.g.-foo
).- timezone String
The property value is a string that denotes the geographic region associated with the time zone, (default UTC).
- unit
Prefix String Must be
"Metric"
or"Binary
"."Metric"
by default.
Outputs
All input properties are implicitly available as output properties. Additionally, the HeatmapChart resource produces the following output properties:
Look up Existing HeatmapChart Resource
Get an existing HeatmapChart 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?: HeatmapChartState, opts?: CustomResourceOptions): HeatmapChart
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
color_range: Optional[HeatmapChartColorRangeArgs] = None,
color_scales: Optional[Sequence[HeatmapChartColorScaleArgs]] = None,
description: Optional[str] = None,
disable_sampling: Optional[bool] = None,
group_bies: Optional[Sequence[str]] = None,
hide_timestamp: Optional[bool] = None,
max_delay: Optional[int] = None,
minimum_resolution: Optional[int] = None,
name: Optional[str] = None,
program_text: Optional[str] = None,
refresh_interval: Optional[int] = None,
sort_by: Optional[str] = None,
timezone: Optional[str] = None,
unit_prefix: Optional[str] = None,
url: Optional[str] = None) -> HeatmapChart
func GetHeatmapChart(ctx *Context, name string, id IDInput, state *HeatmapChartState, opts ...ResourceOption) (*HeatmapChart, error)
public static HeatmapChart Get(string name, Input<string> id, HeatmapChartState? state, CustomResourceOptions? opts = null)
public static HeatmapChart get(String name, Output<String> id, HeatmapChartState 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
Range Pulumi.Signal Fx. Inputs. Heatmap Chart Color Range Args Values and color for the color range. Example:
color_range : { min : 0, max : 100, color : "#0000ff" }
. Look at this link.- Color
Scales List<Pulumi.Signal Fx. Inputs. Heatmap Chart Color Scale Args> One to N blocks, each defining a single color range including both the color to display for that range and the borders of the range. Example:
color_scale { gt = 60, color = "blue" } color_scale { lte = 60, color = "yellow" }
. Look at this link.- Description string
Description of the chart.
- Disable
Sampling bool If
false
, samples a subset of the output MTS, which improves UI performance.false
by default.- Group
Bies List<string> Properties to group by in the heatmap (in nesting order).
- Hide
Timestamp bool Whether to show the timestamp in the chart.
false
by default.- Max
Delay int How long (in seconds) to wait for late datapoints.
- Minimum
Resolution int The minimum resolution (in seconds) to use for computing the underlying program.
- Name string
Name of the chart.
- Program
Text string 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 heatmap.
- Sort
By string The property to use when sorting the elements. Must be prepended with
+
for ascending or-
for descending (e.g.-foo
).- Timezone string
The property value is a string that denotes the geographic region associated with the time zone, (default UTC).
- Unit
Prefix string Must be
"Metric"
or"Binary
"."Metric"
by default.- Url string
The URL of the chart.
- Color
Range HeatmapChart Color Range Args Values and color for the color range. Example:
color_range : { min : 0, max : 100, color : "#0000ff" }
. Look at this link.- Color
Scales []HeatmapChart Color Scale Args One to N blocks, each defining a single color range including both the color to display for that range and the borders of the range. Example:
color_scale { gt = 60, color = "blue" } color_scale { lte = 60, color = "yellow" }
. Look at this link.- Description string
Description of the chart.
- Disable
Sampling bool If
false
, samples a subset of the output MTS, which improves UI performance.false
by default.- Group
Bies []string Properties to group by in the heatmap (in nesting order).
- Hide
Timestamp bool Whether to show the timestamp in the chart.
false
by default.- Max
Delay int How long (in seconds) to wait for late datapoints.
- Minimum
Resolution int The minimum resolution (in seconds) to use for computing the underlying program.
- Name string
Name of the chart.
- Program
Text string 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 heatmap.
- Sort
By string The property to use when sorting the elements. Must be prepended with
+
for ascending or-
for descending (e.g.-foo
).- Timezone string
The property value is a string that denotes the geographic region associated with the time zone, (default UTC).
- Unit
Prefix string Must be
"Metric"
or"Binary
"."Metric"
by default.- Url string
The URL of the chart.
- color
Range HeatmapChart Color Range Args Values and color for the color range. Example:
color_range : { min : 0, max : 100, color : "#0000ff" }
. Look at this link.- color
Scales List<HeatmapChart Color Scale Args> One to N blocks, each defining a single color range including both the color to display for that range and the borders of the range. Example:
color_scale { gt = 60, color = "blue" } color_scale { lte = 60, color = "yellow" }
. Look at this link.- description String
Description of the chart.
- disable
Sampling Boolean If
false
, samples a subset of the output MTS, which improves UI performance.false
by default.- group
Bies List<String> Properties to group by in the heatmap (in nesting order).
- hide
Timestamp Boolean Whether to show the timestamp in the chart.
false
by default.- max
Delay Integer How long (in seconds) to wait for late datapoints.
- minimum
Resolution Integer The minimum resolution (in seconds) to use for computing the underlying program.
- name String
Name of the chart.
- program
Text String Signalflow program text for the chart. More info at https://developers.signalfx.com/docs/signalflow-overview.
- refresh
Interval Integer How often (in seconds) to refresh the values of the heatmap.
- sort
By String The property to use when sorting the elements. Must be prepended with
+
for ascending or-
for descending (e.g.-foo
).- timezone String
The property value is a string that denotes the geographic region associated with the time zone, (default UTC).
- unit
Prefix String Must be
"Metric"
or"Binary
"."Metric"
by default.- url String
The URL of the chart.
- color
Range HeatmapChart Color Range Args Values and color for the color range. Example:
color_range : { min : 0, max : 100, color : "#0000ff" }
. Look at this link.- color
Scales HeatmapChart Color Scale Args[] One to N blocks, each defining a single color range including both the color to display for that range and the borders of the range. Example:
color_scale { gt = 60, color = "blue" } color_scale { lte = 60, color = "yellow" }
. Look at this link.- description string
Description of the chart.
- disable
Sampling boolean If
false
, samples a subset of the output MTS, which improves UI performance.false
by default.- group
Bies string[] Properties to group by in the heatmap (in nesting order).
- hide
Timestamp boolean Whether to show the timestamp in the chart.
false
by default.- max
Delay number How long (in seconds) to wait for late datapoints.
- minimum
Resolution number The minimum resolution (in seconds) to use for computing the underlying program.
- name string
Name of the chart.
- program
Text string Signalflow program text for the chart. More info at https://developers.signalfx.com/docs/signalflow-overview.
- refresh
Interval number How often (in seconds) to refresh the values of the heatmap.
- sort
By string The property to use when sorting the elements. Must be prepended with
+
for ascending or-
for descending (e.g.-foo
).- timezone string
The property value is a string that denotes the geographic region associated with the time zone, (default UTC).
- unit
Prefix string Must be
"Metric"
or"Binary
"."Metric"
by default.- url string
The URL of the chart.
- color_
range HeatmapChart Color Range Args Values and color for the color range. Example:
color_range : { min : 0, max : 100, color : "#0000ff" }
. Look at this link.- color_
scales Sequence[HeatmapChart Color Scale Args] One to N blocks, each defining a single color range including both the color to display for that range and the borders of the range. Example:
color_scale { gt = 60, color = "blue" } color_scale { lte = 60, color = "yellow" }
. Look at this link.- description str
Description of the chart.
- disable_
sampling bool If
false
, samples a subset of the output MTS, which improves UI performance.false
by default.- group_
bies Sequence[str] Properties to group by in the heatmap (in nesting order).
- hide_
timestamp bool Whether to show the timestamp in the chart.
false
by default.- max_
delay int How long (in seconds) to wait for late datapoints.
- minimum_
resolution int The minimum resolution (in seconds) to use for computing the underlying program.
- 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 heatmap.
- sort_
by str The property to use when sorting the elements. Must be prepended with
+
for ascending or-
for descending (e.g.-foo
).- timezone str
The property value is a string that denotes the geographic region associated with the time zone, (default UTC).
- unit_
prefix str Must be
"Metric"
or"Binary
"."Metric"
by default.- url str
The URL of the chart.
- color
Range Property Map Values and color for the color range. Example:
color_range : { min : 0, max : 100, color : "#0000ff" }
. Look at this link.- color
Scales List<Property Map> One to N blocks, each defining a single color range including both the color to display for that range and the borders of the range. Example:
color_scale { gt = 60, color = "blue" } color_scale { lte = 60, color = "yellow" }
. Look at this link.- description String
Description of the chart.
- disable
Sampling Boolean If
false
, samples a subset of the output MTS, which improves UI performance.false
by default.- group
Bies List<String> Properties to group by in the heatmap (in nesting order).
- hide
Timestamp Boolean Whether to show the timestamp in the chart.
false
by default.- max
Delay Number How long (in seconds) to wait for late datapoints.
- minimum
Resolution Number The minimum resolution (in seconds) to use for computing the underlying program.
- name String
Name of the chart.
- program
Text String Signalflow program text for the chart. More info at https://developers.signalfx.com/docs/signalflow-overview.
- refresh
Interval Number How often (in seconds) to refresh the values of the heatmap.
- sort
By String The property to use when sorting the elements. Must be prepended with
+
for ascending or-
for descending (e.g.-foo
).- timezone String
The property value is a string that denotes the geographic region associated with the time zone, (default UTC).
- unit
Prefix String Must be
"Metric"
or"Binary
"."Metric"
by default.- url String
The URL of the chart.
Supporting Types
HeatmapChartColorRange
- Color string
The color range to use. Hex values are not supported here. 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.
- Max
Value double The maximum value within the coloring range.
- Min
Value double The minimum value within the coloring range.
- Color string
The color range to use. Hex values are not supported here. 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.
- Max
Value float64 The maximum value within the coloring range.
- Min
Value float64 The minimum value within the coloring range.
- color String
The color range to use. Hex values are not supported here. 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.
- max
Value Double The maximum value within the coloring range.
- min
Value Double The minimum value within the coloring range.
- color string
The color range to use. Hex values are not supported here. 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.
- max
Value number The maximum value within the coloring range.
- min
Value number The minimum value within the coloring range.
- color str
The color range to use. Hex values are not supported here. 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.
- max_
value float The maximum value within the coloring range.
- min_
value float The minimum value within the coloring range.
- color String
The color range to use. Hex values are not supported here. 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.
- max
Value Number The maximum value within the coloring range.
- min
Value Number The minimum value within the coloring range.
HeatmapChartColorScale
- Color string
The color range to use. Hex values are not supported here. 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-inclusive value for this range.
- Lte double
Indicates the upper threshold inclusive value for this range.
- Color string
The color range to use. Hex values are not supported here. 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-inclusive value for this range.
- Lte float64
Indicates the upper threshold inclusive value for this range.
- color String
The color range to use. Hex values are not supported here. 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-inclusive value for this range.
- lte Double
Indicates the upper threshold inclusive value for this range.
- color string
The color range to use. Hex values are not supported here. 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-inclusive value for this range.
- lte number
Indicates the upper threshold inclusive value for this range.
- color str
The color range to use. Hex values are not supported here. 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-inclusive value for this range.
- lte float
Indicates the upper threshold inclusive value for this range.
- color String
The color range to use. Hex values are not supported here. 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-inclusive value for this range.
- lte Number
Indicates the upper threshold inclusive value for this range.
Package Details
- Repository
- SignalFx pulumi/pulumi-signalfx
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
signalfx
Terraform Provider.