Skip to content

Commit c8791e0

Browse files
committed
Polishing.
Refine documentation towards recommending Spring Boot and degrading custom configuration code as fallback for a clearer guidance. Closes #3313 Original pull request: #3323
1 parent 833df54 commit c8791e0

1 file changed

Lines changed: 7 additions & 2 deletions

File tree

src/main/antora/modules/ROOT/pages/observability.adoc

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,12 @@ Getting insights from an application component about its operations, timing and
55
Lettuce ships with a Micrometer integration to collect observations during Redis interaction.
66
Once the integration is set up, Micrometer will create meters and spans (for distributed tracing) for each Redis command.
77

8+
We recommend using Spring Boot with its Redis auto-configuration to enable metrics and tracing spans for Redis commands.
9+
10+
[[redis.observability.configuration]]
11+
== Configuration Code
12+
13+
If you are not using Spring Boot or you want to fully customize `ClientResources` or the tracing configuration, you can set up the integration manually.
814
To enable the integration, apply the following configuration to `LettuceClientConfiguration`:
915

1016
[source,java]
@@ -31,8 +37,7 @@ class ObservabilityConfiguration {
3137
}
3238
----
3339

34-
NOTE: NOTE: When using Spring Boot, Redis auto-configuration configures Lettuce's `MicrometerTracing` to integrate with Micrometer's Observation API, providing both metrics and tracing spans for Redis commands.
3540
See also for further reference:
36-
* https://redis.github.io/lettuce/advanced-usage/#micrometer[Lettuce Tracing]
41+
* https://redis.github.io/lettuce/advanced-usage/observability/#tracing[Lettuce Tracing]
3742
* https://opentelemetry.io/docs/reference/specification/trace/semantic_conventions/database/#redis[OpenTelemetry Semantic Conventions] .
3843

0 commit comments

Comments
 (0)