Repository navigation
[Automated] Draft docs (kagent): feat(telemetry): record the trusted user as user.id - #727
Open
github-actions[bot] wants to merge 1 commit into
Open
github-actions[bot] wants to merge 1 commit into
github-actions[bot] wants to merge 1 commit into
Conversation
…user as user.id Signed-off-by: GitHub Action <action@github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
kagent-dev/kagent#3552 — feat(telemetry): record the trusted user as user.id
Docs versions:
mainNo code-path rule covers 5 touched file(s). The planner could route these only by identifier search, so the candidate pages may miss what they changed, including in the other mode:
python/packages/kagent-core/src/kagent/core/a2a/_telemetry.pytelemetry/conformance/live-check.tomltelemetry/policies/kagent.regotelemetry/registry/signals.yamltelemetry/resolved.yamlWhat changes for users: The runtimes now record the gateway-forwarded
x-user-idvalue asuser.id, notenduser.id, on the request span and its descendant spans. Users with dashboards, queries, or access rules that readenduser.idmust update them to readuser.id.What the docs now say: The Tracing page's correlation attributes table already used
user.id; the row now also tells readers who carried telemetry rules forward from earlier releases to update dashboards, queries, and access rules fromenduser.idtouser.id.How
kagent-3552was draftedPlan, and what changed it
user.id.docs-site/content/kagent/main/observability/tracing.mdalready useduser.id, but did not state the migration action that the PR body calls breaking;docs-site/content/kagent/main/agents/agent-harness.mdhad noenduser.idoruser.idhits.user.idrow on the Tracing page.Why a documentation change is necessary
The pull request changes the span attribute for the trusted gateway user from
enduser.idtouser.idin the Go ADK runtime, the Python runtime, telemetry policy, registry, and live-check rule. The PR body calls the rename a breaking change for queries, dashboards, and access rules. The Tracing page owns the user-facing list of correlation attributes, so the page needs to tell readers what to query now and what to change from earlier releases.How to verify this change
x-user-id.user.id=<caller>, andenduser.idis absent.clauderuntime, inspect the kagent invocation span for the trusted caller. Native Claude Code spans can set their ownuser.id, which is a hash of the Claude account.Proposed release note
No
proposed-release-note.md:markers.notes_placeableis false.Suggested note: The runtimes now record the gateway-forwarded user from
x-user-idasuser.idinstead ofenduser.idon the request span and the spans beneath it. Update dashboards, queries, and access rules that readenduser.idto readuser.id.Files in this pull request
docs-site/content/kagent/main/observability/tracing.mdHow the pages were chosen (triage report)
Draft a documentation change
kagent-dev/kagent#3552 — feat(telemetry): record the trusted user as user.id
kagent-dev/websitex-user-id) asuser.idinstead ofenduser.id, on the request span and the spans beneath it. Go ADK and the Python runtimes change together, and the registry, policy, live-check rule and docs follow.python/packages/kagent-core/src/kagent/core/a2a/_telemetry.pytelemetry/conformance/live-check.tomltelemetry/policies/kagent.regotelemetry/registry/signals.yamltelemetry/resolved.yamlDraft branch:
pr-tracker-draft-kagent-3552Important
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.