Repository navigation
.NET: [BREAKING] align workflow span name with OpenTelemetry conventions - #9899
Vincent Biret (baywet) wants to merge 1 commit into
Conversation
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: fa592ce6-05c6-4421-801b-59c77df4b2df
There was a problem hiding this comment.
🟢 Approval recommended
The workflow invocation span-name correction has no active review issues.
No open issues 🎉
What changed in this PR
Corrects the .NET workflow invocation span name from workflow_invoke to invoke_workflow to align with OpenTelemetry conventions. Telemetry filters using the old name will need updating.
Changes:
- Updates the shared span-name constant and declarative telemetry expectation.
- Adds six regression cases covering streaming and non-streaming execution across Lockstep, OffThread, and Concurrent environments.
- Aligns API documentation and existing test comments with the corrected name.
| File | Description |
|---|---|
dotnet/tests/Microsoft.Agents.AI.Workflows.UnitTests/WorkflowRunActivityStopTests.cs |
Updates comments only to use the corrected span name. |
dotnet/tests/Microsoft.Agents.AI.Workflows.UnitTests/ObservabilityTests.cs |
Adds six cases asserting the literal convention name. |
dotnet/tests/Microsoft.Agents.AI.Workflows.Declarative.UnitTests/DeclarativeWorkflowOptionsTest.cs |
Updates the expected invocation span name. |
dotnet/src/Microsoft.Agents.AI.Workflows/Observability/WorkflowTelemetryOptions.cs |
Corrects the span name in API documentation. |
dotnet/src/Microsoft.Agents.AI.Workflows/Observability/ActivityNames.cs |
Changes the shared invocation span-name constant. |
Review effort: Balanced
There was a problem hiding this comment.
MAF Automated Review — Iteration 1
Result: No findings
Scope: full PR (1 commit(s)): c0fa63f0d9bb
Model: gpt-5.6-sol
Overview
The PR centralizes the corrected invoke_workflow activity name in the existing internal constant and updates its public documentation and declarative expectation consistently. The new regression covers streaming and non-streaming runs across Lockstep, OffThread, and Concurrent execution, while existing tests preserve activity enablement, routing, and disposal guarantees. No PR-introduced Critical, High, or Medium defect remains after reconciliation.
Reviewed the supplied pull-request change set across correctness, security/reliability, architecture, and failure behavior.
No publishable findings remained after source verification for this scope.
Code coverage overviewLanguages: C# C# / code-coverage/dotnet
View coverage of the 1 most impacted file.
ℹ️ Calculations represent line coverage. Results may change as calculations are updated. |
Motivation & Context
Workflow invocation spans currently use
workflow_invokeinstead ofinvoke_workflow, the name specified by the OpenTelemetry GenAI workflow span conventions. Correct the name so telemetry consumers can identify workflow invocations consistently.Description & Review Guide
invoke_workflow; execution, span lifetime, and public API signatures are unchanged. Telemetry filters using the incorrect old name must be updated.workflow_invoke.From
dotnet, the following commands passed:The full solution test suite was not run.
Related Issue
N/A - trivial change: correct an unambiguous span-name mismatch with the linked specification. No competing open span-name PR was found.
AI Assistance
AI assistance details: GitHub Copilot assisted with implementation, regression tests, documentation, validation, and this PR description.
Contribution Checklist
breaking changelabel (or add "[BREAKING]" to the title prefix, before or after any language prefix) — a workflow keeps the label and title prefix in sync automatically.