@opentelemetry/plugin-redis

OpenTelemetry redis Instrumentation for Node.js

This module provides automatic instrumentation for redis@^2.6.0.

For automatic instrumentation see the @opentelemetry/node package.

Installation

npm install --save @opentelemetry/plugin-redis

Supported Versions

• >=2.6.0

Usage

OpenTelemetry Redis 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 redis.

To load a specific plugin (redis 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: {
        redis: {
          enabled: true,
          // You may use a package name or absolute path to the file.
          path: '@opentelemetry/plugin-redis',
        }
      },
    },
  ],
  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,
});

See examples/redis for a short example.

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)