dd-trace
    Preparing search index...

    Interface bullmq

    This plugin automatically instruments the bullmq message queue library.

    interface bullmq {
        enabled?: boolean;
        measured?: boolean | { [key: string]: boolean };
        producerFilter?: (
            job: {
                data?: unknown;
                name?: string;
                opts?: unknown;
                queueName?: string;
            },
        ) => boolean;
        service?: any;
    }
    Index

    Properties

    enabled? measured? producerFilter? service?

    Properties

    enabled?: boolean

    Whether to enable the plugin.

    true
    measured?: boolean | { [key: string]: boolean }

    Whether to measure the span. Can also be set to a key-value pair with span names as keys and booleans as values for more granular control.

    producerFilter?: (
        job: {
            data?: unknown;
            name?: string;
            opts?: unknown;
            queueName?: string;
        },
    ) => boolean

    Filter applied to BullMQ producer operations (Queue.add, Queue.addBulk, FlowProducer.add). Return false to skip span creation, trace context injection, and DSM checkpoint handling for the matching job. Consumer-side (Worker) instrumentation is unaffected.

    Type Declaration

      • (
            job: {
                data?: unknown;
                name?: string;
                opts?: unknown;
                queueName?: string;
            },
        ): boolean

      • Parameters

        • job: { data?: unknown; name?: string; opts?: unknown; queueName?: string }
          • Optionaldata?: unknown

            The BullMQ job data.

          • Optionalname?: string

            The BullMQ job name.

          • Optionalopts?: unknown

            The BullMQ job options.

          • OptionalqueueName?: string

            The name of the queue the job is being added to.

        Returns boolean

        true to instrument the producer operation, false to skip it.

    service?: any

    The service name to be used for this plugin.

    Settings

    Member Visibility

    On This Page

    Properties