NR1 Kentik Network Monitoring

About this Nerdpack

This Nerdpack contains visualizations for Kentik specific network data as a part of the Kentik & New Relic partnership. Currently, you will find two visualizations, a sankey and a map. You can use these for visualizing network data flows and location.

Open source license

This project is distributed under the Apache 2 license.

What do you need to make this work?

Required:

Kentik's network agent installed and sending data to your New Relic
FSO user permission unless running locally only

Getting started

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

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.
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-kentik-network-monitoring.git
cd nr1-kentik-network-monitoring
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. Please use the API key associated with the account for which you have Kentik data.

# 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: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, 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. 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/new-relic-one-network-monitoring/157184

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 [email protected].

isabella232 / nr1-kentik-network-monitoring Goto Github PK