Propagate database number, user, and RedisURI into Tracing (#3005)

* Propagate database number, user, and RedisURI into Tracing * Update attribute names as recommend * Add db.user info * Polishing
redis · Oct 11, 2024 · 542b6a5 · 542b6a5
1 parent 9185a49
commit 542b6a5
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 0 deletions.
diff --git a/src/main/java/io/lettuce/core/protocol/CommandHandler.java b/src/main/java/io/lettuce/core/protocol/CommandHandler.java
@@ -30,13 +30,17 @@
 import java.util.Collection;
 import java.util.LinkedHashSet;
 import java.util.List;
+import java.util.Optional;
 import java.util.Queue;
 import java.util.Set;
 import java.util.concurrent.atomic.AtomicLong;
 
 import io.lettuce.core.ClientOptions;
+import io.lettuce.core.ConnectionBuilder;
 import io.lettuce.core.RedisConnectionException;
+import io.lettuce.core.RedisCredentials;
 import io.lettuce.core.RedisException;
+import io.lettuce.core.RedisURI;
 import io.lettuce.core.api.push.PushListener;
 import io.lettuce.core.api.push.PushMessage;
 import io.lettuce.core.internal.LettuceAssert;
@@ -478,6 +482,15 @@ private void attachTracing(ChannelHandlerContext ctx, RedisCommand<?, ?, ?> comm
             Tracer.Span span = tracer.nextSpan(context);
             span.name(command.getType().toString());
 
+            if (channel.hasAttr(ConnectionBuilder.REDIS_URI)) {
+                String redisUriStr = channel.attr(ConnectionBuilder.REDIS_URI).get();
+                RedisURI redisURI = RedisURI.create(redisUriStr);
+                span.tag("server.address", redisURI.toString());
+                span.tag("db.namespace", String.valueOf(redisURI.getDatabase()));
+                span.tag("user.name", Optional.ofNullable(redisURI.getCredentialsProvider().resolveCredentials().block())
+                        .map(RedisCredentials::getUsername).orElse(""));
+            }
+
             if (tracedEndpoint != null) {
                 span.remoteEndpoint(tracedEndpoint);
             } else {

diff --git a/src/test/java/io/lettuce/core/tracing/SynchronousIntegrationTests.java b/src/test/java/io/lettuce/core/tracing/SynchronousIntegrationTests.java
@@ -75,6 +75,9 @@ public SampleTestRunnerConsumer yourCode() {
                         .containsEntry("net.sock.peer.addr", TestSettings.host())
                         .containsEntry("net.sock.peer.port", "" + TestSettings.port());
                 assertThat(finishedSpan.getTags()).containsKeys("db.operation");
+                assertThat(finishedSpan.getTags()).containsKeys("server.address");
+                assertThat(finishedSpan.getTags()).containsKeys("db.namespace");
+                assertThat(finishedSpan.getTags()).containsKeys("user.name");
             }
 
             assertThat(commands).extracting(RedisCommand::getType).contains(CommandType.PING, CommandType.HELLO);