Skip to content

Document github.copilot.* OTel attribute namespace#9834

Merged
zhichli merged 1 commit into
mainfrom
zhichli/otel-namespace-docs
May 27, 2026
Merged

Document github.copilot.* OTel attribute namespace#9834
zhichli merged 1 commit into
mainfrom
zhichli/otel-namespace-docs

Conversation

@zhichli
Copy link
Copy Markdown
Member

@zhichli zhichli commented May 27, 2026

Expand the agent OpenTelemetry monitoring guide to cover the canonical `github.copilot.*` attribute namespace landed in microsoft/vscode#318031.

The namespace is shared with the GitHub Copilot CLI OpenTelemetry conventions, so a single set of dashboards and alerts can now cover both surfaces.

What's new

  • Attribute namespaces subsection at the top of "What gets collected" describing the three namespaces (`gen_ai.`, `github.copilot.`, `copilot_chat.*`) and the legacy/dual-emit policy
  • Per-span attribute tables for `invoke_agent`, `chat`, `execute_tool`, and the previously-undocumented `execute_hook` span
  • New `github.copilot.*` attributes:
    • `github.copilot.agent.type` (`builtin` | `custom` | `plugin`)
    • `github.copilot.git.{repository,branch,commit_sha}` + `github.copilot.github.org`
    • `github.copilot.tool.parameters.*` (edit type, skill name, MCP server/tool, shell command, file path)
    • `github.copilot.hook.{decision,duration,tool_names}`
  • `gen_ai.usage.reasoning.output_tokens` (preferred over legacy `gen_ai.usage.reasoning_tokens`)
  • Existing `copilot_chat.repo.` rows marked as legacy with pointers to the preferred `github.copilot.git.` keys

Related

  • Source doc this mirrors: `extensions/copilot/docs/monitoring/agent_monitoring.md` in microsoft/vscode#318031
  • Linked from the 1.122 release notes entry currently on `vnext`

No Claude-specific attribute changes here — those are tracked separately in microsoft/vscode#318472.

Expand the agent OpenTelemetry monitoring guide to cover the canonical
github.copilot.* attribute namespace (shared with the GitHub Copilot CLI
conventions) alongside the legacy copilot_chat.* keys.

Adds per-span attribute tables for invoke_agent, chat, execute_tool, and
the previously-undocumented execute_hook span, including:

- github.copilot.agent.type
- github.copilot.git.{repository,branch,commit_sha}
- github.copilot.github.org
- github.copilot.tool.parameters.*
- github.copilot.hook.{decision,duration,tool_names}
- gen_ai.usage.reasoning.output_tokens

Calls out the dual-emit policy: copilot_chat.* keys continue to emit
indefinitely so existing dashboards keep working.
@zhichli zhichli merged commit cac96f2 into main May 27, 2026
4 checks passed
@zhichli zhichli deleted the zhichli/otel-namespace-docs branch May 27, 2026 05:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants