telemetry: Telemetry Class

In aisdk: Unified Interface for AI Model Providers

Telemetry Class

Description

R6 class for logging events in a structured format (JSON).

Public fields

trace_id

Current trace ID for the session.

events

Collected telemetry events for in-memory inspection.

emit

Logical; when TRUE, events are printed as JSON lines.

pricing_table

Pricing for common models (USD per 1M tokens).

Methods

Public methods

• Telemetry$new()

• Telemetry$log_event()

• Telemetry$get_events()

• Telemetry$clear_events()

• Telemetry$as_hooks()

• Telemetry$calculate_cost()

• Telemetry$clone()

---

Method new()

Initialize Telemetry

Usage

Telemetry$new(trace_id = NULL, emit = TRUE)

Arguments

trace_id

Optional trace ID. If NULL, generates a random one.

emit

Logical; when TRUE, events are printed as JSON lines.

---

Method log_event()

Log an event

Usage

Telemetry$log_event(type, ...)

Arguments

type

Event type (e.g., "generation_start", "tool_call").

...

Additional fields to log.

---

Method get_events()

Return collected telemetry events.

Usage

Telemetry$get_events()

Returns

A list of event payloads.

---

Method clear_events()

Clear collected telemetry events.

Usage

Telemetry$clear_events()

Returns

Invisibly returns self.

---

Method as_hooks()

Create hooks for telemetry

Usage

Telemetry$as_hooks()

Returns

A HookHandler object pre-configured with telemetry logs.

---

Method calculate_cost()

Calculate estimated cost for a generation result

Usage

Telemetry$calculate_cost(result, model_id = NULL)

Arguments

result

The GenerateResult object.

model_id

Optional model ID string. if NULL, tries to guess from context (not reliable yet, passing in log_event might be better).

Returns

Estimated cost in USD, or NULL if unknown.

---

Method clone()

The objects of this class are cloneable with this method.

Usage

Telemetry$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

aisdk documentation built on May 29, 2026, 9:07 a.m.