Update id format when in W3C mode

Author: trask

web/src/main/java/com/microsoft/applicationinsights/web/internal/SdkBridgeImpl.java

@@ -26,6 +26,7 @@
 import com.microsoft.applicationinsights.telemetry.RequestTelemetry;
 import com.microsoft.applicationinsights.web.internal.correlation.TelemetryCorrelationUtils;
 import com.microsoft.applicationinsights.web.internal.correlation.TraceContextCorrelation;
+import com.microsoft.applicationinsights.web.internal.correlation.tracecontext.Traceparent;
 
 class SdkBridgeImpl extends AbstractSdkBridge<RequestTelemetryContext> {
 
@@ -63,21 +64,20 @@ public String generateChildDependencyTarget(String requestContext, boolean w3c)
     @Override
     public <C> String propagate(Setter<C> setter, C carrier, boolean w3c, boolean w3cBackCompat) {
         if (w3c) {
-            String traceparent = TraceContextCorrelation.generateChildDependencyTraceparent();
+            Traceparent traceparent = TraceContextCorrelation.generateChildDependencyTraceparentObj();
             if (traceparent == null) {
                 // this means an error occurred (and was logged) in above method, so just return a valid outgoingSpanId
-                return TelemetryCorrelationUtils.generateChildDependencyId();
+                return new Traceparent().getSpanId();
             }
-            String outgoingSpanId = TraceContextCorrelation.createChildIdFromTraceparentString(traceparent);
             String tracestate = TraceContextCorrelation.retriveTracestate();
-            setter.put(carrier, "traceparent", traceparent);
+            setter.put(carrier, "traceparent", traceparent.toString());
             if (w3cBackCompat) {
-                setter.put(carrier, "Request-Id", outgoingSpanId);
+                setter.put(carrier, "Request-Id", "|" + traceparent.getTraceId() + "." + traceparent.getSpanId() + ".");
             }
             if (tracestate != null) {
                 setter.put(carrier, "tracestate", tracestate);
             }
-            return outgoingSpanId;
+            return traceparent.getSpanId();
         } else {
             String outgoingSpanId = TelemetryCorrelationUtils.generateChildDependencyId();
             String correlationContext = TelemetryCorrelationUtils.retrieveCorrelationContext();

web/src/main/java/com/microsoft/applicationinsights/web/internal/correlation/TraceContextCorrelation.java

@@ -73,16 +73,14 @@ public static void resolveCorrelation(HttpServletRequest request, HttpServletRes
             Traceparent processedTraceParent = processIncomingTraceparent(incomingTraceparent, request);
 
             // represents the id of the current request.
-            requestTelemetry.setId("|" + processedTraceParent.getTraceId() + "." + processedTraceParent.getSpanId()
-                + ".");
+            requestTelemetry.setId(processedTraceParent.getSpanId());
 
             // represents the trace-id of this distributed trace
             requestTelemetry.getContext().getOperation().setId(processedTraceParent.getTraceId());
 
             // assign parent id
             if (incomingTraceparent != null) {
-                requestTelemetry.getContext().getOperation().setParentId("|" + processedTraceParent.getTraceId() + "." +
-                    incomingTraceparent.getSpanId() + ".");
+                requestTelemetry.getContext().getOperation().setParentId(incomingTraceparent.getSpanId());
             } else {
                 // set parentId only if not already set (legacy processing can set it)
                 if (requestTelemetry.getContext().getOperation().getParentId() == null) {
@@ -453,6 +451,11 @@ public static String retriveTracestate() {
      * @return Outbound Traceparent
      */
     public static String generateChildDependencyTraceparent() {
+        Traceparent tp = generateChildDependencyTraceparentObj();
+        return tp == null ? null : tp.toString();
+    }
+
+    public static Traceparent generateChildDependencyTraceparentObj() {
         try {
 
             RequestTelemetryContext context = ThreadContext.getRequestTelemetryContext();
@@ -461,7 +464,7 @@ public static String generateChildDependencyTraceparent() {
             // This is likely worker role scenario, where a worker is trying
             // to create a new outbound call, so generate a new traceparent.
             if (context == null) {
-               return new Traceparent().toString();
+                return new Traceparent();
             }
 
             RequestTelemetry requestTelemetry = context.getHttpRequestTelemetry();
@@ -470,7 +473,7 @@ public static String generateChildDependencyTraceparent() {
             Traceparent tp = new Traceparent(0, traceId, null, context.getTraceflag());
 
             // We need to propagate full blown traceparent header.
-            return tp.toString();
+            return tp;
         }
         catch (Exception ex) {
             InternalLogger.INSTANCE.error("Failed to generate child ID. Exception information: %s", ex.toString());
@@ -485,6 +488,8 @@ public static String generateChildDependencyTraceparent() {
      * @param traceparent
      * @return legacy format traceparent
      */
+    // no longer used, but not removing since public
+    @Deprecated
     public static String createChildIdFromTraceparentString(String traceparent) {
         if (traceparent == null) {
             throw new NullPointerException("traceparent cannot be null");

web/src/test/java/com/microsoft/applicationinsights/web/extensibility/initializers/WebOperationIdTelemetryInitializerTests.java

@@ -22,7 +22,9 @@
 package com.microsoft.applicationinsights.web.extensibility.initializers;
 
 import org.junit.*;
+
 import java.util.List;
+
 import com.microsoft.applicationinsights.TelemetryConfiguration;
 import com.microsoft.applicationinsights.extensibility.context.OperationContext;
 import com.microsoft.applicationinsights.internal.util.DateTimeUtils;
@@ -80,11 +82,7 @@ public void testRequestTelemetryInitializedWithOperationId() throws Exception {
         assertEquals(1, items.size());
         RequestTelemetry requestTelemetry = items.get(0);
 
-        // the WebRequestTrackingModule automatically creates a hierarchical ID for request telemetry of the
-        // following form: "|guid.spanid", where guid is the OperationId
-        String requestTelemetryId = requestTelemetry.getId();
-        requestTelemetryId = requestTelemetryId.substring(0, requestTelemetryId.indexOf('.') + 1);
-        Assert.assertEquals("Operation id not match", requestTelemetryId, "|" + requestTelemetry.getContext().getOperation().getId() + ".");
+        Assert.assertNotNull("Operation id not set", requestTelemetry.getContext().getOperation().getId());
     }
 
     @Test
@@ -94,7 +92,8 @@ public void testTelemetryInitializedWithOperationId() {
 
         OperationContext operationContext = createAndInitializeTelemetry();
 
-        Assert.assertEquals("Operation ID hasn't been set.", context.getHttpRequestTelemetry().getId(), operationContext.getId());
+        Assert.assertEquals("Operation ID hasn't been set.", context.getHttpRequestTelemetry().getId(),
+                operationContext.getId());
     }
 
     @Test

web/src/test/java/com/microsoft/applicationinsights/web/extensibility/modules/WebRequestTrackingTelemetryModuleTests.java

@@ -260,15 +260,13 @@ public void testCrossComponentCorrelationHeadersAreCapturedWhenW3CTurnedOn() thr
         RequestTelemetry requestTelemetry = ThreadContext.getRequestTelemetryContext().getHttpRequestTelemetry();
         assertNotNull(requestTelemetry.getId());
         // spanIds are different
-        String[] id = requestTelemetry.getId().split("[.]");
-        Assert.assertNotEquals(tp.getSpanId(), id[1]);
-        // traceIds are same
-        Assert.assertTrue(requestTelemetry.getId().startsWith(formatedID(tp.getTraceId())));
+        String spanId = requestTelemetry.getId();
+        Assert.assertNotEquals(tp.getSpanId(), spanId);
 
         //validate operation context ID's
         OperationContext operation = requestTelemetry.getContext().getOperation();
         assertEquals(tp.getTraceId(), operation.getId());
-        assertEquals(formatedID(tp.getTraceId() + "." + tp.getSpanId()), operation.getParentId());
+        assertEquals(tp.getSpanId(), operation.getParentId());
 
         //run onEnd
         defaultModule.onEndRequest(request, null);
@@ -310,8 +308,6 @@ public void testLegacyHeadersAreCapturedWhenW3CIsTurnedOn() throws Exception {
         RequestTelemetry requestTelemetry = ThreadContext.getRequestTelemetryContext().getHttpRequestTelemetry();
         assertNotNull(requestTelemetry.getId());
 
-        Assert.assertTrue(requestTelemetry.getId().startsWith("|"+tp.getTraceId()));
-
         //validate operation context ID's
         OperationContext operation = requestTelemetry.getContext().getOperation();
         assertEquals(tp.getTraceId(), operation.getId());
@@ -524,11 +520,6 @@ public void testLegacyHeadersAreNotCapturedWhenW3CIsTurnedOnAndBackPortSwitchIsO
         Assert.assertFalse(requestTelemetry.getContext().getProperties().containsKey("ai_legacyRootID"));
     }
 
-
-    private String formatedID(String id) {
-        return "|" + id + ".";
-    }
-
     @Test
     public void testTelemetryCreatedWithinRequestScopeIsRequestChild() throws Exception {
 

web/src/test/java/com/microsoft/applicationinsights/web/internal/correlation/TraceContextCorrelationTests.java

@@ -47,12 +47,10 @@ public void testTraceparentAreResolved() {
         //validate we have generated proper ID's
         assertNotNull(requestTelemetry.getId());
 
-        assertTrue(requestTelemetry.getId().startsWith(formatedID(t.getTraceId())));
-
         //validate operation context ID's
         OperationContext operation = requestTelemetry.getContext().getOperation();
         assertEquals(t.getTraceId(), operation.getId());
-        assertEquals(formatedID(t.getTraceId() + "." + t.getSpanId()), operation.getParentId());
+        assertEquals(t.getSpanId(), operation.getParentId());
     }
 
     @Test
@@ -73,9 +71,6 @@ public void testCorrelationIdsAreResolvedIfNoTraceparentHeader() {
         OperationContext operation = requestTelemetry.getContext().getOperation();
 
         assertNotNull(requestTelemetry.getId());
-
-        // First trace will have it's own spanId also.
-        assertTrue(requestTelemetry.getId().startsWith(formatedID(operation.getId())));
         assertNull(operation.getParentId());
     }
 
@@ -99,8 +94,6 @@ public void testCorrelationIdsAreResolvedIfTraceparentEmpty() {
         OperationContext operation = requestTelemetry.getContext().getOperation();
 
         assertNotNull(requestTelemetry.getId());
-        // First trace will have it's own spanId also.
-        assertTrue(requestTelemetry.getId().startsWith("|" + operation.getId()));
         assertNull(operation.getParentId());
     }
 
@@ -228,9 +221,4 @@ public static String getRequestSourceValue(String appId) {
 
         return String.format("cid-v1:%s", appId);
     }
-
-    private String formatedID(String id) {
-        return "|" + id + ".";
-    }
-
 }