Skip to content

newrelic/nr1-learn-nrql

New Relic One Catalog Project header

CI GitHub release (latest SemVer including pre-releases) Snyk

NRQL Lessons

The NRQL (New Relic Query Language) Lessons App will help you quickly learn the value and power of our query language. We've developed this application for dashboard and alerts users, but everyone will get something out of it. We've broken this content into four levels, from simple to complex. Each level will expand your understanding of NRQL in a different way.

  1. Level One: Learning the Ropes
  2. Level Two: Controlling Your Data
  3. Level Three: Advancing Your Dashboarding
  4. Level Four: NRQL Power User

Each level uses easily understanable examples and descriptions with live data from your account to improve your NRQL skill.

We built these lessons with APM data in mind. If you're not using APM data, you may see some empty results, even though the query logic will still work. In future, we plan to include fallback queries so that lessons will work regardless of the data you're using.

Enabling this App

This app is available via the New Relic Catalog.

To enable it in your account:

  1. Go to Integrations & Agents > Apps and Visualizations and search for "NRQL Lessons"
  2. Click the NRQL Lessons card, and then click the Add this App button to add it to your account(s)
  3. Click Open App to launch the app (note: on the first time accessing the app, you may be prompted to enable it)

Once you have added your accounts, you can also open the app by:

  1. Open the Apps left-hand navigation menu item (you may need to click on the Add More ellipsis if it doesn't show up by default)
  2. In the Your Apps section, locate and click on the NRQL Lessons card to open the app

Manual Deployment

Ensure you have git and npm installed. If you're unsure whether you have them installed, run the following commands (they'll return version numbers if they're installed):

git --version
npm -v

Install the New Relic One CLI. Follow the instructions to set up your New Relic development environment

git clone https://github.com/newrelic/nr1-learn-nrql.git
cd nr1-learn-nrql
npm install
nr1 nerdpack:uuid -gf
nr1 nerdpack:publish
nr1 nerdpack:subscribe

This last command will subscribe the application to the account you've set as your default profile. You can check this using nr1 profiles:default. If you're not ready to deploy it to your account or want to test out changes you've made locally you can use:

git clone https://github.com/newrelic/nr1-learn-nrql.git
cd nr1-learn-nrql
npm install
** Make Any Desired Changes **
nr1 nerdpack:uuid -gf
nr1 nerdpack:serve

Once you've done that, visit https://one.newrelic.com/?nerdpacks=local, navigate to Apps, then NRQL Lessons, and ✨ enjoy!

Support

This project is actively maintained by the New Relic Labs team. Connect with us directly by creating issues or asking questions in the discussions section of this repo.

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 has open-sourced this project, which is provided AS-IS WITHOUT WARRANTY OR DEDICATED SUPPORT.

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 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@newrelic.com.

Open Source License

This project is distributed under the Apache 2 license.

About

NR1 learn NRQL helps New Relic Customers quickly learn our custom query language - NRQL

Topics

Resources

License

Code of conduct

Contributing

Security policy

Stars

20 stars

Watchers

20 watching

Forks

Packages

 
 
 

Contributors