OpenTracing instrumentation for Redis Client
- Java 8
pom.xml
<dependency> <groupId>io.opentracing.contrib</groupId> <artifactId>opentracing-redis-jedis</artifactId> <version>VERSION</version> </dependency>pom.xml
<dependency> <groupId>io.opentracing.contrib</groupId> <artifactId>opentracing-redis-jedis3</artifactId> <version>VERSION</version> </dependency>pom.xml
<dependency> <groupId>io.opentracing.contrib</groupId> <artifactId>opentracing-redis-lettuce-5.2</artifactId> <version>VERSION</version> </dependency>pom.xml
<dependency> <groupId>io.opentracing.contrib</groupId> <artifactId>opentracing-redis-redisson</artifactId> <version>VERSION</version> </dependency>pom.xml
<dependency> <groupId>io.opentracing.contrib</groupId> <artifactId>opentracing-redis-spring-data</artifactId> <version>VERSION</version> </dependency>pom.xml
<dependency> <groupId>io.opentracing.contrib</groupId> <artifactId>opentracing-redis-spring-data2</artifactId> <version>VERSION</version> </dependency>// Instantiate tracer Tracer tracer = ... // Create TracingConfiguration TracingConfiguration tracingConfiguration = new TracingConfiguration.Builder(tracer).build(); // Create Tracing Jedis Jedis jedis = new TracingJedis(tracingConfiguration); jedis.set("foo", "bar"); String value = jedis.get("foo");Set<HostAndPort> jedisClusterNodes = new HashSet<HostAndPort>(); jedisClusterNodes.add(new HostAndPort("127.0.0.1", 7379)); // Create Tracing Jedis Cluster JedisCluster jc = new TracingJedisCluster(jedisClusterNodes, tracingConfiguration); jc.set("foo", "bar"); String value = jc.get("foo");// Configure the pool JedisPoolConfig poolConfig = new JedisPoolConfig(); poolConfig.setMaxIdle(10); poolConfig.setTestOnBorrow(false); // Create Tracing Jedis Pool JedisPool pool = new TracingJedisPool(poolConfig, "127.0.0.1", 6379, tracingConfiguration); try (Jedis jedis = pool.getResource()) { // jedis will be automatically closed and returned to the pool at the end of "try" block jedis.set("foo", "bar"); String value = jedis.get("foo"); }// Create Tracing Jedis Sentinel Pool JedisSentinelPool pool = new TracingJedisSentinelPool(tracingConfiguration, MASTER_NAME, sentinels, poolConfig); try (Jedis jedis = pool.getResource()) { // jedis will be automatically closed and returned to the pool at the end of "try" block jedis.set("foo", "bar")); String value = jedis.get("foo")); }By default, span names are set to the operation performed by the Jedis object. To customize the span name, provide a Function to the TracingConfiguration object that alters the span name. If a function is not provided, the span name will remain the default. Refer to the RedisSpanNameProvider class for a function that prefixes the operation name.
TracingConfiguration tracingConfiguration = new TracingConfiguration.Builder(tracer) .withSpanNameProvider(RedisSpanNameProvider.PREFIX_OPERATION_NAME("redis.")) .build(); //Create Tracing Jedis with custom span name Jedis jedis = new TracingJedis(tracingConfiguration); jedis.set("foo", "bar"); //Span name is now set to "redis.set"// Create client RedisClient client = RedisClient.create("redis://localhost"); // Decorate StatefulRedisConnection with TracingStatefulRedisConnection StatefulRedisConnection<String, String> connection = new TracingStatefulRedisConnection(client.connect(), tracingConfiguration); // Get sync redis commands RedisCommands<String, String> commands = connection.sync(); // Get async redis commands RedisAsyncCommands<String, String> commandsAsync = connection.async();// Create Redisson config object Config = ... // Create Redisson instance RedissonClient redissonClient = Redisson.create(config); // Decorate RedissonClient with TracingRedissonClient RedissonClient tracingRedissonClient = new TracingRedissonClient(redissonClient, tracingConfiguration); // Get object you need using TracingRedissonClient RMap<MyKey, MyValue> map = tracingRedissonClient.getMap("myMap");// Create tracing connection factory bean @Bean public RedisConnectionFactory redisConnectionFactory() { LettuceConnectionFactory lettuceConnectionFactory = new LettuceConnectionFactory(); lettuceConnectionFactory.afterPropertiesSet(); return new TracingRedisConnectionFactory(lettuceConnectionFactory, new TracingConfiguration.Builder(tracer()).build()); }Note: if you use Lettuce/Jedis you could achieve the same result using the Lettuce/Jedis support when configuring LettuceConnectionFactory/JedisConnectionFactory instead of using a wrapping TracingRedisConnectionFactory.