Skip to content

Latest commit

 

History

History

esm-app

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
custom-instrumentation
custom-instrumentation
 
 
images
images
 
 
.npmrc
.npmrc
 
 
README.md
README.md
 
 
index.js
index.js
 
 
newrelic.cjs
newrelic.cjs
 
 
package.json
package.json
 
 

README.md

Sample ESM Application

This application demonstrates using the agent to instrument both New Relic built-instrumentation and custom ESM instrumentation. It is done by using the newrelic/esm-loader.mjs via --experimental-loader flag to node.

Getting started

Note: You must be running Node >=v16.2.0.

  1. Clone or fork this repository.

  2. Install dependencies and run application

npm ci
PORT=3000 NEW_RELIC_LICENSE_KEY=<Your New Relic License Key> npm start
  1. Make requests to application.
curl http://localhost:3000
curl http://localhost:3000/instrumentation-example
curl http://localhost:3000/user/100

  1. Navigate to New Relic One > APM > ESM Example App > Monitor > Distributed Tracing. DT view

  2. Click a trace and you can see the express instrumentation recording relevant spans. Detailed trace

Custom ESM instrumentation

The process of registering custom instrumentation in an ESM application is the same as a CommonJS(cjs) one. You can use newrelic.instrument, newrelic.instrumentConglomerate, newrelic.instrumentDatastore, newrelic.instrumentWebframework, or newrelic.instrumentMessages before the module is imported, and it will properly instrument.

Note: You can no longer use newrelic.instrumentLoadedModule as the mechanics of that API method were geared towards CommonJS modules.

Additional Configuration

If you are a New Relic employee and wanting to testing on a staging environment, add the following to the npm start command:

NEW_RELIC_HOST=staging-collector.newrelic.com