@livekit/agents 1.0.22 → 1.0.24

package/src/telemetry/traces.ts

@@ -1,6 +1,7 @@
 // SPDX-FileCopyrightText: 2025 LiveKit, Inc.
 //
 // SPDX-License-Identifier: Apache-2.0
+import { MetricsRecordingHeader } from '@livekit/protocol';
 import {
   type Attributes,
   type Context,
@@ -11,13 +12,20 @@ import {
   context as otelContext,
   trace,
 } from '@opentelemetry/api';
-import { OTLPTraceExporter } from '@opentelemetry/exporter-trace-otlp-http';
+import { SeverityNumber } from '@opentelemetry/api-logs';
+import { OTLPTraceExporter } from '@opentelemetry/exporter-trace-otlp-proto';
 import { CompressionAlgorithm } from '@opentelemetry/otlp-exporter-base';
 import { Resource } from '@opentelemetry/resources';
 import type { ReadableSpan, SpanProcessor } from '@opentelemetry/sdk-trace-base';
 import { BatchSpanProcessor, NodeTracerProvider } from '@opentelemetry/sdk-trace-node';
 import { ATTR_SERVICE_NAME } from '@opentelemetry/semantic-conventions';
+import FormData from 'form-data';
 import { AccessToken } from 'livekit-server-sdk';
+import type { ChatContent, ChatItem } from '../llm/index.js';
+import { enableOtelLogging } from '../log.js';
+import type { SessionReport } from '../voice/report.js';
+import { type SimpleLogRecord, SimpleOTLPHttpLogExporter } from './otel_http_exporter.js';
+import { flushPinoLogs, initPinoCloudExporter } from './pino_otel_transport.js';
 
 export interface StartSpanOptions {
   /** Name of the span */
@@ -94,19 +102,15 @@ class DynamicTracer {
     const endOnExit = options.endOnExit === undefined ? true : options.endOnExit; // default true
     const opts: SpanOptions = { attributes: options.attributes };
 
-    return new Promise((resolve, reject) => {
-      this.tracer.startActiveSpan(options.name, opts, ctx, async (span) => {
-        try {
-          const result = await fn(span);
-          resolve(result);
-        } catch (error) {
-          reject(error);
-        } finally {
-          if (endOnExit) {
-            span.end();
-          }
+    // Directly return the tracer's startActiveSpan result - it handles async correctly
+    return await this.tracer.startActiveSpan(options.name, opts, ctx, async (span) => {
+      try {
+        return await fn(span);
+      } finally {
+        if (endOnExit) {
+          span.end();
         }
-      });
+      }
     });
   }
 
@@ -162,10 +166,6 @@ class MetadataSpanProcessor implements SpanProcessor {
   }
 }
 
-// TODO(brian): PR4 - Add MetadataLogProcessor for structured logging
-
-// TODO(brian): PR4 - Add ExtraDetailsProcessor for structured logging
-
 /**
  * Set the tracer provider for the livekit-agents framework.
  * This should be called before agent session start if using custom tracer providers.
@@ -254,13 +254,313 @@ export async function setupCloudTracer(options: {
     });
     tracerProvider.register();
 
-    // Metadata processor is already configured in the constructor above
     setTracerProvider(tracerProvider);
 
-    // TODO(brian): PR4 - Add logger provider setup here for structured logging
-    // Similar to Python's setup: LoggerProvider, OTLPLogExporter, BatchLogRecordProcessor
+    // Initialize standalone Pino cloud exporter (no OTEL SDK dependency)
+    initPinoCloudExporter({
+      cloudHostname,
+      roomId,
+      jobId,
+    });
+
+    enableOtelLogging();
   } catch (error) {
     console.error('Failed to setup cloud tracer:', error);
     throw error;
   }
 }
+
+/**
+ * Flush all pending Pino logs to ensure they are exported.
+ * Call this before session/job ends to ensure all logs are sent.
+ *
+ * @internal
+ */
+export async function flushOtelLogs(): Promise<void> {
+  await flushPinoLogs();
+}
+
+/**
+ * Convert ChatItem to proto-compatible dictionary format.
+ * TODO: Use actual agent_session proto types once @livekit/protocol v1.43.1+ is published
+ */
+function chatItemToProto(item: ChatItem): Record<string, any> {
+  const itemDict: Record<string, any> = {};
+
+  if (item.type === 'message') {
+    const roleMap: Record<string, string> = {
+      developer: 'DEVELOPER',
+      system: 'SYSTEM',
+      user: 'USER',
+      assistant: 'ASSISTANT',
+    };
+
+    const msg: Record<string, any> = {
+      id: item.id,
+      role: roleMap[item.role] || item.role.toUpperCase(),
+      content: item.content.map((c: ChatContent) => ({ text: c })),
+      createdAt: toRFC3339(item.createdAt),
+    };
+
+    if (item.interrupted) {
+      msg.interrupted = item.interrupted;
+    }
+
+    // TODO(brian): Add extra and transcriptConfidence to ChatMessage
+    // if (item.extra && Object.keys(item.extra).length > 0) {
+    //   msg.extra = item.extra;
+    // }
+
+    // if (item.transcriptConfidence !== undefined && item.transcriptConfidence !== null) {
+    //   msg.transcriptConfidence = item.transcriptConfidence;
+    // }
+
+    // TODO(brian): Add metrics to ChatMessage
+    // const metrics = item.metrics || {};
+    // if (Object.keys(metrics).length > 0) {
+    //   msg.metrics = {};
+    //   if (metrics.started_speaking_at) {
+    //     msg.metrics.startedSpeakingAt = toRFC3339(metrics.started_speaking_at);
+    //   }
+    //   if (metrics.stopped_speaking_at) {
+    //     msg.metrics.stoppedSpeakingAt = toRFC3339(metrics.stopped_speaking_at);
+    //   }
+    //   if (metrics.transcription_delay !== undefined) {
+    //     msg.metrics.transcriptionDelay = metrics.transcription_delay;
+    //   }
+    //   if (metrics.end_of_turn_delay !== undefined) {
+    //     msg.metrics.endOfTurnDelay = metrics.end_of_turn_delay;
+    //   }
+    //   if (metrics.on_user_turn_completed_delay !== undefined) {
+    //     msg.metrics.onUserTurnCompletedDelay = metrics.on_user_turn_completed_delay;
+    //   }
+    //   if (metrics.llm_node_ttft !== undefined) {
+    //     msg.metrics.llmNodeTtft = metrics.llm_node_ttft;
+    //   }
+    //   if (metrics.tts_node_ttfb !== undefined) {
+    //     msg.metrics.ttsNodeTtfb = metrics.tts_node_ttfb;
+    //   }
+    //   if (metrics.e2e_latency !== undefined) {
+    //     msg.metrics.e2eLatency = metrics.e2e_latency;
+    //   }
+    // }
+
+    itemDict.message = msg;
+  } else if (item.type === 'function_call') {
+    itemDict.functionCall = {
+      id: item.id,
+      callId: item.callId,
+      arguments: item.args,
+      name: item.name,
+      createdAt: toRFC3339(item.createdAt),
+    };
+  } else if (item.type === 'function_call_output') {
+    itemDict.functionCallOutput = {
+      id: item.id,
+      name: item.name,
+      callId: item.callId,
+      output: item.output,
+      isError: item.isError,
+      createdAt: toRFC3339(item.createdAt),
+    };
+  } else if (item.type === 'agent_handoff') {
+    const handoff: Record<string, any> = {
+      id: item.id,
+      newAgentId: item.newAgentId,
+      createdAt: toRFC3339(item.createdAt),
+    };
+    if (item.oldAgentId !== undefined && item.oldAgentId !== null && item.oldAgentId !== '') {
+      handoff.oldAgentId = item.oldAgentId;
+    }
+    itemDict.agentHandoff = handoff;
+  }
+
+  try {
+    if (item.type === 'function_call' && typeof itemDict.functionCall?.arguments === 'string') {
+      itemDict.functionCall.arguments = JSON.parse(itemDict.functionCall.arguments);
+    } else if (
+      item.type === 'function_call_output' &&
+      typeof itemDict.functionCallOutput?.output === 'string'
+    ) {
+      itemDict.functionCallOutput.output = JSON.parse(itemDict.functionCallOutput.output);
+    }
+  } catch {
+    // ignore parsing errors
+  }
+
+  return itemDict;
+}
+
+/**
+ * Convert timestamp to RFC3339 format matching Python's _to_rfc3339.
+ * Note: TypeScript createdAt is in milliseconds (Date.now()), not seconds like Python.
+ * @internal
+ */
+function toRFC3339(valueMs: number | Date): string {
+  // valueMs is already in milliseconds (from Date.now())
+  const dt = valueMs instanceof Date ? valueMs : new Date(valueMs);
+  // Truncate sub-millisecond precision
+  const truncated = new Date(Math.floor(dt.getTime()));
+  return truncated.toISOString();
+}
+
+/**
+ * Upload session report to LiveKit Cloud observability.
+ * @param options - Configuration with agentName, cloudHostname, and report
+ */
+export async function uploadSessionReport(options: {
+  agentName: string;
+  cloudHostname: string;
+  report: SessionReport;
+}): Promise<void> {
+  const { agentName, cloudHostname, report } = options;
+
+  // Create OTLP HTTP exporter for chat history logs
+  // Uses raw HTTP JSON format which is required by LiveKit Cloud
+  const logExporter = new SimpleOTLPHttpLogExporter({
+    cloudHostname,
+    resourceAttributes: {
+      room_id: report.roomId,
+      job_id: report.jobId,
+    },
+    scopeName: 'chat_history',
+    scopeAttributes: {
+      room_id: report.roomId,
+      job_id: report.jobId,
+      room: report.room,
+    },
+  });
+
+  // Build log records for session report and chat items
+  const logRecords: SimpleLogRecord[] = [];
+
+  const commonAttrs = {
+    room_id: report.roomId,
+    job_id: report.jobId,
+    'logger.name': 'chat_history',
+  };
+
+  logRecords.push({
+    body: 'session report',
+    timestampMs: report.startedAt || report.timestamp || 0,
+    attributes: {
+      ...commonAttrs,
+      'session.options': report.options || {},
+      'session.report_timestamp': report.timestamp,
+      agent_name: agentName,
+    },
+  });
+
+  // Track last timestamp to ensure monotonic ordering when items have identical timestamps
+  // This fixes the issue where function_call and function_call_output with same timestamp
+  // get reordered by the dashboard
+  let lastTimestamp = 0;
+  for (const item of report.chatHistory.items) {
+    // Ensure monotonically increasing timestamps for proper ordering
+    // Add 0.001ms (1 microsecond) offset when timestamps collide
+    let itemTimestamp = item.createdAt;
+    if (itemTimestamp <= lastTimestamp) {
+      itemTimestamp = lastTimestamp + 0.001; // Add 1 microsecond
+    }
+    lastTimestamp = itemTimestamp;
+
+    const itemProto = chatItemToProto(item);
+    let severityNumber = SeverityNumber.UNSPECIFIED;
+    let severityText = 'unspecified';
+
+    if (item.type === 'function_call_output' && item.isError) {
+      severityNumber = SeverityNumber.ERROR;
+      severityText = 'error';
+    }
+
+    logRecords.push({
+      body: 'chat item',
+      timestampMs: itemTimestamp, // Adjusted for monotonic ordering
+      attributes: { 'chat.item': itemProto, ...commonAttrs },
+      severityNumber,
+      severityText,
+    });
+  }
+  await logExporter.export(logRecords);
+
+  const apiKey = process.env.LIVEKIT_API_KEY;
+  const apiSecret = process.env.LIVEKIT_API_SECRET;
+
+  if (!apiKey || !apiSecret) {
+    throw new Error('LIVEKIT_API_KEY and LIVEKIT_API_SECRET must be set for session upload');
+  }
+
+  const token = new AccessToken(apiKey, apiSecret, { ttl: '6h' });
+  token.addObservabilityGrant({ write: true });
+  const jwt = await token.toJwt();
+
+  const formData = new FormData();
+
+  // Add header (protobuf MetricsRecordingHeader)
+  const headerMsg = new MetricsRecordingHeader({
+    roomId: report.roomId,
+    duration: BigInt(0), // TODO: Calculate actual duration from report
+    startTime: {
+      seconds: BigInt(Math.floor(report.timestamp / 1000)),
+      nanos: Math.floor((report.timestamp % 1000) * 1e6),
+    },
+  });
+
+  const headerBytes = Buffer.from(headerMsg.toBinary());
+  formData.append('header', headerBytes, {
+    filename: 'header.binpb',
+    contentType: 'application/protobuf',
+    knownLength: headerBytes.length,
+    header: {
+      'Content-Type': 'application/protobuf',
+      'Content-Length': headerBytes.length.toString(),
+    },
+  });
+
+  // Add chat_history JSON
+  const chatHistoryJson = JSON.stringify(report.chatHistory.toJSON({ excludeTimestamp: false }));
+  const chatHistoryBuffer = Buffer.from(chatHistoryJson, 'utf-8');
+  formData.append('chat_history', chatHistoryBuffer, {
+    filename: 'chat_history.json',
+    contentType: 'application/json',
+    knownLength: chatHistoryBuffer.length,
+    header: {
+      'Content-Type': 'application/json',
+      'Content-Length': chatHistoryBuffer.length.toString(),
+    },
+  });
+
+  // TODO(brian): Add audio recording file when recorder IO is implemented
+
+  // Upload to LiveKit Cloud using form-data's submit method
+  // This properly streams the multipart form with all headers including Content-Length
+  return new Promise<void>((resolve, reject) => {
+    formData.submit(
+      {
+        protocol: 'https:',
+        host: cloudHostname,
+        path: '/observability/recordings/v0',
+        method: 'POST',
+        headers: {
+          Authorization: `Bearer ${jwt}`,
+        },
+      },
+      (err, res) => {
+        if (err) {
+          reject(new Error(`Failed to upload session report: ${err.message}`));
+          return;
+        }
+
+        if (res.statusCode && res.statusCode >= 400) {
+          reject(
+            new Error(`Failed to upload session report: ${res.statusCode} ${res.statusMessage}`),
+          );
+          return;
+        }
+
+        res.resume(); // Drain the response
+        res.on('end', () => resolve());
+      },
+    );
+  });
+}

package/src/tts/tts.ts

@@ -3,12 +3,14 @@
 // SPDX-License-Identifier: Apache-2.0
 import type { AudioFrame } from '@livekit/rtc-node';
 import type { TypedEventEmitter as TypedEmitter } from '@livekit/typed-emitter';
+import type { Span } from '@opentelemetry/api';
 import { EventEmitter } from 'node:events';
 import type { ReadableStream } from 'node:stream/web';
 import { APIConnectionError, APIError } from '../_exceptions.js';
 import { log } from '../log.js';
 import type { TTSMetrics } from '../metrics/base.js';
 import { DeferredReadableStream } from '../stream/deferred_stream.js';
+import { recordException, traceTypes, tracer } from '../telemetry/index.js';
 import { type APIConnectOptions, DEFAULT_API_CONNECT_OPTIONS } from '../types.js';
 import { AsyncIterableQueue, delay, mergeFrames, startSoon, toError } from '../utils.js';
 
@@ -134,6 +136,7 @@ export abstract class SynthesizeStream
   #monitorMetricsTask?: Promise<void>;
   private _connOptions: APIConnectOptions;
   protected abortController = new AbortController();
+  #ttsRequestSpan?: Span;
 
   private deferredInputStream: DeferredReadableStream<
     string | typeof SynthesizeStream.FLUSH_SENTINEL
@@ -160,12 +163,27 @@ export abstract class SynthesizeStream
     startSoon(() => this.mainTask().then(() => this.queue.close()));
   }
 
-  private async mainTask() {
-    // TODO(brian): PR3 - Add span wrapping: tracer.startActiveSpan('tts_request', ..., { endOnExit: false })
+  private _mainTaskImpl = async (span: Span) => {
+    this.#ttsRequestSpan = span;
+    span.setAttributes({
+      [traceTypes.ATTR_TTS_STREAMING]: true,
+      [traceTypes.ATTR_TTS_LABEL]: this.#tts.label,
+    });
+
     for (let i = 0; i < this._connOptions.maxRetry + 1; i++) {
       try {
-        // TODO(brian): PR3 - Add span for retry attempts: tracer.startActiveSpan('tts_request_run', ...)
-        return await this.run();
+        return await tracer.startActiveSpan(
+          async (attemptSpan) => {
+            attemptSpan.setAttribute(traceTypes.ATTR_RETRY_COUNT, i);
+            try {
+              return await this.run();
+            } catch (error) {
+              recordException(attemptSpan, toError(error));
+              throw error;
+            }
+          },
+          { name: 'tts_request_run' },
+        );
       } catch (error) {
         if (error instanceof APIError) {
           const retryInterval = this._connOptions._intervalForRetry(i);
@@ -197,7 +215,13 @@ export abstract class SynthesizeStream
         }
       }
     }
-  }
+  };
+
+  private mainTask = async () =>
+    tracer.startActiveSpan(async (span) => this._mainTaskImpl(span), {
+      name: 'tts_request',
+      endOnExit: false,
+    });
 
   private emitError({ error, recoverable }: { error: Error; recoverable: boolean }) {
     this.#tts.emit('error', {
@@ -265,6 +289,9 @@ export abstract class SynthesizeStream
           label: this.#tts.label,
           streamed: false,
         };
+        if (this.#ttsRequestSpan) {
+          this.#ttsRequestSpan.setAttribute(traceTypes.ATTR_TTS_METRICS, JSON.stringify(metrics));
+        }
         this.#tts.emit('metrics_collected', metrics);
       }
     };
@@ -289,6 +316,11 @@ export abstract class SynthesizeStream
     if (requestId) {
       emit();
     }
+
+    if (this.#ttsRequestSpan) {
+      this.#ttsRequestSpan.end();
+      this.#ttsRequestSpan = undefined;
+    }
   }
 
   protected abstract run(): Promise<void>;
@@ -377,6 +409,7 @@ export abstract class ChunkedStream implements AsyncIterableIterator<Synthesized
   abstract label: string;
   #text: string;
   #tts: TTS;
+  #ttsRequestSpan?: Span;
   private _connOptions: APIConnectOptions;
   private logger = log();
 
@@ -398,12 +431,27 @@ export abstract class ChunkedStream implements AsyncIterableIterator<Synthesized
     Promise.resolve().then(() => this.mainTask().then(() => this.queue.close()));
   }
 
-  private async mainTask() {
-    // TODO(brian): PR3 - Add span wrapping: tracer.startActiveSpan('tts_request', ..., { endOnExit: false })
+  private _mainTaskImpl = async (span: Span) => {
+    this.#ttsRequestSpan = span;
+    span.setAttributes({
+      [traceTypes.ATTR_TTS_STREAMING]: false,
+      [traceTypes.ATTR_TTS_LABEL]: this.#tts.label,
+    });
+
     for (let i = 0; i < this._connOptions.maxRetry + 1; i++) {
       try {
-        // TODO(brian): PR3 - Add span for retry attempts: tracer.startActiveSpan('tts_request_run', ...)
-        return await this.run();
+        return await tracer.startActiveSpan(
+          async (attemptSpan) => {
+            attemptSpan.setAttribute(traceTypes.ATTR_RETRY_COUNT, i);
+            try {
+              return await this.run();
+            } catch (error) {
+              recordException(attemptSpan, toError(error));
+              throw error;
+            }
+          },
+          { name: 'tts_request_run' },
+        );
       } catch (error) {
         if (error instanceof APIError) {
           const retryInterval = this._connOptions._intervalForRetry(i);
@@ -435,6 +483,13 @@ export abstract class ChunkedStream implements AsyncIterableIterator<Synthesized
         }
       }
     }
+  };
+
+  private async mainTask() {
+    return tracer.startActiveSpan(async (span) => this._mainTaskImpl(span), {
+      name: 'tts_request',
+      endOnExit: false,
+    });
   }
 
   private emitError({ error, recoverable }: { error: Error; recoverable: boolean }) {
@@ -482,6 +537,13 @@ export abstract class ChunkedStream implements AsyncIterableIterator<Synthesized
       label: this.#tts.label,
       streamed: false,
     };
+
+    if (this.#ttsRequestSpan) {
+      this.#ttsRequestSpan.setAttribute(traceTypes.ATTR_TTS_METRICS, JSON.stringify(metrics));
+      this.#ttsRequestSpan.end();
+      this.#ttsRequestSpan = undefined;
+    }
+
     this.#tts.emit('metrics_collected', metrics);
   }
 

package/src/utils.ts

@@ -839,3 +839,8 @@ export async function waitForAbort(signal: AbortSignal) {
   signal.addEventListener('abort', handler, { once: true });
   return await abortFuture.await;
 }
+
+export const isCloud = (url: URL) => {
+  const hostname = url.hostname;
+  return hostname.endsWith('.livekit.cloud') || hostname.endsWith('.livekit.run');
+};