Distributed Tracing for Entities (Isolated)

src/DurableTask.Core/Entities/ClientEntityHelpers.cs

@@ -18,6 +18,7 @@ namespace DurableTask.Core.Entities
     using Newtonsoft.Json.Linq;
     using Newtonsoft.Json;
     using System;
+    using DurableTask.Core.Tracing;
 
     /// <summary>
     /// Utility functions for clients that interact with entities, either by sending events or by accessing the entity state directly in storage
@@ -32,8 +33,11 @@ public static class ClientEntityHelpers
         /// <param name="operationName">The name of the operation.</param>
         /// <param name="input">The serialized input for the operation.</param>
         /// <param name="scheduledTimeUtc">The time to schedule this signal, or null if not a scheduled signal</param>
+        /// <param name="parentTraceContext">The parent trace context for this operation.</param>
+        /// <param name="requestTime">The time at which the request was made.</param>
+        /// <param name="createTrace">Whether to create a trace for this signal operation.</param>
         /// <returns>The event to send.</returns>
-        public static EntityMessageEvent EmitOperationSignal(OrchestrationInstance targetInstance, Guid requestId, string operationName, string? input, (DateTime Original, DateTime Capped)? scheduledTimeUtc)
+        public static EntityMessageEvent EmitOperationSignal(OrchestrationInstance targetInstance, Guid requestId, string operationName, string? input, (DateTime Original, DateTime Capped)? scheduledTimeUtc, DistributedTraceContext? parentTraceContext = null, DateTimeOffset? requestTime = null, bool createTrace = false)
         {
             var request = new RequestMessage()
             {
@@ -44,6 +48,9 @@ public static EntityMessageEvent EmitOperationSignal(OrchestrationInstance targe
                 Operation = operationName,
                 ScheduledTime = scheduledTimeUtc?.Original,
                 Input = input,
+                ParentTraceContext = parentTraceContext,
+                RequestTime = requestTime,
+                CreateTrace = createTrace,
             };
 
             var eventName = scheduledTimeUtc.HasValue

src/DurableTask.Core/Entities/EventFormat/RequestMessage.cs

@@ -13,6 +13,7 @@
 #nullable enable
 namespace DurableTask.Core.Entities.EventFormat
 {
+    using DurableTask.Core.Tracing;
     using System;
     using System.Runtime.Serialization;
 
@@ -98,6 +99,29 @@ internal class RequestMessage : EntityMessage
         [DataMember]
         public bool IsLockRequest => LockSet != null;
 
+        /// <summary>
+        /// Parent trace context of this request message.
+        /// </summary>
+        [DataMember(Name = "parentTraceContext", EmitDefaultValue = false)]
+        public DistributedTraceContext? ParentTraceContext { get; set; }
+
+        /// <summary>
+        /// Whether or not to create an entity-specific trace for this request message
+        /// </summary>
+        [DataMember(Name = "createTrace")]
+        public bool CreateTrace { get; set; }
+
+        /// <summary>
+        /// The time the request was generated.
+        /// </summary>
+        [DataMember(Name = "requestTime", EmitDefaultValue = false)]
+        public DateTimeOffset? RequestTime { get; set; }
+
+        /// <summary>
+        /// The client span ID of this request.
+        /// </summary>
+        public string? ClientSpanId { get; set; }
+
         /// <inheritdoc/>
         public override string GetShortDescription()
         {

src/DurableTask.Core/Entities/OperationFormat/OperationRequest.cs

@@ -13,6 +13,7 @@
 #nullable enable
 namespace DurableTask.Core.Entities.OperationFormat
 {
+    using DurableTask.Core.Tracing;
     using System;
 
     /// <summary>
@@ -37,5 +38,10 @@ public class OperationRequest
         /// The input for the operation. Can be null if no input was given.
         /// </summary>
         public string? Input { get; set; }
+
+        /// <summary>
+        /// The trace context for the operation, if any.
+        /// </summary>
+        public DistributedTraceContext? TraceContext { get; set; }
     }
 }

src/DurableTask.Core/Entities/OperationFormat/OperationResult.cs

@@ -11,6 +11,8 @@
 //  limitations under the License.
 //  ----------------------------------------------------------------------------------
 #nullable enable
+using System;
+
 namespace DurableTask.Core.Entities.OperationFormat
 {
     /// <summary>
@@ -46,5 +48,15 @@ public bool IsError
         /// this field exclusively when collecting error information.
         /// </summary>
         public FailureDetails? FailureDetails { get; set; }
+
+        /// <summary>
+        /// The start time of the operation.
+        /// </summary>
+        public DateTime? StartTime { get; set; }
+
+        /// <summary>
+        /// The completion time of the operation.
+        /// </summary>
+        public DateTime? EndTime { get; set; }
     }
 }

src/DurableTask.Core/Entities/OperationFormat/SendSignalOperationAction.cs

@@ -13,6 +13,7 @@
 #nullable enable
 namespace DurableTask.Core.Entities.OperationFormat
 {
+    using DurableTask.Core.Tracing;
     using System;
 
     /// <summary>
@@ -45,5 +46,15 @@ public class SendSignalOperationAction : OperationAction
         /// Optionally, a scheduled delivery time for the signal.
         /// </summary>
         public DateTime? ScheduledTime { get; set; }
+
+        /// <summary>
+        /// The time the signal request was generated.
+        /// </summary>
+        public DateTime? RequestTime { get; set; }
+
+        /// <summary>
+        /// The parent trace context for the signal, if any.
+        /// </summary>
+        public DistributedTraceContext? ParentTraceContext { get; set; }
     }
 }

src/DurableTask.Core/Entities/OperationFormat/StartNewOrchestrationOperationAction.cs

@@ -13,6 +13,7 @@
 #nullable enable
 namespace DurableTask.Core.Entities.OperationFormat
 {
+    using DurableTask.Core.Tracing;
     using System;
     using System.Collections.Generic;
 
@@ -52,5 +53,15 @@ public class StartNewOrchestrationOperationAction : OperationAction
         /// </summary>
         public DateTime? ScheduledStartTime { get; set; }
 
+        /// <summary>
+        /// The time of the new orchestration request creation.
+        /// </summary>
+        public DateTime? RequestTime { get; set; }
+
+        /// <summary>
+        /// The parent trace context for the operation, if any.
+        /// </summary>
+        public DistributedTraceContext? ParentTraceContext { get; set; }
+
     }
 }

src/DurableTask.Core/Entities/OrchestrationEntityContext.cs

@@ -228,14 +228,18 @@ public IEnumerable<EntityMessageEvent> EmitLockReleaseMessages()
         /// <param name="operationId">A unique identifier for this request.</param>
         /// <param name="scheduledTimeUtc">A time for which to schedule the delivery, or null if this is not a scheduled message</param>
         /// <param name="input">The operation input</param>
+        /// <param name="requestTime">The time at which the request was made.</param>
+        /// <param name="createTrace">Whether or not to create an entity-specific trace for this event</param>
         /// <returns>The event to send.</returns>
         public EntityMessageEvent EmitRequestMessage(
             OrchestrationInstance target,
             string operationName,
             bool oneWay,
             Guid operationId,
             (DateTime Original, DateTime Capped)? scheduledTimeUtc,
-            string? input)
+            string? input,
+            DateTimeOffset? requestTime = null,
+            bool createTrace = false)
         {
             this.CheckEntitySupport();
 
@@ -248,6 +252,8 @@ public EntityMessageEvent EmitRequestMessage(
                 Operation = operationName,
                 ScheduledTime = scheduledTimeUtc?.Original,
                 Input = input,
+                RequestTime = requestTime,
+                CreateTrace = createTrace,
             };
 
             this.AdjustOutgoingMessage(target.InstanceId, request, scheduledTimeUtc?.Capped, out string eventName);

src/DurableTask.Core/OrchestrationTags.cs

@@ -36,6 +36,26 @@ public static class OrchestrationTags
         /// </remarks>
         public const string FireAndForget = "FireAndForget";
 
+        /// <summary>
+        /// The ID of the parent trace that created this orchestration instance (see https://www.w3.org/TR/trace-context/#traceparent-header)
+        /// </summary>
+        public const string TraceParent = "MS_Entities_TraceParent";
+
+        /// <summary>
+        /// The trace state of the parent trace that created this orchestration instance (see https://www.w3.org/TR/trace-context/#tracestate-header)
+        /// </summary>
+        public const string TraceState = "MS_Entities_TraceState";
+
+        /// <summary>
+        /// The time the request for a new orchestration was created.
+        /// </summary>
+        public const string RequestTime = "MS_Entities_RequestTime";
+
+        /// <summary>
+        /// Whether or not to create a trace for the <see cref="DurableTask.Core.History.ExecutionStartedEvent"/> of the orchestration
+        /// </summary>
+        public const string CreateTraceForNewOrchestration = "MS_CreateTrace";
+
         /// <summary>
         /// Check whether the given tags contain the fire and forget tag
         /// </summary>