Pinpoint Node.js Agent

This is the official Node.js agent for Pinpoint.

If you have any feedback or questions, please post them on the Discuss issues.

Installation and getting started

1. Install

Install with npm:

npm install --save pinpoint-node-agent

Install with yarn:

yarn add pinpoint-node-agent

2. Adding a code

To run Pinpoint agent for your own applications, make sure you have the prerequisites in place first.

ES6

  import 'pinpoint-node-agent'

CommonJS

  require('pinpoint-node-agent')

Next.js

In Next.js application, the Pinpoint Node Agent can be integrated:

• package.json using NODE_OPTIONS

Package.json

  "scripts": {
    "build": "next build",
    "dev": "next dev --turbopack",
    "start": "NODE_OPTIONS=--require=pinpoint-node-agent next start"
  },

The PINPOINT_TRACE_EXCLUSION_URL_PATTERN value cannot be set using environment variables from a .env file. While there are alternative approaches, one option is to modify the "start" script in package.json to point to a shell script (e.g., start.sh) where common environment variables can be configured.

Example

Update the package.json:

"scripts": {
  "start": "./start.sh"
}

Create a start.sh file:

#!/bin/bash

export PINPOINT_TRACE_EXCLUSION_URL_PATTERN="/health_check,/admin/**"
export PINPOINT_APPLICATION_NAME="your-app-name"

# 2. Run Next.js with Pinpoint agent
NODE_OPTIONS=--require=pinpoint-node-agent next start

Make the script executable:

chmod +x start.sh

Webpack with node -r (required: above v0.8.2)

In Node with Webpack, if the Pinpoint Node agent cannot hook the HTTP module, it is the case that http.createServer is called first in the JS code compiled by webpack.

The'pinpoint-node-agent' require or import in the source code should be deleted.

$ node -r pinpoint-node-agent dist/entry.js

If you are using pm2, use node-args(CLI) or node_args(Ecosystem File).

module.exports = {
  apps : [{
    name: "app",
    script: "./app.js",
    'node_args': ['-r', 'pinpoint-node-agent']
  }]
}

3. Configuration with Environment variables

Based on the pinpoint-config-default.json file, only necessary parts are set as environment variables.

The PINPOINT_AGENT_ID, PINPOINT_AGENT_NAME and PINPOINT_APPLICATION_NAME pattern are [a-zA-Z0-9\\._\\-]+.

4. User configuration file (pinpoint-config.json) — since v1.4.0

From #404 onward, the agent loads pinpoint-config.json automatically with the following priority:

1. The directory that contains your entry script (require.main.filename), e.g. the folder where app.js or server.js lives.
2. The current working directory returned by process.cwd() (the folder from which you executed node or pm2).

If neither location contains the file, the agent simply uses the built-in defaults.

Tip: When using node -r pinpoint-node-agent or tools that bootstrap the agent before your app starts, require.main can be temporarily undefined. In that case, the second location (process.cwd()) must contain pinpoint-config.json or you can set configuration values via environment variables.

Example layout:

my-service/
├─ package.json
├─ server.js         # entry point (require.main)
└─ pinpoint-config.json

Running the app from a different folder? Make sure either the entry directory or the directory you execute from includes pinpoint-config.json.

name	default	description
PINPOINT_AGENT_ID		Optional env var (≤24 chars). When left unset, the agent generates a random hex value that still respects the [a-zA-Z0-9._-]+ pattern.
PINPOINT_AGENT_NAME		Optional env var (≤255 chars). Use meaningful labels that will be shown in the Inspector UI.
PINPOINT_APPLICATION_NAME		meaningful name of the app. an application name can have multiple PINPOINT_AGENT_ID. The maximum length is 24. a required variable.
PINPOINT_COLLECTOR_IP	localhost	The address that the Pinpoint collector. ex) 192.168.0.1
PINPOINT_SAMPLING_RATE	10	Sample rate of incoming HTTP or HTTPS request. The value is calculated as 1/value.
PINPOINT_ENABLE	true	If you set it to false, the agent will not work.
PINPOINT_CONTAINER	false	Whether to use docker or kubernetes. If the PINPOINT_CONTAINER environment variable is not set, the agent analyzes the'/.dockerenv' and'/proc/self/cgroup' files to determine whether to use the Docker container. If the KUBERNETES_SERVICE_HOST environment variable exists, it is determined that it is the kubernetes environment and changes it to the true value.
PINPOINT_TRACE_EXCLUSION_URL_PATTERNS		comma-separated string. ex) /health_check,/admin/** or Unit tests. PINPOINT_TRACE_EXCLUSION_URL_PATTERNS replaces PINPOINT_TRACE_EXCLUSION_URL_PATTERN. For backward compatibility, the old name(PINPOINT_TRACE_EXCLUSION_URL_PATTERN) is still recognized and applied the same way. If both are set, the plural form (PINPOINT_TRACE_EXCLUSION_URL_PATTERNS) takes precedence.
PINPOINT_TRACE_EXCLUSION_URL_CACHE_SIZE		If the app is designed so that the pathname of the URL is fixed, if the cache size is set, the pathname of the frequently used URL does not match with patterns. In case of using query for pathname like /user/1000, cache is unnecessarily. Unit tests
PINPOINT_PROFILER_SQL_STAT	false	SQL uid
PINPOINT_TRACE_LOCATION_AND_FILENAME_OF_CALL_SITE	false	CallSite line number and filename
PINPOINT_HTTP_STATUS_CODE_ERRORS	5xx,401,403	Comma-separated list of HTTP status codes that should be treated as errors. When a response matches one of these codes, the agent will record the request as an error in Pinpoint. You can customize this list to include any status codes relevant to your application's error.

Agent ID

PINPOINT_AGENT_ID should uniquely identify each server or node (≤24 chars). A common convention is to reuse the hostname or another node identifier.

PINPOINT_AGENT_ID=${HOSTNAME} pm2 start ~/service/bin/pm2_start.json​

Supported Modules

• Express 4
• Koa(koa-router >=5.2.0 <8)
• HTTP, HTTPS
• Redis, ioredis(>=2.0.0 <5.0.0)
• mysql and mysql2
• mongoDB driver v4.0 or higher
• Fetch API with Undici in Node.js
• Next.js

Agent - Collector compatibility table

Agent Version	Collector 1.x	Collector 2.x	Collector 3.x
above v0.8	no	yes	yes

Sampling rate

If you use Performance tester for sampling rate, you can review while changing the sampling rate of the node agent of the Node application.

No support the JVM agent features

The Pinpoint Node agent does not support the following the JVM agent features. We plan to provide more detailed app information like the JVM agent.

• Some inspector information

Contributing

We are looking forward to your contributions via pull requests.

To contribute to Pinpoint Node JS agent, you should pass all test suites and your unit tests.

License

   Copyright 2020-present NAVER Corp.

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.