Hacktoberfest 2026：メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

Docs: reconcile the tracing page with the generated telemetry contract

オープン
  • 何か問題がありますか？
#519 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
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分
マージ済み PR（30日）
64

環境構築

このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

kagent-dev/website のほかの issue

kagent-dev/website の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。