Skip to content

Commit 4ecf3a8

Browse files
committed
fix: redis docs to include consolidated version
1 parent ca617a5 commit 4ecf3a8

File tree

2 files changed

+182
-4
lines changed

2 files changed

+182
-4
lines changed

package-lock.json

Lines changed: 180 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

plugins/node/opentelemetry-instrumentation-redis/README.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
[![NPM Published Version][npm-img]][npm-url]
44
[![Apache License][license-image]][license-image]
55

6-
This module provides automatic instrumentation for the [`redis`](https://github.com/NodeRedis/node_redis) module versions `>=2.6.0 <4`, which may be loaded using the [`@opentelemetry/sdk-trace-node`](https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-sdk-trace-node) package and is included in the [`@opentelemetry/auto-instrumentations-node`](https://www.npmjs.com/package/@opentelemetry/auto-instrumentations-node) bundle.
6+
This module provides automatic instrumentation for the [`redis`](https://github.com/NodeRedis/node_redis) module versions `>=2.6.0 <5`, which may be loaded using the [`@opentelemetry/sdk-trace-node`](https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-sdk-trace-node) package and is included in the [`@opentelemetry/auto-instrumentations-node`](https://www.npmjs.com/package/@opentelemetry/auto-instrumentations-node) bundle.
77

88
If total installation size is not constrained, it is recommended to use the [`@opentelemetry/auto-instrumentations-node`](https://www.npmjs.com/package/@opentelemetry/auto-instrumentations-node) bundle with [@opentelemetry/sdk-node](`https://www.npmjs.com/package/@opentelemetry/sdk-node`) for the most seamless instrumentation experience.
99

@@ -17,9 +17,7 @@ npm install --save @opentelemetry/instrumentation-redis
1717

1818
### Supported Versions
1919

20-
- [`redis`](https://www.npmjs.com/package/redis) versions `>=2.6.0 <4`
21-
22-
For versions `redis@^4.0.0`, please use `@opentelemetry/instrumentation-redis-4`
20+
- [`redis`](https://www.npmjs.com/package/redis) versions `>=2.6.0 <5`
2321

2422
## Usage
2523

0 commit comments

Comments
 (0)