@opentelemetry/plugin-ioredis

OpenTelemetry ioredis Instrumentation for Node.js

This module provides automatic instrumentation for ioredis.

For automatic instrumentation see the @opentelemetry/node package.

Installation

npm install --save @opentelemetry/plugin-ioredis

Supported Versions

• >=2.0.0

Usage

To load a specific plugin (ioredis in this case), specify it in the registerInstrumentations's configuration

const { NodeTracerProvider } = require('@opentelemetry/node');
const { registerInstrumentations } = require('@opentelemetry/instrumentation');

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

registerInstrumentations({
  instrumentations: [
    {
      plugins: {
        ioredis: {
          enabled: true,
          // You may use a package name or absolute path to the file.
          path: '@opentelemetry/plugin-ioredis',
        }
      }
    },
  ],
  tracerProvider: provider,
});

To load all of the supported plugins, use below approach. Each plugin is only loaded when the module that it patches is loaded; in other words, there is no computational overhead for listing plugins for unused modules.

const { NodeTracerProvider } = require('@opentelemetry/node');
const { registerInstrumentations } = require('@opentelemetry/instrumentation');

const provider = new NodeTracerProvider();
provider.register();
registerInstrumentations({
  tracerProvider: provider,
});

IORedis Plugin Options

IORedis plugin has few options available to choose from. You can set the following:

Options	Type	Description
dbStatementSerializer	DbStatementSerializer	IORedis plugin will serialize db.statement using the specified function.

#### Custom db.statement Serializer The plugin serializes the whole command into a Span attribute called db.statement. The standard serialization format is {cmdName} {cmdArgs.join(',')}. It is also possible to define a custom serialization function. The function will receive the command name and arguments and must return a string.

Here is a simple example to serialize the command name skipping arguments:

const { NodeTracerProvider } = require('@opentelemetry/node');

const provider = new NodeTracerProvider({
  plugins: {
    ioredis: {
      enabled: true,
      // You may use a package name or absolute path to the file.
      path: '@opentelemetry/plugin-ioredis',
      dbStatementSerializer: function (cmdName, cmdArgs) {
        return cmdName;
      }
    }
  }
});

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

License

Apache 2.0 - See LICENSE for more information.

Changelog

0.15.0

:rocket: Enhancement

• Other
  • #366 Add automated release workflows (@willarmiros)
• auto-instrumentation-web
  • #391 chore: adding meta package for web (@obecny)
• auto-instrumentation-node
  • #379 chore: creating meta package for default auto instrumentations for node (@obecny)
• opentelemetry-instrumentation-hapi
  • #380 Moving Hapi Plugin to Instrumentation (@obecny)
• opentelemetry-instrumentation-koa
  • #327 feat: enable root span to contain route (@DinaYakovlev)
• opentelemetry-instrumentation-mysql
  • #393 feat: mysql instrumentation (@dyladan)
• opentelemetry-instrumentation-net
  • #389 feat: net module instrumentation (@seemk)
• opentelemetry-host-metrics
  • #395 chore: fixing broken links, updating to correct base url, replacing gitter with github discussions (@obecny)

:house: Internal

• opentelemetry-host-metrics, opentelemetry-test-utils
  • #408 chore: bump otel dependencies to latest patch (@dyladan)
• Other
  • #392 chore: fixing broken links (@obecny)

:memo: Documentation

• opentelemetry-host-metrics
  • #373 Update README.md (@z1c0)

Committers: 9

• Bartlomiej Obecny (@obecny)
• Daniel Dyla (@dyladan)
• Dina.Yakovlev (@DinaYakovlev)
• Gerhard Stöbich (@Flarna)
• Jakub Malinowski (@jtmalinowski)
• Siim Kallas (@seemk)
• Valentin Marchaud (@vmarchaud)
• William Armiros (@willarmiros)
• Wolfgang Ziegler (@z1c0)