google-adk-kotlin-core/com.google.adk.kt.plugins/LoggingPlugin

LoggingPlugin

class LoggingPlugin(val name: String = "logging_plugin") : Plugin

A plugin that logs a high volume of requests and responses handled by the agent at each callback point.

This plugin is primarily intended for ADK development and debugging purposes, helping to print all critical events in the console.

CAUTION: The plugin logs raw requests / responses, including user prompts. Be mindful of sensitive data disclosure.

Constructors

LoggingPlugin

constructor(name: String = "logging_plugin")

Types

Companion

object Companion

Properties

name

open override val name: String

The unique name of the plugin.

Functions

afterAgent

open suspend override fun afterAgent(context: CallbackContext): CallbackChoice<Unit, Content>

Callback executed after a specific agent finishes its processing.

afterModel

open suspend override fun afterModel(context: CallbackContext, response: LlmResponse): LlmResponse

Callback executed after an LLM response is received.

afterRun

open suspend override fun afterRun(invocationContext: InvocationContext)

Callback executed after the ADK runner completes its execution.

afterTool

open suspend override fun afterTool(context: ToolContext, tool: BaseTool, args: Map<String, Any>, result: Map<String, Any>): Map<String, Any>

Callback executed after a tool finishes its execution.

beforeAgent

open suspend override fun beforeAgent(context: CallbackContext): CallbackChoice<EventActions, Content>

Callback executed before a specific agent starts processing.

beforeModel

open suspend override fun beforeModel(context: CallbackContext, request: LlmRequest): CallbackChoice<LlmRequest, LlmResponse>

Callback executed before an LLM request is sent.

beforeRun

open suspend override fun beforeRun(invocationContext: InvocationContext): CallbackChoice<Unit, Content>

Callback executed before the ADK runner starts the main execution loop.

beforeTool

open suspend override fun beforeTool(context: ToolContext, tool: BaseTool, args: Map<String, Any>): CallbackChoice<Map<String, Any>, Map<String, Any>>

Callback executed before a tool is invoked.

open suspend fun close()

Method executed when the runner is closed.

formatArgs

fun formatArgs(args: Map<String, Any>?): String

formatContent

fun formatContent(content: Content?): String

onEvent

open suspend override fun onEvent(invocationContext: InvocationContext, event: Event): Event

Callback executed when an event is yielded by an agent during execution.

onModelError

open suspend override fun onModelError(context: CallbackContext, request: LlmRequest, error: Throwable): CallbackChoice<Unit, LlmResponse>

Callback executed when an error occurs during an LLM interaction.

onToolError

open suspend override fun onToolError(context: ToolContext, tool: BaseTool, args: Map<String, Any>, error: Throwable): CallbackChoice<Unit, Map<String, Any>>

Callback executed when an error occurs during a tool invocation.

onUserMessage

open suspend override fun onUserMessage(invocationContext: InvocationContext, userMessage: Content): Content

Callback executed when a user message is received before an invocation starts.