.NET: Workflows: the span tag `message.type` collides with the obsoleted OpenTelemetry RPC attribute of the same name
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 55/100
- Issue type
- Bug
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- csharp
- Domain
- observability
Research direction
The tag name is declared in dotnet/src/Microsoft.Agents.AI.Workflows/Observability/Tags.cs around line 20, and it is set on the executor.process span in WorkflowTelemetryContext.cs around line 146. Start there, then search the .NET tests for the literal message.type to find assertions that also need updating. Done means the tag uses a library-owned name such as executor.message.type, every reference and test uses it, and the new name is confirmed with a maintainer first.
Written by the indexing model from the issue text.
Description
Summary
Microsoft.Agents.AI.Workflows sets the span tag message.type to the .NET type name of the message being processed. message.type is a registered OpenTelemetry semantic-convention attribute: the RPC message-event key with the enum values SENT / RECEIVED, deprecated as obsoleted in semantic-conventions 1.44.0 (model/rpc/deprecated/registry-deprecated.yaml). A registry-driven pipeline therefore treats the workflow tag as the obsoleted RPC key: Weaver live-check reports it as a deprecated attribute carrying a value outside its enum, and a collector that follows the registry drops it. The message type never reaches a backend.
Where (tag dotnet-1.24.0)
dotnet/src/Microsoft.Agents.AI.Workflows/Observability/Tags.cs:20declaresmessage.type.dotnet/src/Microsoft.Agents.AI.Workflows/Observability/WorkflowTelemetryContext.cs:146sets it onexecutor.process.
Why only this tag
The other workflow tags live in namespaces upstream does not define (workflow.*, executor.*, edge_group.*, message.content, message.source_id, message.target_id), so a downstream registry can declare them as library-owned keys and pass them through. message.type is the one tag that cannot be declared, because the catalog already carries the upstream key of that name with a different meaning. (session.id, error.type and error.message also collide, but their meaning matches upstream's, so they pass as the upstream keys.)
Ask
Give the tag a library-owned name, for example executor.message.type or workflow.message.type, the way the executor and edge-group tags already are. Longer term, prefixing all of message.* (workflow.message.*) would keep the library clear of the deprecated RPC message.* keys entirely.
Context
We maintain a Weaver registry that layers the GenAI conventions and library-owned keys for .NET instrumentation, and declare the workflow tags there as pass-through keys: https://github.com/ANcpLua/Qyl.OpenTelemetry.SemanticConventions/blob/main/registry/vendor/microsoft-agents-ai-workflows.yaml. Happy to send a PR for the rename if the direction is agreed.
- Dominant language
- Python
- Stars
- 14k
- Forks
- 2.5k
- Avg merge
- 1d 20h
- Merged PRs (30d)
- 370
Getting set up
Starts the project's dev container in your browser, under your own GitHub account.
- No Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from microsoft/agent-framework
-
.NET python triage
Difficulty 1/5 Under an hour Newbie friendliness 85/100
microsoft/agent-framework#9092 · 1 comment ·
Maintainers usually reply within 1 day
-
Python: raw-data content mappings lose annotations and attachment metadataPossibly taken @moonbox3 claimed this 12 days ago. Openpython triage
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
microsoft/agent-framework#8632 · 2 comments ·
Maintainers usually reply within 1 day
-
Python: Clarify when to use platformPossibly taken @eavanvalkenburg claimed this 11 days ago. Openpython triage
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
microsoft/agent-framework#8599 · 1 comment ·
Maintainers usually reply within 1 day
-
.NET Compaction - Update docs to refer to `AIContextProvider` deep divePossibly taken A pull request linked to this issue is open or already merged. Open.NET compaction documentation
Difficulty 1/5 Under an hour Newbie friendliness 82/100
microsoft/agent-framework#4629 · 1 comment ·
Maintainers usually reply within 1 day
-
Python: [Bug]: After a checkpoint restore, a sub-workflow re-emits a pending request while handling a sibling response, so later restores keep asking for an already-answered requestPossibly taken @eavanvalkenburg claimed this today. Openpython reproduced workflows
microsoft/agent-framework#9270 · 2 comments · 1 assignee ·
Maintainers usually reply within 1 day
All issues in microsoft/agent-framework
Similar issues
-
Difficulty 1/5 Under an hour Newbie friendliness 82/100
esphome/esphome.io#7657 ·
Maintainers usually reply within 1 day
-
comp/gateway comp/plugins duplicate P3 type/bug
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
NousResearch/hermes-agent#137019 ·
Maintainers usually reply within 1 day
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Maintainers usually reply within 1 day
-
Kumo-Tabular weights unreachable behind restrictive egress proxies (Xet + plain HTTP both fail)Open
Difficulty 2/5 1-3 hours Newbie friendliness 67/100
NVIDIA/structured-data-models#1091 ·
Maintainers usually reply within 1 day
-
[work-item] adam-adae-worsening-emergence: conform spec.yaml to the specification style contract (REQ-1280)Possibly taken @muse-yamaa-bot claimed this today. Openwork-item
Difficulty 1/5 1-3 hours Newbie friendliness 82/100
Maintainers usually reply within 1 day