Adding IKey and EndpointAddress in the ApplicationInsights Transmission Status log. (#9705)

Adding IKey and EndpointAddress in the log.

Author: RohitRanjanMS

src/WebJobs.Script/Config/TransmissionStatusHandler.cs

@@ -44,6 +44,10 @@ internal static string FormattedLog(object sender, TransmissionStatusEventArgs a
                             Count = n.Count()
                         });
 
+            // Log all the unique ikeys in the transmission, avoid storing the complete key.
+            IEnumerable<string> iKeys = transmission?.TelemetryItems.GroupBy(n => n.Context.InstrumentationKey)
+                                        .Select(n => n.Key.Length > 24 ? $"{n.Key[..24]}************" : n.Key);
+
             IngestionServiceResponse response = null;
             if (!string.IsNullOrWhiteSpace(args?.Response?.Content))
             {
@@ -70,7 +74,9 @@ internal static string FormattedLog(object sender, TransmissionStatusEventArgs a
                 ErrorMessage = topErrorMessage,
                 ErrorCode = topStatusCode,
                 ResponseTimeInMs = args?.ResponseDurationInMs,
-                RetryAfterHeader = args?.Response?.RetryAfterHeader
+                RetryAfterHeader = args?.Response?.RetryAfterHeader,
+                EndpointAddress = transmission?.EndpointAddress.OriginalString,
+                IKeys = iKeys
             };
             return JsonSerializer.Serialize(log, LogMessageContext.Default.LogMessage);
         }
@@ -136,7 +142,11 @@ internal class LogMessage
 
         public string RetryAfterHeader { get; set; }
 
+        public string EndpointAddress { get; set; }
+
         public IEnumerable<TelemetryItem> Items { get; set; }
+
+        public IEnumerable<string> IKeys { get; set; }
     }
 
     internal class TelemetryItem

test/WebJobs.Script.Tests/Configuration/TransmissionStatusHandlerTest.cs

@@ -100,5 +100,49 @@ public void FormattedLog_Success()
             Assert.Equal(3, log["items"].Count());
             Assert.Null(log.Value<string>("errorMessage"));
         }
+
+        [Fact]
+        public void FormattedLog_InstrumentationKeys()
+        {
+            TransmissionStatusHandler handler = new();
+            var request1 = new RequestTelemetry();
+            request1.Context.InstrumentationKey = "AAAAA-AAAAAAAAAA-AAAAAAAA-AAAAAAAA";
+
+            var request2 = new RequestTelemetry();
+            request2.Context.InstrumentationKey = "CCCCC-CCCCCCCCCCCCCCCCC-";
+
+            var trace1 = new TraceTelemetry();
+            trace1.Context.InstrumentationKey = "BBBBB-BBBBBBBBB-BBBBBBBBBBB-BBBBBBB";
+
+            var trace2 = new TraceTelemetry();
+            trace2.Context.InstrumentationKey = "BBBBB-BBBBBBBBB-BBBBBBBBBBB-BBBBBBB";
+
+            Transmission transmission = new(new("https://test"), new List<ITelemetry>() { request1, request2, trace1, trace2 }, new TimeSpan(500));
+            IngestionServiceResponse backendResponse = new()
+            {
+                ItemsAccepted = 100,
+                ItemsReceived = 100
+            };
+            HttpWebResponseWrapper response = new()
+            {
+                StatusCode = 200,
+                StatusDescription = "ok",
+                Content = JsonConvert.SerializeObject(backendResponse, new JsonSerializerSettings { ContractResolver = new CamelCasePropertyNamesContractResolver() })
+            };
+
+            TransmissionStatusEventArgs args = new(response, 100);
+            JObject log = JsonConvert.DeserializeObject<JObject>(TransmissionStatusHandler.FormattedLog(transmission, args));
+
+            Assert.Equal(200, log.Value<int>("statusCode"));
+            Assert.Equal("https://test", log.Value<string>("endpointAddress"));
+            Assert.Equal("ok", log.Value<string>("statusDescription"));
+            Assert.Equal(100, log.Value<int>("responseTimeInMs"));
+            Assert.True(log.ContainsKey("id"));
+            Assert.Equal(2, log["items"].Count());
+            Assert.Equal(3, log["iKeys"].Count());
+            Assert.Null(log.Value<string>("errorMessage"));
+            string keys = log["iKeys"].ToString();
+            Assert.True(keys.Contains("AAAAA-AAAAAAAAAA-AAAAAAA************") && keys.Contains("BBBBB-BBBBBBBBB-BBBBBBBB************") && keys.Contains("CCCCC-CCCCCCCCCCCCCCCCC-"));
+        }
     }
 }