Merge pull request #1519 from Azure/dev

Promoting dev to master for 2.3.1 release, now with fixed CI test and extra logging fields

Author: davidmrdavid

src/WebJobs.Extensions.DurableTask/LinuxAppServiceLogger.cs

@@ -35,8 +35,9 @@ internal class LinuxAppServiceLogger
         // logging metadata
         private readonly JToken roleInstance;
         private readonly JToken tenant;
-        private readonly JToken sourceMoniker;
         private readonly JToken procID;
+        private readonly string stamp;
+        private readonly string primaryStamp;
 
         // if true, we write to console (linux consumption), else to a file (linux dedicated).
         private readonly bool writeToConsole;
@@ -58,9 +59,11 @@ public LinuxAppServiceLogger(
             this.writeToConsole = writeToConsole;
             this.roleInstance = JToken.FromObject("App-" + containerName);
             this.tenant = JToken.FromObject(tenant);
+            this.stamp = stampName;
+
+            var finalCharIndex = stampName.Length - 1;
+            this.primaryStamp = char.IsLetter(stampName[finalCharIndex]) ? stampName.Remove(finalCharIndex) : stampName;
 
-            this.sourceMoniker = JToken.FromObject(
-                string.IsNullOrEmpty(stampName) ? string.Empty : "L" + stampName.Replace("-", "").ToUpperInvariant());
             using (var process = Process.GetCurrentProcess())
             {
                 this.procID = process.Id;
@@ -97,6 +100,10 @@ private string GenerateJsonStr(EventWrittenEventArgs eventData)
             // We pack them into a JSON
             JObject json = new JObject
             {
+                { "EventStampName", this.stamp },
+                { "EventPrimaryStampName", this.primaryStamp },
+                { "ProviderName", eventData.EventSource.Name },
+                { "TaskName", eventData.EventName },
                 { "EventId", eventData.EventId },
                 { "TimeStamp", DateTime.UtcNow },
                 { "RoleInstance", this.roleInstance },
@@ -105,11 +112,23 @@ private string GenerateJsonStr(EventWrittenEventArgs eventData)
                 { "Tid", Thread.CurrentThread.ManagedThreadId },
             };
 
+            // Add payload elements
             for (int i = 0; i < values.Count; i++)
             {
                 json.Add(keys[i], JToken.FromObject(values[i]));
             }
 
+            // Add ActivityId and RelatedActivityId, if non-null
+            if (!eventData.ActivityId.Equals(Guid.Empty))
+            {
+                json.Add("ActivityId", eventData.ActivityId);
+            }
+
+            if (!eventData.RelatedActivityId.Equals(Guid.Empty))
+            {
+                json.Add("RelatedActivityId", eventData.RelatedActivityId);
+            }
+
             // Generate string-representation of JSON. Also remove newlines.
             string jsonString = json.ToString(Newtonsoft.Json.Formatting.None);
             jsonString = jsonString.Replace("\n", "\\n").Replace("\r", "\\r");

test/Common/DurableTaskEndToEndTests.cs

@@ -371,9 +371,10 @@ public async Task RemovesNewlinesFromExceptions()
         /// this test checks our JSON logs satisfy a minimal set of requirements:
         /// (1) Is JSON parseable
         /// (2) Contains minimal expected fields: EventId, TimeStamp, RoleInstance,
-        ///     Tenant, SourceMoniker, Pid, Tid.
+        ///     Tenant, SourceMoniker, Pid, Tid, etc.
         /// (3) Ensure some Enums are printed correctly.
         /// (4) That we have logs from a variety of EventSource providers.
+        /// (5) Ensure ActivityId and RelatedActivityId are eventually present.
         /// </summary>
         [Fact]
         [Trait("Category", PlatformSpecificHelpers.TestCategory)]
@@ -420,6 +421,9 @@ public async Task OutputsValidJSONLogs()
             bool foundEtwEventSourceLog = false;
             bool foundDurableTaskCoreLog = false;
 
+            bool foundActivityId = false;
+            bool foundRelatedActivityId = false;
+
             // Validating JSON outputs
             foreach (string line in lines)
             {
@@ -428,11 +432,14 @@ public async Task OutputsValidJSONLogs()
 
                 // (2) Contains minimal expected fields
                 List<string> keys = json.Properties().Select(p => p.Name).ToList();
+                Assert.Contains("EventStampName", keys);
+                Assert.Contains("EventPrimaryStampName", keys);
+                Assert.Contains("ProviderName", keys);
+                Assert.Contains("TaskName", keys);
                 Assert.Contains("EventId", keys);
                 Assert.Contains("TimeStamp", keys);
                 Assert.Contains("RoleInstance", keys);
                 Assert.Contains("Tenant", keys);
-                Assert.Contains("SourceMoniker", keys);
                 Assert.Contains("Pid", keys);
                 Assert.Contains("Tid", keys);
 
@@ -451,6 +458,18 @@ public async Task OutputsValidJSONLogs()
                     foundAzureStorageLog = true;
                 }
 
+                // recording if ActivityId and RelatedActivityId are seen
+                // we expect to see them, at some point, in a trivial orchestrator
+                if (keys.Contains("ActivityId"))
+                {
+                    foundActivityId = true;
+                }
+
+                if (keys.Contains("RelatedActivityId"))
+                {
+                    foundRelatedActivityId = true;
+                }
+
                 // (3) Ensure some Enums are printed correctly: as strings
                 string eventType = (string)json.GetValue("EventType");
                 if (!string.IsNullOrEmpty(eventType))
@@ -464,6 +483,10 @@ public async Task OutputsValidJSONLogs()
             Assert.True(foundEtwEventSourceLog);
             Assert.True(foundDurableTaskCoreLog);
 
+            // (5) Ensure ActivityId and RelatedActivityId are present in logs
+            Assert.True(foundActivityId);
+            Assert.True(foundRelatedActivityId);
+
             // To ensure other tests generate the path
             File.Delete(LinuxAppServiceLogger.LoggingPath);
         }