OpenTelemetry Amqplib (RabbitMQ) Instrumentation for Node.js

This module provides automatic instrumentation for the amqplib (RabbitMQ) 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-amqplib

Supported Versions

amqplib versions >=0.5.5 <1

Usage

OpenTelemetry amqplib Instrumentation allows the user to automatically collect trace data and export them to the backend of choice, to give observability to distributed systems when working with amqplib (RabbitMQ).

To load a specific plugin, specify it in the registerInstrumentations's configuration:

const { NodeTracerProvider } = require('@opentelemetry/sdk-trace-node');
const { AmqplibInstrumentation } = require('@opentelemetry/instrumentation-amqplib');
const { registerInstrumentations } = require('@opentelemetry/instrumentation');

const provider = new NodeTracerProvider();
provider.register();

registerInstrumentations({
  instrumentations: [
    new AmqplibInstrumentation({
      // publishHook: (span: Span, publishInfo: PublishInfo) => { },
      // publishConfirmHook: (span: Span, publishConfirmedInto: PublishConfirmedInfo) => { },
      // consumeHook: (span: Span, consumeInfo: ConsumeInfo) => { },
      // consumeEndHook: (span: Span, consumeEndInfo: ConsumeEndInfo) => { },
      // useLinksForConsume: boolean,
    }),
  ],
})

amqplib Instrumentation Options

amqplib instrumentation has few options available to choose from. You can set the following:

Options	Type	Description
`publishHook`	`AmqplibPublishCustomAttributeFunction`	hook for adding custom attributes before publish message is sent.
`publishConfirmHook`	`AmqplibPublishConfirmCustomAttributeFunction`	hook for adding custom attributes after publish message is confirmed by the broker.
`consumeHook`	`AmqplibConsumeCustomAttributeFunction`	hook for adding custom attributes before consumer message is processed.
`consumeEndHook`	`AmqplibConsumeEndCustomAttributeFunction`	hook for adding custom attributes after consumer message is acked to server.
`consumeTimeoutMs`	`number`	read Consume Timeout below
`useLinksForConsume`	`boolean`	read Links for Consume below

Consume Timeout

When user is setting up consume callback, it is user's responsibility to call ack/nack etc on the msg to resolve it in the server. If user is not calling the ack, the message will stay in the queue until channel is closed, or until server timeout expires (if configured).

While we wait for the ack, a reference to the message is stored in plugin, which will never be garbage collected. To prevent memory leak, plugin has it's own configuration of timeout, which will close the span if user did not call ack after this timeout.

If timeout is not big enough, span might be closed with 'InstrumentationTimeout', and then received valid ack from the user later which will not be instrumented.

Default is 1 minute

Links for Consume

By default, consume spans continue the trace where a message was produced. However, per the spec, consume spans should be linked to the message's creation context. Setting to true, this will enable the behavior to follow the spec.

Default is false

Running Tests Locally

To run the tests locally, you need to have a RabbitMQ server running. You can use the following command to start a RabbitMQ server using Docker:

npm run test:docker:run

By default, the tests that connect to RabbitMQ are skipped. To make sure these tests are run, you can set the RUN_RABBIT_TESTS environment variable to true

Semantic Conventions

This instrumentation implements Semantic Conventions (semconv) v1.7.0. Since then, many networking-related semantic conventions (in semconv v1.21.0 and v1.23.1) were stabilized. As of @opentelemetry/instrumentation-amqplib@0.56.0 support has been added for migrating to the stable semantic conventions using the OTEL_SEMCONV_STABILITY_OPT_IN environment variable as follows:

Upgrade to the latest version of this instrumentation package.
Set OTEL_SEMCONV_STABILITY_OPT_IN=http/dup to emit both old and stable semantic conventions. (The http token is used to control the net.* attributes.)
Modify alerts, dashboards, metrics, and other processes in your Observability system to use the stable semantic conventions.
Set OTEL_SEMCONV_STABILITY_OPT_IN=http to emit only the stable semantic conventions.

By default, if OTEL_SEMCONV_STABILITY_OPT_IN is not set or does not include http, then the old v1.7.0 semconv is used. The intent is to provide an approximate 6 month time window for users of this instrumentation to migrate to the new networking semconv, after which a new minor version will use the new semconv by default and drop support for the old semconv. See the HTTP migration guide and deprecated network attributes for details.

Attributes collected:

Attribute	Short Description
`messaging.destination`	The message destination name.
`messaging.destination_kind`	The kind of message destination.
`messaging.rabbitmq.routing_key`	RabbitMQ message routing key.
`messaging.operation`	A string identifying the kind of message consumption.
`messaging.message_id`	A value used by the messaging system as an identifier for the message.
`messaging.conversation_id`	The ID identifying the conversation to which the message belongs.
`messaging.protocol`	The name of the transport protocol.
`messaging.protocol_version`	The version of the transport protocol.
`messaging.system`	A string identifying the messaging system.
`messaging.url`	The connection string.

Old semconv	Stable semconv	Description
`net.peer.name`	`server.address`	Remote hostname
`net.peer.port`	`server.port`	Remote port number

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