Security News
Research
Supply Chain Attack on Rspack npm Packages Injects Cryptojacking Malware
A supply chain attack on Rspack's npm packages injected cryptomining malware, potentially impacting thousands of developers.
@opentelemetry/instrumentation-redis-4
Advanced tools
OpenTelemetry instrumentation for `redis` v4 database client for Redis
@opentelemetry/instrumentation-redis-4 is an OpenTelemetry instrumentation package for Redis version 4.x. It allows you to automatically collect and report telemetry data from your Redis operations, which can be used for monitoring, tracing, and performance analysis.
Automatic Tracing
This feature allows you to automatically trace Redis operations. The code sample demonstrates how to set up the OpenTelemetry NodeTracerProvider and register the Redis instrumentation. Once set up, Redis operations like `set` and `get` will be automatically traced.
const { NodeTracerProvider } = require('@opentelemetry/sdk-trace-node');
const { registerInstrumentations } = require('@opentelemetry/instrumentation');
const { RedisInstrumentation } = require('@opentelemetry/instrumentation-redis-4');
const provider = new NodeTracerProvider();
provider.register();
registerInstrumentations({
instrumentations: [
new RedisInstrumentation(),
],
});
const redis = require('redis');
const client = redis.createClient();
client.on('error', (err) => console.error('Redis Client Error', err));
client.connect();
client.set('key', 'value');
client.get('key', (err, reply) => {
console.log(reply); // 'value'
});
Custom Span Attributes
This feature allows you to add custom attributes to spans. The code sample demonstrates how to set up a response hook that adds the length of the Redis response as a custom attribute to the span.
const { NodeTracerProvider } = require('@opentelemetry/sdk-trace-node');
const { registerInstrumentations } = require('@opentelemetry/instrumentation');
const { RedisInstrumentation } = require('@opentelemetry/instrumentation-redis-4');
const provider = new NodeTracerProvider();
provider.register();
registerInstrumentations({
instrumentations: [
new RedisInstrumentation({
responseHook: (span, response) => {
span.setAttribute('redis.response_length', response.length);
},
}),
],
});
const redis = require('redis');
const client = redis.createClient();
client.on('error', (err) => console.error('Redis Client Error', err));
client.connect();
client.set('key', 'value');
client.get('key', (err, reply) => {
console.log(reply); // 'value'
});
This package provides OpenTelemetry instrumentation for Redis versions 2.x and 3.x. It offers similar functionalities to @opentelemetry/instrumentation-redis-4 but is designed for older versions of Redis.
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+
.
npm install --save @opentelemetry/instrumentation-redis-4
redis
versions >=4.0.0
For versions redis@^2.6.0
and redis@^3.0.0
, please use @opentelemetry/instrumentation-redis
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 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. |
db.statement
SerializerThe 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(" ");
},
});
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. |
Apache 2.0 - See LICENSE for more information.
FAQs
OpenTelemetry instrumentation for `redis` v4 database client for Redis
We found that @opentelemetry/instrumentation-redis-4 demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 3 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
A supply chain attack on Rspack's npm packages injected cryptomining malware, potentially impacting thousands of developers.
Research
Security News
Socket researchers discovered a malware campaign on npm delivering the Skuld infostealer via typosquatted packages, exposing sensitive data.
Security News
Sonar’s acquisition of Tidelift highlights a growing industry shift toward sustainable open source funding, addressing maintainer burnout and critical software dependencies.