@opentelemetry/instrumentation-socket.io

OpenTelemetry socket.io Instrumentation for Node.js

This module provides automatic instrumentation for the socket.io module.

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-socket.io

Supported Versions

• socket.io versions >=2.0.0 <5

Usage

To enable a specific instrumentation, pass it to registerInstrumentations(). This is commonly done via NodeSDK for fully setting up all OpenTelemetry SDK components:

const { NodeSDK } = require('@opentelemetry/sdk-node');
const { SocketIoInstrumentation } = require("@opentelemetry/instrumentation-socket.io");

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

Optional Parameters

Option	Type	Default	Description
emitHook	SocketIoHookFunction	undefined	hook for adding custom attributes before socket.io emits the event
emitIgnoreEventList	string[]	[]	names of emitted events to ignore tracing for
onHook	SocketIoHookFunction	undefined	hook for adding custom attributes before the event listener (callback) is invoked
onIgnoreEventList	string[]	[]	names of listened events to ignore tracing for
traceReserved	boolean	false	set to true if you want to trace socket.io reserved events (see docs)

Filter Http Transport

If you do not want to trace the socket.io HTTP polling requests, use the ignoreIncomingRequestHook option from @opentelemetry/instrumentation-http to filter out requests on the default socket.io route:

const { HttpInstrumentation } = require("@opentelemetry/instrumentation-http");
const {
  SocketIoInstrumentation,
} = require("@opentelemetry/instrumentation-socket.io");
const { registerInstrumentations } = require("@opentelemetry/instrumentation");

registerInstrumentations({
  instrumentations: [
    new HttpInstrumentation({
      ignoreIncomingRequestHook(req) {
        // Ignore socket.io HTTP polling transport requests
        return !!req.url?.startsWith("/socket.io/");
      },
    }),
    new SocketIoInstrumentation(),
  ],
});

Semantic Conventions

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

Attributes collected:

Attribute	Short Description
messaging.destination	The message destination name. This might be equal to the span name but is required nevertheless.
messaging.destination_kind	The kind of message destination.
messaging.operation	A string identifying the kind of message consumption.
messaging.system	A string identifying the messaging system.

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.