![Introducing Enhanced Alert Actions and Triage Functionality](https://cdn.sanity.io/images/cgdhsj6q/production/fe71306d515f85de6139b46745ea7180362324f0-2530x946.png?w=800&fit=max&auto=format)
Product
Introducing Enhanced Alert Actions and Triage Functionality
Socket now supports four distinct alert actions instead of the previous two, and alert triaging allows users to override the actions taken for all individual alerts.
@opentelemetry/instrumentation-redis-4
Advanced tools
Readme
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
This package supports redis@^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
The npm package @opentelemetry/instrumentation-redis-4 receives a total of 882,985 weekly downloads. As such, @opentelemetry/instrumentation-redis-4 popularity was classified as popular.
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.
Product
Socket now supports four distinct alert actions instead of the previous two, and alert triaging allows users to override the actions taken for all individual alerts.
Security News
Polyfill.io has been serving malware for months via its CDN, after the project's open source maintainer sold the service to a company based in China.
Security News
OpenSSF is warning open source maintainers to stay vigilant against reputation farming on GitHub, where users artificially inflate their status by manipulating interactions on closed issues and PRs.