Package Exports

@opentelemetry/instrumentation-redis
@opentelemetry/instrumentation-redis/build/src/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@opentelemetry/instrumentation-redis) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

OpenTelemetry redis Instrumentation for Node.js

This module provides automatic instrumentation for redis@^2.6.0.

For automatic instrumentation see the @opentelemetry/sdk-trace-node package.

Compatible with OpenTelemetry JS API and SDK 1.0+.

Installation

npm install --save @opentelemetry/instrumentation-redis

Supported Versions

This package supports redis@^2.6.0 and redis@^3.0.0 For version redis@^4.0.0, please use @opentelemetry/instrumentation-redis-4

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 instrumentation (redis in this case), specify it in the registerInstrumentations' configuration

const { NodeTracerProvider } = require('@opentelemetry/sdk-trace-node');
const { RedisInstrumentation } = require('@opentelemetry/instrumentation-redis');
const { registerInstrumentations } = require('@opentelemetry/instrumentation');

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

registerInstrumentations({
  instrumentations: [
    new RedisInstrumentation(),
  ],
})

See examples/redis for a short example.

Redis Instrumentation Options

Redis instrumentation has a few options available to choose from. You can set the following:

Options	Type	Description
`dbStatementSerializer`	`DbStatementSerializer` (function)	Redis instrumentation will serialize the command to the `db.statement` attribute using the specified function.
`responseHook`	`RedisResponseCustomAttributeFunction` (function)	Function for adding custom attributes on db response. Receives params: `span, moduleVersion, cmdName, cmdArgs`
`requireParentSpan`	`boolean`	Require parent to create redis span, default when unset is false.

Custom `db.statement` Serializer

The instrumentation serializes the command into a Span attribute called db.statement. The default serialization sets the attribute to the command name, without the command arguments.

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 and arguments:

const { RedisInstrumentation } = require('@opentelemetry/instrumentation-redis');

const redisInstrumentation = new RedisInstrumentation({
  dbStatementSerializer: function (cmdName, cmdArgs) {
    return [cmdName, ...cmdArgs].join(" ");
  },
});

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.

@opentelemetry/instrumentation-redis