@opentelemetry/instrumentation-redis-4
TypeScript icon, indicating that this package has built-in type declarations

0.41.0 • Public • Published

OpenTelemetry redis Instrumentation for Node.js

NPM Published Version Apache License

This module provides automatic instrumentation for the redis@^4.0.0 module, which may be loaded using the @opentelemetry/sdk-trace-node package and is included in the @opentelemetry/auto-instrumentations-node bundle.

If total installation size is not constrained, it is recommended to use the @opentelemetry/auto-instrumentations-node bundle with @opentelemetry/sdk-node for the most seamless instrumentation experience.

Compatible with OpenTelemetry JS API and SDK 1.0+.

Installation

npm install --save @opentelemetry/instrumentation-redis-4

Supported Versions

For versions redis@^2.6.0 and redis@^3.0.0, please use @opentelemetry/instrumentation-redis

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-4');
const { registerInstrumentations } = require('@opentelemetry/instrumentation');

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

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

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, cmdName, cmdArgs, response
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 standard serialization format attempts to be as informative as possible while avoiding the export of potentially sensitive data. The number of serialized arguments depends on the specific command, see the configuration list in @opentelemetry/redis-common.

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 all command arguments. Notice that it might capture sensitive data and big payloads:

const { RedisInstrumentation } = require('@opentelemetry/instrumentation-redis');
const redisInstrumentation = new RedisInstrumentation({
  dbStatementSerializer: function (cmdName, cmdArgs) {
    return [cmdName, ...cmdArgs].join(" ");
  },
});

Semantic Conventions

This package uses @opentelemetry/semantic-conventions version 1.22+, which implements Semantic Convention Version 1.7.0

Attributes collected:

Attribute Short Description
db.connection_string The connection string used to connect to the database (without credentials).
db.statement The database statement being executed.
db.system An identifier for the database management system (DBMS) product being used.
net.peer.name Remote hostname or similar, see note below.
net.peer.port Remote port number.

Useful links

License

Apache 2.0 - See LICENSE for more information.

Package Sidebar

Install

npm i @opentelemetry/instrumentation-redis-4

Weekly Downloads

1,232,857

Version

0.41.0

License

Apache-2.0

Unpacked Size

82.3 kB

Total Files

21

Last publish

Collaborators

  • pichlermarc
  • bogdandrutu
  • dyladan