@opentelemetry/node
Advanced tools
OpenTelemetry Node SDK provides automatic telemetry (tracing, metrics, etc) for Node.js applications
This module provides automated instrumentation and tracing for Node.js applications.
For manual instrumentation see the @opentelemetry/tracing package.
This package exposes a NodeTracerProvider that will automatically hook into the module loader of Node.js.
For this to work, please make sure that NodeTracerProvider is initialized before any other module of your application, (like http or express) is loaded.
OpenTelemetry comes with a growing number of instrumentation plugins for well know modules (see supported modules) and an API to create custom plugins (see the plugin developer guide).
Whenever a module is loaded NodeTracerProvider will check if a matching instrumentation plugin has been installed.
Please note: This module does not bundle any plugins. They need to be installed separately.
If the respective plugin was found, it will be used to patch the original module to add instrumentation code. This is done by wrapping all tracing-relevant functions.
This instrumentation code will automatically
In short, this means that this module will use provided plugins to automatically instrument your application to produce spans and provide end-to-end tracing by just adding a few lines of code.
Additionally to automated instrumentation, NodeTracerProvider exposes the same API as @opentelemetry/tracing, allowing creating custom spans if needed.
npm install --save @opentelemetry/api
npm install --save @opentelemetry/node
# Install instrumentation plugins
npm install --save @opentelemetry/plugin-http
npm install --save @opentelemetry/plugin-https
The following code will configure the NodeTracerProvider to instrument http
(and any other installed supported
modules)
using @opentelemetry/plugin-http.
const { NodeTracerProvider } = require('@opentelemetry/node');
// Create and configure NodeTracerProvider
const provider = new NodeTracerProvider();
// Initialize the provider
provider.register()
// Your application code - http will automatically be instrumented if
// @opentelemetry/plugin-http is present
const http = require('http');
User supplied plugin configuration is merged with the default plugin configuration. Furthermore, custom plugins that are configured are implicitly enabled just as default plugins are.
In the following example:
requestHookconst provider = new NodeTracerProvider({
plugins: {
express: {
enabled: false,
},
http: {
requestHook: (span, request) => {
span.setAttribute("custom request hook attribute", "request");
},
},
customPlugin: {
path: "/path/to/custom/module",
},
},
});
Plugins can be disabled without modifying and redeploying code.
OTEL_NO_PATCH_MODULES accepts a
comma separated list of module names to disabled specific plugins.
The names should match what you use to require the module into your application.
For example, OTEL_NO_PATCH_MODULES=pg,https will disable the postgres plugin and the https plugin. To disable all plugins, set the environment variable to *.
See how to automatically instrument http and gRPC / grpc-js using node-sdk.
Apache 2.0 - See LICENSE for more information.
0.15.0
opentelemetry-api-metrics, opentelemetry-api, opentelemetry-exporter-collector-grpc, opentelemetry-exporter-collector-proto, opentelemetry-exporter-collector, opentelemetry-exporter-prometheus, opentelemetry-instrumentation, opentelemetry-metrics, opentelemetry-sdk-node
opentelemetry-api, opentelemetry-context-zone-peer-dep, opentelemetry-context-zone, opentelemetry-grpc-utils, opentelemetry-instrumentation-http, opentelemetry-instrumentation-xml-http-request, opentelemetry-node, opentelemetry-plugin-fetch, opentelemetry-plugin-grpc-js, opentelemetry-plugin-grpc, opentelemetry-plugin-http, opentelemetry-plugin-https, opentelemetry-tracing, opentelemetry-web
opentelemetry-exporter-collector-grpc, opentelemetry-exporter-collector-proto
opentelemetry-api, opentelemetry-core, opentelemetry-instrumentation-http, opentelemetry-node, opentelemetry-plugin-fetch, opentelemetry-plugin-http, opentelemetry-plugin-https, opentelemetry-propagator-b3, opentelemetry-shim-opentracing, opentelemetry-tracing
opentelemetry-instrumentation-http, opentelemetry-plugin-http, opentelemetry-plugin-https
opentelemetry-web
opentelemetry-instrumentation-fetch
opentelemetry-exporter-zipkin
opentelemetry-api-metrics, opentelemetry-api, opentelemetry-exporter-collector-grpc, opentelemetry-exporter-collector-proto, opentelemetry-exporter-collector, opentelemetry-exporter-prometheus, opentelemetry-instrumentation, opentelemetry-metrics, opentelemetry-sdk-node
opentelemetry-exporter-collector
opentelemetry-api
opentelemetry-instrumentation
opentelemetry-instrumentation, opentelemetry-node
opentelemetry-instrumentation-grpc, opentelemetry-instrumentation
opentelemetry-core, opentelemetry-tracing
opentelemetry-instrumentation-http
opentelemetry-core, opentelemetry-exporter-collector-proto, opentelemetry-exporter-collector, opentelemetry-exporter-jaeger, opentelemetry-exporter-prometheus, opentelemetry-exporter-zipkin, opentelemetry-grpc-utils, opentelemetry-instrumentation-http, opentelemetry-metrics, opentelemetry-node, opentelemetry-plugin-http, opentelemetry-plugin-https, opentelemetry-resource-detector-aws, opentelemetry-resource-detector-gcp, opentelemetry-resources, opentelemetry-shim-opentracing, opentelemetry-tracing, opentelemetry-web
opentelemetry-core
opentelemetry-exporter-collector-grpc, opentelemetry-exporter-collector-proto
FAQs
OpenTelemetry Node SDK provides automatic telemetry (tracing, metrics, etc) for Node.js applications
The npm package @opentelemetry/node receives a total of 24,450 weekly downloads. As such, @opentelemetry/node popularity was classified as popular.
We found that @opentelemetry/node demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 4 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.
Security News
The Ultralytics' PyPI Package was compromised four times in one weekend through GitHub Actions cache poisoning and failure to rotate previously compromised API tokens.
Security News
Research
Socket researchers found a malicious Maven package impersonating the legitimate ‘XZ for Java’ library, introducing a backdoor for remote code execution.