You should also include at least one screenshot. Remove any sensitive data like customer data, NR-only tools, and system information like hostnames (for a full list, see Docs site security guidelines for images on Jive).
This project is distributed under the Apache 2 license.
Give a complete list of prerequisites for using your app, and include links to other New Relic features when necessary.
For example:
Required:
- New Relic Infrastructure agent(s) installed on your cloud computing devices and the related access to New Relic One.
You'll get the best possible data out of this application if you also:
- Activate the EC2 integration to group by your cloud provider account.
- Install APM on your applications to group by application.
Include a step-by-step procedure on how to get your app installed and deployed. The clone and deploy steps are similar across all apps. If your app has additional steps required to get started, include them here or in their own section.
- First, ensure that you have Git and NPM installed. If you're unsure whether you have one or both of them installed, run the following command(s) (If you have them installed these commands will return a version number, if not, the commands won't be recognized):
git --version
npm -v- Next, install the NR1 CLI by going to this link and following the instructions (5 minutes or less) to install and setup your New Relic development environment.
- Next, to clone this repository and run the code locally against your New Relic data, execute the following command:
nr1 nerdpack:clone -r https://github.com/newrelic/nr1-vividcortex.git
cd nr1-vividcortex
nr1 nerdpack:serveVisit https://one.newrelic.com/?nerdpacks=local, navigate to the Nerdpack, and ✨
Include the necessary steps to deploy your app. Generally, you shouldn't need to change any of these steps.
Open a command prompt in the nerdpack's directory and run the following commands.
# If you need to create a new uuid for the account to which you're deploying this Nerdpack, 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:deploy [-c [DEV|BETA|STABLE]] [--profile=your_profile_name]
nr1 nerdpack:subscribe [-c [DEV|BETA|STABLE]] [--profile=your_profile_name]Visit https://one.newrelic.com, navigate to the Nerdpack, and ✨
Your VividCortex API key is stored with New Relic One’s UserStorage APIs. UserStorage data is accessible only to the user account and Nerdpack which created it. The data is encrypted in transmission, but is not encrypted at rest (within the underlying database). Because of this, UserStorage data may be accessible to a New Relic employee via an administrative privilege in the platform.
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.
Work with the Explorer's Hub team to create a tag for your app, then update the link below.
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/nr1-vividcortex (Note: URL subject to change before GA)
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.
Work with the Open Source Office to update the email alias below.
Contributions are welcome (and if you submit a Enhancement Request, expect to be invited to contribute it 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-vividcortex@newrelic.com.