@opentelemetry/instrumentation-connect

OpenTelemetry Connect Instrumentation for Node.js

This module provides automatic instrumentation for connect.

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

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

• 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.

Changelog

0.25.0

:bug: Bug Fix

• #619 fix: GraphQL throws TypeError: Cannot read property 'startToken' of undefined (@obecny)
• #643 fix(user-interaction): event listeners have wrong this when listening for bubbled events (@t2t2)
• #562 fix(mysql): bind get connection callback to active context (@sstone1)
• #589 fix(hapi-instrumentation): close spans on errors in instrumented functions (@CptSchnitz)
• #580 fix: redis instrumentation loses context when using callbacks (@aspectom)

:rocket: Enhancement

• Other
  • #626 feat(mongodb): add db statement serializer config (@nozik)
  • #622 docs: add missing fetch instrumentation (@meteorlxy)
  • #553 feat: Add NestJS instrumentation (@Rauno56)
  • #588 chore: adding instrumentation for connect (@obecny)
• opentelemetry-test-utils
  • #593 feat: move aws/gcp detectors from opentelemetry-js repo (@legendecas)

:house: Internal

• opentelemetry-test-utils
  • #641 chore(mysql2): adding TAV script (@YanivD)
  • #639 build(test-utils): marking test-utils as non private so it can be published (@blumamir)
  • #596 docs(test-utils): add README.md for @opentelemetry/test-utils (@Rauno56)
• Other
  • #648 ci: speed up lint workflow with hoisting (@YanivD)
  • #614 ci: speed up PR unit-test run time (@blumamir)
  • #612 chore: ignore renovate-bot for component owners (@dyladan)
  • #597 chore: add script to update core dependencies (@dyladan)
  • #606 chore: add ownership for aws propagator (@dyladan)
  • #601 chore: configure renovate to bump API (@Flarna)

:memo: Documentation

• opentelemetry-browser-extension-autoinjection
  • #615 docs: correct the build instructions (@jessitron)

Committers: 16

• Amir Blum (@blumamir)
• Bartlomiej Obecny (@obecny)
• Daniel Dyla (@dyladan)
• Gerhard Stöbich (@Flarna)
• Herman (@hermanbanken)
• Jessica Kerr (@jessitron)
• Ofer Adelstein (@CptSchnitz)
• Ran Nozik (@nozik)
• Rauno Viskus (@Rauno56)
• Simon Stone (@sstone1)
• Tom Zach (@aspectom)
• William Armiros (@willarmiros)
• Yaniv Davidi (@YanivD)
• legendecas (@legendecas)
• meteorlxy (@meteorlxy)
• t2t2 (@t2t2)