https://github.com/gatkin/nrdashboards

Manage New Relic Dashboards in Source Control
https://github.com/gatkin/nrdashboards

configuration-as-code monitoring newrelic

Last synced: 12 months ago
JSON representation

Manage New Relic Dashboards in Source Control

• Host: GitHub
• URL: https://github.com/gatkin/nrdashboards
• Owner: gatkin
• License: mit
• Created: 2019-07-21T17:34:25.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2022-12-08T05:56:37.000Z (over 3 years ago)
• Last Synced: 2025-04-09T17:55:22.287Z (about 1 year ago)
• Topics: configuration-as-code, monitoring, newrelic
• Language: Python
• Homepage: https://gatkin.github.io/nrdashboards/
• Size: 861 KB
• Stars: 5
• Watchers: 0
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# New Relic Dashboard Builder

[![Build Status](https://dev.azure.com/gregscottatkin/New%20Relic%20Dashboard%20Builder/_apis/build/status/gatkin.nrdashboards?branchName=master)](https://dev.azure.com/gregscottatkin/New%20Relic%20Dashboard%20Builder/_build/latest?definitionId=7&branchName=master)

[![Docs](https://img.shields.io/badge/docs-yes-blue)](https://gatkin.github.io/nrdashboards/)

[![PyPI Package](https://img.shields.io/pypi/v/nrdash)](https://pypi.org/project/nrdash/)

[![Coverage Status](https://coveralls.io/repos/github/gatkin/nrdashboards/badge.svg?branch=HEAD)](https://coveralls.io/github/gatkin/nrdashboards?branch=HEAD)

[![License](https://img.shields.io/github/license/gatkin/nrdashboards?color=blue)](https://github.com/gatkin/nrdashboards/blob/master/LICENSE)

[![Code Style](https://img.shields.io/badge/codestyle-black-black)](https://black.readthedocs.io/en/stable/)

[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/nrdash)](https://pypi.org/project/nrdash/)

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

```sh

pip install nrdash

```

Create your dashboard definitions in a YAML file

```yaml

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.

```sh

nrdash build --api-key  --account-id  

```

## Documentation

See the [documentation site](https://gatkin.github.io/nrdashboards/) for complete documentation.