Skip to main content

New Relic Dashboard Builder

Project description

New Relic Dashboard Builder

Build Status Docs PyPI Package Coverage Status License Code Style PyPI - Python Version

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nrdash-0.2.1.tar.gz (7.9 kB view details)

Uploaded Source

Built Distribution

nrdash-0.2.1-py3-none-any.whl (9.8 kB view details)

Uploaded Python 3

File details

Details for the file nrdash-0.2.1.tar.gz.

File metadata

  • Download URL: nrdash-0.2.1.tar.gz
  • Upload date:
  • Size: 7.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.6.0 requests-toolbelt/0.9.1 tqdm/4.33.0 CPython/3.7.5

File hashes

Hashes for nrdash-0.2.1.tar.gz
Algorithm Hash digest
SHA256 e6786055bee5a59b0ea713a3092e5439c1375051677b039816b328562613e55b
MD5 5d2820e72c190ae8b0b7257576f148d2
BLAKE2b-256 4482f651ffe7d5f427601e37b5023d586c25c336b2be8d6658694a742719b089

See more details on using hashes here.

File details

Details for the file nrdash-0.2.1-py3-none-any.whl.

File metadata

  • Download URL: nrdash-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 9.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.6.0 requests-toolbelt/0.9.1 tqdm/4.33.0 CPython/3.7.5

File hashes

Hashes for nrdash-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 735066205f93f94d29239c14c624e3b9e4d8b562df0f797cdaf49d9ead8b9141
MD5 892de50f0b421dfdde60320d352b0ce7
BLAKE2b-256 3b2ad24eee22dc062904f673b96868107a79568d40ee9380735361085cca9484

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page