Merge pull request #464 from XiaoliangHuang/FixBug462-TelemetryNamingMissInstrumentationKey

dhaval24 · web-flow · commit 0e2fe37143ad · 2017-11-27T09:36:30.000-08:00
Merging Fix bug462 telemetry naming miss instrumentation key.
diff --git a/core/src/main/java/com/microsoft/applicationinsights/telemetry/BaseTelemetry.java b/core/src/main/java/com/microsoft/applicationinsights/telemetry/BaseTelemetry.java
@@ -33,13 +33,17 @@
 import java.util.concurrent.ConcurrentHashMap;
 import java.util.concurrent.ConcurrentMap;
 
+import org.apache.commons.lang3.StringUtils;
+
 /**
  * Superclass for all telemetry data classes.
  */
 public abstract class BaseTelemetry<T extends Domain> implements Telemetry {
     private TelemetryContext context;
     private Date timestamp;
     private String sequence;
+    
+    private final String TELEMETRY_NAME_PREFIX = "Microsoft.ApplicationInsights.";
 
     protected BaseTelemetry() {
     }
@@ -139,9 +143,12 @@ public void sanitize() {
      */
     @Override
     public void serialize(JsonTelemetryDataSerializer writer) throws IOException {
-
+    	
+    	String telemetryName = this.getTelemetryName(
+    			this.normalizeInstrumentationKey(context.getInstrumentationKey()), this.getEnvelopName());
+    	
         Envelope envelope = new Envelope();
-        envelope.setName(this.getEnvelopName());
+        envelope.setName(telemetryName);
 
         setSampleRate(envelope);
         envelope.setIKey(context.getInstrumentationKey());
@@ -184,4 +191,23 @@ protected String getEnvelopName() {
     protected String getBaseTypeName() {
         throw new UnsupportedOperationException();
     }
+    
+    private String normalizeInstrumentationKey(String instrumentationKey){
+    	if (StringUtils.isEmpty(instrumentationKey) || StringUtils.containsOnly(instrumentationKey, ".- ")){
+    		return "";
+    	}
+    	else{
+    		return instrumentationKey.replace("-", "").toLowerCase() + ".";
+    	}
+    }
+    
+    private String getTelemetryName(String normalizedInstrumentationKey, String envelopType){
+    	return String.format(
+    			"%s%s%s",
+    			TELEMETRY_NAME_PREFIX,
+    			normalizedInstrumentationKey,
+    			envelopType
+    			);
+    }
+    
 }
diff --git a/core/src/main/java/com/microsoft/applicationinsights/telemetry/EventTelemetry.java b/core/src/main/java/com/microsoft/applicationinsights/telemetry/EventTelemetry.java
@@ -37,7 +37,7 @@ public final class EventTelemetry extends BaseSampleSourceTelemetry<EventData> {
     /**
      * Envelope Name for this telemetry.
      */
-    private static final String ENVELOPE_NAME = "Microsoft.ApplicationInsights.Event";
+    private static final String ENVELOPE_NAME = "Event";
 
 
     /**
diff --git a/core/src/main/java/com/microsoft/applicationinsights/telemetry/ExceptionTelemetry.java b/core/src/main/java/com/microsoft/applicationinsights/telemetry/ExceptionTelemetry.java
@@ -42,7 +42,7 @@ public final class ExceptionTelemetry extends BaseSampleSourceTelemetry<Exceptio
     /**
      * Envelope Name for this telemetry.
      */
-    private static final String ENVELOPE_NAME = "Microsoft.ApplicationInsights.Exception";
+    private static final String ENVELOPE_NAME = "Exception";
 
 
     /**
diff --git a/core/src/main/java/com/microsoft/applicationinsights/telemetry/MetricTelemetry.java b/core/src/main/java/com/microsoft/applicationinsights/telemetry/MetricTelemetry.java
@@ -37,7 +37,7 @@ public final class MetricTelemetry extends BaseTelemetry<MetricData> {
     /**
      * Envelope Name for this telemetry.
      */
-    private static final String ENVELOPE_NAME = "Microsoft.ApplicationInsights.Metric";
+    private static final String ENVELOPE_NAME = "Metric";
 
 
     /**
diff --git a/core/src/main/java/com/microsoft/applicationinsights/telemetry/PageViewTelemetry.java b/core/src/main/java/com/microsoft/applicationinsights/telemetry/PageViewTelemetry.java
@@ -40,7 +40,7 @@ public final class PageViewTelemetry extends BaseSampleSourceTelemetry<PageViewD
     /**
      * Envelope Name for this telemetry.
      */
-    private static final String ENVELOPE_NAME = "Microsoft.ApplicationInsights.PerformanceCounter";
+    private static final String ENVELOPE_NAME = "PerformanceCounter";
 
 
     /**
diff --git a/core/src/main/java/com/microsoft/applicationinsights/telemetry/PerformanceCounterTelemetry.java b/core/src/main/java/com/microsoft/applicationinsights/telemetry/PerformanceCounterTelemetry.java
@@ -34,7 +34,7 @@ public final class PerformanceCounterTelemetry extends BaseTelemetry<Performance
     /**
      * Envelope Name for this telemetry.
      */
-    private static final String ENVELOPE_NAME = "Microsoft.ApplicationInsights.PerformanceCounter";
+    private static final String ENVELOPE_NAME = "PerformanceCounter";
 
 
     /**
diff --git a/core/src/main/java/com/microsoft/applicationinsights/telemetry/RemoteDependencyTelemetry.java b/core/src/main/java/com/microsoft/applicationinsights/telemetry/RemoteDependencyTelemetry.java
@@ -39,7 +39,7 @@ public final class RemoteDependencyTelemetry extends BaseSampleSourceTelemetry<R
     /**
      * Envelope Name for this telemetry.
      */
-    private static final String ENVELOPE_NAME = "Microsoft.ApplicationInsights.RemoteDependency";
+    private static final String ENVELOPE_NAME = "RemoteDependency";
 
 
     /**
diff --git a/core/src/main/java/com/microsoft/applicationinsights/telemetry/RequestTelemetry.java b/core/src/main/java/com/microsoft/applicationinsights/telemetry/RequestTelemetry.java
@@ -46,7 +46,7 @@ public final class RequestTelemetry extends BaseSampleSourceTelemetry<RequestDat
     /**
      * Envelope Name for this telemetry.
      */
-    private static final String ENVELOPE_NAME = "Microsoft.ApplicationInsights.Request";
+    private static final String ENVELOPE_NAME = "Request";
 
 
     /**
diff --git a/core/src/main/java/com/microsoft/applicationinsights/telemetry/SessionStateTelemetry.java b/core/src/main/java/com/microsoft/applicationinsights/telemetry/SessionStateTelemetry.java
@@ -34,7 +34,7 @@ public final class SessionStateTelemetry extends BaseTelemetry<SessionStateData>
     /**
      * Envelope Name for this telemetry.
      */
-    private static final String ENVELOPE_NAME = "Microsoft.ApplicationInsights.SessionState";
+    private static final String ENVELOPE_NAME = "SessionState";
 
 
     /**
diff --git a/core/src/main/java/com/microsoft/applicationinsights/telemetry/TraceTelemetry.java b/core/src/main/java/com/microsoft/applicationinsights/telemetry/TraceTelemetry.java
@@ -34,7 +34,7 @@ public final class TraceTelemetry extends BaseSampleSourceTelemetry<MessageData>
     /**
      * Envelope Name for this telemetry.
      */
-    private static final String ENVELOPE_NAME = "Microsoft.ApplicationInsights.Message";
+    private static final String ENVELOPE_NAME = "Message";
 
 
     /**
diff --git a/core/src/test/java/com/microsoft/applicationinsights/internal/schemav2/SessionStateDataTest.java b/core/src/test/java/com/microsoft/applicationinsights/internal/schemav2/SessionStateDataTest.java
@@ -66,7 +66,7 @@ private static void verifyEnvelope(SessionStateData sessionStateData, SessionSta
         String expectedDataAsString = String.format("\"data\":{\"baseType\":\"SessionStateData\",\"baseData\":{\"ver\":2,\"state\":\"%s\"}}", expectedState.toString());
         int index = asJson.indexOf(expectedDataAsString);
         assertTrue(index != -1);
-        index = asJson.indexOf("\"name\":\"Microsoft.ApplicationInsights.SessionState\"");
+        index = asJson.indexOf("\"name\":\"SessionState\"");
         assertTrue(index != -1);
     }
 }
diff --git a/core/src/test/java/com/microsoft/applicationinsights/telemetry/BaseTelemetryTest.java b/core/src/test/java/com/microsoft/applicationinsights/telemetry/BaseTelemetryTest.java
@@ -23,11 +23,16 @@
 
 import com.microsoft.applicationinsights.internal.schemav2.Data;
 import com.microsoft.applicationinsights.internal.schemav2.Domain;
+import com.microsoft.applicationinsights.internal.schemav2.Envelope;
+import com.microsoft.applicationinsights.internal.schemav2.SessionStateData;
+
 import org.junit.Test;
 
 import java.io.IOException;
+import java.io.StringWriter;
 import java.util.Date;
 import java.util.concurrent.ConcurrentHashMap;
+import java.util.concurrent.ConcurrentMap;
 
 import static org.junit.Assert.assertTrue;
 import static org.junit.Assert.assertNull;
@@ -43,7 +48,13 @@ public void serialize(JsonTelemetryDataSerializer serializer) throws IOException
     }
 
     private static class StubTelemetry extends BaseTelemetry<StubDomainData> {
-        public int numberOfCallsToAdditionalSanitize;
+        
+        private static final String ENVELOPE_NAME = "Stub";
+
+        private static final String BASE_TYPE = "StubData";
+    	
+    	public int numberOfCallsToAdditionalSanitize;
+        
 
         public StubTelemetry() {
         }
@@ -61,6 +72,16 @@ protected void additionalSanitize() {
         protected StubDomainData getData() {
             return null;
         }
+        
+        @Override
+        public String getEnvelopName() {
+            return ENVELOPE_NAME;
+        }
+
+        @Override
+        public String getBaseTypeName() {
+            return BASE_TYPE;
+        }
     }
 
     @Test
@@ -103,5 +124,54 @@ public void testSetTimestamp() {
 
         assertEquals(telemetry.getTimestamp(), date);
     }
+    
+    
+    @Test
+    public void testTelemetryNameWithIkey() throws IOException{
+    	StubTelemetry telemetry = new StubTelemetry("Test Base Telemetry");
+    	telemetry.getContext().setInstrumentationKey("AIF-00000000-1111-2222-3333-000000000000");
+    	telemetry.setTimestamp(new Date());
+    	
+        StringWriter writer = new StringWriter();
+        JsonTelemetryDataSerializer jsonWriter = new JsonTelemetryDataSerializer(writer);
+        telemetry.serialize(jsonWriter);
+        jsonWriter.close();
+        String asJson = writer.toString();
+
+        int index = asJson.indexOf("\"name\":\"Microsoft.ApplicationInsights.aif00000000111122223333000000000000.Stub\"");
+        assertTrue(index != -1);
+    }
+    
+    @Test
+    public void testTelemetryNameWithIkey_SpecialChar() throws IOException{
+    	StubTelemetry telemetry = new StubTelemetry("Test Base Telemetry");
+    	telemetry.getContext().setInstrumentationKey("--. .--");
+    	telemetry.setTimestamp(new Date());
+    	
+        StringWriter writer = new StringWriter();
+        JsonTelemetryDataSerializer jsonWriter = new JsonTelemetryDataSerializer(writer);
+        telemetry.serialize(jsonWriter);
+        jsonWriter.close();
+        String asJson = writer.toString();
+
+        int index = asJson.indexOf("\"name\":\"Microsoft.ApplicationInsights.Stub\"");
+        assertTrue(index != -1);
+    }
+    
+    @Test
+    public void testTelemetryNameWithIkey_Empty() throws IOException{
+    	StubTelemetry telemetry = new StubTelemetry("Test Base Telemetry");
+    	telemetry.setTimestamp(new Date());
+    	
+        StringWriter writer = new StringWriter();
+        JsonTelemetryDataSerializer jsonWriter = new JsonTelemetryDataSerializer(writer);
+        telemetry.serialize(jsonWriter);
+        jsonWriter.close();
+        String asJson = writer.toString();
+
+        int index = asJson.indexOf("\"name\":\"Microsoft.ApplicationInsights.Stub\"");
+        assertTrue(index != -1);
+    }
+    
 
 }
