@jenniferplusplus/opentelemetry-instrumentation-bullmq
TypeScript icon, indicating that this package has built-in type declarations

0.5.0 • Public • Published

OpenTelemetry Bullmq Instrumentation for Node.js

Node.js CI npm version

This module provides automatic tracing instrumentation for BullMQ.

Compatible with OpenTelemetry JS API and SDK 1.0+.

Installation

npm install --save @jenniferplusplus/opentelemetry-instrumentation-bullmq

Supported Versions

  • [1.90.1, 2.x, 3.x, 4.x, 5.x]

It's likely that the instrumentation would support earlier versions of BullMQ, but I haven't tested it.

Usage

OpenTelemetry Bullmq Instrumentation allows the user to automatically collect trace data from Bullmq jobs and workers and export them to the backend of choice.

To load the instrumentation, specify it in the instrumentations list to registerInstrumentations. There is currently no configuration option.

const { NodeTracerProvider } = require('@opentelemetry/sdk-trace-node');
const { registerInstrumentations } = require('@opentelemetry/instrumentation');
const { BullMQInstrumentation } = require('@jenniferplusplus/opentelemetry-instrumentation-bullmq');

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

registerInstrumentations({
  instrumentations: [
    new BullMQInstrumentation(),
  ],
});

Emitted Spans

Name BullMQ method Description
{QueueName.JobName} Queue.add Queue.add A new job is added to the queue
{QueueName} Queue.addBulk Queue.addBulk New jobs are added to the queue in bulk
{QueueName.FlowName} FlowProducer.add FlowProducer.add A new job flow is added to a queue
FlowProducer.addBulk FlowProducer.addBulk New job flows are added to queues in bulk
{QueueName.JobName} Job.addJob Job.addJob Each individual job added to a queue
{WorkerName} Worker.run Worker.run While a worker is accepting jobs
{QueueName.JobName} Worker.{WorkerName} #{attempt} Worker.callProcessJob Each job execution by a worker's processor function

Useful links

License

Apache 2.0 - See LICENSE for more information.

Contributing

Contributions are welcome. Feel free to open an issue or submit a PR. I would like to have this package included in opentelemetry-js-contrib at some point. Until then, it lives here.

BullMQ has a hard dependency on Redis, which means that Redis is (for now) a test dependency for the instrumentations. To run the tests, you should have a redis server running on localhost at the default port. If you have docker installed, you can just do docker-compose up and be ready to go.

Package Sidebar

Install

npm i @jenniferplusplus/opentelemetry-instrumentation-bullmq

Weekly Downloads

9,732

Version

0.5.0

License

Apache-2.0

Unpacked Size

46.3 kB

Total Files

18

Last publish

Collaborators

  • jenniferplusplus