Skip to content

Commit fb7f3d0

Browse files
committed
docs(redis): update README with semantic conventions info
1 parent 7130d22 commit fb7f3d0

File tree

1 file changed

+3
-20
lines changed

1 file changed

+3
-20
lines changed

packages/instrumentation-redis/README.md

Lines changed: 3 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -73,29 +73,12 @@ const redisInstrumentation = new RedisInstrumentation({
7373
});
7474
```
7575

76-
See [examples/redis](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/examples/redis) for a short example.
77-
78-
## Semantic Conventions Stability
79-
80-
To select which semconv version(s) is emitted from this instrumentation, use the `OTEL_SEMCONV_STABILITY_OPT_IN` environment variable.
81-
82-
- `database` - Emit only the stable database conventions.
83-
- `database/dup` - Emit both the old and stable database conventions.
84-
- By default, if `OTEL_SEMCONV_STABILITY_OPT_IN` includes neither of the above tokens, the old v1.27.0 semconv is used.
85-
86-
The migration guide for the database conventions can be found [here](https://opentelemetry.io/docs/specs/semconv/non-normative/database-migration/).
87-
88-
### Migrating to stable database semantic conventions
76+
## Semantic Conventions
8977

90-
1. Update your telemetry infrastructure to support the new stable database attributes
91-
2. Set `OTEL_SEMCONV_STABILITY_OPT_IN=database/dup` to emit both old and new semantic conventions
92-
3. Update your applications and infrastructure to use the new attributes
93-
4. Set `OTEL_SEMCONV_STABILITY_OPT_IN=database` to emit only the new semantic conventions
94-
```
9578

96-
## Semantic Conventions
79+
This package uses `@opentelemetry/semantic-conventions` version `1.22+`, which implements Semantic Convention [Version 1.7.0](https://github.com/open-telemetry/opentelemetry-specification/blob/v1.7.0/semantic_conventions/README.md) ("old" conventions).
9780

98-
This package supports both old semantic conventions (v1.27.0 and prior) and the stable v1.33.0 semantic conventions.
81+
It also supports the new stable semantic conventions introduced in [Version 1.33.0]
9982
By default, old semantic conventions are used. Use the `OTEL_SEMCONV_STABILITY_OPT_IN` environment variable to control which version to emit.
10083

10184
Attributes collected:

0 commit comments

Comments
 (0)