Class DebugLoggingPlugin

src/google/adk/plugins/debug_logging_plugin.py:67–572

A plugin that captures complete debug information to a file. This plugin records detailed interaction data including: - LLM requests (model, system instruction, contents, tools) - LLM responses (content, usage metadata, errors) - Function calls with arguments - Function responses with res

class DebugLoggingPlugin(BasePlugin):
  """A plugin that captures complete debug information to a file.

  This plugin records detailed interaction data including:
  - LLM requests (model, system instruction, contents, tools)
  - LLM responses (content, usage metadata, errors)
  - Function calls with arguments
  - Function responses with results
  - Events yielded from the runner
  - Session state at the end of each invocation

  The output is written as YAML format for human readability. Each invocation
  is appended to the file as a separate YAML document (separated by ---).
  This format is easy to read and can be shared for debugging purposes.

  Example:
      >>> debug_plugin = DebugLoggingPlugin(output_path="/tmp/adk_debug.yaml")
      >>> runner = Runner(
      ...     agent=my_agent,
      ...     plugins=[debug_plugin],
      ... )

  Attributes:
      output_path: Path to the output file. Defaults to "adk_debug.yaml".
      include_session_state: Whether to include session state in the output.
      include_system_instruction: Whether to include system instructions.
  """

  def __init__(
      self,
      *,
      name: str = "debug_logging_plugin",
      output_path: str = "adk_debug.yaml",
      include_session_state: bool = True,
      include_system_instruction: bool = True,
  ):
    """Initialize the debug logging plugin.

    Args:
      name: The name of the plugin instance.
      output_path: Path to the output file. Defaults to "adk_debug.yaml".
      include_session_state: Whether to include session state snapshot.
      include_system_instruction: Whether to include full system instructions.
    """
    super().__init__(name)
    self._output_path = Path(output_path)
    self._include_session_state = include_session_state
    self._include_system_instruction = include_system_instruction
    self._invocation_states: dict[str, _InvocationDebugState] = {}

  def _get_timestamp(self) -> str:
    """Get current timestamp in ISO format."""
    return datetime.now().isoformat()

  def _serialize_content(
      self, content: types.Content | None
  ) -> dict[str, Any] | None:
    """Serialize Content to a dictionary."""