Hacktoberfest 2026：维护者为十月标记出来的 issue，仍然开放、适合新手。 浏览 Hacktoberfest issue

Docs: reconcile the tracing page with the generated telemetry contract

未关闭
  • 哪里不对？
#519 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
3/5
预计耗时
1-2 天
新手友好度
65/100
Issue 类型
文档
描述清晰度
描述清楚
活跃度
活跃
技术栈
go, python, typescript
领域
documentation, observability

调研方向

Start by reading docs/architecture/telemetry.md and docs/architecture/telemetry-contract.md in the kagent repository. Run an agent to capture a live trace, comparing emitted attributes and span names against the tables in docs/observability/tracing.md. Verify the capture control environment variables by testing each. Update the correlation table to distinguish contract attributes from transitional Go ADK keys, and ensure audit-prompts.md receives the same updates. Done when all claims are validated against a live trace and both pages are reconciled.

由索引模型根据 Issue 内容生成。

描述

help wanted

The correlation attributes table on observability/tracing.md is wrong for kagent, the default runtime.

Targets v1.0.0-alpha7, verified 2026-10-06. Sequence after #531, which rewrites the same pages for the Helm value rename. The Agent and Session pass landed in #551.

Attribute the page lists What alpha7 emits
gen_ai.conversation.id Correct on every runtime.
gen_ai.task.id Python runtimes only. The Go ADK emits a2a.task.id.
kagent.user_id Python runtimes only. The Go ADK emits enduser.id.
kagent.app_name Nothing emits it. At alpha7 the name survives only in go/core/test/e2e/tracing_test.go.

A reader who builds a dashboard from this table keys it on one attribute no runtime writes, and two more that are absent on the runtime they are most likely using.

The table has to split by runtime

The split is durable, not a brief overlap: the Go ADK's only remaining keys outside the contract are gcp.vertex.agent.*, while the Python ADK, LangGraph and CrewAI still carry kagent.user_id and gen_ai.task.id. Moving Python off OpenLLMetry remains open on kagent#2907. docs/architecture/telemetry.md records the split in its Who emits what table.

The contract's request identity is gen_ai.conversation.id, a2a.task.id and enduser.id, with kagent.runtime on the resource and kagent.invocation.segment on request spans. kagent.runtime is absent on every Python runtime, so those traces cannot be filtered by runtime at all.

Also worth covering, since neither is discoverable from a span name: kagent.invocation.segment distinguishes initial from resumed, and turns are counted by it rather than by invoke_agent spans; kagent.invocation.relationship is a link attribute that states a relationship without reparenting spans or moving token usage.

Spans and captured content

The span table names invocation, which kagent#2929 removed. At alpha7 the request span is an otelgrpc or otelhttp SERVER span, with kagent's a2a.request on the Go ADK and a FastAPI SERVER span on the Python runtimes. The contract names span definitions rather than emitted names, so kagent.invoke_agent.internal is emitted as invoke_agent {gen_ai.agent.name}.

The capture warning names gcp.vertex.agent.llm_request and llm_response, which are Go ADK keys outside the contract. The contract records content as gen_ai.input.messages and gen_ai.output.messages, with kagent.capture.*_truncated reporting truncation. The capture variable question is settled and belongs to #531; do not reopen it here.

Before starting

This needs a live trace. Everything above is read from generated documentation and source, and telemetry.md states that nothing yet compares emitted telemetry against the registry. Run the tracing guide on the kagent runtime and on one Python runtime, since the point is that they differ, and confirm kagent.app_name is genuinely absent rather than emitted from a path the source search missed.

Done when

  • The correlation table splits by runtime, and a reader can tell which attributes their runtime emits without capturing a trace to find out.
  • kagent.app_name is gone, or is shown with evidence that something emits it.
  • a2a.task.id, enduser.id, kagent.invocation.segment and kagent.runtime are covered, including kagent.runtime being absent on Python.
  • The span table matches alpha7, with invocation removed.
  • The capture warning names the contract attributes and marks gcp.vertex.agent.* as Go ADK only.
  • Every claim was checked against a trace captured on the documented version.
  • observability/audit-prompts.md got the same pass.
主要语言
TypeScript
星标
21
派生
69
平均合并
16 小时 25 分钟
30 天内合并 PR
64

环境准备

这个项目没有提供开发容器、Dockerfile 或贡献指南，环境需要你自己搭建：先看它的 README，通用步骤见我们的新手贡献指南。

从这里开始

  1. 先读完整个 Issue，再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库，在一个分支上完成修改。
  4. 提交 Pull Request，并在描述里引用这个 Issue 编号。

kagent-dev/website 的其他 Issue

查看 kagent-dev/website 的全部 Issue

相似的 Issue

更多 TypeScript Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。