Open
Conversation
Entity operations triggered from orchestrations don't propagate distributed trace context because SendEntityMessageAction lacks a parentTraceContext field. This causes entity operations to appear disconnected from their parent orchestration traces. Changes: - Vendor updated proto with parentTraceContext field on SendEntityMessageAction (see microsoft/durabletask-protobuf#64) - Set ParentTraceContext in ProtoUtils.ConstructOrchestratorResponse for entity message actions (matching existing behavior for tasks and sub-orchestrations) - Add unit tests for entity trace context propagation Note: A corresponding server-side change is also needed in the Durable Task Scheduler backend to propagate SendEntityMessageAction.ParentTraceContext to OperationRequest.traceContext on entity work items. Fixes #653
Contributor
There was a problem hiding this comment.
Pull request overview
This PR fixes a distributed tracing gap where entity operations dispatched from orchestrations lacked trace context propagation. Without ParentTraceContext on SendEntityMessageAction, entity spans appeared as disconnected root traces in distributed trace viewers (e.g., Aspire Dashboard, Jaeger) rather than as children of the orchestration that triggered them.
Changes:
- Added
parentTraceContextfield (field 5) to theSendEntityMessageActionproto message, consistent withScheduleTaskActionandCreateSubOrchestrationAction - Set
ParentTraceContext = CreateTraceContext()inProtoUtils.ConstructOrchestratorResponsefor entity message actions, matching the existing behavior for activities and sub-orchestrations - Added unit tests verifying trace context propagation for signal/call entity, null-activity fallback, non-entity-converted actions, and unique span ID generation
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
src/Grpc/orchestrator_service.proto |
Adds parentTraceContext field (index 5) to SendEntityMessageAction |
src/Shared/Grpc/ProtoUtils.cs |
Sets ParentTraceContext on entity message actions; incidental character encoding change in unrelated comments |
test/Worker/Grpc.Tests/ProtoUtilsTraceContextTests.cs |
New test class covering trace context propagation for entity operations |
Comment on lines
1059
to
+1068
| @@ -1063,7 +1065,7 @@ internal static T Base64Decode<T>(this MessageParser parser, string encodedMessa | |||
| } | |||
| } | |||
|
|
|||
| // If the value starts with the 'dto:' prefix, it may represent a DateTime value � attempt to parse it. | |||
| // If the value starts with the 'dto:' prefix, it may represent a DateTime value � attempt to parse it. | |||
There was a problem hiding this comment.
The comment at this line (and line 1068) contains a Unicode replacement character (U+FFFD, rendered as ?) where there was previously a dash character (likely an en-dash –). This is a character encoding corruption introduced by this PR and should be replaced with the intended dash character or a plain hyphen-minus (-) to ensure the source file has clean encoding.
…quest Add parentTraceContext fields to EntityOperationSignaledEvent and EntityOperationCalledEvent proto messages, and extract them in ToEntityBatchRequest to populate OperationRequest.TraceContext. This is the receiving side of the trace context propagation: once the DTS backend populates parentTraceContext on entity operation events (from SendEntityMessageAction.ParentTraceContext), the SDK will correctly extract and use the trace context for entity operations.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Entity operations triggered from orchestrations don't propagate distributed trace context because
SendEntityMessageActionlacks aparentTraceContextfield, and entity operation events (EntityOperationSignaledEvent,EntityOperationCalledEvent) also lack this field. This causes entity operations to appear disconnected from their parent orchestration traces in distributed tracing tools.Changes
Proto updates (see microsoft/durabletask-protobuf#64)
parentTraceContextfield toSendEntityMessageActionparentTraceContextfield toEntityOperationSignaledEventandEntityOperationCalledEventSDK sending side
ParentTraceContextinProtoUtils.ConstructOrchestratorResponsefor entity message actions, matching existing behavior for tasks and sub-orchestrationsSDK receiving side
parentTraceContextfromEntityOperationSignaledEvent/EntityOperationCalledEventinToEntityBatchRequest, populatingOperationRequest.TraceContextTests
Merge note
Follow-up work
SendEntityMessageAction.ParentTraceContexttoEntityOperationSignaledEvent/CalledEvent.ParentTraceContexton entity operation events.OnRunEntityBatchAsync) needs span creation for entity operations to complete the distributed tracing story.Fixes #653