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

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 Pulumi;
using SignalFx = Pulumi.SignalFx;

class MyStack : Stack
{
    public MyStack()
    {
        var myheatmapchart0 = new SignalFx.HeatmapChart("myheatmapchart0", new SignalFx.HeatmapChartArgs
        {
            ColorRange = new SignalFx.Inputs.HeatmapChartColorRangeArgs
            {
                Color = "#ff0000",
                MaxValue = 100,
                MinValue = 0,
            },
            ColorScales = 
            {
                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 = 
            {
                "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/v4/go/signalfx"
    "github.com/pulumi/pulumi/sdk/v2/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("%v%v%v", "myfilters = filter(\"cluster_name\", \"prod\") and filter(\"role\", \"search\")\n", "data(\"cpu.total.idle\", filter=myfilters).publish()\n", "\n")),
            SortBy:        pulumi.String("+host"),
            Timezone:      pulumi.String("Europe/Paris"),
        })
        if err != nil {
            return err
        }
        return nil
    })
}
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: [
        // You can only use one of color_range or color_scale!
        {
            color: "green",
            gte: 99,
        },
        {
            color: "yellow",
            gte: 95,
            lt: 99, // This ensures terraform recognizes that we cover the range 95-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 a HeatmapChart Resource

new HeatmapChart(name: string, args: HeatmapChartArgs, opts?: CustomResourceOptions);
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)
func NewHeatmapChart(ctx *Context, name string, args HeatmapChartArgs, opts ...ResourceOption) (*HeatmapChart, error)
public HeatmapChart(string name, HeatmapChartArgs args, CustomResourceOptions? opts = null)
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.
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 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.

HeatmapChart Resource Properties

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

Inputs

The HeatmapChart resource accepts the following input properties:

ProgramText string

Signalflow program text for the chart. More info at https://developers.signalfx.com/docs/signalflow-overview.

ColorRange Pulumi.SignalFx.Inputs.HeatmapChartColorRangeArgs

Values and color for the color range. Example: color_range : { min : 0, max : 100, color : "#0000ff" }. Look at this link.

ColorScales List<Pulumi.SignalFx.Inputs.HeatmapChartColorScaleArgs>

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.

DisableSampling bool

If false, samples a subset of the output MTS, which improves UI performance. false by default.

GroupBies List<string>

Properties to group by in the heatmap (in nesting order).

HideTimestamp bool

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

MaxDelay int

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

MinimumResolution int

The minimum resolution (in seconds) to use for computing the underlying program.

Name string

Name of the chart.

RefreshInterval int

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

SortBy 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).

UnitPrefix string

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

ProgramText string

Signalflow program text for the chart. More info at https://developers.signalfx.com/docs/signalflow-overview.

ColorRange HeatmapChartColorRange

Values and color for the color range. Example: color_range : { min : 0, max : 100, color : "#0000ff" }. Look at this link.

ColorScales []HeatmapChartColorScale

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.

DisableSampling bool

If false, samples a subset of the output MTS, which improves UI performance. false by default.

GroupBies []string

Properties to group by in the heatmap (in nesting order).

HideTimestamp bool

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

MaxDelay int

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

MinimumResolution int

The minimum resolution (in seconds) to use for computing the underlying program.

Name string

Name of the chart.

RefreshInterval int

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

SortBy 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).

UnitPrefix string

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

programText string

Signalflow program text for the chart. More info at https://developers.signalfx.com/docs/signalflow-overview.

colorRange HeatmapChartColorRange

Values and color for the color range. Example: color_range : { min : 0, max : 100, color : "#0000ff" }. Look at this link.

colorScales HeatmapChartColorScale[]

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.

disableSampling boolean

If false, samples a subset of the output MTS, which improves UI performance. false by default.

groupBies string[]

Properties to group by in the heatmap (in nesting order).

hideTimestamp boolean

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

maxDelay number

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

minimumResolution number

The minimum resolution (in seconds) to use for computing the underlying program.

name string

Name of the chart.

refreshInterval number

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

sortBy 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).

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

Values and color for the color range. Example: color_range : { min : 0, max : 100, color : "#0000ff" }. Look at this link.

color_scales Sequence[HeatmapChartColorScaleArgs]

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.

Outputs

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

ColorRange Pulumi.SignalFx.Inputs.HeatmapChartColorRangeArgs

Values and color for the color range. Example: color_range : { min : 0, max : 100, color : "#0000ff" }. Look at this link.

ColorScales List<Pulumi.SignalFx.Inputs.HeatmapChartColorScaleArgs>

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.

DisableSampling bool

If false, samples a subset of the output MTS, which improves UI performance. false by default.

GroupBies List<string>

Properties to group by in the heatmap (in nesting order).

HideTimestamp bool

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

MaxDelay int

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

MinimumResolution int

The minimum resolution (in seconds) to use for computing the underlying program.

Name string

Name of the chart.

ProgramText string

Signalflow program text for the chart. More info at https://developers.signalfx.com/docs/signalflow-overview.

RefreshInterval int

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

SortBy 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).

UnitPrefix string

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

Url string

The URL of the chart.

ColorRange HeatmapChartColorRange

Values and color for the color range. Example: color_range : { min : 0, max : 100, color : "#0000ff" }. Look at this link.

ColorScales []HeatmapChartColorScale

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.

DisableSampling bool

If false, samples a subset of the output MTS, which improves UI performance. false by default.

GroupBies []string

Properties to group by in the heatmap (in nesting order).

HideTimestamp bool

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

MaxDelay int

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

MinimumResolution int

The minimum resolution (in seconds) to use for computing the underlying program.

Name string

Name of the chart.

ProgramText string

Signalflow program text for the chart. More info at https://developers.signalfx.com/docs/signalflow-overview.

RefreshInterval int

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

SortBy 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).

UnitPrefix string

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

Url string

The URL of the chart.

colorRange HeatmapChartColorRange

Values and color for the color range. Example: color_range : { min : 0, max : 100, color : "#0000ff" }. Look at this link.

colorScales HeatmapChartColorScale[]

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.

disableSampling boolean

If false, samples a subset of the output MTS, which improves UI performance. false by default.

groupBies string[]

Properties to group by in the heatmap (in nesting order).

hideTimestamp boolean

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

maxDelay number

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

minimumResolution number

The minimum resolution (in seconds) to use for computing the underlying program.

name string

Name of the chart.

programText string

Signalflow program text for the chart. More info at https://developers.signalfx.com/docs/signalflow-overview.

refreshInterval number

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

sortBy 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).

unitPrefix string

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

url string

The URL of the chart.

color_range HeatmapChartColorRangeArgs

Values and color for the color range. Example: color_range : { min : 0, max : 100, color : "#0000ff" }. Look at this link.

color_scales Sequence[HeatmapChartColorScaleArgs]

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.

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.

MaxValue double

The maximum value within the coloring range.

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

MaxValue float64

The maximum value within the coloring range.

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

maxValue number

The maximum value within the coloring range.

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

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

Package Details

Repository
https://github.com/pulumi/pulumi-signalfx
License
Apache-2.0
Notes
This Pulumi package is based on the signalfx Terraform Provider.