@opentelemetry/instrumentation-router

OpenTelemetry Router Instrumentation for Node.js

This module provides automatic instrumentation for the router module. It allows the user to automatically collect trace data and export them to their backend of choice.

If total installation size is not constrained, it is recommended to use the @opentelemetry/auto-instrumentations-node bundle with @opentelemetry/sdk-node for the most seamless instrumentation experience.

Compatible with OpenTelemetry JS API and SDK 1.0+.

Installation

npm install --save @opentelemetry/instrumentation-router

Supported Versions

• router versions >=1.0.0 <2

Usage

const { NodeSDK } = require('@opentelemetry/sdk-node');
const { RouterInstrumentation } = require('@opentelemetry/instrumentation-router');

const sdk = new NodeSDK({
  instrumentations: [
    new RouterInstrumentation(),
  ],
});
sdk.start();
process.once('beforeExit', async () => { await sdk.shutdown(); });

Semantic Conventions

This package uses @opentelemetry/semantic-conventions version 1.22+, which implements Semantic Convention Version 1.7.0

Attributes collected:

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 in GitHub Discussions

License

Apache 2.0 - See LICENSE for more information.