nrdash 0.1.0

New Relic Dashboard Builder

New Relic Dashboard Builder

New Relic Dashboard Builder is a command-line tool for configuring New Relic dashboards using simple, human-readable YAML files. With New Relic Dashboard Builder, definitions for New Relic dashboards can be kept in version control to support tracking change history for dashboards. Definitions for NRQL queries and widgets can be consolidated into a single canonical location to be shared across multiple dashboards, enabling easier maintenance of a large number of dashboards and widgets.

Usage

Install with pip, note that New Relic Dashboard Builder only works with Python 3.6 or higher

pip install nrdash

Create your dashboard definitions in a YAML file

dashboards:
  sample-dashboard:
    title: Sample Dashboard
    widgets:
      - widget:
        query:
          title: Transactions by Response Status
          nrql: SELECT COUNT(*) FROM Transaction WHERE transactionType = 'Web' FACET response.status
          visualization: facet_bar_chart
        row: 1
        column: 1
        width: 3
        height: 2

Run the New Relic Dashboard Builder tool to create or update your New Relic dashboards based on the YAML definition file.

nrdash --api-key <YOUR_ADMIN_API_KEY> --account-id <YOUR_ACCOUNT_ID> <DASHBOARD_DEFINITION_YAML_FILE>

Documentation

See the documentation site for complete documentation.