Class TelemetryService

Main telemetry service Unified interface for all telemetry operations

Constructors

constructor

new TelemetryService(): TelemetryService
Returns TelemetryService

Accessors

initialized

get initialized(): boolean
Check if telemetry is initialized

Returns boolean
- Defined in packages/adk/src/telemetry/index.ts:118

Methods

initialize

initialize(config): Promise<void>
Initialize telemetry system
Parameters
- config: TelemetryConfig
Returns Promise<void>
- Defined in packages/adk/src/telemetry/index.ts:102

getConfig

getConfig(): TelemetryConfig
Get current configuration

Returns TelemetryConfig
- Defined in packages/adk/src/telemetry/index.ts:125

getTracer

getTracer(): Tracer
Get tracer instance

Returns Tracer
- Defined in packages/adk/src/telemetry/index.ts:132

getActiveSpan

getActiveSpan(): Span
Get currently active span

Returns Span
- Defined in packages/adk/src/telemetry/index.ts:139

shouldCaptureContent

shouldCaptureContent(): boolean
Check if content capture is enabled

Returns boolean
- Defined in packages/adk/src/telemetry/index.ts:146

traceAgentInvocation

traceAgentInvocation(agent, invocationContext, input?, output?): void
Trace an agent invocation
Parameters
- agent: {
  name: string;
  description?: string;
  }
  - name: string
  - Optionaldescription?: string
- invocationContext: InvocationContext
- Optionalinput: string | Record<string, any>
- Optionaloutput: string | Record<string, any>
Returns void
- Defined in packages/adk/src/telemetry/index.ts:155

traceToolCall

traceToolCall(tool, args, functionResponseEvent, llmRequest?, invocationContext?): void
Trace a tool call
Parameters
- tool: BaseTool
- args: Record<string, any>
- functionResponseEvent: Event
- OptionalllmRequest: LlmRequest
- OptionalinvocationContext: InvocationContext
Returns void
- Defined in packages/adk/src/telemetry/index.ts:172

traceLlmCall

traceLlmCall(invocationContext, eventId, llmRequest, llmResponse): void
Trace an LLM call
Parameters
- invocationContext: InvocationContext
- eventId: string
- llmRequest: LlmRequest
- llmResponse: LlmResponse
Returns void
- Defined in packages/adk/src/telemetry/index.ts:191

traceAsyncGenerator

traceAsyncGenerator<T>(spanName, generator, attributes?): AsyncGenerator<T, void, unknown>
Wrap an async generator with tracing
Type Parameters
- T
Parameters
- spanName: string
- generator: AsyncGenerator<T, void, unknown>
- Optionalattributes: Record<string, any>
Returns AsyncGenerator<T, void, unknown>
- Defined in packages/adk/src/telemetry/index.ts:208

withSpan

withSpan<T>(spanName, fn, attributes?): Promise<T>
Execute a function within a traced span
Type Parameters
- T
Parameters
- spanName: string
- fn: ((span: Span) => Promise<T>)
  - - (span): Promise<T>
    - Parameters
      span: Span
      Returns Promise<T>
- Optionalattributes: Record<string, any>
Returns Promise<T>
- Defined in packages/adk/src/telemetry/index.ts:219

setActiveSpanAttributes

setActiveSpanAttributes(attributes): void
Set attributes on the active span
Parameters
- attributes: Record<string, any>
Returns void
- Defined in packages/adk/src/telemetry/index.ts:230

recordException

recordException(error, attributes?): void
Record an exception on the active span
Parameters
- error: Error
- Optionalattributes: Record<string, any>
Returns void
- Defined in packages/adk/src/telemetry/index.ts:237

addEvent

addEvent(name, attributes?): void
Add an event to the active span
Parameters
- name: string
- Optionalattributes: Record<string, any>
Returns void
- Defined in packages/adk/src/telemetry/index.ts:244

traceCallback

traceCallback(callbackType, callbackName, callbackIndex, invocationContext?): void
Trace a callback execution
Parameters
- callbackType: string
- callbackName: string
- callbackIndex: number
- OptionalinvocationContext: InvocationContext
Returns void
- Defined in packages/adk/src/telemetry/index.ts:251

traceAgentTransfer

traceAgentTransfer(sourceAgent, targetAgent, transferChain, transferDepth, reason?, invocationContext?): void
Trace an agent transfer
Parameters
- sourceAgent: string
- targetAgent: string
- transferChain: string[]
- transferDepth: number
- Optionalreason: string
- OptionalinvocationContext: InvocationContext
Returns void
- Defined in packages/adk/src/telemetry/index.ts:268

traceEnhancedTool

traceEnhancedTool(executionOrder?, parallelGroup?, retryCount?, isCallbackOverride?): void
Record enhanced tool execution attributes
Parameters
- OptionalexecutionOrder: number
- OptionalparallelGroup: string
- OptionalretryCount: number
- OptionalisCallbackOverride: boolean
Returns void
- Defined in packages/adk/src/telemetry/index.ts:289

traceEnhancedLlm

traceEnhancedLlm(streaming?, timeToFirstTokenMs?, chunkCount?, cachedTokens?, contextWindowUsedPct?): void
Record enhanced LLM attributes
Parameters
- Optionalstreaming: boolean
- OptionaltimeToFirstTokenMs: number
- OptionalchunkCount: number
- OptionalcachedTokens: number
- OptionalcontextWindowUsedPct: number
Returns void
- Defined in packages/adk/src/telemetry/index.ts:306

traceError

traceError(error, category, recoverable?, retryRecommended?): void
Record standardized error information
Parameters
- error: Error
- category:
      | "tool_error"
      | "model_error"
      | "transfer_error"
      | "callback_error"
      | "memory_error"
      | "session_error"
      | "plugin_error"
      | "unknown_error"
- recoverable: boolean = false
- retryRecommended: boolean = false
Returns void
- Defined in packages/adk/src/telemetry/index.ts:325

traceMemoryOperation

traceMemoryOperation(operation, sessionId, query?, resultsCount?, invocationContext?): void
Trace memory operations
Parameters
- operation: "search" | "insert" | "delete"
- sessionId: string
- Optionalquery: string
- OptionalresultsCount: number
- OptionalinvocationContext: InvocationContext
Returns void
- Defined in packages/adk/src/telemetry/index.ts:345

tracePluginHook

tracePluginHook(pluginName, hook, agentName?, invocationContext?): void
Trace plugin hook execution
Parameters
- pluginName: string
- hook: string
- OptionalagentName: string
- OptionalinvocationContext: InvocationContext
Returns void
- Defined in packages/adk/src/telemetry/index.ts:364

recordAgentInvocation

recordAgentInvocation(dimensions): void
Record an agent invocation
Parameters
- dimensions: AgentMetricDimensions
Returns void
- Defined in packages/adk/src/telemetry/index.ts:383

recordAgentDuration

recordAgentDuration(durationMs, dimensions): void
Record agent duration
Parameters
- durationMs: number
- dimensions: AgentMetricDimensions
Returns void
- Defined in packages/adk/src/telemetry/index.ts:392

recordToolExecution

recordToolExecution(dimensions): void
Record a tool execution
Parameters
- dimensions: ToolMetricDimensions
Returns void
- Defined in packages/adk/src/telemetry/index.ts:402

recordToolDuration

recordToolDuration(durationMs, dimensions): void
Record tool duration
Parameters
- durationMs: number
- dimensions: ToolMetricDimensions
Returns void
- Defined in packages/adk/src/telemetry/index.ts:411

recordLlmCall

recordLlmCall(dimensions): void
Record an LLM call
Parameters
- dimensions: LlmMetricDimensions
Returns void
- Defined in packages/adk/src/telemetry/index.ts:421

recordLlmDuration

recordLlmDuration(durationMs, dimensions): void
Record LLM duration
Parameters
- durationMs: number
- dimensions: LlmMetricDimensions
Returns void
- Defined in packages/adk/src/telemetry/index.ts:428

recordLlmTokens

recordLlmTokens(inputTokens, outputTokens, dimensions): void
Record LLM token usage
Parameters
- inputTokens: number
- outputTokens: number
- dimensions: LlmMetricDimensions
Returns void
- Defined in packages/adk/src/telemetry/index.ts:438

recordError

recordError(errorType, context): void
Record an error
Parameters
- errorType: "agent" | "tool" | "llm"
- context: string
Returns void
- Defined in packages/adk/src/telemetry/index.ts:449

flush

flush(timeoutMs?): Promise<void>
Flush all pending telemetry data
Parameters
- timeoutMs: number = 5000
Returns Promise<void>
- Defined in packages/adk/src/telemetry/index.ts:458

shutdown

shutdown(timeoutMs?): Promise<void>
Shutdown telemetry system
Parameters
- OptionaltimeoutMs: number
Returns Promise<void>
- Defined in packages/adk/src/telemetry/index.ts:465

Class TelemetryService

Index

Constructors

Accessors

Methods

Constructors

constructor

Returns TelemetryService

Accessors

initialized

Returns boolean

Methods

initialize

Parameters

Returns Promise<void>

getConfig

Returns TelemetryConfig

getTracer

Returns Tracer

getActiveSpan

Returns Span

shouldCaptureContent

Returns boolean

traceAgentInvocation

Parameters

name: string

Optionaldescription?: string

Returns void

traceToolCall

Parameters

Returns void

traceLlmCall

Parameters

Returns void

traceAsyncGenerator

Type Parameters

Parameters

Returns AsyncGenerator<T, void, unknown>

withSpan

Type Parameters

Parameters

Parameters

Returns Promise<T>

Returns Promise<T>

setActiveSpanAttributes

Parameters

Returns void

recordException

Parameters

Returns void

addEvent

Parameters

Returns void

traceCallback

Parameters

Returns void

traceAgentTransfer

Parameters

Returns void

traceEnhancedTool

Parameters

Returns void

traceEnhancedLlm

Parameters

Returns void

traceError

Parameters

Returns void

traceMemoryOperation

Parameters

Returns void

tracePluginHook

Parameters

Returns void

recordAgentInvocation

Parameters

Returns void

recordAgentDuration

Parameters

Returns void

`Optional`description?: string