Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@opentelemetry/instrumentation-socket.io

Package Overview
Dependencies
Maintainers
3
Versions
22
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@opentelemetry/instrumentation-socket.io

OpenTelemetry instrumentation for `socket.io` messaging server implementation for Socket.IO communication

  • 0.45.0
  • unpublished
  • latest
  • Source
  • npm
  • Socket score

Version published
Maintainers
3
Created
Source

OpenTelemetry socket.io Instrumentation for Node.js

NPM Published Version Apache License

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

Installation

npm install --save @opentelemetry/instrumentation-socket.io

Supported Versions

  • socket.io versions >=2.0.0 <5

Usage

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()],
});

Optional Parameters

OptionTypeDefaultDescription
emitHookSocketIoHookFunctionundefinedhook for adding custom attributes before socket.io emits the event
emitIgnoreEventListstring[][]names of emitted events to ignore tracing for
onHookSocketIoHookFunctionundefinedhook for adding custom attributes before the event listener (callback) is invoked
onIgnoreEventListstring[][]names of listened events to ignore tracing for
traceReservedbooleanfalseset 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 requests, add the default socket.io route (/socket.io/) to the HttpInstrumentationConfig.ignoreIncomingPaths array

Semantic Conventions

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

Attributes collected:

AttributeShort Description
messaging.destinationThe message destination name. This might be equal to the span name but is required nevertheless.
messaging.destination_kindThe kind of message destination.
messaging.operationA string identifying the kind of message consumption.
messaging.systemA string identifying the messaging system.

License

Apache 2.0 - See LICENSE for more information.

Keywords

FAQs

Package last updated on 05 Dec 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc