Custom dashboards v1 (legacy)

Legacy
feature

Custom dashboards v1 (legacy) is a deprecated feature. New Relic recommends using the Metric explorer in Insights to:

  • Search all your metric data, including custom metrics
  • Create customizable metric charts
  • Add metric charts to Insights dashboards

This document applies only to New Relic's original custom dashboards feature (prior to Feb. 2014). As of February 2014, New Relic launched an improved custom dashboards feature (v2) that allows you to create custom dashboards that present charts from web and mobile applications, hosts, custom metrics, and plugin metrics.

Plugins is not supported with accounts that host data in the EU region data center.

Examples (v1)

The custom dashboards v1 (legacy) feature allows you to view any data that New Relic agents track as collections of charts and tables. It also provides a way to view any custom metrics you are collecting.

Custom dashboards are useful for creating unique overview pages for your users who want to view data differently than the Overview pages in New Relic APM or Browser. For example, you can:

  • Show application information, host information, and custom metrics all on a single custom dashboard.
  • Create dashboards that present charts and tables with a uniform size and arrangement on a grid.
  • Select existing New Relic charts for your dashboard, or create your own charts and tables.

Access to this feature depends on your subscription level.

Charts created with the original v1 (legacy) technology show data only for the selected application. You can still create, view, edit, and delete custom dashboards with the v1 (legacy) technology. However, the available data is limited to the selected application.

Customized plugin dashboards

Plugins are treated as third party products, including the plugins made by New Relic. The data they collect is separate from New Relic agent data and currently cannot be integrated with custom dashboards.

Instead, plugin authors and publishers create customized plugin dashboards as part of the plugin. Additional customized plugin dashboards can only be added by the publisher. For more information, see:

Create v1 (legacy) dashboards

To create a new custom dashboard:

  1. From rpm.newrelic.com, select Tools > Create custom dashboard.
  2. Type the dashboard's title, or keep the default name.
  3. To create a dashboard with the selected application data only, select the Legacy mode checkbox.
  4. Select the layout (Overview or Grid), then select Create.
  5. From the dashboard layout page, select Add Chart or Table, then select your choice.
  6. From the Edit chart page, fill in your custom dashboard fields as applicable.
  7. Optional: To select additional values, select Advanced options.
  8. Optional: To view and continue, select Save and preview.
  9. To exit and go to your custom dashboard, select Save and finish.

After you select Save and finish, you can continue adding more charts and tables to your dashboard. You can also make changes to or delete existing charts and tables.

View v1 (legacy) dashboards

To view, edit, or delete custom dashboards:

  1. From rpm.newrelic.com, select Tools > Dashboards > Custom dashboards > (select a custom dashboard).
  2. Use any of New Relic's standard user interface functions to drill down into detailed information.

A partial list of custom dashboards also appears above your selected custom dashboard. To view the complete list of custom dashboards and custom views, select View all.

Select v1 (legacy) dashboard metrics

When you use the v1 (legacy) feature to build a chart or table for your custom dashboard, the Metrics, Value, and Limit fields work together to determine what appears.

Metric naming conventions

The root (initial) metric folders contain many of the metrics used to show data about your application throughout New Relic. Use the arrow keys to view a metric and its sub-folders, then press Enter to select your choice, or include a wildcard * with the value. For example, you could select:

  • Apdex/* (all)
  • Apdex/cases/* (all Apdex cases)
  • Apdex/cases/case_study (a specific one)

Naming conventions for available metric values depend on your programming language. For example, Java and .NET users select WebTransaction as a valid metric option, while Ruby users select Controller.

Examples:

  • To plot the response time for a single web transaction (or controller/action), select the metric value named WebTransaction/accounts/index (or Controller/accounts/index, if your app has an accounts controller). This will plot a transaction that shows an index of accounts.
  • To plot a multi-series chart of all web transactions (or controller/actions) dealing with accounts, use the * wildcard. For example, from the Metrics field, select WebTransaction/accounts/* or Controller/accounts/*.
Metric folders

The v1 (legacy) feature includes many root metric folders for you to experiment with. Here is a summary of some of the most common.

Metrics Explanation
EndUser/ All browser metrics, including web transactions from the browser perspective. Without the trailing slash, this name also serves as a metric and will plot overall response time and throughput from the browser perspective for your entire app.
Database/ or ActiveRecord/ (Ruby) Database performance from the app's perspective.
HttpDispatcher A single metric with summary data about your entire app in aggregate. This metric does not include a trailing slash.
Custom/ Custom metrics that you may be tracking (for example, Custom/MyMetric/My_label). The Custom/prefix is required for all custom metrics.
Value and limit

By default, metrics plotted on your chart or table appear in order from the highest to the lowest number. For example, if you choose Average response time for the Value field, this plots the slowest to fastest response times for the selected metrics. (Typical values selected are average response time or requests per minute.)

In addition, the Limit field controls the number of series visible on the chart. It defaults to five unless your metrics value includes a wildcard. For example, to plot the top ten slowest web transactions, use these values:

  • Metrics: WebTransaction/*
  • Value: Average response time
  • Limit: 10

Edit v1 (legacy) dashboards

Your v1 (legacy) custom dashboard includes tools to edit, delete, and move charts and tables on it. You cannot edit existing New Relic charts that you add to your dashboard. However, you can move or delete them.

Edit procedures

To edit an existing custom dashboard:

  1. From rpm.newrelic.com, select Tools > Custom dashboards.
  2. From the custom dashboards index, select the pencil [pencil icon] icon for your dashboard.

    OR

    From the custom dashboards index, select the dashboard's name, then select Edit dashboard.

  3. Optional: Add more charts or tables to your dashboard.
  4. Optional: To update or remove an existing chart or table on your dashboard, select the corresponding icon.
  5. When finished, select I'm done editing.
Custom dashboard tools

If an area on a chart appears blank when you preview it, this may be due to the selected time value. For example, if a chart shows data in minutes, areas with activity in milliseconds may be empty. To change the Number format for time, edit the custom dashboard, and select Advanced options. Or, use the time picker to change the time period itself.

If you want to... Do this...
Rename the dashboard Select the title's Edit [pencil icon] icon, type a new name, and select Return or Enter.
Rearrange charts and tables Select the Column icon-cd-column-move.png icon, then drag the chart or table to a new location on the dashboard.
Add more charts or tables to an existing dashboard

From the selected dashboard:

  1. Select Edit dashboard.
  2. Select Add chart or table.
  3. Follow standard procedures to create another chart or table.
Identify an app for a chart on an existing dashboard

From the Edit page, select Advanced options, then select your choice.

When you create a new chart, it defaults to the first app on your list unless you select one. When you add an existing New Relic chart, it uses the currently selected app. You cannot change this.

Insert an existing New Relic chart into an existing dashboard

From the New Relic APM dashboard:

  1. Follow standard procedures to select an existing New Relic chart.
  2. Select Add to dashboard, and select the existing dashboard's name.
  3. To move or delete the chart on your custom dashboard, select the here link.

You cannot edit New Relic charts that you insert into your custom dashboard.

Add labels to a chart or table

From the Edit page:

  • To give the chart or table a name, use the Title field. (This is useful, for example, to identify an app if you select a specific one.)
  • To identify the type of units on your table or chart (seconds, kbps, etc.), use the Suffix field.
Select how many items show on your chart or table

From the Edit page, select the pencil [pencil icon] icon for the chart or table, and type a value in the Limit field.

This field defaults to the top five unless your Metrics value includes a wildcard (*). Also, the sorting value depends on the Metrics you select. Typically items sort from slowest to fastest, so your chart or table will show the top 5 slowest items.

However, if you include a wildcard (*) with the metric, then you can specify the number of items that show. For example, if you type 25 for a table, then your custom dashboard will show the first five rows of the table and include a link indicating how many more rows are available.

Define the Y axis

From the Edit page, type a value in the Y-axis unit label field. For example, you may want to clarify that the Y axis shows data in milliseconds, seconds, pages per minute (PPM), etc.

You can also use the Suffix field to clarify what appears on your chart or table; for example, when the Y axis is not related to a time value.

Change the time period for charts on the dashboard

Select I'm done editing to return to the custom dashboard. Then use the time picker to change the range.

If an existing New Relic chart on your dashboard has been locked to a specific time period, you cannot change it. Instead, you can delete the New Relic chart, add it to your dashboard again, and this time do not select the Lock to span checkbox.

Remove a chart or table from the dashboard

Select the trash can [delete icon] icon for the chart or table.

Delete the entire dashboard Select Delete dashboard.

For more help

Recommendations for learning more: