# 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
Link copied to clipboard
constructor(name: String = "logging_plugin")

## Types

Companion
Link copied to clipboard
object Companion

## Properties

name
Link copied to clipboard
open override val name: String

The unique name of the plugin.

## Functions

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

Callback executed after a specific agent finishes its processing.

afterModel
Link copied to clipboard
open suspend override fun afterModel(context: CallbackContext, response: LlmResponse): LlmResponse

Callback executed after an LLM response is received.

afterRun
Link copied to clipboard
open suspend override fun afterRun(invocationContext: InvocationContext)

Callback executed after the ADK runner completes its execution.

afterTool
Link copied to clipboard
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
Link copied to clipboard
open suspend override fun beforeAgent(context: CallbackContext): CallbackChoice<EventActions, Content>

Callback executed before a specific agent starts processing.

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

Callback executed before an LLM request is sent.

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

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

beforeTool
Link copied to clipboard
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.

close
Link copied to clipboard
open suspend fun close()

Method executed when the runner is closed.

formatArgs
Link copied to clipboard
fun formatArgs(args: Map<String, Any>?): String
formatContent
Link copied to clipboard
fun formatContent(content: Content?): String
onEvent
Link copied to clipboard
open suspend override fun onEvent(invocationContext: InvocationContext, event: Event): Event

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

onModelError
Link copied to clipboard
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
Link copied to clipboard
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
Link copied to clipboard
open suspend override fun onUserMessage(invocationContext: InvocationContext, userMessage: Content): Content

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