Skip to content

Latest commit

 

History

History
149 lines (106 loc) · 6.6 KB

README.md

File metadata and controls

149 lines (106 loc) · 6.6 KB
Raw

New Relic One Catalog Project header

Status Widget Pack

This nerdpack contains three status widget custom visualizations to be used with dashboards.

  • NRQL Status Widget (Configurable variations)
  • NRQL Status Timeline Widget
  • NRQL Status Table Widget
  • Entity Status Widget (2 modes: Summary & Table)

NRQL Status Widget statuswidget2

NRQL Status Widget Features

  • Custom labelling for critical, warning, healthy
  • Metric suffixes and labels
  • Timeline
  • Togglability for all features
  • Regex matching for string values
  • Configurable OnClick actions to url or Modal
  • Modal can be provided any number of additional NRQL queries to be displayed
  • Toggle flash/pulse effect
  • Define bottom left and right metrics

NRQL Status Table Widget

NRQL Status Table Widget NRQL Status Table Widget

NRQL Status Table Widget Features

  • Custom thresholds
    • Configurable background and font colors
    • Highlight just the cell or the full row
  • Sortable
  • Toggle Keys
  • Handle 0, undefined, null cases
  • Customizable table
    • Headers
    • Metric cells

NRQL Status Timeline Widget

NRQL Status Widget

NRQL Status Timeline Widget Features

Example query: FROM Transaction SELECT count(*) FACET appName, hourOf(timestamp) ORDER BY timestamp LIMIT MAX

  • Custom thresholds
    • Configurable background and font colors
  • Toggle Key
  • Toggle Metrics
  • Set decimal places

Entity Status Widget

Summary

Entity Status Widget 1

Table

Entity Status Widget 2

Entity Widget Features

  • Track specific alerting states
  • Set custom labels
  • Provides a summary and table view mode
  • Toggle flash/pulse effect
  • Define custom entity search query
  • Define specific entity guids
  • Set custom display values
  • On click to stacked entity or modal to many entities

Open source license

This project is distributed under the Apache 2 license.

Getting started

This project is automatically available in the New Relic One Catalog under custom visualizations. If you would like to develop or deploy your own version follow the steps below.

  1. Ensure that you have Git and NPM installed. If you're unsure whether you have one or both of them installed, run the following commands. (If you have them installed, these commands return a version number; if not, the commands aren't recognized.)
git --version
npm -v
  1. Install the NR1 CLI by going to the developer center, and following the instructions to install and set up your New Relic development environment. This should take about 5 minutes.
  2. Execute the following command to clone this repository and run the code locally against your New Relic data:
nr1 nerdpack:clone -r https://github.com/newrelic/nr1-status-widgets.git
cd nr1-status-widgets
nr1 nerdpack:serve

Visit https://one.newrelic.com/?nerdpacks=local to launch your app locally.

Deploying this Nerdpack manually

Open a command prompt in the app's directory and run the following commands.

# If you need to create a new uuid for the account to which you're deploying this app, use the following
# nr1 nerdpack:uuid -g [--profile=your_profile_name]
# to see a list of APIkeys / profiles available in your development environment, run nr1 credentials:list
nr1 nerdpack:publish [--profile=your_profile_name]
nr1 nerdpack:tag [-t [CURRENT]] [--profile=your_profile_name]

Visit https://one.newrelic.com, and launch your app in New Relic.

Manual dashboard deployment

https://developer.newrelic.com/build-apps/build-visualization#deploy-and-use-your-visualization

This needs to be deployed into your account so that the custom visualizations can be added to dashboards.
After this has been deployed, ensure you navigate to the app and add to the account.

Support

New Relic has open-sourced this project. This project is provided AS-IS WITHOUT WARRANTY OR DEDICATED SUPPORT. Issues and contributions should be reported to the project here on GitHub.

We encourage you to bring your experiences and questions to the Explorers Hub where our community members collaborate on solutions and new ideas.

Community

New Relic hosts and moderates an online forum where customers can interact with New Relic employees as well as other customers to get help and share best practices. Like all official New Relic open source projects, there's a related Community topic in the New Relic Explorers Hub. You can find this project's topic/threads here:

https://discuss.newrelic.com/t/status-widget-visualizations-nerdpack-for-dashboards/154721

Issues / enhancement requests

Issues and enhancement requests can be submitted in the Issues tab of this repository. Please search for and review the existing open issues before submitting a new issue.

Security

As noted in our security policy, New Relic is committed to the privacy and security of our customers and their data. We believe that providing coordinated disclosure by security researchers and engaging with the security community are important means to achieve our security goals.

If you believe you have found a security vulnerability in this project or any of New Relic's products or websites, we welcome and greatly appreciate you reporting it to New Relic through HackerOne.

Contributing

Contributions are encouraged! If you submit an enhancement request, we'll invite you to contribute the change yourself. Please review our Contributors Guide.

Keep in mind that when you submit your pull request, you'll need to sign the CLA via the click-through using CLA-Assistant. If you'd like to execute our corporate CLA, or if you have any questions, please drop us an email at opensource+statuswidgets@newrelic.com.