@opentelemetry/plugin-ioredis
Advanced tools
OpenTelemetry ioredis automatic instrumentation package.
This module provides automatic instrumentation for ioredis.
For automatic instrumentation see the @opentelemetry/node package.
npm install --save @opentelemetry/plugin-ioredis
>=2.0.0To load a specific plugin (ioredis in this case), specify it in the Node Tracer's configuration
const { NodeTracerProvider } = require('@opentelemetry/node');
const provider = new NodeTracerProvider({
plugins: {
ioredis: {
enabled: true,
// You may use a package name or absolute path to the file.
path: '@opentelemetry/plugin-ioredis',
}
}
});
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 provider = new NodeTracerProvider();
IORedis plugin has few options available to choose from. You can set the following:
| Options | Type | Description |
|---|---|---|
dbStatementSerializer | DbStatementSerializer | IORedis plugin will serialize db.statement using the specified function. |
#### Custom db.statement Serializer
The plugin serializes the whole command into a Span attribute called db.statement. The standard serialization format is {cmdName} {cmdArgs.join(',')}.
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 skipping arguments:
const { NodeTracerProvider } = require('@opentelemetry/node');
const provider = new NodeTracerProvider({
plugins: {
ioredis: {
enabled: true,
// You may use a package name or absolute path to the file.
path: '@opentelemetry/plugin-ioredis',
dbStatementSerializer: function (cmdName, cmdArgs) {
return cmdName;
}
}
}
});
Apache 2.0 - See LICENSE for more information.
0.12.1
FAQs
OpenTelemetry ioredis automatic instrumentation package.
The npm package @opentelemetry/plugin-ioredis receives a total of 702 weekly downloads. As such, @opentelemetry/plugin-ioredis popularity was classified as not popular.
We found that @opentelemetry/plugin-ioredis demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 4 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 malicious npm package disguised as a WhatsApp client is exploiting authentication flows with a remote kill switch to exfiltrate data and destroy files.
Security News
PyPI now supports digital attestations, enhancing security and trust by allowing package maintainers to verify the authenticity of Python packages.
Security News
GitHub removed 27 malicious pull requests attempting to inject harmful code across multiple open source repositories, in another round of low-effort attacks.