This module provides automatic instrumentation for the socket.io
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+
.
npm install --save @opentelemetry/instrumentation-socket.io
>=2.0.0 <5
To load a specific plugin, specify it in the registerInstrumentations's configuration:
const { NodeTracerProvider } = require("@opentelemetry/sdk-trace-node"); const { SocketIoInstrumentation, } = require("@opentelemetry/instrumentation-socket.io"); const { registerInstrumentations } = require("@opentelemetry/instrumentation"); const provider = new NodeTracerProvider(); provider.register(); registerInstrumentations({ instrumentations: [new SocketIoInstrumentation()], });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)
If you do not want to trace the socket.io http requests, add the default socket.io route (/socket.io/
) to the HttpInstrumentationConfig.ignoreIncomingPaths
array
This package uses @opentelemetry/semantic-conventions
version 1.22+
, which implements Semantic Convention Version 1.7.0
Attributes collected:
Attribute Short Descriptionmessaging.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.
Apache 2.0 - See LICENSE for more information.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4