Skip to content

Update ADK doc according to issue #1173 - 2 - DebugLoggingPlugin #1176

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
adk-bot wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update ADK doc according to issue #1173 - 2 - DebugLoggingPlugin #1176

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions docs/observability/debug-logging.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Debug Logging Plugin

The `DebugLoggingPlugin` captures detailed interaction data to a YAML file for debugging. This data includes LLM requests and responses, tool calls, events, and session state.

## Usage

To use the `DebugLoggingPlugin`, initialize it and add it to the `Runner`.

```python
from google.adk.plugins import DebugLoggingPlugin

debug_plugin = DebugLoggingPlugin(output_path="debug_logs.yaml")
runner = Runner(agent=my_agent, plugins=[debug_plugin])
```

## Output Format

The output is written in YAML format. Each invocation is appended to the file as a separate YAML document, separated by `---`. This format is human-readable and can be shared for debugging purposes.

## Configuration

You can configure the `DebugLoggingPlugin` with the following parameters:

| Parameter | Type | Default | Description |
|---|---|---|---|
| `output_path` | `str` | `"adk_debug.yaml"` | The path to the output file. |
| `include_session_state` | `bool` | `True` | Whether to include a snapshot of the session state at the end of each invocation. |
| `include_system_instruction` | `bool` | `True` | Whether to include the full system instructions in the log. |
Loading