Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

@opentelemetry/plugin-https

0.9.0 • Public • Published

OpenTelemetry HTTPS Instrumentation for Node.js

Gitter chat NPM Published Version dependencies devDependencies Apache License

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 { NodeTracerProvider } = require('@opentelemetry/node');
 
const provider = new NodeTracerProvider({
  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 of 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 { NodeTracerProvider } = require('@opentelemetry/node');
 
const provider = new NodeTracerProvider();

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

License

Apache 2.0 - See LICENSE for more information.

Install

npm i @opentelemetry/plugin-https

DownloadsWeekly Downloads

6,651

Version

0.9.0

License

Apache-2.0

Unpacked Size

25.5 kB

Total Files

11

Last publish

Collaborators

  • avatar
  • avatar
  • avatar
  • avatar