Build on the New Relic One platform

Using the same tools we use to build the New Relic One platform, you can build highly customized applications and visualizations that meet your unique business needs. Your applications live on New Relic One, ready to be shared with your team members.

If you're familiar with React, GraphQL, and NRQL (our query language), building a simple application will take you only a few minutes.

Get started:

New Relic One Applications

Intro to components and tools

You can jump right into building with the quick-start procedure, but first it may help you to understand the components and tools you'll be using.

A New Relic One application is made up of:

  • A Nerdpack: The package containing all the files required by your application. It contains two types of files that you'll customize to build your app: Nerdlets, and the launcher.
  • One or more Nerdlet filesA specific UI view or window. A Nerdlet is a React JavaScript package that includes an index.js file, a stylesheet, and a JSON-format config file. It can contain any JS functionality (charts, interactive fields, tooltips, etc.). 
  • A launcher file: Your team members select the launcher to open your application. It's located on the New Relic One home page

Want to understand the file structure? See Nerdpack file structure.  

Tools you'll be using include: 

  • CLI: Use our CLI (command line interface application) to generate Nerdpack/Nerdlet templates, locally serve your app, manage the app, and deploy it to New Relic One.
  • React: To build out the functionality of your Nerdlets, you'd use:

    • Our nr1 component library, which includes UI components (charts, tooltips, etc.) and API calls that give you access to platform features/functions.

    • Any React package.
  • NerdGraph: Our GraphQL API, used for retrieving data and making mutations (like saving user/account data). Explore our schema with our GraphiQL interface.
  • NRQL: The New Relic query language, used for retrieving data from the entities you monitor. 
  • NerdStorage: NerdStorage lets you store data related to using your app, such as user data, account data, or entity data. 

Quick start

To build a New Relic One application, you'll need a paid New Relic account. If you don't yet have a New Relic account, you can sign up for a free trial

To start building:

This procedure will download the CLI, and create and locally serve a simple application that can be found on the one.newrelic.com home page.

After you've done that, you can start to add React JS functionality to your application. You can also clone, fork, and deploy our example open-source applications

Keep reading to learn how to build. 

Steps to building an app

To help you build on New Relic One, it can help you to understand a typical building process for a fairly complex custom app:

  1. Decide on a data-driven problem you want to solve (that cannot be solved by existing New Relic monitoring tools). You can use data from any source, not just New Relic-stored data. 
  2. Brainstorm ways to solve the problem with data visualization. Need ideas? See our library of open-source New Relic One apps.
  3. Read our docs on how to build. Recommended places to start: Review the Intro to the SDK docs and go through the Build on New Relic One workshop.
  4. Generate and locally serve a Nerdpack template. You can do this with the quick-start procedure or with CLI commands.
  5. Use our library of recommended components to build out the JavaScript functionality of your Nerdlets. When your app is locally served, any changes you make are immediately visible in New Relic One.
  6. When your app is ready for your team to use, publish and deploy it.

Educational resources

Resources for learning to build: 

Get inspired

To help you get started, we have a library of example open-source applications. You can download these applications and deploy them as-is, customize them, borrow code to use in your own application, or just explore them to help you understand how New Relic One applications work.