Class Instrumentation

java.lang.Object

com.google.adk.telemetry.Instrumentation

public final class Instrumentation
extends Object

Unified context manager utility class for agent and tool execution telemetry in ADK.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	Instrumentation.AgentInvocation	AutoCloseable telemetry tracking scope for agent invocations.
static class	Instrumentation.ClosableTelemetryScope	Base class for AutoCloseable telemetry tracking scopes.
static final class	Instrumentation.TelemetryContext	Stores all telemetry related state.
static final class	Instrumentation.ToolExecution	AutoCloseable telemetry tracking scope for tool executions.

Method Summary

Modifier and Type	Method	Description
static Instrumentation.AgentInvocation	recordAgentInvocation(InvocationContext ctx, BaseAgent agent)	Deprecated. Use the version with explicit parent context instead.
static Instrumentation.AgentInvocation	recordAgentInvocation(InvocationContext ctx, BaseAgent agent, io.opentelemetry.context.Context parentContext)	Creates an Instrumentation.AgentInvocation context to record agent invocation telemetry with an explicit parent context.
static Instrumentation.ToolExecution	recordToolExecution(BaseTool tool, BaseAgent agent, Map<String,Object> functionArgs)	Creates a ToolExecution context to record tool execution telemetry.
static Instrumentation.ToolExecution	recordToolExecution(BaseTool tool, BaseAgent agent, Map<String,Object> functionArgs, io.opentelemetry.context.Context parentContext)	Creates a Instrumentation.ToolExecution context to record tool execution telemetry with an explicit parent context.

Methods inherited from class Object

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

Method Details

recordAgentInvocation

@Deprecated
public static Instrumentation.AgentInvocation recordAgentInvocation(InvocationContext ctx,
 BaseAgent agent)

Deprecated.

Use the version with explicit parent context instead. This method will be removed once all callers are updated.

Creates an AgentInvocation context to record agent invocation telemetry.

recordAgentInvocation

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

Creates an Instrumentation.AgentInvocation context to record agent invocation telemetry with an explicit parent context.

Parameters:

ctx - The invocation context of the agent execution.

agent - The agent being invoked.

parentContext - The OpenTelemetry parent context.

Returns:

A new Instrumentation.AgentInvocation scope.

recordToolExecution

public static Instrumentation.ToolExecution recordToolExecution(BaseTool tool,
 BaseAgent agent,
 Map<String,Object> functionArgs)

Creates a ToolExecution context to record tool execution telemetry.

recordToolExecution

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

Creates a Instrumentation.ToolExecution context to record tool execution telemetry with an explicit parent context.

Parameters:

tool - The tool being executed.

agent - The agent invoking the tool.

functionArgs - The arguments passed to the tool.

parentContext - The OpenTelemetry parent context.

Returns:

A new Instrumentation.ToolExecution scope.