Class Instrumentation.AgentInvocation

java.lang.Object

com.google.adk.telemetry.Instrumentation.ClosableTelemetryScope

com.google.adk.telemetry.Instrumentation.AgentInvocation

All Implemented Interfaces:

AutoCloseable

Enclosing class:

Instrumentation

public static final class Instrumentation.AgentInvocation
extends Instrumentation.ClosableTelemetryScope

AutoCloseable telemetry tracking scope for agent invocations.

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
AgentInvocation(InvocationContext ctx, BaseAgent agent, io.opentelemetry.context.Context parentContext)	Constructs a new AgentInvocation telemetry scope.

Method Summary

Modifier and Type	Method	Description
void	addEvent(Event event)	Adds an event to the list of events tracked during this agent invocation.
InvocationContext	getCtx()	Retrieves the invocation context associated with this agent invocation.
protected void	handleMetricsError(RuntimeException e)	Handles errors that occur while recording metrics for the agent invocation.
protected void	recordMetrics(Duration elapsed, @Nullable Throwable error)	Records metrics for the agent invocation including duration, request size, response size, and workflow steps.

Methods inherited from class Instrumentation.ClosableTelemetryScope

beforeSpanEnd, close, context, setError

Modifier and Type	Method	Description
protected void	beforeSpanEnd()	Hook for subclasses to run code before span ends.
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

AgentInvocation

public AgentInvocation(InvocationContext ctx,
 BaseAgent agent,
 io.opentelemetry.context.Context parentContext)

Constructs a new AgentInvocation telemetry scope.

Parameters:

ctx - The invocation context of the agent execution.

agent - The agent being invoked.

parentContext - The OpenTelemetry parent context.

Method Details

getCtx

public InvocationContext getCtx()

Retrieves the invocation context associated with this agent invocation.

Returns:

The InvocationContext.

addEvent

public void addEvent(Event event)

Adds an event to the list of events tracked during this agent invocation.

Parameters:

event - The Event to add.

recordMetrics

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

Records metrics for the agent invocation including duration, request size, response size, and workflow steps.

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 agent invocation.

Specified by:

handleMetricsError in class Instrumentation.ClosableTelemetryScope

Parameters:

e - The runtime exception encountered during metrics recording.