Skip to content

Latest commit

 

History

History
287 lines (180 loc) · 15.1 KB

README.md

File metadata and controls

287 lines (180 loc) · 15.1 KB
Raw

New Relic Open Source community plus project banner.

New Relic's Node.js agent

npm status badge Server Smoke Tests Node Agent CI codecov

This package instruments your application for performance monitoring with New Relic.

In order to take full advantage of this package, make sure you have a New Relic account before starting. Available features, such as slow transaction traces, will vary based on account level.

As with any instrumentation tool, please test before using in production.

Installation

To use New Relic's Node.js agent entails these three steps, which are described in detail below:

  1. To install the agent for performance monitoring, use your favorite npm-based package manager and install the newrelic package into your application:

    $ npm install newrelic

  2. Then, copy the stock configuration file to your program's base folder:

    $ cp ./node_modules/newrelic/newrelic.js ./<your destination>

  3. Now, add your New Relic license key and application/service name to that file:

    /* File: newrelic.js */
    'use strict'
    /**
     * New Relic agent configuration.
     *
     * See lib/config/default.js in the agent distribution for a more complete
     * description of configuration variables and their potential values.
     */
    exports.config = {
      app_name: ['Your application or service name'],
      license_key: 'your new relic license key',
      /* ... rest of configuration .. */
    }
  1. Finally, run your program with the newrelic module loaded first by using node's -r/--require flag.
 $ node -r newrelic your-program.js

If you cannot control how your program is run, you can load the newrelic module before any other module in your program.

    const newrelic = require('newrelic')

    /* ... the rest of your program ... */

Next.js instrumentation

Note: The minimum supported Next.js version is 12.0.9. If you are using Next.js middleware the minimum supported version is 12.2.0.

The New Relic Node.js agent provides instrumentation for Next.js The instrumentation provides telemetry for server-side rendering via getServerSideProps, middleware, and New Relic transaction naming for both page and server requests. It does not provide any instrumentation for actions occurring during build or in client-side code. If you want telemetry data on actions occurring on the client (browser), you can inject the browser agent.

Here are documents for more in-depth explanations about transaction naming, and segments/spans.

Setup

Typically you are running a Next.js app with the next cli and you must load the agent via NODE_OPTIONS:

NODE_OPTIONS='-r newrelic' next start

If you are having trouble getting the newrelic package to instrument Next.js, take a look at our FAQs.

Next.js example projects

The following example applications show how to load the newrelic instrumentation, inject browser agent, and handle errors:

Custom Next.js servers

If you are using next as a custom server, you're probably not running your application with the next CLI. In that scenario we recommend running the Next.js instrumentation as follows.

node -r newrelic your-program.js

ECMAScript Modules

If your application is written with import and export statements in javascript, you are using ES Modules and must bootstrap the agent in a different way.

The New Relic Node.js agent includes experimental support for ES Modules. The agent is reliant on an experimental feature in Node.js in order to appropriately register instrumentation. Until the Node.js API for ES Module Loaders is stable, breaking changes may occur when updating Node.js. Lastly, the ESM loader does not follow the same supported Node.js versions as the agent. The minimum supported version of Node.js is v16.12.0.

Setup

  1. If you rely on a configuration file to run the agent, you must rename the file from newrelic.js to newrelic.cjs so it can be properly loaded. All the contents of the configuration file will behave the same once you rename. See CommonJS modules in ESM for more details.
$ mv newrelic.js newrelic.cjs
  1. To use the newrelic ESM loader, start your program with node and use the --experimental-loader flag and a path to the loader file, like this:
$ node --experimental-loader newrelic/esm-loader.mjs -r newrelic your-program.js

Note: Unlike the CommonJS methods listed above, there are no alternatives to running the agent without the --experimental-loader flag.

Custom Instrumentation

The agent supports adding your own custom instrumentation to ES module applications. You can use the instrumentation API methods. The only other difference between CommonJS custom instrumentation and ESM is you must provide a property of isEsm: true.

import newrelic from 'newrelic'
newrelic.instrument({ moduleName: 'parse-json', isEsm: true }, function wrap(shim, parseJson, moduleName) {
  shim.wrap(parseJson.default, function wrapParseJson(shim, orig) {
      return function wrappedParseJson() {
          const result = orig.apply(this, arguments)
          result.instrumented = true
          return true
      }
  })
})

We support the following custom instrumentation API methods in ES module apps:

  • newrelic.instrument
  • newrelic.instrumentConglomerate
  • newrelic.instrumentDatastore
  • newrelic.instrumentMessages
  • newrelic.instrumentWebframework

Note that we do not support newrelic.instrumentLoadedModule, for the same issue of immutability mentioned above.

If you want to see an example of how to write custom instrumentation in an ES module app, check out our examples repo for a working demo.

Getting Started

For more information on getting started, check the Node.js docs.

External Modules

There are modules that can be installed and configured to accompany the Node.js agent:

There are modules included within the Node.js agent to add more instrumentation for 3rd party modules:

Usage

Using the API

The newrelic module returns an object with the Node.js agent's API methods attached.

    const newrelic = require('newrelic')

    /* ... */
    newrelic.addCustomAttribute('some-attribute', 'some-value')

You can read more about using the API over on the New Relic documentation site.

Testing

These are the steps to work on core agent features, with more detail below:

  • Fork the agent
  • Install its dependencies
  • Run tests using npm

  1. Fork and clone this GitHub repository:

    $ git clone [email protected]:your-user-name/node-newrelic.git $ cd node-newrelic

  2. Install the project's dependencies:

    $ npm install

Then you're all set to start programming.

To run the test suite

  1. Install Docker
  2. Start the Docker services: $ npm run services
  3. Run all the tests using $ npm run test

Available test suites include:

$ npm run unit
$ npm run integration
$ npm run versioned
$ npm run lint
$ npm run smoke

Further Reading

Here are some resources for learning more about the agent:

Support

Should you need assistance with New Relic products, you are in good hands with several support channels.

If the issue has been confirmed as a bug or is a feature request, please file a GitHub issue.

Support Channels

Privacy

At New Relic we take your privacy and the security of your information seriously, and are committed to protecting your information. We must emphasize the importance of not sharing personal data in public forums, and ask all users to scrub logs and diagnostic information for sensitive information, whether personal, proprietary, or otherwise.

We define “Personal Data” as any information relating to an identified or identifiable individual, including, for example, your name, phone number, post code or zip code, Device ID, IP address and email address.

Please review New Relic’s General Data Privacy Notice for more information.

Roadmap

See our roadmap, to learn more about our product vision, understand our plans, and provide us valuable feedback.

Contribute

We encourage your contributions to improve the Node.js agent! Keep in mind when you submit your pull request, you'll need to sign the CLA via the click-through using CLA-Assistant. You only have to sign the CLA one time per project.

If you have any questions, or to execute our corporate CLA, required if your contribution is on behalf of a company, please drop us an email at [email protected].

A note about vulnerabilities

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 our bug bounty program.

If you would like to contribute to this project, review these guidelines.

To all contributors, we thank you! Without your contribution, this project would not be what it is today. We also host a community project page dedicated to New Relic Node Agent.

License

Except as noted below, the Node.js agent is licensed under the Apache 2.0 License.

The New Relic security agent is licensed under the New Relic Software License v1.0. The New Relic security agent module may be integrated like the New Relic Node.js agent.

The Node.js agent also uses source code from third-party libraries. You can find full details on which libraries are used and the terms under which they are licensed in the third-party notices document.