Class 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.
Inheritance
System.Object
Resource
CustomResource
Dashboard
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Pulumi.NewRelic
Assembly: Pulumi.NewRelic.dll
Syntax
public class Dashboard : CustomResource

Constructors

View Source

Dashboard(String, DashboardArgs, CustomResourceOptions)

Create a Dashboard resource with the given unique name, arguments, and options.

Declaration
public Dashboard(string name, DashboardArgs args, CustomResourceOptions options = null)
Parameters
Type Name Description
System.String name

The unique name of the resource
DashboardArgs args

The arguments used to populate this resource's properties
CustomResourceOptions options

A bag of options that control this resource's behavior

Properties

View Source

DashboardUrl

The URL for viewing the dashboard.

Declaration
public Output<string> DashboardUrl { get; }
Property Value
Type Description
Output<System.String>
View Source

Editable

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.

Declaration
public Output<string> Editable { get; }
Property Value
Type Description
Output<System.String>
View Source

Filter

A nested block that describes a dashboard filter. Exactly one nested filter block is allowed. See Nested filter block below for details.

Declaration
public Output<DashboardFilter> Filter { get; }
Property Value
Type Description
Output<DashboardFilter>
View Source

GridColumnCount

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.

Declaration
public Output<int?> GridColumnCount { get; }
Property Value
Type Description
Output<System.Nullable<System.Int32>>
View Source

Icon

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.

Declaration
public Output<string> Icon { get; }
Property Value
Type Description
Output<System.String>
View Source

Title

The title of the dashboard.

Declaration
public Output<string> Title { get; }
Property Value
Type Description
Output<System.String>
View Source

Visibility

Determines who can see the dashboard in an account. Valid values are all or owner. Defaults to all.

Declaration
public Output<string> Visibility { get; }
Property Value
Type Description
Output<System.String>
View Source

Widgets

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.

Declaration
public Output<ImmutableArray<DashboardWidget>> Widgets { get; }
Property Value
Type Description
Output<System.Collections.Immutable.ImmutableArray<DashboardWidget>>

Methods

View Source

Get(String, Input<String>, DashboardState, CustomResourceOptions)

Get an existing Dashboard resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Declaration
public static Dashboard Get(string name, Input<string> id, DashboardState state = null, CustomResourceOptions options = null)
Parameters
Type Name Description
System.String name

The unique name of the resulting resource.
Input<System.String> id

The unique provider ID of the resource to lookup.
DashboardState state

Any extra arguments used during the lookup.
CustomResourceOptions options

A bag of options that control this resource's behavior
Returns
Type Description
Dashboard