Class Instrumentation.ToolExecution

java.lang.Object

com.google.adk.telemetry.Instrumentation.ClosableTelemetryScope

com.google.adk.telemetry.Instrumentation.ToolExecution

All Implemented Interfaces:

AutoCloseable

Enclosing class:

Instrumentation

public static final class Instrumentation.ToolExecution
extends Instrumentation.ClosableTelemetryScope

AutoCloseable telemetry tracking scope for tool executions.

Field Summary

Fields inherited from class Instrumentation.ClosableTelemetryScope

caughtError, closed, scope, span, startTimeNanos, telemetryContext

Modifier and Type	Field	Description
protected @Nullable Throwable	caughtError	The error caught during execution, if any.
protected final AtomicBoolean	closed	Whether this scope has been closed.
protected final io.opentelemetry.context.Scope	scope	The OpenTelemetry scope associated with this span.
protected final io.opentelemetry.api.trace.Span	span	The OpenTelemetry span associated with this scope.
protected final long	startTimeNanos	The start time of the scope in nanoseconds.
protected final Instrumentation.TelemetryContext	telemetryContext	The telemetry context for this scope.

Constructor Summary

Constructors

Constructor	Description
ToolExecution(BaseTool tool, BaseAgent agent, Map<String,Object> functionArgs, io.opentelemetry.context.Context parentContext)	Constructs a new ToolExecution telemetry scope.

Method Summary

Modifier and Type	Method	Description
protected void	beforeSpanEnd()	Traces the tool execution attributes on the span before it ends.
protected void	handleMetricsError(RuntimeException e)	Handles errors that occur while recording metrics for the tool execution.
protected void	recordMetrics(Duration elapsed, @Nullable Throwable error)	Records metrics for the tool execution including duration, request size, and response size.

Methods inherited from class Instrumentation.ClosableTelemetryScope

close, context, setError

Modifier and Type	Method	Description
final void	close()	Closes the scope and ends the underlying span, recording any applicable metrics.
Instrumentation.TelemetryContext	context()	Retrieves the telemetry context associated with this scope.
void	setError(Throwable caughtError)	Records an error on the span and sets its status to error.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ToolExecution

public ToolExecution(BaseTool tool,
 BaseAgent agent,
 Map<String,Object> functionArgs,
 io.opentelemetry.context.Context parentContext)

Constructs a new ToolExecution telemetry scope.

Parameters:

tool - The tool being executed.

agent - The agent invoking the tool.

functionArgs - The arguments passed to the tool.

parentContext - The OpenTelemetry parent context.

Method Details

beforeSpanEnd

protected void beforeSpanEnd()

Traces the tool execution attributes on the span before it ends.

Overrides:

beforeSpanEnd in class Instrumentation.ClosableTelemetryScope

recordMetrics

protected void recordMetrics(Duration elapsed,
 @Nullable Throwable error)

Records metrics for the tool execution including duration, request size, and response size.

Specified by:

recordMetrics in class Instrumentation.ClosableTelemetryScope

Parameters:

elapsed - The total execution duration.

error - The exception thrown during execution, if any.

handleMetricsError

protected void handleMetricsError(RuntimeException e)

Handles errors that occur while recording metrics for the tool execution.

Specified by:

handleMetricsError in class Instrumentation.ClosableTelemetryScope

Parameters:

e - The runtime exception encountered during metrics recording.