Found docs updates needed from ADK python release v2.9.1 to v2.9.2

Open Beginner friendly
#2,247 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
1-3 hours
Newbie friendliness
88/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
google-cloud, python
Domain
cloud, documentation, observability

Research direction

Start with docs/observability/logging.md and compare the v2.9.1 to v2.9.2 changes. Read src/google/adk/telemetry/google_cloud.py to confirm how GOOGLE_CLOUD_AGENT_ENGINE_ID affects record.event_name. Done means the documentation explains the different Cloud Logging behavior outside Vertex AI Agent Engine and on Agent Engine, including event-named log routing.

Written by the indexing model from the issue text.

Description

docs updates

Compare link: https://github.com/google/adk-python/compare/v2.9.1...v2.9.2

1. Document environment-specific log routing behavior for Cloud Logging exporter

Doc file: docs/observability/logging.md

Current state:

os.environ["OTEL_SERVICE_NAME"] = "your-adk-agent"
os.environ["OTEL_RESOURCE_ATTRIBUTES"] = "key1=value1,key2=value2"
maybe_set_otel_providers([gcp_exporters])


### Kotlin programmatic setup

Proposed Change:

os.environ["OTEL_SERVICE_NAME"] = "your-adk-agent"
os.environ["OTEL_RESOURCE_ATTRIBUTES"] = "key1=value1,key2=value2"
maybe_set_otel_providers([gcp_exporters])


!!! note
    When running outside of Vertex AI Agent Engine, the Google Cloud Logging exporter preserves the OpenTelemetry event name in the log record. This allows Cloud Logging to route records to distinct logs named after each event type, making it easier to integrate with sinks like BigQuery tables. On Vertex AI Agent Engine, this behavior is suppressed to group all records into a single log pipeline.

### Kotlin programmatic setup

Reasoning:
The underlying logic in google_cloud.py changed to only drop record.event_name when running on Vertex AI Agent Engine (identified by GOOGLE_CLOUD_AGENT_ENGINE_ID). Everywhere else, it is now preserved so that Cloud Logging can create event-named logs and correctly route them to sinks. Users configuring GCP export setup should be aware of this environment-dependent behavior.

Reference: src/google/adk/telemetry/google_cloud.py

Dominant language
Shell
Stars
1.5k
Forks
1.3k
Avg merge
5d 7h
Merged PRs (30d)
26

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from google/adk-docs

All issues in google/adk-docs

Similar issues

More Shell/Bash issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.