GitHub Nerdpack

Integrate New Relic One with GitHub!

Integrate New Relic One with GitHub (either public or private enterprise instance) to bring more context to your entities.

You have the ability to associate any service or application with its GitHub repository as a one-time action, and then you can quickly see that application’s README file, as well as a list of most active source code contributors. These are obviously a great way to find “your people” and other inspiring New Relic One projects!

Clone This Nerdpack

What do you need to make this work?

  1. A GitHub (either public or private enterprise instance) organization and access to New Relic One.
  2. The ability to generate a personal access token in GitHub.

Using GitHub Personal Access Tokens

Integration with GitHub requires the user to create or use a private access token as a one-time setup step. New Relic will store that access token, but the user can easily delete it from New Relic’s storage at any time.

Every user must provide their own GitHub personal access token to increase security and allow the user to see only the repositories they have access to. The GitHub personal access token should be read only and scoped to this application only (i.e. we don’t recommend re-using a personal access token).

Personal access tokens are stored with New Relic One’s UserStorage API’s. 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). Finally, it’s important to note that UserStorage data may be accessible to a New Relic employee via an administrative privilege in the platform. :+1:

Clone this repository and run the following scripts:

git clone https://github.com/newrelic/nr1-github.git
cd nr1-github
nr1 nerdpack:uuid -gf
npm install
npm start

Deploy this Nerdpack

Open a command prompt in the nerdpack’s directory and run the following commands.

# this is to create a new uuid for the nerdpack so that you can deploy it to your account
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 :sparkles:


The full New Relic One GitHub repository and ReadMe can be found here.

Happy Nerd-ing! :nerd_face:

which profile name we have to use

Hi @shiv1 the NR1 CLI Profile you should use is the one which is set up with the API Key of the account you want to deploy this nerdpack to.

For example, I have two test accounts;

Ryan Veitch - Testing Account 1
Ryan Veitch - Testing Account 2

If I want to deploy a Nerdpack to Testing account 1, I will use the CLI profile that correlates to that account.


You can use

nr1 profiles:default

to select a default profile, you can then run all nr1 commands without the profile flag, for example;

You can run this:
   nr1 nerdpack:deploy [-c [DEV|BETA|STABLE]]
Instead of this:
   nr1 nerdpack:subscribe [-c [DEV|BETA|STABLE]] [--profile=your_profile_name]

How do I uninstall this nerd pack and install a fresh copy?

Hey @nicholas.shook - I went through uninstalling published nerdpacks here:

Let me know if that is helpful :smiley:

1 Like

I added the Nerdpack via the New Relic One interface, and I can’t seem to find a nerdpack:list command or anything similar. How would I go about finding the UUID of the nerd pack another way?

Hey @nicholas.shook - If you added the Nerdpack through the UI, you may not have it listed in your command line interface.

In that case you can remove it in the same way it was added. Navigate in New Relic One to the Application Catalog launcher, Select the Nerdpack in question, and from there you can manage access.

You can see this in the video attached to the post I linked to previously :smiley:

1 Like

thanks @RyanVeitch, I got it working

1 Like

Perfect! Thanks for confirming

I have been asked to query here for my problem for which I raised a new relic support ticket https://support.newrelic.com/tickets/463291/edit . So can someone please look into the issue and help me?