opentelemetry-java-instrume.../instrumentation/lettuce/lettuce-5.1/library
Jay DeLuca 17a0bde1f9
Library readmes - batch 2 (#14631)
2025-09-16 10:24:13 +03:00
..
src fix(deps): update errorproneversion to v2.41.0 (minor) (#14331) 2025-07-28 10:38:51 -07:00
README.md Library readmes - batch 2 (#14631) 2025-09-16 10:24:13 +03:00
build.gradle.kts Revert JvmTestSuite changes (#14550) 2025-08-31 13:25:26 +03:00

README.md

Library Instrumentation for Lettuce version 5.1 and higher

Provides OpenTelemetry instrumentation for Lettuce, enabling database client spans and metrics.

Quickstart

Add these dependencies to your project

Replace OPENTELEMETRY_VERSION with the latest release.

For Maven, add to your pom.xml dependencies:

<dependencies>
  <dependency>
    <groupId>io.opentelemetry.instrumentation</groupId>
    <artifactId>opentelemetry-lettuce-5.1</artifactId>
    <version>OPENTELEMETRY_VERSION</version>
  </dependency>
</dependencies>

For Gradle, add to your dependencies:

implementation("io.opentelemetry.instrumentation:opentelemetry-lettuce-5.1:OPENTELEMETRY_VERSION")

Usage

import io.lettuce.core.RedisClient;
import io.lettuce.core.api.StatefulRedisConnection;
import io.lettuce.core.resource.ClientResources;
import io.opentelemetry.api.OpenTelemetry;
import io.opentelemetry.instrumentation.lettuce.v5_1.LettuceTelemetry;

// Get an OpenTelemetry instance
OpenTelemetry openTelemetry = ...;

LettuceTelemetry lettuceTelemetry = LettuceTelemetry.create(openTelemetry);

ClientResources clientResources = ClientResources.builder()
    .tracing(lettuceTelemetry.newTracing())
    .build();

RedisClient redisClient = RedisClient.create(clientResources, "redis://localhost:6379");
StatefulRedisConnection<String, String> connection = redisClient.connect();