Repository navigation
[Automated] Draft docs (kagent): feat(telemetry): Weaver live-check, registry catch-up, reference… - #601
[Automated] Draft docs (kagent): feat(telemetry): Weaver live-check, registry catch-up, reference…#601github-actions[bot] wants to merge 1 commit into
Conversation
…registry catch-up, reference… Signed-off-by: GitHub Action <action@github.com>
|
Closing this as superseded. The resource-attribute split, the runtime metrics section, the otel.metrics Helm row, and the invocation-latency query all landed on main in "Document kagent telemetry resource attributes and runtime metrics", which is why this branch now conflicts. The one piece not on main is the signaltometrics connector, and it needs work before it ships: the copy omits the metric-type block, so the collector fails config validation and will not start. The upstream reference uses an exponential histogram, which the prometheus exporter renders as a native histogram with no _bucket series, so the documented histogram_quantile query would still return nothing. Tracking that as a separate issue. |
|
Closing this as superseded. The resource-attribute split, the runtime metrics section, the The one piece not already on main was the Both stack guides now get the connector with an explicit bucket histogram instead, verified against collector 0.159.0. Thanks for flagging the gap. |
kagent-dev/kagent#3107 — feat(telemetry): Weaver live-check, registry catch-up, reference collector
Docs versions:
1.x(first shipped in v1.0.0-alpha10)What changes for users: Runtime telemetry now puts the top-level agent identity on resource attributes as
gen_ai.main_agent.nameandgen_ai.main_agent.id, while request spans keep invoked-agent identity ingen_ai.agent.*. Operators can enable OTLP metrics from agent runtimes and querygen_ai.invoke_agent.durationfor invocation latency.What the docs now say: The Tracing page now separates span attributes from resource attributes. The Metrics, OTel stack, and Lightweight OTel stack pages now enable runtime metrics, derive invocation duration from
invoke_agentspans before sampling, and show the Prometheus query for invocation latency.Not verified: No cluster; the steps are unrun.
How
kagent-3107was drafted, and what was not verifiedPlan, and what changed it
body.mdand the code diff show both a resource-attribute rename and a newgen_ai.invoke_agent.durationmetric;diff-truncated.mdshows only tests were cut off.Why a documentation change is necessary
The pull request changes what readers see in their telemetry backends: the runtime identity
kagent.runtimemoved to the resource, and the main agent identity now usesgen_ai.main_agent.*on resources. The existing tracing page still describedkagent.runtimeas a request attribute. The pull request also adds thegen_ai.invoke_agent.durationmetric and a reference collector connector that derives the metric frominvoke_agentspans, but the stack guides did not enable runtime metrics or configure that connector.What changed on disk
docs-site/content/kagent/1.x/observability/tracing.md— Clarified span attributes versus resource attributes for agent identity and runtime identity.docs-site/content/kagent/1.x/observability/metrics.md— Added runtime OTLP metrics, the invocation-duration metric reference, and a Prometheus query.docs-site/content/kagent/1.x/observability/otel-stack.md— Enabled runtime metrics and added thesignaltometricsconnector to derive invocation duration before sampling.docs-site/content/kagent/1.x/observability/lightweight-otel-stack.md— Enabled runtime metrics and added the samesignaltometricsconnector to the lightweight collector.How to verify this change
signaltometricsconnector andotel.metrics.enabled: truein the kagent Helm values.histogram_quantile(0.95, sum by (le, gen_ai_agent_name) (rate(gen_ai_invoke_agent_duration_seconds_bucket[5m]))); the query shows invocation latency series for the agent that served the request.gen_ai.agent.*attributes, and the runtime resource showsgen_ai.main_agent.*andkagent.runtime.What was not verified
go/pkg/tracing/invocation_test.go,go/pkg/tracing/runtime_test.go, andpython/packages/kagent-core/tests/test_a2a_telemetry.py; no documentation claim depends on those cut-off files.How the pages were chosen (triage report)
Draft a documentation change
kagent-dev/kagent#3107 — feat(telemetry): Weaver live-check, registry catch-up, reference collector
kagent-dev/website.gitignoreDEVELOPMENT.mdMakefiledocs/architecture/telemetry-contract.mddocs/architecture/telemetry.mddocs/env.mdWarnings
Draft branch:
pr-tracker-draft-kagent-3107Important
The test suite has not run on this pull request. It was opened by
github-actions[bot], and GitHub does not start workflows for pull requests opened with the repository's own token. This repository's checks are held asaction_requireduntil somebody presses Approve and run on the Checks tab. Checks that come from GitHub Apps rather than Actions, such as DCO, run on their own.Please approve the checks before reviewing the content: an absence of failures here means the tests have not run, not that they passed.