npmpackage.info

elastic-apm-node

4.11.1

586

BSD-2-Clause

JavaScript

249.88 kB

63,288,786 6

Installations

npm install elastic-apm-node

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS

Min. Node Version

>=14.17.0

Node Version

16.20.2

NPM Version

8.19.4 Score

83.6

Supply Chain

98.3

Quality

90.7

Maintenance

100

Vulnerability

92.2

License

Pull Requests

Open

20

Total

3,069

Closed

572

Merged

2,477

Issues

Open

313

Total

1,433

Closed

1,120

Releases

v4.11.1

Updated on Mar 13, 2025

v4.11.0

Updated on Jan 20, 2025

v4.10.0

Updated on Dec 24, 2024

v4.9.0

Updated on Dec 10, 2024

v3.52.2

Updated on Nov 05, 2024

v4.8.1

Updated on Nov 04, 2024

View All 49 releases

Contributors

2,153

View All 2,153 Contributors

Languages

JavaScript

Shell

TypeScript

Makefile

Dockerfile

CSS

JavaScript (97.73%)

Shell (1.64%)

TypeScript (0.37%)

Makefile (0.18%)

Dockerfile (0.08%)

validate.email 🚀

Verify real, reachable, and deliverable emails with instant MX records, SMTP checks, and disposable email detection.

Developer

elastic

Download Statistics

Total Downloads

63,288,786

Last Day

79,896

Last Week

380,180

Last Month

1,605,641

Last Year

19,761,822

GitHub Statistics

BSD-2-Clause License

586 Stars

3,820 Commits

230 Forks

263 Watchers

44 Branches

2,153 Contributors

Updated on Mar 13, 2025

Bundle Size

934.30 kB

Minified

249.88 kB

Minified + Gzipped

Bundlephobia

Maintainers

Package Meta Information

Latest Version

4.11.1

Package Id

elastic-apm-node@4.11.1

Unpacked Size

907.79 kB

Size

235.18 kB

File Count

160

NPM Version

8.19.4

Node Version

16.20.2

Published on

Mar 13, 2025

Oops! Something went wrong.

Dependencies

Dev Dependencies

@apollo/server @aws-sdk/client-dynamodb @aws-sdk/client-s3 @aws-sdk/client-sns @aws-sdk/client-sqs @aws-sdk/s3-request-presigner @babel/cli @babel/core @babel/preset-env @elastic/elasticsearch @fastify/formbody @hapi/hapi @koa/router @types/node ajv apollo-server-core apollo-server-express aws-sdk benchmark bluebird body-parser cassandra-driver columnify connect dashdash dependency-check diagnostics_channel elasticsearch eslint eslint-config-prettier eslint-plugin-import eslint-plugin-license-header eslint-plugin-n eslint-plugin-prettier eslint-plugin-promise express express-queue fastify finalhandler generic-pool get-port glob got graphql handlebars ioredis js-yaml json kafkajs knex koa koa-bodyparser koa-router lambda-local memcached mimic-response mkdirp mongodb mongodb-core mysql mysql2 ndjson numeral once pg prettier pug redis restify rimraf tape tedious test-all-versions thunky tree-kill typescript undici vasync wait-on ws

Elastic APM Node.js Agent

This is the official Node.js application performance monitoring (APM) agent for the Elastic Observability solution. It is a Node.js package that runs with your Node.js application to automatically capture errors, tracing data, and performance metrics. APM data is sent to your Elastic Observability deployment -- hosted in Elastic's cloud or in your own on-premises deployment -- where you can monitor your application, create alerts, and quick identify root causes of service issues.

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

Installation

npm install --save elastic-apm-node

Getting started

First, you will need an Elastic Stack deployment. This is a deployment of APM Server (which receives APM data from the APM agent running in your application), Elasticsearch (the database that stores all APM data), and Kibana (the application that provides the interface to visualize and analyze the data). If you do not already have an Elastic deployment to use, follow this APM Quick Start guide to create a free trial on Elastic's cloud. From this deployment you will need the APM serverUrl and secretToken (or a configured apiKey) to use for configuring the APM agent.

Next, the best and easiest way to see how to install and start the APM agent is to follow one of the "Get started" guides for the web framework or technology that you are using:

Typically, the quick start steps are:

Install the APM agent package as a dependency:
```
npm install --save elastic-apm-node
```

Configure and start the APM agent. For the APM agent's automatic instrumentation of popular modules to work, it must be started before your application imports its other dependencies. For example, if you use CommonJS, then put this at the very top of your main application file:

1require('elastic-apm-node').start({
2    serverUrl: '<serverUrl from your Elastic Stack deployment>',
3    secretToken: '<secretToken from your Elastic Stack deployment>'
4    serviceName: '...', // https://www.elastic.co/guide/en/apm/agent/nodejs/current/configuration.html#service-name
5    environment: '...', // https://www.elastic.co/guide/en/apm/agent/nodejs/current/configuration.html#environment
6});

There are other ways to start the APM agent: for example, to support starting the APM agent without having to change application code; or to avoid certain surprises when using TypeScript or other transpilers like Babel or esbuild. See Starting the agent for a reference of all ways to start the agent and for details on gotchas with transpilers and bundlers (like Webpack and esbuild).

If your application is using ES modules, please see ECMAScript module support for the current experimental support.

Documentation

The full Node.js APM agent documentation is here. Some important links:

Release notes
Supported Technologies describes the supported Node.js versions, which modules (and version ranges) are automatically traced, and other technologies.
Configuring the agent describes the different ways to configure the APM agent (via options to apm.start(...), environment variables, or other mechanisms).
Configuration options is a full configuration reference.
Troubleshooting describes some common issues and a way to get debugging output from the APM agent for bug reports.
Upgrading includes a guide for upgrading from each past major version of the APM agent.
Metrics describes the metrics that the APM agent automatically collects.
The APM agent includes an OpenTelemetry Bridge that allows one to use the vendor-agnostic OpenTelemetry API for manual instrumentation in your application, should you require manual instrumentation.

Active release branches

The following git branches are active:

The "main" branch is being used for 4.x releases.
The "3.x" branch is being used for 3.x maintenance releases. The 3.x line will be supported until 2024-03-07 -- for 6 months after the release of v4.0.0.

Contributing

Contributions are very welcome. You can get in touch with us through our Discuss forum. If you have found an issue, you can open an issue at https://github.com/elastic/apm-agent-nodejs/issues.

If you are considering contributing code to the APM agent, please read our contribution guide.

Please see TESTING.md for instructions on how to run the test suite.

License

BSD-2-Clause

Made with ♥️ by Elastic and our community.

No vulnerabilities found.

10

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

10

Maintained

Determines if the project is "actively maintained".

10

Security-Policy

Determines if the project has published a security policy.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

License

Determines if the project has defined a license.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

Packaging

Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.

5

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

4

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

Reason

dependency not pinned by hash detected -- score normalized to 4

Details

Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/edge.yml:37: update your workflow using https://app.stepsecurity.io/secureworkflow/elastic/apm-agent-nodejs/edge.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/edge.yml:58: update your workflow using https://app.stepsecurity.io/secureworkflow/elastic/apm-agent-nodejs/edge.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/labeler.yml:29: update your workflow using https://app.stepsecurity.io/secureworkflow/elastic/apm-agent-nodejs/labeler.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/labeler.yml:40: update your workflow using https://app.stepsecurity.io/secureworkflow/elastic/apm-agent-nodejs/labeler.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/microbenchmark.yml:24: update your workflow using https://app.stepsecurity.io/secureworkflow/elastic/apm-agent-nodejs/microbenchmark.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/elastic/apm-agent-nodejs/release.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:26: update your workflow using https://app.stepsecurity.io/secureworkflow/elastic/apm-agent-nodejs/release.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:33: update your workflow using https://app.stepsecurity.io/secureworkflow/elastic/apm-agent-nodejs/release.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:118: update your workflow using https://app.stepsecurity.io/secureworkflow/elastic/apm-agent-nodejs/release.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:141: update your workflow using https://app.stepsecurity.io/secureworkflow/elastic/apm-agent-nodejs/release.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/slack-lite.yml:122: update your workflow using https://app.stepsecurity.io/secureworkflow/elastic/apm-agent-nodejs/slack-lite.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/tav-command.yml:144: update your workflow using https://app.stepsecurity.io/secureworkflow/elastic/apm-agent-nodejs/tav-command.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/tav-command.yml:25: update your workflow using https://app.stepsecurity.io/secureworkflow/elastic/apm-agent-nodejs/tav-command.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/tav-command.yml:44: update your workflow using https://app.stepsecurity.io/secureworkflow/elastic/apm-agent-nodejs/tav-command.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/tav-command.yml:50: update your workflow using https://app.stepsecurity.io/secureworkflow/elastic/apm-agent-nodejs/tav-command.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/tav.yml:30: update your workflow using https://app.stepsecurity.io/secureworkflow/elastic/apm-agent-nodejs/tav.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/tav.yml:34: update your workflow using https://app.stepsecurity.io/secureworkflow/elastic/apm-agent-nodejs/tav.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/tav.yml:73: update your workflow using https://app.stepsecurity.io/secureworkflow/elastic/apm-agent-nodejs/tav.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/test-fips.yml:55: update your workflow using https://app.stepsecurity.io/secureworkflow/elastic/apm-agent-nodejs/test-fips.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/test-fips.yml:60: update your workflow using https://app.stepsecurity.io/secureworkflow/elastic/apm-agent-nodejs/test-fips.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test-fips.yml:33: update your workflow using https://app.stepsecurity.io/secureworkflow/elastic/apm-agent-nodejs/test-fips.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:37: update your workflow using https://app.stepsecurity.io/secureworkflow/elastic/apm-agent-nodejs/test.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:38: update your workflow using https://app.stepsecurity.io/secureworkflow/elastic/apm-agent-nodejs/test.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:169: update your workflow using https://app.stepsecurity.io/secureworkflow/elastic/apm-agent-nodejs/test.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:170: update your workflow using https://app.stepsecurity.io/secureworkflow/elastic/apm-agent-nodejs/test.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:182: update your workflow using https://app.stepsecurity.io/secureworkflow/elastic/apm-agent-nodejs/test.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:183: update your workflow using https://app.stepsecurity.io/secureworkflow/elastic/apm-agent-nodejs/test.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/test.yml:207: update your workflow using https://app.stepsecurity.io/secureworkflow/elastic/apm-agent-nodejs/test.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/updatecli.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/elastic/apm-agent-nodejs/updatecli.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/updatecli.yml:38: update your workflow using https://app.stepsecurity.io/secureworkflow/elastic/apm-agent-nodejs/updatecli.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/updatecli.yml:45: update your workflow using https://app.stepsecurity.io/secureworkflow/elastic/apm-agent-nodejs/updatecli.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/updatecli.yml:53: update your workflow using https://app.stepsecurity.io/secureworkflow/elastic/apm-agent-nodejs/updatecli.yml/main?enable=pin
Warn: containerImage not pinned by hash: .ci/docker/node-container/Dockerfile:2
Warn: containerImage not pinned by hash: .ci/docker/node-edge-container/Dockerfile:1: pin your Docker image by updating ubuntu:20.04 to ubuntu:20.04@sha256:8e5c4f0285ecbb4ead070431d29b576a530d3166df73ec44affc1cd27555141b
Warn: containerImage not pinned by hash: test/Dockerfile:2
Warn: downloadThenRun not pinned by hash: .ci/docker/node-edge-container/Dockerfile:27
Warn: downloadThenRun not pinned by hash: .ci/scripts/prepare-benchmarks-env.sh:22
Info: 3 out of 23 GitHub-owned GitHubAction dependencies pinned
Info: 9 out of 21 third-party GitHubAction dependencies pinned
Info: 2 out of 5 containerImage dependencies pinned
Info: 0 out of 2 downloadThenRun dependencies pinned
Info: 6 out of 6 npmCommand dependencies pinned

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

Fuzzing

Determines if the project uses fuzzing.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

0

SAST

Determines if the project uses static code analysis.

Score

6

/10

Last Scanned on 2025-03-10

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

Other packages similar to elastic-apm-node

elastic-apm-node-opentracing

2.0.1

An OpenTracing bridge for the Elastic APM Node.js Agent

elastic-apm-node-logger

1.1.2

As of 25th Aug 2022, the official `elastic-apm-node` NPM library does not send the STDOUT logs of the nodejs application that it is installed on to back to your designated Elastic Stack, hence this NPM library aims to bridge this gap. it also enables your

@types/elastic-apm-node

2.7.2

Stub TypeScript definitions entry for elastic-apm-node, which provides its own types definitions

elastic-apm-node-with-metrics

0.0.9

The Elastic APM agent for Node.js with ability to read raw metrics.