/nr1-victory-visualizations

NR1 Victory Visualizations are NRQL-ready Victory charts you can use with New Relic data.

Primary LanguageJavaScriptApache License 2.0Apache-2.0

Community Project header

Victory Visualizations

GitHub release (latest SemVer including pre-releases) Snyk

About this Nerdpack

This Nerdpack provides NRQL-based custom visualizations built on top of the Victory charting library.

  • Circular progress bar
  • Range chart
  • Scatter plot chart
  • Stacked bar chart

To read more about the visualizations and their configuration, visit our documentation.

Open source license

This project is distributed under the Apache 2 license.

Getting started

  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
  2. 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.

  3. 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-victory-visualizations.git
    cd nr1-victory-visualizations
    npm install
    nr1 nerdpack:serve

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

Deploying this Nerdpack

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.

Support

New Relic has open-sourced this project. This project is provided AS-IS WITHOUT WARRANTY OR DEDICATED SUPPORT. That said, we welcome feedback, contributions and feature requests!

There are 2 main areas to request support:

  • GitHub issues/enhancement requests: Issues and enhancement requests should be reported to the project here on GitHub. They can be submitted in the issues tab of this repository. Please search for and review the existing open issues before submitting a new issue.
  • Community forum: We also encourage you to bring your experiences and questions to the Explorers Hub, where our community members collaborate on solutions and new ideas. New Relic hosts and moderates this 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/tags/c/build-on-new-relic/nerdpacks/323/victoryvisualizations

Support related to Victory can be found at: https://spectrum.chat/victory?tab=posts

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+nr1-victory-visualizations@newrelic.com.

A note about vulnerabilities

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.