Implement OnAgentErrorCallback for error metrics#708
Open
jlapenna wants to merge 2 commits intogoogle:mainfrom
Open
Implement OnAgentErrorCallback for error metrics#708jlapenna wants to merge 2 commits intogoogle:mainfrom
jlapenna wants to merge 2 commits intogoogle:mainfrom
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR introduces an
OnAgentErrorCallbackmechanism to the ADK framework. This allows agents and plugins to register callbacks that are executed when an agent encounters an error during its execution.Fixes #709
Rationale
Currently, there is no standardized way for plugins to intercept and handle or record errors that occur during agent execution (e.g., in
agent.Run). This makes it difficult to implement observability metrics for agent failures, such as counting invocation errors.By adding
OnAgentErrorCallback, we enable plugins to listen for these errors and perform actions like incrementing error counters, logging, or attempting recovery.Changes
agent/agent.goOnAgentErrorCallbacktype definition.OnAgentErrorCallbackstoConfigstruct.Runmethod to triggerrunOnAgentErrorCallbackswhena.run(ctx)yields an error.runOnAgentErrorCallbackshelper to execute callbacks from both the agent and registered plugins.RunOnAgentErrorCallbackto thepluginManagerinterface.plugin/plugin.goOnAgentErrorCallbacktoConfigandPluginstructs.OnAgentErrorCallback().internal/plugininternal/plugin_manager.goRunOnAgentErrorCallbackto iterate over registered plugins and execute theirOnAgentErrorCallback.