1. Docs
  2. Reference
  3. API
  4. SignalFx
  5. Dashboard

Dashboard

A dashboard is a curated collection of specific charts and supports dimensional filters, dashboard variables and time range options. These options are applied to all charts in the dashboard, providing a consistent view of the data displayed in that dashboard. This also means that when you open a chart to drill down for more details, you are viewing the same data that is visible in the dashboard view.

NOTE Since every dashboard is included in a dashboard group (SignalFx collection of dashboards), you need to create that first and reference it as shown in the example.

Dashboard Layout Information

Every SignalFx dashboard is shown as a grid of 12 columns and potentially infinite number of rows. The dimension of the single column depends on the screen resolution.

When you define a dashboard resource, you need to specify which charts (by chart_id) should be displayed in the dashboard, along with layout information determining where on the dashboard the charts should be displayed. You have to assign to every chart a width in terms of number of columns to cover up (from 1 to 12) and a height in terms of number of rows (more or equal than 1). You can also assign a position in the dashboard grid where you like the graph to stay. In order to do that, you assign a row that represents the topmost row of the chart and a column that represent the leftmost column of the chart. If by mistake, you wrote a configuration where there are not enough columns to accommodate your charts in a specific row, they will be split in different rows. In case a row was specified with value higher than 1, if all the rows above are not filled by other charts, the chart will be placed the first empty row.

The are a bunch of use cases where this layout makes things too verbose and hard to work with loops. For those you can now use one of these two layouts: grids and columns.

WARNING These other layouts are not supported by the SignalFx API and are purely provider-side constructs. As such the provider cannot import them and cannot properly reconcile API-side changes. In other words, if someone changes the charts in the UI it will not be reconciled at the next apply. Also, you may only use one of chart, column, or grid when laying out dashboards. You can, however, use multiple instances of each (e.g. multiple grids) for fancy layout.

Example Usage

Column

using System.Linq;
using Pulumi;
using SignalFx = Pulumi.SignalFx;

class MyStack : Stack
{
    public MyStack()
    {
        var load = new SignalFx.Dashboard("load", new SignalFx.DashboardArgs
        {
            Columns = 
            {
                new SignalFx.Inputs.DashboardColumnArgs
                {
                    ChartIds = 
                    {
                        signalfx_single_value_chart.Rps.Select(__item => __item.Id).ToList(),
                    },
                    Width = 2,
                },
                new SignalFx.Inputs.DashboardColumnArgs
                {
                    ChartIds = 
                    {
                        signalfx_time_chart.Cpu_capacity.Select(__item => __item.Id).ToList(),
                    },
                    Column = 2,
                    Width = 4,
                },
            },
            DashboardGroup = signalfx_dashboard_group.Example.Id,
        });
    }

}

Coming soon!

import pulumi
import pulumi_signalfx as signalfx

load = signalfx.Dashboard("load",
    columns=[
        {
            "chartIds": [[__item["id"] for __item in signalfx_single_value_chart["rps"]]],
            "width": 2,
        },
        {
            "chartIds": [[__item["id"] for __item in signalfx_time_chart["cpu_capacity"]]],
            "column": 2,
            "width": 4,
        },
    ],
    dashboard_group=signalfx_dashboard_group["example"]["id"])
import * as pulumi from "@pulumi/pulumi";
import * as signalfx from "@pulumi/signalfx";

const load = new signalfx.Dashboard("load", {
    columns: [
        {
            chartIds: [signalfx_single_value_chart_rps.map(v => v.id)],
            width: 2,
        },
        {
            chartIds: [signalfx_time_chart_cpu_capacity.map(v => v.id)],
            column: 2,
            width: 4,
        },
    ],
    dashboardGroup: signalfx_dashboard_group_example.id,
});

Create a Dashboard Resource

new Dashboard(name: string, args: DashboardArgs, opts?: CustomResourceOptions);
def Dashboard(resource_name, opts=None, authorized_writer_teams=None, authorized_writer_users=None, charts=None, charts_resolution=None, columns=None, dashboard_group=None, description=None, discovery_options_query=None, discovery_options_selectors=None, end_time=None, event_overlays=None, filters=None, grids=None, name=None, selected_event_overlays=None, start_time=None, time_range=None, variables=None, __props__=None);
func NewDashboard(ctx *Context, name string, args DashboardArgs, opts ...ResourceOption) (*Dashboard, error)
public Dashboard(string name, DashboardArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args DashboardArgs
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 DashboardArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args DashboardArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

Dashboard Resource Properties

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

Inputs

The Dashboard resource accepts the following input properties:

DashboardGroup string

The ID of the dashboard group that contains the dashboard.

AuthorizedWriterTeams List<string>

Team IDs that have write access to this dashboard

AuthorizedWriterUsers List<string>

User IDs that have write access to this dashboard

Charts List<Pulumi.SignalFx.Inputs.DashboardChartArgs>

Chart ID and layout information for the charts in the dashboard.

ChartsResolution string

Specifies the chart data display resolution for charts in this dashboard. Value can be one of "default", "low", "high", or "highest".

Columns List<Pulumi.SignalFx.Inputs.DashboardColumnArgs>

Column number for the layout.

Description string

Variable description.

DiscoveryOptionsQuery string
DiscoveryOptionsSelectors List<string>
EndTime int

Seconds since epoch. Used for visualization. You must specify time_span_type = "absolute" too.

EventOverlays List<Pulumi.SignalFx.Inputs.DashboardEventOverlayArgs>

Specify a list of event overlays to include in the dashboard. Note: These overlays correspond to the suggested event overlays specified in the web UI, and they’re not automatically applied as active overlays. To set default active event overlays, use the selected_event_overlay property instead.

Filters List<Pulumi.SignalFx.Inputs.DashboardFilterArgs>

Filter to apply to the charts when displaying the dashboard.

Grids List<Pulumi.SignalFx.Inputs.DashboardGridArgs>

Grid dashboard layout. Charts listed will be placed in a grid by row with the same width and height. If a chart cannot fit in a row, it will be placed automatically in the next row.

Name string

Name of the dashboard.

SelectedEventOverlays List<Pulumi.SignalFx.Inputs.DashboardSelectedEventOverlayArgs>

Defines event overlays which are enabled by default. Any overlay specified here should have an accompanying entry in event_overlay, which are similar to the properties here.

StartTime int

Seconds since epoch. Used for visualization. You must specify time_span_type = "absolute" too.

TimeRange string

The time range prior to now to visualize. SignalFx time syntax (e.g. "-5m", "-1h").

Variables List<Pulumi.SignalFx.Inputs.DashboardVariableArgs>

Dashboard variable to apply to each chart in the dashboard.

DashboardGroup string

The ID of the dashboard group that contains the dashboard.

AuthorizedWriterTeams []string

Team IDs that have write access to this dashboard

AuthorizedWriterUsers []string

User IDs that have write access to this dashboard

Charts []DashboardChart

Chart ID and layout information for the charts in the dashboard.

ChartsResolution string

Specifies the chart data display resolution for charts in this dashboard. Value can be one of "default", "low", "high", or "highest".

Columns []DashboardColumn

Column number for the layout.

Description string

Variable description.

DiscoveryOptionsQuery string
DiscoveryOptionsSelectors []string
EndTime int

Seconds since epoch. Used for visualization. You must specify time_span_type = "absolute" too.

EventOverlays []DashboardEventOverlay

Specify a list of event overlays to include in the dashboard. Note: These overlays correspond to the suggested event overlays specified in the web UI, and they’re not automatically applied as active overlays. To set default active event overlays, use the selected_event_overlay property instead.

Filters []DashboardFilter

Filter to apply to the charts when displaying the dashboard.

Grids []DashboardGrid

Grid dashboard layout. Charts listed will be placed in a grid by row with the same width and height. If a chart cannot fit in a row, it will be placed automatically in the next row.

Name string

Name of the dashboard.

SelectedEventOverlays []DashboardSelectedEventOverlay

Defines event overlays which are enabled by default. Any overlay specified here should have an accompanying entry in event_overlay, which are similar to the properties here.

StartTime int

Seconds since epoch. Used for visualization. You must specify time_span_type = "absolute" too.

TimeRange string

The time range prior to now to visualize. SignalFx time syntax (e.g. "-5m", "-1h").

Variables []DashboardVariable

Dashboard variable to apply to each chart in the dashboard.

dashboardGroup string

The ID of the dashboard group that contains the dashboard.

authorizedWriterTeams string[]

Team IDs that have write access to this dashboard

authorizedWriterUsers string[]

User IDs that have write access to this dashboard

charts DashboardChart[]

Chart ID and layout information for the charts in the dashboard.

chartsResolution string

Specifies the chart data display resolution for charts in this dashboard. Value can be one of "default", "low", "high", or "highest".

columns DashboardColumn[]

Column number for the layout.

description string

Variable description.

discoveryOptionsQuery string
discoveryOptionsSelectors string[]
endTime number

Seconds since epoch. Used for visualization. You must specify time_span_type = "absolute" too.

eventOverlays DashboardEventOverlay[]

Specify a list of event overlays to include in the dashboard. Note: These overlays correspond to the suggested event overlays specified in the web UI, and they’re not automatically applied as active overlays. To set default active event overlays, use the selected_event_overlay property instead.

filters DashboardFilter[]

Filter to apply to the charts when displaying the dashboard.

grids DashboardGrid[]

Grid dashboard layout. Charts listed will be placed in a grid by row with the same width and height. If a chart cannot fit in a row, it will be placed automatically in the next row.

name string

Name of the dashboard.

selectedEventOverlays DashboardSelectedEventOverlay[]

Defines event overlays which are enabled by default. Any overlay specified here should have an accompanying entry in event_overlay, which are similar to the properties here.

startTime number

Seconds since epoch. Used for visualization. You must specify time_span_type = "absolute" too.

timeRange string

The time range prior to now to visualize. SignalFx time syntax (e.g. "-5m", "-1h").

variables DashboardVariable[]

Dashboard variable to apply to each chart in the dashboard.

dashboard_group str

The ID of the dashboard group that contains the dashboard.

authorized_writer_teams List[str]

Team IDs that have write access to this dashboard

authorized_writer_users List[str]

User IDs that have write access to this dashboard

charts List[DashboardChart]

Chart ID and layout information for the charts in the dashboard.

charts_resolution str

Specifies the chart data display resolution for charts in this dashboard. Value can be one of "default", "low", "high", or "highest".

columns List[DashboardColumn]

Column number for the layout.

description str

Variable description.

discovery_options_query str
discovery_options_selectors List[str]
end_time float

Seconds since epoch. Used for visualization. You must specify time_span_type = "absolute" too.

event_overlays List[DashboardEventOverlay]

Specify a list of event overlays to include in the dashboard. Note: These overlays correspond to the suggested event overlays specified in the web UI, and they’re not automatically applied as active overlays. To set default active event overlays, use the selected_event_overlay property instead.

filters List[DashboardFilter]

Filter to apply to the charts when displaying the dashboard.

grids List[DashboardGrid]

Grid dashboard layout. Charts listed will be placed in a grid by row with the same width and height. If a chart cannot fit in a row, it will be placed automatically in the next row.

name str

Name of the dashboard.

selected_event_overlays List[DashboardSelectedEventOverlay]

Defines event overlays which are enabled by default. Any overlay specified here should have an accompanying entry in event_overlay, which are similar to the properties here.

start_time float

Seconds since epoch. Used for visualization. You must specify time_span_type = "absolute" too.

time_range str

The time range prior to now to visualize. SignalFx time syntax (e.g. "-5m", "-1h").

variables List[DashboardVariable]

Dashboard variable to apply to each chart in the dashboard.

Outputs

All input properties are implicitly available as output properties. Additionally, the Dashboard resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Url string

URL of the dashboard

Id string
The provider-assigned unique ID for this managed resource.
Url string

URL of the dashboard

id string
The provider-assigned unique ID for this managed resource.
url string

URL of the dashboard

id str
The provider-assigned unique ID for this managed resource.
url str

URL of the dashboard

Look up an Existing Dashboard Resource

Get an existing Dashboard 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?: DashboardState, opts?: CustomResourceOptions): Dashboard
static get(resource_name, id, opts=None, authorized_writer_teams=None, authorized_writer_users=None, charts=None, charts_resolution=None, columns=None, dashboard_group=None, description=None, discovery_options_query=None, discovery_options_selectors=None, end_time=None, event_overlays=None, filters=None, grids=None, name=None, selected_event_overlays=None, start_time=None, time_range=None, url=None, variables=None, __props__=None);
func GetDashboard(ctx *Context, name string, id IDInput, state *DashboardState, opts ...ResourceOption) (*Dashboard, error)
public static Dashboard Get(string name, Input<string> id, DashboardState? 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:

AuthorizedWriterTeams List<string>

Team IDs that have write access to this dashboard

AuthorizedWriterUsers List<string>

User IDs that have write access to this dashboard

Charts List<Pulumi.SignalFx.Inputs.DashboardChartArgs>

Chart ID and layout information for the charts in the dashboard.

ChartsResolution string

Specifies the chart data display resolution for charts in this dashboard. Value can be one of "default", "low", "high", or "highest".

Columns List<Pulumi.SignalFx.Inputs.DashboardColumnArgs>

Column number for the layout.

DashboardGroup string

The ID of the dashboard group that contains the dashboard.

Description string

Variable description.

DiscoveryOptionsQuery string
DiscoveryOptionsSelectors List<string>
EndTime int

Seconds since epoch. Used for visualization. You must specify time_span_type = "absolute" too.

EventOverlays List<Pulumi.SignalFx.Inputs.DashboardEventOverlayArgs>

Specify a list of event overlays to include in the dashboard. Note: These overlays correspond to the suggested event overlays specified in the web UI, and they’re not automatically applied as active overlays. To set default active event overlays, use the selected_event_overlay property instead.

Filters List<Pulumi.SignalFx.Inputs.DashboardFilterArgs>

Filter to apply to the charts when displaying the dashboard.

Grids List<Pulumi.SignalFx.Inputs.DashboardGridArgs>

Grid dashboard layout. Charts listed will be placed in a grid by row with the same width and height. If a chart cannot fit in a row, it will be placed automatically in the next row.

Name string

Name of the dashboard.

SelectedEventOverlays List<Pulumi.SignalFx.Inputs.DashboardSelectedEventOverlayArgs>

Defines event overlays which are enabled by default. Any overlay specified here should have an accompanying entry in event_overlay, which are similar to the properties here.

StartTime int

Seconds since epoch. Used for visualization. You must specify time_span_type = "absolute" too.

TimeRange string

The time range prior to now to visualize. SignalFx time syntax (e.g. "-5m", "-1h").

Url string

URL of the dashboard

Variables List<Pulumi.SignalFx.Inputs.DashboardVariableArgs>

Dashboard variable to apply to each chart in the dashboard.

AuthorizedWriterTeams []string

Team IDs that have write access to this dashboard

AuthorizedWriterUsers []string

User IDs that have write access to this dashboard

Charts []DashboardChart

Chart ID and layout information for the charts in the dashboard.

ChartsResolution string

Specifies the chart data display resolution for charts in this dashboard. Value can be one of "default", "low", "high", or "highest".

Columns []DashboardColumn

Column number for the layout.

DashboardGroup string

The ID of the dashboard group that contains the dashboard.

Description string

Variable description.

DiscoveryOptionsQuery string
DiscoveryOptionsSelectors []string
EndTime int

Seconds since epoch. Used for visualization. You must specify time_span_type = "absolute" too.

EventOverlays []DashboardEventOverlay

Specify a list of event overlays to include in the dashboard. Note: These overlays correspond to the suggested event overlays specified in the web UI, and they’re not automatically applied as active overlays. To set default active event overlays, use the selected_event_overlay property instead.

Filters []DashboardFilter

Filter to apply to the charts when displaying the dashboard.

Grids []DashboardGrid

Grid dashboard layout. Charts listed will be placed in a grid by row with the same width and height. If a chart cannot fit in a row, it will be placed automatically in the next row.

Name string

Name of the dashboard.

SelectedEventOverlays []DashboardSelectedEventOverlay

Defines event overlays which are enabled by default. Any overlay specified here should have an accompanying entry in event_overlay, which are similar to the properties here.

StartTime int

Seconds since epoch. Used for visualization. You must specify time_span_type = "absolute" too.

TimeRange string

The time range prior to now to visualize. SignalFx time syntax (e.g. "-5m", "-1h").

Url string

URL of the dashboard

Variables []DashboardVariable

Dashboard variable to apply to each chart in the dashboard.

authorizedWriterTeams string[]

Team IDs that have write access to this dashboard

authorizedWriterUsers string[]

User IDs that have write access to this dashboard

charts DashboardChart[]

Chart ID and layout information for the charts in the dashboard.

chartsResolution string

Specifies the chart data display resolution for charts in this dashboard. Value can be one of "default", "low", "high", or "highest".

columns DashboardColumn[]

Column number for the layout.

dashboardGroup string

The ID of the dashboard group that contains the dashboard.

description string

Variable description.

discoveryOptionsQuery string
discoveryOptionsSelectors string[]
endTime number

Seconds since epoch. Used for visualization. You must specify time_span_type = "absolute" too.

eventOverlays DashboardEventOverlay[]

Specify a list of event overlays to include in the dashboard. Note: These overlays correspond to the suggested event overlays specified in the web UI, and they’re not automatically applied as active overlays. To set default active event overlays, use the selected_event_overlay property instead.

filters DashboardFilter[]

Filter to apply to the charts when displaying the dashboard.

grids DashboardGrid[]

Grid dashboard layout. Charts listed will be placed in a grid by row with the same width and height. If a chart cannot fit in a row, it will be placed automatically in the next row.

name string

Name of the dashboard.

selectedEventOverlays DashboardSelectedEventOverlay[]

Defines event overlays which are enabled by default. Any overlay specified here should have an accompanying entry in event_overlay, which are similar to the properties here.

startTime number

Seconds since epoch. Used for visualization. You must specify time_span_type = "absolute" too.

timeRange string

The time range prior to now to visualize. SignalFx time syntax (e.g. "-5m", "-1h").

url string

URL of the dashboard

variables DashboardVariable[]

Dashboard variable to apply to each chart in the dashboard.

authorized_writer_teams List[str]

Team IDs that have write access to this dashboard

authorized_writer_users List[str]

User IDs that have write access to this dashboard

charts List[DashboardChart]

Chart ID and layout information for the charts in the dashboard.

charts_resolution str

Specifies the chart data display resolution for charts in this dashboard. Value can be one of "default", "low", "high", or "highest".

columns List[DashboardColumn]

Column number for the layout.

dashboard_group str

The ID of the dashboard group that contains the dashboard.

description str

Variable description.

discovery_options_query str
discovery_options_selectors List[str]
end_time float

Seconds since epoch. Used for visualization. You must specify time_span_type = "absolute" too.

event_overlays List[DashboardEventOverlay]

Specify a list of event overlays to include in the dashboard. Note: These overlays correspond to the suggested event overlays specified in the web UI, and they’re not automatically applied as active overlays. To set default active event overlays, use the selected_event_overlay property instead.

filters List[DashboardFilter]

Filter to apply to the charts when displaying the dashboard.

grids List[DashboardGrid]

Grid dashboard layout. Charts listed will be placed in a grid by row with the same width and height. If a chart cannot fit in a row, it will be placed automatically in the next row.

name str

Name of the dashboard.

selected_event_overlays List[DashboardSelectedEventOverlay]

Defines event overlays which are enabled by default. Any overlay specified here should have an accompanying entry in event_overlay, which are similar to the properties here.

start_time float

Seconds since epoch. Used for visualization. You must specify time_span_type = "absolute" too.

time_range str

The time range prior to now to visualize. SignalFx time syntax (e.g. "-5m", "-1h").

url str

URL of the dashboard

variables List[DashboardVariable]

Dashboard variable to apply to each chart in the dashboard.

Supporting Types

DashboardChart

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

ChartId string

ID of the chart to display.

Column int

Column number for the layout.

Height int

How many rows every chart should take up (greater than or equal to 1). 1 by default.

Row int

The row to show the chart in (zero-based); if height > 1, this value represents the topmost row of the chart (greater than or equal to 0).

Width int

How many columns (out of a total of 12) every chart should take up (between 1 and 12). 12 by default.

ChartId string

ID of the chart to display.

Column int

Column number for the layout.

Height int

How many rows every chart should take up (greater than or equal to 1). 1 by default.

Row int

The row to show the chart in (zero-based); if height > 1, this value represents the topmost row of the chart (greater than or equal to 0).

Width int

How many columns (out of a total of 12) every chart should take up (between 1 and 12). 12 by default.

chartId string

ID of the chart to display.

column number

Column number for the layout.

height number

How many rows every chart should take up (greater than or equal to 1). 1 by default.

row number

The row to show the chart in (zero-based); if height > 1, this value represents the topmost row of the chart (greater than or equal to 0).

width number

How many columns (out of a total of 12) every chart should take up (between 1 and 12). 12 by default.

chartId str

ID of the chart to display.

column float

Column number for the layout.

height float

How many rows every chart should take up (greater than or equal to 1). 1 by default.

row float

The row to show the chart in (zero-based); if height > 1, this value represents the topmost row of the chart (greater than or equal to 0).

width float

How many columns (out of a total of 12) every chart should take up (between 1 and 12). 12 by default.

DashboardColumn

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

ChartIds List<string>

List of IDs of the charts to display.

Column int

Column number for the layout.

Height int

How many rows every chart should take up (greater than or equal to 1). 1 by default.

Width int

How many columns (out of a total of 12) every chart should take up (between 1 and 12). 12 by default.

ChartIds []string

List of IDs of the charts to display.

Column int

Column number for the layout.

Height int

How many rows every chart should take up (greater than or equal to 1). 1 by default.

Width int

How many columns (out of a total of 12) every chart should take up (between 1 and 12). 12 by default.

chartIds string[]

List of IDs of the charts to display.

column number

Column number for the layout.

height number

How many rows every chart should take up (greater than or equal to 1). 1 by default.

width number

How many columns (out of a total of 12) every chart should take up (between 1 and 12). 12 by default.

chartIds List[str]

List of IDs of the charts to display.

column float

Column number for the layout.

height float

How many rows every chart should take up (greater than or equal to 1). 1 by default.

width float

How many columns (out of a total of 12) every chart should take up (between 1 and 12). 12 by default.

DashboardEventOverlay

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

Signal string

Search term used to choose the events shown in the overlay.

Color string

Color to use : gray, blue, azure, navy, brown, orange, yellow, iris, magenta, pink, purple, violet, lilac, emerald, green, aquamarine.

Label string

Text shown in the dropdown when selecting this overlay from the menu.

Line bool

Show a vertical line for the event. false by default.

Sources List<Pulumi.SignalFx.Inputs.DashboardEventOverlaySourceArgs>

Each element specifies a filter to use against the signal specified in the signal.

Type string

Can be set to eventTimeSeries (the default) to refer to externally reported events, or detectorEvents to refer to events from detector triggers.

Signal string

Search term used to choose the events shown in the overlay.

Color string

Color to use : gray, blue, azure, navy, brown, orange, yellow, iris, magenta, pink, purple, violet, lilac, emerald, green, aquamarine.

Label string

Text shown in the dropdown when selecting this overlay from the menu.

Line bool

Show a vertical line for the event. false by default.

Sources []DashboardEventOverlaySource

Each element specifies a filter to use against the signal specified in the signal.

Type string

Can be set to eventTimeSeries (the default) to refer to externally reported events, or detectorEvents to refer to events from detector triggers.

signal string

Search term used to choose the events shown in the overlay.

color string

Color to use : gray, blue, azure, navy, brown, orange, yellow, iris, magenta, pink, purple, violet, lilac, emerald, green, aquamarine.

label string

Text shown in the dropdown when selecting this overlay from the menu.

line boolean

Show a vertical line for the event. false by default.

sources DashboardEventOverlaySource[]

Each element specifies a filter to use against the signal specified in the signal.

type string

Can be set to eventTimeSeries (the default) to refer to externally reported events, or detectorEvents to refer to events from detector triggers.

signal str

Search term used to choose the events shown in the overlay.

color str

Color to use : gray, blue, azure, navy, brown, orange, yellow, iris, magenta, pink, purple, violet, lilac, emerald, green, aquamarine.

label str

Text shown in the dropdown when selecting this overlay from the menu.

line bool

Show a vertical line for the event. false by default.

sources List[DashboardEventOverlaySource]

Each element specifies a filter to use against the signal specified in the signal.

type str

Can be set to eventTimeSeries (the default) to refer to externally reported events, or detectorEvents to refer to events from detector triggers.

DashboardEventOverlaySource

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

Property string

The name of a dimension to filter against.

Values List<string>

A list of values to be used with the property, they will be combined via OR.

Negated bool

If true, only data that does not match the specified value of the specified property appear in the event overlay. Defaults to false.

Property string

The name of a dimension to filter against.

Values []string

A list of values to be used with the property, they will be combined via OR.

Negated bool

If true, only data that does not match the specified value of the specified property appear in the event overlay. Defaults to false.

property string

The name of a dimension to filter against.

values string[]

A list of values to be used with the property, they will be combined via OR.

negated boolean

If true, only data that does not match the specified value of the specified property appear in the event overlay. Defaults to false.

property str

The name of a dimension to filter against.

values List[str]

A list of values to be used with the property, they will be combined via OR.

negated bool

If true, only data that does not match the specified value of the specified property appear in the event overlay. Defaults to false.

DashboardFilter

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

Property string

The name of a dimension to filter against.

Values List<string>

A list of values to be used with the property, they will be combined via OR.

ApplyIfExist bool

If true, this variable will also match data that doesn’t have this property at all.

Negated bool

If true, only data that does not match the specified value of the specified property appear in the event overlay. Defaults to false.

Property string

The name of a dimension to filter against.

Values []string

A list of values to be used with the property, they will be combined via OR.

ApplyIfExist bool

If true, this variable will also match data that doesn’t have this property at all.

Negated bool

If true, only data that does not match the specified value of the specified property appear in the event overlay. Defaults to false.

property string

The name of a dimension to filter against.

values string[]

A list of values to be used with the property, they will be combined via OR.

applyIfExist boolean

If true, this variable will also match data that doesn’t have this property at all.

negated boolean

If true, only data that does not match the specified value of the specified property appear in the event overlay. Defaults to false.

property str

The name of a dimension to filter against.

values List[str]

A list of values to be used with the property, they will be combined via OR.

applyIfExist bool

If true, this variable will also match data that doesn’t have this property at all.

negated bool

If true, only data that does not match the specified value of the specified property appear in the event overlay. Defaults to false.

DashboardGrid

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

ChartIds List<string>

List of IDs of the charts to display.

Height int

How many rows every chart should take up (greater than or equal to 1). 1 by default.

Width int

How many columns (out of a total of 12) every chart should take up (between 1 and 12). 12 by default.

ChartIds []string

List of IDs of the charts to display.

Height int

How many rows every chart should take up (greater than or equal to 1). 1 by default.

Width int

How many columns (out of a total of 12) every chart should take up (between 1 and 12). 12 by default.

chartIds string[]

List of IDs of the charts to display.

height number

How many rows every chart should take up (greater than or equal to 1). 1 by default.

width number

How many columns (out of a total of 12) every chart should take up (between 1 and 12). 12 by default.

chartIds List[str]

List of IDs of the charts to display.

height float

How many rows every chart should take up (greater than or equal to 1). 1 by default.

width float

How many columns (out of a total of 12) every chart should take up (between 1 and 12). 12 by default.

DashboardSelectedEventOverlay

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

Signal string

Search term used to choose the events shown in the overlay.

Sources List<Pulumi.SignalFx.Inputs.DashboardSelectedEventOverlaySourceArgs>

Each element specifies a filter to use against the signal specified in the signal.

Type string

Can be set to eventTimeSeries (the default) to refer to externally reported events, or detectorEvents to refer to events from detector triggers.

Signal string

Search term used to choose the events shown in the overlay.

Sources []DashboardSelectedEventOverlaySource

Each element specifies a filter to use against the signal specified in the signal.

Type string

Can be set to eventTimeSeries (the default) to refer to externally reported events, or detectorEvents to refer to events from detector triggers.

signal string

Search term used to choose the events shown in the overlay.

sources DashboardSelectedEventOverlaySource[]

Each element specifies a filter to use against the signal specified in the signal.

type string

Can be set to eventTimeSeries (the default) to refer to externally reported events, or detectorEvents to refer to events from detector triggers.

signal str

Search term used to choose the events shown in the overlay.

sources List[DashboardSelectedEventOverlaySource]

Each element specifies a filter to use against the signal specified in the signal.

type str

Can be set to eventTimeSeries (the default) to refer to externally reported events, or detectorEvents to refer to events from detector triggers.

DashboardSelectedEventOverlaySource

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

Property string

The name of a dimension to filter against.

Values List<string>

A list of values to be used with the property, they will be combined via OR.

Negated bool

If true, only data that does not match the specified value of the specified property appear in the event overlay. Defaults to false.

Property string

The name of a dimension to filter against.

Values []string

A list of values to be used with the property, they will be combined via OR.

Negated bool

If true, only data that does not match the specified value of the specified property appear in the event overlay. Defaults to false.

property string

The name of a dimension to filter against.

values string[]

A list of values to be used with the property, they will be combined via OR.

negated boolean

If true, only data that does not match the specified value of the specified property appear in the event overlay. Defaults to false.

property str

The name of a dimension to filter against.

values List[str]

A list of values to be used with the property, they will be combined via OR.

negated bool

If true, only data that does not match the specified value of the specified property appear in the event overlay. Defaults to false.

DashboardVariable

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

Alias string

An alias for the dashboard variable. This text will appear as the label for the dropdown field on the dashboard.

Property string

The name of a dimension to filter against.

ApplyIfExist bool

If true, this variable will also match data that doesn’t have this property at all.

Description string

Variable description.

ReplaceOnly bool

If true, this variable will only apply to charts that have a filter for the property.

RestrictedSuggestions bool

If true, this variable may only be set to the values listed in values_suggested and only these values will appear in autosuggestion menus. false by default.

ValueRequired bool

Determines whether a value is required for this variable (and therefore whether it will be possible to view this dashboard without this filter applied). false by default.

Values List<string>

A list of values to be used with the property, they will be combined via OR.

ValuesSuggesteds List<string>

A list of strings of suggested values for this variable; these suggestions will receive priority when values are autosuggested for this variable.

Alias string

An alias for the dashboard variable. This text will appear as the label for the dropdown field on the dashboard.

Property string

The name of a dimension to filter against.

ApplyIfExist bool

If true, this variable will also match data that doesn’t have this property at all.

Description string

Variable description.

ReplaceOnly bool

If true, this variable will only apply to charts that have a filter for the property.

RestrictedSuggestions bool

If true, this variable may only be set to the values listed in values_suggested and only these values will appear in autosuggestion menus. false by default.

ValueRequired bool

Determines whether a value is required for this variable (and therefore whether it will be possible to view this dashboard without this filter applied). false by default.

Values []string

A list of values to be used with the property, they will be combined via OR.

ValuesSuggesteds []string

A list of strings of suggested values for this variable; these suggestions will receive priority when values are autosuggested for this variable.

alias string

An alias for the dashboard variable. This text will appear as the label for the dropdown field on the dashboard.

property string

The name of a dimension to filter against.

applyIfExist boolean

If true, this variable will also match data that doesn’t have this property at all.

description string

Variable description.

replaceOnly boolean

If true, this variable will only apply to charts that have a filter for the property.

restrictedSuggestions boolean

If true, this variable may only be set to the values listed in values_suggested and only these values will appear in autosuggestion menus. false by default.

valueRequired boolean

Determines whether a value is required for this variable (and therefore whether it will be possible to view this dashboard without this filter applied). false by default.

values string[]

A list of values to be used with the property, they will be combined via OR.

valuesSuggesteds string[]

A list of strings of suggested values for this variable; these suggestions will receive priority when values are autosuggested for this variable.

alias str

An alias for the dashboard variable. This text will appear as the label for the dropdown field on the dashboard.

property str

The name of a dimension to filter against.

applyIfExist bool

If true, this variable will also match data that doesn’t have this property at all.

description str

Variable description.

replaceOnly bool

If true, this variable will only apply to charts that have a filter for the property.

restrictedSuggestions bool

If true, this variable may only be set to the values listed in values_suggested and only these values will appear in autosuggestion menus. false by default.

valueRequired bool

Determines whether a value is required for this variable (and therefore whether it will be possible to view this dashboard without this filter applied). false by default.

values List[str]

A list of values to be used with the property, they will be combined via OR.

valuesSuggesteds List[str]

A list of strings of suggested values for this variable; these suggestions will receive priority when values are autosuggested for this variable.

Package Details

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