Dashboard

Use this resource to create and manage New Relic dashboards.

Attribute Refence

In addition to all arguments above, the following attributes are exported:

dashboard_url - The URL for viewing the dashboard.

Nested `widget` blocks

All nested widget blocks support the following common arguments:

title - (Required) A title for the widget.
visualization - (Required) How the widget visualizes data. Valid values are billboard, gauge, billboard_comparison, facet_bar_chart, faceted_line_chart, facet_pie_chart, facet_table, faceted_area_chart, heatmap, attribute_sheet, single_event, histogram, funnel, raw_json, event_feed, event_table, uniques_list, line_chart, comparison_line_chart, markdown, and metric_line_chart.
row - (Required) Row position of widget from top left, starting at 1.
column - (Required) Column position of widget from top left, starting at 1.
width - (Optional) Width of the widget. Valid values are 1 to 3 inclusive. Defaults to 1.
height - (Optional) Height of the widget. Valid values are 1 to 3 inclusive. Defaults to 1.
notes - (Optional) Description of the widget.

Each visualization type supports an additional set of arguments:

billboard, billboard_comparison:
- nrql - (Required) Valid NRQL query string. See Writing NRQL Queries for help.
- threshold_red - (Optional) Threshold above which the displayed value will be styled with a red color.
- threshold_yellow - (Optional) Threshold above which the displayed value will be styled with a yellow color.
gauge:
- nrql - (Required) Valid NRQL query string. See Writing NRQL Queries for help.
- threshold_red - (Required) Threshold above which the displayed value will be styled with a red color.
- threshold_yellow - (Optional) Threshold above which the displayed value will be styled with a yellow color.
facet_bar_chart, facet_pie_chart, facet_table, faceted_area_chart, faceted_line_chart, or heatmap:
- nrql - (Required) Valid NRQL query string. See Writing NRQL Queries for help.
- drilldown_dashboard_id - (Optional) The ID of a dashboard to link to from the widget’s facets.
attribute_sheet, comparison_line_chart, event_feed, event_table, funnel, histogram, line_chart, raw_json, single_event, or uniques_list:
- nrql - (Required) Valid NRQL query string. See Writing NRQL Queries for help.
markdown:
- source - (Required) The markdown source to be rendered in the widget.
metric_line_chart:
- entity_ids - (Required) A collection of entity ids to display data for. These are typically application IDs.
- metric - (Required) A nested block that describes a metric. Nested metric blocks support the following arguments:
  - name - (Required) The metric name to display.
  - values - (Required) The metric values to display.
- duration - (Required) The duration, in ms, of the time window represented in the chart.
- end_time - (Optional) The end time of the time window represented in the chart in epoch time. When not set, the time window will end at the current time.
- facet - (Optional) Can be set to “host” to facet the metric data by host.
- limit - (Optional) The limit of distinct data series to display.
application_breakdown:
- entity_ids - (Required) A collection of entity IDs to display data. These are typically application IDs.

Nested `filter` block

The optional filter block supports the following arguments: * event_types - (Optional) A list of event types to enable filtering for. * attributes - (Optional) A list of attributes belonging to the specified event types to enable filtering for.

Create a Dashboard Resource

new Dashboard(name: string, args: DashboardArgs, opts?: CustomResourceOptions);

def Dashboard(resource_name, opts=None, editable=None, filter=None, grid_column_count=None, icon=None, title=None, visibility=None, widgets=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:

Title string: The title of the dashboard.
Editable string: Determines who can edit the dashboard in an account. Valid values are all, editable_by_all, editable_by_owner, or read_only. Defaults to editable_by_all.
Filter Pulumi.NewRelic.Inputs.DashboardFilterArgs: A nested block that describes a dashboard filter. Exactly one nested filter block is allowed. See Nested filter block below for details.
GridColumnCount int: The number of columns to use when organizing and displaying widgets. New Relic One supports a 3 column grid and a 12 column grid. New Relic Insights supports a 3 column grid.
Icon string: The icon for the dashboard. Valid values are adjust, archive, bar-chart, bell, bolt, bug, bullhorn, bullseye, clock-o, cloud, cog, comments-o, crosshairs, dashboard, envelope, fire, flag, flask, globe, heart, leaf, legal, life-ring, line-chart, magic, mobile, money, none, paper-plane, pie-chart, puzzle-piece, road, rocket, shopping-cart, sitemap, sliders, tablet, thumbs-down, thumbs-up, trophy, usd, user, and users. Defaults to bar-chart.
Visibility string: Determines who can see the dashboard in an account. Valid values are all or owner. Defaults to all.
Widgets List<Pulumi.NewRelic.Inputs.DashboardWidgetArgs>: A nested block that describes a visualization. Up to 300 widget blocks are allowed in a dashboard definition. See Nested widget blocks below for details.

Title string: The title of the dashboard.
Editable string: Determines who can edit the dashboard in an account. Valid values are all, editable_by_all, editable_by_owner, or read_only. Defaults to editable_by_all.
Filter DashboardFilter: A nested block that describes a dashboard filter. Exactly one nested filter block is allowed. See Nested filter block below for details.
GridColumnCount int: The number of columns to use when organizing and displaying widgets. New Relic One supports a 3 column grid and a 12 column grid. New Relic Insights supports a 3 column grid.
Icon string: The icon for the dashboard. Valid values are adjust, archive, bar-chart, bell, bolt, bug, bullhorn, bullseye, clock-o, cloud, cog, comments-o, crosshairs, dashboard, envelope, fire, flag, flask, globe, heart, leaf, legal, life-ring, line-chart, magic, mobile, money, none, paper-plane, pie-chart, puzzle-piece, road, rocket, shopping-cart, sitemap, sliders, tablet, thumbs-down, thumbs-up, trophy, usd, user, and users. Defaults to bar-chart.
Visibility string: Determines who can see the dashboard in an account. Valid values are all or owner. Defaults to all.
Widgets []DashboardWidget: A nested block that describes a visualization. Up to 300 widget blocks are allowed in a dashboard definition. See Nested widget blocks below for details.

title string: The title of the dashboard.
editable string: Determines who can edit the dashboard in an account. Valid values are all, editable_by_all, editable_by_owner, or read_only. Defaults to editable_by_all.
filter DashboardFilter: A nested block that describes a dashboard filter. Exactly one nested filter block is allowed. See Nested filter block below for details.
gridColumnCount number: The number of columns to use when organizing and displaying widgets. New Relic One supports a 3 column grid and a 12 column grid. New Relic Insights supports a 3 column grid.
icon string: The icon for the dashboard. Valid values are adjust, archive, bar-chart, bell, bolt, bug, bullhorn, bullseye, clock-o, cloud, cog, comments-o, crosshairs, dashboard, envelope, fire, flag, flask, globe, heart, leaf, legal, life-ring, line-chart, magic, mobile, money, none, paper-plane, pie-chart, puzzle-piece, road, rocket, shopping-cart, sitemap, sliders, tablet, thumbs-down, thumbs-up, trophy, usd, user, and users. Defaults to bar-chart.
visibility string: Determines who can see the dashboard in an account. Valid values are all or owner. Defaults to all.
widgets DashboardWidget[]: A nested block that describes a visualization. Up to 300 widget blocks are allowed in a dashboard definition. See Nested widget blocks below for details.

title str: The title of the dashboard.
editable str: Determines who can edit the dashboard in an account. Valid values are all, editable_by_all, editable_by_owner, or read_only. Defaults to editable_by_all.
filter Dict[DashboardFilter]: A nested block that describes a dashboard filter. Exactly one nested filter block is allowed. See Nested filter block below for details.
grid_column_count float: The number of columns to use when organizing and displaying widgets. New Relic One supports a 3 column grid and a 12 column grid. New Relic Insights supports a 3 column grid.
icon str: The icon for the dashboard. Valid values are adjust, archive, bar-chart, bell, bolt, bug, bullhorn, bullseye, clock-o, cloud, cog, comments-o, crosshairs, dashboard, envelope, fire, flag, flask, globe, heart, leaf, legal, life-ring, line-chart, magic, mobile, money, none, paper-plane, pie-chart, puzzle-piece, road, rocket, shopping-cart, sitemap, sliders, tablet, thumbs-down, thumbs-up, trophy, usd, user, and users. Defaults to bar-chart.
visibility str: Determines who can see the dashboard in an account. Valid values are all or owner. Defaults to all.
widgets List[DashboardWidget]: A nested block that describes a visualization. Up to 300 widget blocks are allowed in a dashboard definition. See Nested widget blocks below for details.

Outputs

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

DashboardUrl string: The URL for viewing the dashboard.
Id string: The provider-assigned unique ID for this managed resource.

DashboardUrl string: The URL for viewing the dashboard.
Id string: The provider-assigned unique ID for this managed resource.

dashboardUrl string: The URL for viewing the dashboard.
id string: The provider-assigned unique ID for this managed resource.

dashboard_url str: The URL for viewing the dashboard.
id str: The provider-assigned unique ID for this managed resource.

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, dashboard_url=None, editable=None, filter=None, grid_column_count=None, icon=None, title=None, visibility=None, widgets=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:

DashboardUrl string: The URL for viewing the dashboard.
Editable string: Determines who can edit the dashboard in an account. Valid values are all, editable_by_all, editable_by_owner, or read_only. Defaults to editable_by_all.
Filter Pulumi.NewRelic.Inputs.DashboardFilterArgs: A nested block that describes a dashboard filter. Exactly one nested filter block is allowed. See Nested filter block below for details.
GridColumnCount int: The number of columns to use when organizing and displaying widgets. New Relic One supports a 3 column grid and a 12 column grid. New Relic Insights supports a 3 column grid.
Icon string: The icon for the dashboard. Valid values are adjust, archive, bar-chart, bell, bolt, bug, bullhorn, bullseye, clock-o, cloud, cog, comments-o, crosshairs, dashboard, envelope, fire, flag, flask, globe, heart, leaf, legal, life-ring, line-chart, magic, mobile, money, none, paper-plane, pie-chart, puzzle-piece, road, rocket, shopping-cart, sitemap, sliders, tablet, thumbs-down, thumbs-up, trophy, usd, user, and users. Defaults to bar-chart.
Title string: The title of the dashboard.
Visibility string: Determines who can see the dashboard in an account. Valid values are all or owner. Defaults to all.
Widgets List<Pulumi.NewRelic.Inputs.DashboardWidgetArgs>: A nested block that describes a visualization. Up to 300 widget blocks are allowed in a dashboard definition. See Nested widget blocks below for details.

DashboardUrl string: The URL for viewing the dashboard.
Editable string: Determines who can edit the dashboard in an account. Valid values are all, editable_by_all, editable_by_owner, or read_only. Defaults to editable_by_all.
Filter DashboardFilter: A nested block that describes a dashboard filter. Exactly one nested filter block is allowed. See Nested filter block below for details.
GridColumnCount int: The number of columns to use when organizing and displaying widgets. New Relic One supports a 3 column grid and a 12 column grid. New Relic Insights supports a 3 column grid.
Icon string: The icon for the dashboard. Valid values are adjust, archive, bar-chart, bell, bolt, bug, bullhorn, bullseye, clock-o, cloud, cog, comments-o, crosshairs, dashboard, envelope, fire, flag, flask, globe, heart, leaf, legal, life-ring, line-chart, magic, mobile, money, none, paper-plane, pie-chart, puzzle-piece, road, rocket, shopping-cart, sitemap, sliders, tablet, thumbs-down, thumbs-up, trophy, usd, user, and users. Defaults to bar-chart.
Title string: The title of the dashboard.
Visibility string: Determines who can see the dashboard in an account. Valid values are all or owner. Defaults to all.
Widgets []DashboardWidget: A nested block that describes a visualization. Up to 300 widget blocks are allowed in a dashboard definition. See Nested widget blocks below for details.

dashboardUrl string: The URL for viewing the dashboard.
editable string: Determines who can edit the dashboard in an account. Valid values are all, editable_by_all, editable_by_owner, or read_only. Defaults to editable_by_all.
filter DashboardFilter: A nested block that describes a dashboard filter. Exactly one nested filter block is allowed. See Nested filter block below for details.
gridColumnCount number: The number of columns to use when organizing and displaying widgets. New Relic One supports a 3 column grid and a 12 column grid. New Relic Insights supports a 3 column grid.
icon string: The icon for the dashboard. Valid values are adjust, archive, bar-chart, bell, bolt, bug, bullhorn, bullseye, clock-o, cloud, cog, comments-o, crosshairs, dashboard, envelope, fire, flag, flask, globe, heart, leaf, legal, life-ring, line-chart, magic, mobile, money, none, paper-plane, pie-chart, puzzle-piece, road, rocket, shopping-cart, sitemap, sliders, tablet, thumbs-down, thumbs-up, trophy, usd, user, and users. Defaults to bar-chart.
title string: The title of the dashboard.
visibility string: Determines who can see the dashboard in an account. Valid values are all or owner. Defaults to all.
widgets DashboardWidget[]: A nested block that describes a visualization. Up to 300 widget blocks are allowed in a dashboard definition. See Nested widget blocks below for details.

dashboard_url str: The URL for viewing the dashboard.
editable str: Determines who can edit the dashboard in an account. Valid values are all, editable_by_all, editable_by_owner, or read_only. Defaults to editable_by_all.
filter Dict[DashboardFilter]: A nested block that describes a dashboard filter. Exactly one nested filter block is allowed. See Nested filter block below for details.
grid_column_count float: The number of columns to use when organizing and displaying widgets. New Relic One supports a 3 column grid and a 12 column grid. New Relic Insights supports a 3 column grid.
icon str: The icon for the dashboard. Valid values are adjust, archive, bar-chart, bell, bolt, bug, bullhorn, bullseye, clock-o, cloud, cog, comments-o, crosshairs, dashboard, envelope, fire, flag, flask, globe, heart, leaf, legal, life-ring, line-chart, magic, mobile, money, none, paper-plane, pie-chart, puzzle-piece, road, rocket, shopping-cart, sitemap, sliders, tablet, thumbs-down, thumbs-up, trophy, usd, user, and users. Defaults to bar-chart.
title str: The title of the dashboard.
visibility str: Determines who can see the dashboard in an account. Valid values are all or owner. Defaults to all.
widgets List[DashboardWidget]: A nested block that describes a visualization. Up to 300 widget blocks are allowed in a dashboard definition. See Nested widget blocks below for details.