@opentelemetry/instrumentation-connect

OpenTelemetry connect automatic instrumentation package.

Usage no npm install needed!

<script type="module">
  import opentelemetryInstrumentationConnect from 'https://cdn.skypack.dev/@opentelemetry/instrumentation-connect';
</script>

README

OpenTelemetry Connect Instrumentation for Node.js

NPM Published Version dependencies devDependencies Apache License

This module provides automatic instrumentation for connect.

For automatic instrumentation see the @opentelemetry/sdk-trace-node package.

Compatible with OpenTelemetry JS API and SDK 1.0+.

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

  • ^3.0.0

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: [
    // Connect instrumentation expects HTTP layer to be instrumented
    new HttpInstrumentation(),
    new ConnectInstrumentation(),
  ],
});

See examples/connect for a short example.

Useful links

License

Apache 2.0 - See LICENSE for more information.