mmfred/nr1-igor

Infrastructure Geo-Ops Reporter

Usage

IGOR (Infra Geo-Ops Reporter) overlays infrastructure data over a map view within New Relic One.

IGOR plots the highest CPU, memory, and disk usage for hosts at various locations on a map, offering a true 30,000 foot (or thereabouts) view. It allows you to drill down into hosts at a location. Its near-realtime nature allows it to be used in an NOC (network operations center) setting.

IGOR only requires that your hosts are running New Relic Infrastructure agent on them. Configuration happens directly within the app, where you specify the list of locations, and the hosts at each location.

Open source license

This project is distributed under the Apache 2 license.

What do you need to make this work?

One or more host running New Relic Infrastructure agent.

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 command. (If you have them installed these commands will return a version number, if not, the commands won't be recognized.)

git --version
npm -v

2. Install the New Relic One CLI by going to this link and following the instructions (5 minutes or less) to install and set up your New Relic development environment.
3. Run 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-igor.git
cd nr1-igor
nr1 nerdpack:serve

Visit https://one.newrelic.com/?nerdpacks=local, navigate to the Nerdpack, and ✨

Deploying this Nerdpack

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 ✨

Configure and use IGOR

IGOR opens with a splash screen featuring a drop-down that lists accounts that you can switch between, and a button to open the admin panel.

Set up IGOR

1. Select the gear icon to open the admin panel.

2. IGOR uses Mapbox to display the map. To do so, in General Settings, add your Mapbox Access Token. For more information, see the Mapbox access tokens information.

Modify the default map view

1. Select the Add/Edit Locations tab to add locations on the map.

2. List the locations, one location per line, with the name, latitude, and longitude specified as comma-separated values for each location. For example:

San Francisco,37.7913249,-122.3951599
Atlanta,33.7869491,-84.3849318
Portland,45.5221871,-122.6784799
Phoenix,33.4485711,-112.0743242

3. After you add locations, switch to the Hosts at Locations tab.

4. Click on a location to bring up a list of hosts reporting into New Relic Infrastructure. Check all hosts for each location.

5. After you have set up all the locations, close the admin panel to view your map. 🎉

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/nr1-igor-infrastructure-map-nerdpack/91886

Issues and enhancement requests

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

Contributing

Contributions are welcome (and if you submit an 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 [email protected].