dd-trace
    Preparing search index...

    Interface redis

    This plugin automatically instruments the redis module.

    interface redis {
        allowlist?:
            | string
            | RegExp
            | ((command: string) => boolean)
            | (string | RegExp | ((command: string) => boolean))[];
        blocklist?:
            | string
            | RegExp
            | ((command: string) => boolean)
            | (string | RegExp | ((command: string) => boolean))[];
        enabled?: boolean;
        filter?: (command: string) => boolean;
        measured?: boolean | { [key: string]: boolean };
        service?: any;
    }
    Index

    Properties

    allowlist? blocklist? enabled? filter? measured? service?

    Properties

    allowlist?:
        | string
        | RegExp
        | ((command: string) => boolean)
        | (string | RegExp | ((command: string) => boolean))[]

    List of commands that should be instrumented.

    /^.*$/
    blocklist?:
        | string
        | RegExp
        | ((command: string) => boolean)
        | (string | RegExp | ((command: string) => boolean))[]

    List of commands that should not be instrumented. Takes precedence over allowlist if a command matches an entry in both.

    []
    enabled?: boolean

    Whether to enable the plugin.

    true
    filter?: (command: string) => boolean

    Custom filter function used to decide whether a Redis command should be instrumented. When provided, this takes precedence over allowlist/blocklist configuration. If not provided, allowlist/blocklist logic will be used instead.

    Type Declaration

      • (command: string): boolean

      • Parameters

        • command: string

          The Redis command name to filter

        Returns boolean

        true to instrument the command, false to skip it

    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.

    service?: any

    The service name to be used for this plugin.

    Settings

    Member Visibility

    On This Page

    Properties