OpenTelemetry Connect Instrumentation for Node.js
![Apache License](https://img.shields.io/badge/license-Apache_2.0-green.svg?style=flat)
This module provides automatic instrumentation for the connect
module, which may be loaded using the @opentelemetry/sdk-trace-node
package and is included in the @opentelemetry/auto-instrumentations-node
bundle.
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+
.
Status
Installation
This instrumentation relies on HTTP calls to also be instrumented. Make sure you install and enable both, otherwise you will have spans that are not connected to each other.
npm install --save @opentelemetry/instrumentation-http @opentelemetry/instrumentation-connect
Supported Versions
Usage
OpenTelemetry Connect 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 the instrumentation, specify it in the Node Tracer's configuration:
const { NodeTracerProvider } = require('@opentelemetry/sdk-trace-node');
const { registerInstrumentations } = require('@opentelemetry/instrumentation');
const { HttpInstrumentation } = require('@opentelemetry/instrumentation-http');
const { ConnectInstrumentation } = require('@opentelemetry/instrumentation-connnect');
const provider = new NodeTracerProvider();
provider.register();
registerInstrumentations({
instrumentations: [
new HttpInstrumentation(),
new ConnectInstrumentation(),
],
});
See examples/connect for a short example.
Semantic Conventions
This package uses @opentelemetry/semantic-conventions
version 1.22+
, which implements Semantic Convention Version 1.7.0
Attributes collected:
Attribute | Short Description |
---|
http.route | The matched route (path template). |
Useful links
License
Apache 2.0 - See LICENSE for more information.