docs(observability): correct metric names, span attributes, logger names - #2013
Open
GWeale wants to merge 2 commits into
Open
docs(observability): correct metric names, span attributes, logger names#2013GWeale wants to merge 2 commits into
GWeale wants to merge 2 commits into
Conversation
✅ Deploy Preview for adk-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
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
1 participant
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.
Fixes drift on the three observability pages (
metrics.md,traces.md,logging.md) where documented telemetry identifiers did not match what ADK actually emits.Changes
docs/observability/metrics.md— all 5 documented metric names (gen_ai.agent.invocation.duration,gen_ai.tool.execution.duration,gen_ai.agent.request.size,gen_ai.agent.response.size,gen_ai.agent.workflow.steps) are never emitted; replaced with the 7 instruments that are, with their real attributes and units. Also:--otel_to_cloudwas documented as the way to export metrics to Cloud Monitoring — it exports traces and logs only, so that section now points at the programmaticenable_cloud_metrics=Truepath.docs/observability/traces.md— span names carry a suffix (invoke_agent {agent.name},invoke_workflow {workflow.name},execute_tool {tool.name}); attribute lists corrected (gen_ai.systemwas listed on spans that setgen_ai.operation.nameinstead, andgenerate_contentwas credited withuser.id/gen_ai.request.top_p/gen_ai.request.max_tokensit does not set).docs/observability/logging.md— logger names were shown asgoogle_adk.models.google_llm; the real name isgoogle_adk.plus the fully-qualified module (google_adk.google.adk.models.google_llm), so the sample entry, the format table and the debugging example are updated, plus a note thatlogging.getLogger("google_adk")configures them as a group. Also documents the accepted values ofOTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT(and theOTEL_SEMCONV_STABILITY_OPT_INrequirement for span capture), and the per-runRunConfig.telemetryalternative to the process-wide env var.How this was produced
Part of a page-by-page audit of the Python docs against the
google/adk-pythonv2.5.0 source: every import resolved against a real 2.5.0 install, every constructor kwarg checked againstmodel_fields/inspect.signature, every documented default read off the field. A second independent pass re-derived each claim from source rather than trusting the finding, and a third conformed the new wording to the surrounding pages.mkdocs build --strictis clean.Only Python tabs and language-neutral prose were touched — this audit had no ground truth for the Go / Java / TypeScript SDKs.
Split out of a larger audit branch so each area can be reviewed on its own.