* Add Kotlin snippet for DebugLoggingPlugin The Kotlin logging page covered LoggingPlugin's console output but not DebugLoggingPlugin, available since adk-kotlin 0.6.0, which records the same activity in full to a YAML file instead of truncated console summaries. Both plugins override the same twelve callbacks, so the difference really is only fidelity and destination. Transcluded from the existing LoggingExamples.kt rather than written inline, matching the rest of the page and keeping it in the compile regression suite -- the file is already registered in files_to_test.txt. The sample passes includeSystemInstruction = false, since the plugin's KDoc cautions that it writes raw prompts, tool arguments and session state to disk. Verified against the upstream test that the flag records has_system_instruction in place of the instruction text rather than dropping the field, and the comment names that field so it can be found in the output. outputPath is left at its default rather than passed explicitly; the default filename is given in the prose instead, so the snippet does not imply the parameter is required. Page badge left at Kotlin v0.1.0: the other snippets on the page have worked since then, so the version requirement for this one is noted in the prose. * docs: add Kotlin version support tag to debug logging documentation
12 KiB
Agent activity logging
Agent Development Kit (ADK) provides flexible and powerful logging capabilities to monitor agent behavior and debug issues effectively.
Logging philosophy
ADK's approach to logging is to provide detailed diagnostic information without being overly verbose by default. It is designed to be configured by the application developer, allowing you to tailor the log output to your specific needs, whether in a development or production environment.
- Standard Library Integration: ADK uses the standard logging facilities of
the host language (e.g., Python's
loggingmodule, Go'slogpackage). - Structured GenAI Logging: ADK uses OpenTelemetry to log structured events for GenAI requests and responses, allowing for advanced monitoring and debugging in cloud environments.
- User-Configured: While ADK provides defaults and integration with its CLI tools, it is ultimately the responsibility of the application developer to configure logging to suit their specific environment.
Logging schema
ADK emits logs using standard library facilities and structured GenAI events via OpenTelemetry.
Structured GenAI logs
Structured GenAI logs emitted via OpenTelemetry follow the Semantic Conventions for GenAI.
By default prompt content is elided in logs for security. You can enable prompt logging using environment variables or programmatic configuration (see Setup section below).
Log levels (Python)
The following table describes what is logged at different levels in Python when using the standard logger:
| Level | Description | Type of Information Logged |
|---|---|---|
DEBUG |
Crucial for debugging. The most verbose level for fine-grained diagnostic information. |
|
INFO |
General information about the agent's lifecycle. |
|
WARNING |
Indicates a potential issue or deprecated feature use. The agent continues to function, but attention may be required. |
|
ERROR |
A serious error that prevented an operation from completing. |
|
!!! note
It is recommended to use INFO or WARNING in production environments.
Only enable DEBUG when actively troubleshooting an issue, as DEBUG logs
can be very verbose and may contain sensitive information.
Logging setup
Logging in ADK Web
When running agents using the ADK's adk web, adk api_server, adk deploy cloud_run and adk deploy gke commands, you can control the log verbosity or
destination.
Logging level
To start the web server with DEBUG level logging, run:
adk web --log_level DEBUG path/to/your/agents_dir
The available log levels for the --log_level option are: DEBUG, INFO
(default), WARNING, ERROR, CRITICAL.
Capture prompt content
By default a prompt content is elided in logs for security. You can enable prompt logging using the environment variable:
export OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT=true
The available values for this variable are: NO_CONTENT, EVENT_ONLY,
SPAN_ONLY, and SPAN_AND_EVENT. A boolean true or 1 means EVENT_ONLY,
which records content on the emitted log events; any value outside these four
falls back to NO_CONTENT. To record content on the inference span, SPAN_ONLY
and SPAN_AND_EVENT also require
OTEL_SEMCONV_STABILITY_OPT_IN=gen_ai_latest_experimental.
!!! warning
The OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT setting logs the
full content of user prompts and agent responses. This is useful for
debugging but may capture sensitive data or PII. In production, set this to
false or ensure you have appropriate data handling policies in place.
OTLP export
To export logs to an OTLP-compatible backend, set the standard OTel environment variables:
export OTEL_EXPORTER_OTLP_LOGS_ENDPOINT="http://your-collector:4318/v1/logs"
adk web path/to/your/agents_dir
!!! note
You can also set the general OTEL_EXPORTER_OTLP_ENDPOINT environment
variable if you would like to send metrics and traces to the same endpoint
in addition to logs.
GCP export setup
You can enable GCP export using the --otel_to_cloud flag:
adk web --otel_to_cloud path/to/your/agents_dir
Python programmatic setup
In Python, ADK uses the standard logging module and OpenTelemetry for
structured GenAI logs.
Logging level
To enable detailed logging, including DEBUG level messages, add the following
to the top of your script:
import logging
logging.basicConfig(
level=logging.DEBUG,
format='%(asctime)s - %(levelname)s - %(name)s - %(message)s'
)
Capture prompt content
You can enable full prompt logging programmatically by setting an environment variable:
import os
os.environ["OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT"] = "true"
To scope content capture to a single run instead of the whole process, set
RunConfig.telemetry rather than the environment variable:
from google.adk.agents.run_config import RunConfig
from google.adk.telemetry import ContentCapturingMode, TelemetryConfig
run_config = RunConfig(
telemetry=TelemetryConfig(
capture_message_content=ContentCapturingMode.SPAN_AND_EVENT,
),
)
OTLP export
To export logs to an OpenTelemetry Collector (or an OTLP-compatible backend) programmatically:
from google.adk.telemetry.setup import maybe_set_otel_providers
import os
os.environ["OTEL_EXPORTER_OTLP_LOGS_ENDPOINT"] = "http://your-collector:4318/v1/logs"
os.environ["OTEL_SERVICE_NAME"] = "your-adk-agent"
os.environ["OTEL_RESOURCE_ATTRIBUTES"] = "key1=value1,key2=value2"
maybe_set_otel_providers()
GCP export setup
To export logs to Google Cloud Logging programmatically, use the OpenTelemetry Google Cloud exporter. Here is an example in Python:
from google.adk.telemetry.google_cloud import get_gcp_exporters
from google.adk.telemetry.setup import maybe_set_otel_providers
import os
gcp_exporters = get_gcp_exporters(
enable_cloud_logging = True,
)
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
In Kotlin, ADK uses standard JVM logging facilities (defaulting to Flogger) and OpenTelemetry for structured GenAI logs.
Capture prompt content
You can enable full prompt logging by configuring the global TelemetryConfig:
--8<-- "examples/kotlin/snippets/observability/LoggingExamples.kt:capture_content"
Activity logging with Plugins
To get detailed logs of agent activity (user messages, model requests/responses, tool calls) in the console, use the LoggingPlugin:
--8<-- "examples/kotlin/snippets/observability/LoggingExamples.kt:logging_plugin"
Full debug capture to a file
To record the same activity in full, as YAML appended to adk_debug.yaml rather than truncated console output, use the DebugLoggingPlugin:
--8<-- "examples/kotlin/snippets/observability/LoggingExamples.kt:debug_logging_plugin"
!!! warning The output file holds raw prompts, tool arguments and session state. Treat it as sensitive.
Go programmatic setup
In Go, ADK uses the google.golang.org/adk/v2/telemetry package for OpenTelemetry
configuration and the standard log package for general events.
Capture prompt content
You can enable full prompt logging programmatically when initializing telemetry:
package main
import (
"context"
"google.golang.org/adk/v2/telemetry"
)
func main() {
ctx := context.Background()
tp, err := telemetry.New(ctx,
telemetry.WithGenAICaptureMessageContent(true),
)
if err != nil {
// handle error
}
defer tp.Shutdown(ctx)
tp.SetGlobalOtelProviders()
}
OTLP export
To export logs to an OTLP-compatible backend, configure the standard
OpenTelemetry environment variables (e.g., OTEL_EXPORTER_OTLP_ENDPOINT or
OTEL_EXPORTER_OTLP_LOGS_ENDPOINT). The ADK telemetry package will
automatically use these settings when initialized.
GCP export setup
To export logs to Google Cloud Logging, use the WithOtelToCloud option:
package main
import (
"context"
"google.golang.org/adk/v2/telemetry"
)
func main() {
ctx := context.Background()
tp, err := telemetry.New(ctx,
telemetry.WithOtelToCloud(true),
)
if err != nil {
// handle error
}
defer tp.Shutdown(ctx)
tp.SetGlobalOtelProviders()
}
If using the Go launcher, you can also enable GCP export via the CLI flag:
go run main.go web -otel_to_cloud
General events (like server startup or HTTP requests) are logged using the
standard Go log package. These logs are written to stderr by default.
Understanding log output
Sample Python log entry
2025-07-08 11:22:33,456 - DEBUG - google_adk.google.adk.models.google_llm - LLM Request: contents { ... }
| Log Segment | Format Specifier | Meaning |
|---|---|---|
2025-07-08 11:22:33,456 |
%(asctime)s |
Timestamp |
DEBUG |
%(levelname)s |
Severity level |
google_adk.google.adk.models.google_llm |
%(name)s |
Logger name (the module that produced the log) |
LLM Request: contents { ... } |
%(message)s |
The actual log message |
By reading the logger name, you can immediately pinpoint the source of the log
and understand its context within the agent's architecture.
ADK loggers are named google_adk. followed by the module's fully-qualified
name, so every ADK logger is a child of the google_adk logger. Configure them
as a group with logging.getLogger("google_adk").
Debugging example
After enabling DEBUG logging (see Logging level above), run
your agent and look for messages from the
google_adk.google.adk.models.google_llm logger.
The output shows the full LLM request and response:
2025-07-10 15:26:13,778 - DEBUG - google_adk.google.adk.models.google_llm -
LLM Request:
-----------------------------------------------------------
System Instruction:
You roll dice and answer questions about the outcome of the dice rolls.
...
-----------------------------------------------------------
Contents:
{"parts":[{"text":"Roll a 6 sided dice"}],"role":"user"}
{"parts":[{"function_call":{"args":{"sides":6},"name":"roll_die"}}],"role":"model"}
{"parts":[{"function_response":{"name":"roll_die","response":{"result":2}}}],"role":"user"}
-----------------------------------------------------------
Functions:
roll_die: {'sides': {'type': <Type.INTEGER: 'INTEGER'>}}
check_prime: {'nums': {'items': {'type': <Type.INTEGER: 'INTEGER'>}, 'type': <Type.ARRAY: 'ARRAY'>}}
-----------------------------------------------------------
2025-07-10 15:26:14,309 - INFO - google_adk.google.adk.models.google_llm -
LLM Response:
-----------------------------------------------------------
Text:
I have rolled a 6 sided die, and the result is 2.
...
From this output you can verify:
- Is the system instruction correct?
- Is the conversation history (
userandmodelturns) accurate? - Are the correct tools being provided to the model?
- Are the tools correctly called by the model?
- How long it takes for the model to respond?