opentelemetry-js/packages/opentelemetry-plugin-https

OpenTelemetry HTTPS Instrumentation for Node.js

This module provides automatic instrumentation for https.

For automatic instrumentation see the @opentelemetry/node package.

Installation

npm install --save @opentelemetry/plugin-https

Usage

OpenTelemetry HTTPS Instrumentation allows the user to automatically collect trace data and export them to their backend of choice, to give observability to distributed systems.

To load a specific plugin (HTTPS in this case), specify it in the Node Tracer's configuration.

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

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

To load all the supported plugins, use below approach. Each plugin is only loaded when the module that it patches is loaded; in other words, there is no computational overhead for listing plugins for unused modules.

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

const tracer = new NodeTracer();

See examples/https for a short example.

Https Plugin Options

Https plugin has few options available to choose from. You can set the following:

Options	Type	Description
applyCustomAttributesOnSpan	HttpCustomAttributeFunction	Function for adding custom attributes
ignoreIncomingPaths	IgnoreMatcher[]	Http plugin will not trace all incoming requests that match paths
ignoreOutgoingUrls	IgnoreMatcher[]	Http plugin will not trace all outgoing requests that match urls

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.