Ability to provide a custom service name for spans #865

Original pull request: #866
redis · Oct 1, 2018 · 27a7a3a · 27a7a3a
1 parent af1dcad
commit 27a7a3a
Show file tree

Hide file tree

Showing 4 changed files with 108 additions and 8 deletions.
diff --git a/RELEASE-NOTES.md b/RELEASE-NOTES.md
@@ -215,7 +215,7 @@ Usage example:
 ```java
 Tracing tracing = …;
 
-ClientResources clientResources = ClientResources.builder().tracing(BraveTracing.create(tracing)).build();
+ClientResources clientResources = ClientResources.builder().tracing(BraveTracing.builder(tracing).build()).build();
 
 RedisClient client = RedisClient.create(clientResources, redisUri);
 

diff --git a/src/main/java/io/lettuce/core/tracing/BraveTracing.java b/src/main/java/io/lettuce/core/tracing/BraveTracing.java
@@ -52,17 +52,20 @@
 public class BraveTracing implements Tracing {
 
     private final BraveTracer tracer;
+    private final String serviceName;
 
     /**
      * Create a new {@link BraveTracing} instance.
      *
-     * @param tracer
+     * @param builder the {@link BraveTracing.Builder}.
      */
-    private BraveTracing(BraveTracer tracer) {
+    public BraveTracing(Builder builder) {
 
-        LettuceAssert.notNull(tracer, "Tracer must not be null");
+        LettuceAssert.notNull(builder.tracing, "Tracing must not be null");
+        LettuceAssert.notNull(builder.serviceName, "Service name must not be null");
 
-        this.tracer = tracer;
+        this.serviceName = builder.serviceName;
+        this.tracer = new BraveTracer(builder.tracing);
     }
 
     /**
@@ -72,7 +75,45 @@ private BraveTracing(BraveTracer tracer) {
      * @return the {@link BraveTracing}.
      */
     public static BraveTracing create(brave.Tracing tracing) {
-        return new BraveTracing(new BraveTracer(tracing));
+        return (BraveTracing) builder(tracing).build();
+    }
+
+    public static BraveTracing.Builder builder(brave.Tracing tracing) {
+        return new BraveTracing.Builder(tracing);
+    }
+
+    public static class Builder implements Tracing.Builder {
+
+        private String serviceName = "redis";
+        private brave.Tracing tracing;
+
+        private Builder() {
+        }
+
+        private Builder(brave.Tracing tracing) {
+            this.tracing = tracing;
+        }
+
+        /**
+         * Sets the name used in the {@link zipkin2.Endpoint}.
+         *
+         * @param serviceName the name for the {@link zipkin2.Endpoint}, must not be  {@literal null}.
+         * @return this
+         * @since 5.2
+         */
+        @Override
+        public Tracing.Builder serviceName(String serviceName) {
+            this.serviceName = serviceName;
+            return this;
+        }
+
+        /**
+         * @return a new instance of {@link BraveTracing}
+         */
+        @Override
+        public Tracing build() {
+            return new BraveTracing(this);
+        }
     }
 
     @Override
@@ -98,11 +139,11 @@ public Endpoint createEndpoint(SocketAddress socketAddress) {
         if (socketAddress instanceof InetSocketAddress) {
 
             InetSocketAddress inetSocketAddress = (InetSocketAddress) socketAddress;
-            return new BraveEndpoint(builder.serviceName("redis").ip(inetSocketAddress.getAddress())
+            return new BraveEndpoint(builder.serviceName(serviceName).ip(inetSocketAddress.getAddress())
                     .port(inetSocketAddress.getPort()).build());
         }
 
-        return new BraveEndpoint(builder.serviceName("redis").build());
+        return new BraveEndpoint(builder.serviceName(serviceName).build());
     }
 
     /**

diff --git a/src/main/java/io/lettuce/core/tracing/Tracing.java b/src/main/java/io/lettuce/core/tracing/Tracing.java
@@ -103,4 +103,46 @@ static Context withTraceContextProvider(TraceContextProvider supplier) {
      */
     interface Endpoint {
     }
+
+    /**
+     * Create a new {@link Tracing} using default settings.
+     *
+     * @return a new instance of a tracing.
+     * @since 5.2
+     */
+    static Tracing create(brave.Tracing tracing) {
+        return BraveTracing.builder(tracing).build();
+    }
+
+    /**
+     * Create a new {@link BraveTracing.Builder} using default settings.
+     *
+     * @return a new instance of a tracing builder.
+     * @since 5.2
+     */
+    static BraveTracing.Builder builder(brave.Tracing tracing) {
+        return BraveTracing.builder(tracing);
+    }
+
+    /**
+     * Builder for {@link Tracing}.
+     *
+     * @since 5.2
+     */
+    interface Builder {
+
+        /**
+         * Sets the name used in the {@link zipkin2.Endpoint}.
+         *
+         * @param serviceName the name for the {@link zipkin2.Endpoint}, must not be  {@literal null}.
+         * @return this
+         * @since 5.2
+         */
+        Builder serviceName(String serviceName);
+
+        /**
+         * @return a new instance of {@link BraveTracing}
+         */
+        Tracing build();
+    }
 }
diff --git a/src/test/java/io/lettuce/core/tracing/BraveTracingIntegrationTests.java b/src/test/java/io/lettuce/core/tracing/BraveTracingIntegrationTests.java
@@ -214,4 +214,21 @@ void shouldReportSimpleServiceName() {
         assertThat(endpoint.endpoint.ipv4()).isNull();
         assertThat(endpoint.endpoint.ipv6()).isNull();
     }
+
+    @Test
+    public void shouldReportCustomServiceName() {
+
+        DefaultClientResources clientResourcesWithOverridenServiceName = DefaultClientResources.builder()
+                .tracing(BraveTracing.builder(clientTracing)
+                        .serviceName("custom-name-goes-here")
+                        .build())
+                .build();
+        BraveTracing.BraveEndpoint endpoint = (BraveTracing.BraveEndpoint) clientResourcesWithOverridenServiceName.tracing().createEndpoint(
+                new DomainSocketAddress("foo"));
+
+        assertThat(endpoint.endpoint.serviceName()).isEqualTo("custom-name-goes-here");
+        assertThat(endpoint.endpoint.port()).isNull();
+        assertThat(endpoint.endpoint.ipv4()).isNull();
+        assertThat(endpoint.endpoint.ipv6()).isNull();
+    }
 }