Merge pull request #103 from ExpediaDotCom/id_generator_for_tracer

Id generator for tracer

Author: nsahai8

core/pom.xml

@@ -106,6 +106,14 @@
       <artifactId>awaitility</artifactId>
       <scope>test</scope>
     </dependency>
+
+
+    <dependency>
+      <groupId>com.fasterxml.uuid</groupId>
+      <artifactId>java-uuid-generator</artifactId>
+      <version>3.1.4</version>
+    </dependency>
+
   </dependencies>
 
 </project>

core/src/main/java/com/expedia/www/haystack/client/SpanContext.java

@@ -16,6 +16,7 @@
  */
 package com.expedia.www.haystack.client;
 
+import org.apache.commons.lang3.Validate;
 import org.apache.commons.lang3.builder.ReflectionToStringBuilder;
 import org.apache.commons.lang3.builder.ToStringStyle;
 
@@ -25,9 +26,9 @@
 public class SpanContext implements io.opentracing.SpanContext {
 
     private final Map<String, String> baggage;
-    private final UUID traceId;
-    private final UUID spanId;
-    private final UUID parentId;
+    private final Object traceId;
+    private final Object spanId;
+    private final Object parentId;
     private boolean extractedContext;
 
     public SpanContext(UUID traceId, UUID spanId, UUID parentId) {
@@ -44,9 +45,7 @@ public SpanContext(UUID traceId, UUID spanId, UUID parentId, boolean extractedCo
     }
 
     SpanContext(UUID traceId, UUID spanId, UUID parentId, Map<String, String> baggage, boolean extractedContext) {
-        if (baggage == null) {
-            throw new NullPointerException();
-        }
+        Validate.notNull(baggage);
 
         this.traceId = traceId;
         this.spanId = spanId;
@@ -55,6 +54,24 @@ public SpanContext(UUID traceId, UUID spanId, UUID parentId, boolean extractedCo
         this.extractedContext = extractedContext;
     }
 
+
+    SpanContext(Object traceId, Object spanId, Object parentId, Map<String, String> baggage, boolean extractedContext) {
+        Validate.notNull(baggage);
+
+        this.traceId = traceId;
+        this.spanId = spanId;
+        this.parentId = parentId;
+        this.baggage = Collections.unmodifiableMap(baggage);
+        this.extractedContext = extractedContext;
+    }
+
+    public SpanContext(Object traceId, Object spanId, Object parentId) {
+        this(traceId, spanId, parentId, false);
+    }
+
+    public SpanContext(Object traceId, Object spanId, Object parentId, boolean extractedContext) {
+        this(traceId, spanId, parentId, Collections.emptyMap(), extractedContext);
+    }
     @Override
     public int hashCode() {
         return Objects.hash(traceId, spanId, parentId, baggage);
@@ -104,21 +121,21 @@ public String getBaggageItem(String key) {
     /**
      * @return the traceId
      */
-    public UUID getTraceId() {
+    public Object getTraceId() {
         return traceId;
     }
 
     /**
      * @return the spanId
      */
-    public UUID getSpanId() {
+    public Object getSpanId() {
         return spanId;
     }
 
     /**
      * @return the parentId
      */
-    public UUID getParentId() {
+    public Object getParentId() {
         return parentId;
     }
 

core/src/main/java/com/expedia/www/haystack/client/Tracer.java

@@ -17,6 +17,8 @@
 package com.expedia.www.haystack.client;
 
 import com.expedia.www.haystack.client.dispatchers.Dispatcher;
+import com.expedia.www.haystack.client.idgenerators.IdGenerator;
+import com.expedia.www.haystack.client.idgenerators.LongIdGenerator;
 import com.expedia.www.haystack.client.metrics.*;
 import com.expedia.www.haystack.client.metrics.Timer;
 import com.expedia.www.haystack.client.metrics.Timer.Sample;
@@ -39,7 +41,12 @@
 import java.util.*;
 
 public class Tracer implements io.opentracing.Tracer {
+
+    private final static IdGenerator DEFAULT_ID_GENERATOR = new LongIdGenerator();
+    private final static Boolean DEFAULT_DUAL_SPAN_MODE = false;
+
     private final Dispatcher dispatcher;
+    private final IdGenerator idGenerator;
     protected final Clock clock;
     protected final PropagationRegistry registry;
     private final String serviceName;
@@ -64,14 +71,15 @@ public class Tracer implements io.opentracing.Tracer {
 
     public Tracer(String serviceName, ScopeManager scopeManager, Clock clock,
                   Dispatcher dispatcher, PropagationRegistry registry, Metrics metrics) {
-        this(serviceName, scopeManager, clock, dispatcher, registry, metrics, false);
-
+        this(serviceName, scopeManager, clock, dispatcher, registry, metrics, DEFAULT_DUAL_SPAN_MODE, DEFAULT_ID_GENERATOR);
     }
     public Tracer(String serviceName, ScopeManager scopeManager, Clock clock,
-                  Dispatcher dispatcher, PropagationRegistry registry, Metrics metrics, boolean dualSpanMode) {
+                  Dispatcher dispatcher, PropagationRegistry registry,
+                  Metrics metrics, boolean dualSpanMode, IdGenerator idGenerator) {
         this.serviceName = serviceName;
         this.scopeManager = scopeManager;
         this.clock = clock;
+        this.idGenerator = idGenerator;
         this.dispatcher = dispatcher;
         this.registry = registry;
         this.dualSpanMode = dualSpanMode;
@@ -272,13 +280,19 @@ boolean isServerSpan() {
         }
 
         protected SpanContext createNewContext() {
-            return createContext(UUID.randomUUID(), UUID.randomUUID(), null, Collections.emptyMap());
+
+            return createContext(tracer.idGenerator.generate(), tracer.idGenerator.generate(), null, Collections.emptyMap());
         }
 
         protected SpanContext createContext(UUID traceId, UUID spanId, UUID parentId, Map<String, String> baggage) {
             return new SpanContext(traceId, spanId, parentId, baggage, false);
         }
 
+
+        protected SpanContext createContext(Object traceId, Object spanId, Object parentId, Map<String, String> baggage) {//doubt parentId
+            return new SpanContext(traceId, spanId, parentId, baggage, false);
+        }
+
         protected SpanContext createDependentContext() {
             Reference parent = references.get(0);
             for (Reference reference : references) {
@@ -360,6 +374,7 @@ public static class Builder {
         protected Dispatcher dispatcher;
         protected PropagationRegistry registry = new PropagationRegistry();
         protected Metrics metrics;
+        protected IdGenerator idGenerator;
         private boolean dualSpanMode;
 
         public Builder(MetricsRegistry registry, String serviceName, Dispatcher dispatcher) {
@@ -390,6 +405,11 @@ public Builder withClock(Clock clock) {
             return this;
         }
 
+        public Builder withIdGenerator(IdGenerator idGenerator) {
+            this.idGenerator = idGenerator;
+            return this;
+        }
+
         public <T> Builder withFormat(Format<T> format, Injector<T> injector) {
             registry.register(format, injector);
             return this;
@@ -422,7 +442,8 @@ public Builder withDualSpanMode() {
         }
 
         public Tracer build() {
-            return new Tracer(serviceName, scopeManager, clock, dispatcher, registry, metrics, dualSpanMode);
+            idGenerator = idGenerator == null ? DEFAULT_ID_GENERATOR : idGenerator;
+            return new Tracer(serviceName, scopeManager, clock, dispatcher, registry, metrics, dualSpanMode, idGenerator);
         }
     }
 }

core/src/main/java/com/expedia/www/haystack/client/idgenerators/IdGenerator.java

@@ -0,0 +1,21 @@
+/*
+ * Copyright 2019 Expedia, Inc.
+ *
+ *       Licensed under the Apache License, Version 2.0 (the "License");
+ *       you may not use this file except in compliance with the License.
+ *       You may obtain a copy of the License at
+ *
+ *           http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *       Unless required by applicable law or agreed to in writing, software
+ *       distributed under the License is distributed on an "AS IS" BASIS,
+ *       WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *       See the License for the specific language governing permissions and
+ *       limitations under the License.
+ *
+ */
+package com.expedia.www.haystack.client.idgenerators;
+
+public interface IdGenerator {
+    Object generate();
+}

core/src/main/java/com/expedia/www/haystack/client/idgenerators/LongIdGenerator.java

@@ -0,0 +1,30 @@
+/*
+ * Copyright 2019 Expedia, Inc.
+ *
+ *       Licensed under the Apache License, Version 2.0 (the "License");
+ *       you may not use this file except in compliance with the License.
+ *       You may obtain a copy of the License at
+ *
+ *           http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *       Unless required by applicable law or agreed to in writing, software
+ *       distributed under the License is distributed on an "AS IS" BASIS,
+ *       WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *       See the License for the specific language governing permissions and
+ *       limitations under the License.
+ *
+ */
+package com.expedia.www.haystack.client.idgenerators;
+
+
+import com.expedia.www.haystack.client.idgenerators.IdGenerator;
+
+import java.util.concurrent.ThreadLocalRandom;
+
+public class LongIdGenerator implements IdGenerator {
+
+    @Override
+    public Long generate() {
+        return ThreadLocalRandom.current().nextLong(Long.MAX_VALUE);
+    }
+}

core/src/main/java/com/expedia/www/haystack/client/idgenerators/RandomUUIDGenerator.java

@@ -0,0 +1,28 @@
+/*
+ * Copyright 2019 Expedia, Inc.
+ *
+ *       Licensed under the Apache License, Version 2.0 (the "License");
+ *       you may not use this file except in compliance with the License.
+ *       You may obtain a copy of the License at
+ *
+ *           http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *       Unless required by applicable law or agreed to in writing, software
+ *       distributed under the License is distributed on an "AS IS" BASIS,
+ *       WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *       See the License for the specific language governing permissions and
+ *       limitations under the License.
+ *
+ */
+package com.expedia.www.haystack.client.idgenerators;
+
+
+import java.util.UUID;
+
+public class RandomUUIDGenerator implements IdGenerator {
+
+    @Override
+    public UUID generate() {
+        return UUID.randomUUID();
+    }
+}

core/src/main/java/com/expedia/www/haystack/client/idgenerators/TimeBasedUUIDGenerator.java

@@ -0,0 +1,31 @@
+/*
+ * Copyright 2019 Expedia, Inc.
+ *
+ *       Licensed under the Apache License, Version 2.0 (the "License");
+ *       you may not use this file except in compliance with the License.
+ *       You may obtain a copy of the License at
+ *
+ *           http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *       Unless required by applicable law or agreed to in writing, software
+ *       distributed under the License is distributed on an "AS IS" BASIS,
+ *       WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *       See the License for the specific language governing permissions and
+ *       limitations under the License.
+ *
+ */
+package com.expedia.www.haystack.client.idgenerators;
+
+
+import com.fasterxml.uuid.Generators;
+
+import java.util.UUID;
+
+
+public class TimeBasedUUIDGenerator implements IdGenerator {
+
+    @Override
+    public UUID generate() {
+        return Generators.timeBasedGenerator().generate();
+    }
+}

core/src/test/java/com/expedia/www/haystack/client/SpanBuilderTest.java

@@ -18,6 +18,7 @@
 
 import com.expedia.www.haystack.client.dispatchers.Dispatcher;
 import com.expedia.www.haystack.client.dispatchers.NoopDispatcher;
+import com.expedia.www.haystack.client.idgenerators.RandomUUIDGenerator;
 import com.expedia.www.haystack.client.metrics.NoopMetricsRegistry;
 import com.expedia.www.haystack.client.propagation.MapBackedTextMap;
 import io.opentracing.References;
@@ -67,7 +68,7 @@ public void testChildOfWithDualSpanType() {
         //create a client span
         final Tracer clientTracer = new Tracer.Builder(new NoopMetricsRegistry(),
                                                        "ClientService",
-                                                       dispatcher).withDualSpanMode().build();
+                                                       dispatcher).withDualSpanMode().withIdGenerator(new RandomUUIDGenerator()).build();
         final Span clientSpan = clientTracer.buildSpan("Api_call")
                 .withTag(Tags.SPAN_KIND.getKey(), Tags.SPAN_KIND_CLIENT)
                 .start();
@@ -77,7 +78,7 @@ public void testChildOfWithDualSpanType() {
         //create a server
         final Tracer serverTracer = new Tracer.Builder(new NoopMetricsRegistry(),
                                                        "ServerService",
-                                                       dispatcher).withDualSpanMode().build();
+                                                       dispatcher).withDualSpanMode().withIdGenerator(new RandomUUIDGenerator()).build();
         final SpanContext wireContext = serverTracer.extract(Format.Builtin.TEXT_MAP, wireData);
         final Span serverSpan = serverTracer.buildSpan("Api")
                 .asChildOf(wireContext)
@@ -97,7 +98,7 @@ public void testChildOfWithSingleSpanType() {
         //create a client span
         final Tracer clientTracer = new Tracer.Builder(new NoopMetricsRegistry(),
                                                        "ClientService",
-                                                       dispatcher).build();
+                                                       dispatcher).withIdGenerator(new RandomUUIDGenerator()).build();
         final Span clientSpan = clientTracer.buildSpan("Api_call")
                 .withTag(Tags.SPAN_KIND.getKey(), Tags.SPAN_KIND_CLIENT)
                 .start();
@@ -107,7 +108,7 @@ public void testChildOfWithSingleSpanType() {
         //create a server
         final Tracer serverTracer = new Tracer.Builder(new NoopMetricsRegistry(),
                                                        "ServerService",
-                                                       dispatcher).build();
+                                                       dispatcher).withIdGenerator(new RandomUUIDGenerator()).build();
         final SpanContext wireContext = serverTracer.extract(Format.Builtin.TEXT_MAP, wireData);
         final Span serverSpan = serverTracer.buildSpan("Api")
                 .asChildOf(wireContext)
@@ -128,7 +129,8 @@ public void testChildOfWithSingleSpanTypeAndExtractedContext() {
         //create a client span
         final Tracer clientTracer = new Tracer.Builder(new NoopMetricsRegistry(),
                                                        "ClientService",
-                                                       dispatcher).build();
+                                                       dispatcher).withIdGenerator(new RandomUUIDGenerator()).build();
+
         final Span clientSpan = clientTracer.buildSpan("Api_call")
                 .withTag(Tags.SPAN_KIND.getKey(), Tags.SPAN_KIND_CLIENT)
                 .start();
@@ -157,7 +159,7 @@ public void testChildOfSingleSpanTypeWithExtractedContextDoesNotPropagateExtract
         //create a client span
         final Tracer clientTracer = new Tracer.Builder(new NoopMetricsRegistry(),
                                                        "ClientService",
-                                                       dispatcher).build();
+                                                       dispatcher).withIdGenerator(new RandomUUIDGenerator()).build();
         final Span clientSpan = clientTracer.buildSpan("Api_call")
                 .withTag(Tags.SPAN_KIND.getKey(), Tags.SPAN_KIND_CLIENT)
                 .start();
@@ -167,7 +169,7 @@ public void testChildOfSingleSpanTypeWithExtractedContextDoesNotPropagateExtract
         //create a server
         final Tracer serverTracer = new Tracer.Builder(new NoopMetricsRegistry(),
                                                        "ServerService",
-                                                       dispatcher).build();
+                                                       dispatcher).withIdGenerator(new RandomUUIDGenerator()).build();
         final SpanContext wireContext = serverTracer.extract(Format.Builtin.TEXT_MAP, wireData);
         final Span serverSpan = serverTracer.buildSpan("Api")
                 .asChildOf(wireContext)