@opentelemetry/node

OpenTelemetry Node

This module provides automated instrumentation and tracing for Node.js applications.

For manual instrumentation see the @opentelemetry/tracing package.

How does automated instrumentation work?

This package exposes a NodeTracer that will automatically hook into the module loader of Node.js.

For this to work, please make sure that NodeTracer 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 NodeTracer 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

• extract a trace-context identifier from inbound requests to allow distributed tracing (if applicable)
• make sure that this current trace-context is propagated while the transaction traverses an application (see @opentelemetry/opentelemetry-scope-base for an in-depth explanation)
• add this trace-context identifier to outbound requests to allow continuing the distributed trace on the next hop (if applicable)
• create and end spans

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.

Creating custom spans on top of auto-instrumentation

Additionally to automated instrumentation, NodeTracer exposes the same API as @opentelemetry/tracing, allowing creating custom spans if needed.

Installation

npm install --save @opentelemetry/core
npm install --save @opentelemetry/node

# Install instrumentation plugins
npm install --save @opentelemetry/plugin-http
npm install --save @opentelemetry/plugin-grpc
npm install --save @opentelemetry/plugin-https

Usage

The following code will configure the NodeTracer to instrument http using @opentelemetry/plugin-http.

const opentelemetry = require('@opentelemetry/core');
const { NodeTracer } = require('@opentelemetry/node');

// Create and configure NodeTracer
const tracer = new NodeTracer({
  plugins: {
    http: {
      enabled: true,
      // You may use a package name or absolute path to the file.
      path: '@opentelemetry/plugin-http',
      // http plugin options
    }
  }
});

// Initialize the tracer
opentelemetry.initGlobalTracer(tracer);

// Your application code - http will automatically be instrumented if
// @opentelemetry/plugin-http is present
const http = require('http');

To enable instrumentation for all supported modules, create an instance of NodeTracer without providing any plugin configuration to the constructor.

const opentelemetry = require('@opentelemetry/core');
const { NodeTracer } = require('@opentelemetry/node');

// Create and initialize NodeTracer
const tracer = new NodeTracer();

// Initialize the tracer
opentelemetry.initGlobalTracer(tracer);

// Your application code
// ...

Examples

See how to automatically instrument http and gRPC using node-sdk.

Useful links

• For more information on OpenTelemetry, visit: https://opentelemetry.io/
• For more about OpenTelemetry JavaScript: https://github.com/open-telemetry/opentelemetry-js
• For help or feedback on this project, join us on gitter

License

Apache 2.0 - See LICENSE for more information.

Changelog

0.2.0

Released 2019-11-04

:rocket: (Enhancement)

• opentelemetry-shim-opentracing, opentelemetry-tracing, opentelemetry-types
  • #449 fix: allow recording links only at Span creation time
• opentelemetry-core, opentelemetry-node, opentelemetry-tracing, opentelemetry-types
  • #454 fix(span): rename span recording flag
• opentelemetry-metrics
  • #475 add shutdown method on MetricExporter interface
• opentelemetry-plugin-document-load
  • #469 chore: fixing problem with load event and performance for loadend
• opentelemetry-core, opentelemetry-plugin-document-load, opentelemetry-tracing, opentelemetry-web
  • #466 chore: fixing coverage for karma using istanbul

:bug: (Bug Fix)

• opentelemetry-tracing
  • #444 fix: batchSpanProcessor test failing intermittently
• opentelemetry-core
  • #472 fix(core): add missing semver dependency

:books: (Refine Doc)

• #462 chore: update README
• #460 chore: move members list out of community repo
• #445 chore: update CONTRIBUTING.md
• #459 chore: update API docs

:sparkles: (Feature)

• opentelemetry-metrics, opentelemetry-types
  • #437 feat(metrics): add registerMetric and getMetrics
• opentelemetry-metrics
  • #468 feat: validate metric names
• opentelemetry-plugin-postgres
  • #417 feature(plugin): implement postgres plugin
• opentelemetry-core, opentelemetry-types
  • #451 feat: add IsRemote field to SpanContext, set by propagators
• opentelemetry-core, opentelemetry-plugin-document-load, opentelemetry-tracing, opentelemetry-types, opentelemetry-web
  • #433 feat(plugin-document-load): new plugin for document load for web tracer