@livekit/agents 1.0.22 → 1.0.23

package/src/log.ts

@@ -1,8 +1,11 @@
 // SPDX-FileCopyrightText: 2024 LiveKit, Inc.
 //
 // SPDX-License-Identifier: Apache-2.0
-import type { Logger } from 'pino';
-import { pino } from 'pino';
+import { Writable } from 'node:stream';
+import type { DestinationStream, Logger } from 'pino';
+import { multistream, pino } from 'pino';
+import { build as pinoPretty } from 'pino-pretty';
+import { type PinoLogObject, emitToOtel } from './telemetry/pino_otel_transport.js';
 
 /** @internal */
 export type LoggerOptions = {
@@ -16,6 +19,9 @@ export let loggerOptions: LoggerOptions;
 /** @internal */
 let logger: Logger | undefined = undefined;
 
+/** @internal */
+let otelEnabled = false;
+
 /** @internal */
 export const log = () => {
   if (!logger) {
@@ -28,19 +34,50 @@ export const log = () => {
 export const initializeLogger = ({ pretty, level }: LoggerOptions) => {
   loggerOptions = { pretty, level };
   logger = pino(
-    pretty
-      ? {
-          transport: {
-            target: 'pino-pretty',
-            options: {
-              colorize: true,
-            },
-          },
-        }
-      : {},
+    { level: level || 'info' },
+    pretty ? pinoPretty({ colorize: true }) : process.stdout,
   );
-  if (level) {
-    logger.level = level;
+};
+
+/**
+ * Custom Pino destination that parses JSON logs and emits to OTEL.
+ * This receives the FULL serialized log including msg, level, time, etc.
+ */
+class OtelDestination extends Writable {
+  _write(chunk: Buffer, _encoding: string, callback: (error?: Error | null) => void): void {
+    try {
+      const line = chunk.toString().trim();
+      if (line) {
+        const logObj = JSON.parse(line) as PinoLogObject;
+        emitToOtel(logObj);
+      }
+    } catch {
+      // Ignore parse errors (e.g., non-JSON lines)
+    }
+    callback();
   }
-  // TODO(brian): PR4 - Add Pino bridge to OTEL LoggingHandler for structured logging integration
+}
+
+/**
+ * Enable OTEL logging by reconfiguring the logger with multistream.
+ * Uses a custom destination that receives full JSON logs (with msg, level, time).
+ *
+ * @internal
+ */
+export const enableOtelLogging = () => {
+  if (otelEnabled || !logger) {
+    console.warn('OTEL logging already enabled or logger not initialized');
+    return;
+  }
+  otelEnabled = true;
+
+  const { pretty, level } = loggerOptions;
+
+  const logLevel = level || 'info';
+  const streams: { stream: DestinationStream; level: string }[] = [
+    { stream: pretty ? pinoPretty({ colorize: true }) : process.stdout, level: logLevel },
+    { stream: new OtelDestination(), level: 'debug' },
+  ];
+
+  logger = pino({ level: logLevel }, multistream(streams));
 };

package/src/telemetry/index.ts

@@ -2,9 +2,27 @@
 //
 // SPDX-License-Identifier: Apache-2.0
 
-// TODO(brian): PR4 - Add logging integration exports
-// TODO(brian): PR5 - Add uploadSessionReport export
-
+export { ExtraDetailsProcessor, MetadataLogProcessor } from './logging.js';
+export {
+  SimpleOTLPHttpLogExporter,
+  type SimpleLogRecord,
+  type SimpleOTLPHttpLogExporterConfig,
+} from './otel_http_exporter.js';
+export {
+  emitToOtel,
+  flushPinoLogs,
+  initPinoCloudExporter,
+  PinoCloudExporter,
+  type PinoCloudExporterConfig,
+  type PinoLogObject,
+} from './pino_otel_transport.js';
 export * as traceTypes from './trace_types.js';
-export { setTracerProvider, setupCloudTracer, tracer, type StartSpanOptions } from './traces.js';
+export {
+  flushOtelLogs,
+  setTracerProvider,
+  setupCloudTracer,
+  tracer,
+  uploadSessionReport,
+  type StartSpanOptions,
+} from './traces.js';
 export { recordException, recordRealtimeMetrics } from './utils.js';

package/src/telemetry/logging.ts

@@ -0,0 +1,55 @@
+// SPDX-FileCopyrightText: 2025 LiveKit, Inc.
+//
+// SPDX-License-Identifier: Apache-2.0
+import type { Attributes } from '@opentelemetry/api';
+import type { LogRecord, LogRecordProcessor } from '@opentelemetry/sdk-logs';
+
+/**
+ * Metadata log processor that injects metadata (room_id, job_id) into all log records.
+ */
+export class MetadataLogProcessor implements LogRecordProcessor {
+  private metadata: Attributes;
+
+  constructor(metadata: Attributes) {
+    this.metadata = metadata;
+  }
+
+  onEmit(logRecord: LogRecord): void {
+    // Add metadata to log record attributes
+    if (logRecord.attributes) {
+      Object.assign(logRecord.attributes, this.metadata);
+    } else {
+      (logRecord as any).attributes = { ...this.metadata };
+    }
+  }
+
+  shutdown(): Promise<void> {
+    return Promise.resolve();
+  }
+
+  forceFlush(): Promise<void> {
+    return Promise.resolve();
+  }
+}
+
+/**
+ * Extra details processor that adds logger name to log records.
+ */
+export class ExtraDetailsProcessor implements LogRecordProcessor {
+  onEmit(logRecord: LogRecord): void {
+    const loggerName = logRecord.instrumentationScope.name;
+    if (logRecord.attributes) {
+      (logRecord.attributes as any)['logger.name'] = loggerName;
+    } else {
+      (logRecord as any).attributes = { 'logger.name': loggerName };
+    }
+  }
+
+  shutdown(): Promise<void> {
+    return Promise.resolve();
+  }
+
+  forceFlush(): Promise<void> {
+    return Promise.resolve();
+  }
+}

package/src/telemetry/otel_http_exporter.ts

@@ -0,0 +1,191 @@
+// SPDX-FileCopyrightText: 2025 LiveKit, Inc.
+//
+// SPDX-License-Identifier: Apache-2.0
+
+/**
+ * OTLP HTTP JSON Log Exporter for LiveKit Cloud
+ *
+ * This module provides a custom OTLP log exporter that uses HTTP with JSON format
+ * instead of the default protobuf format.
+ */
+import { SeverityNumber } from '@opentelemetry/api-logs';
+import { AccessToken } from 'livekit-server-sdk';
+
+export interface SimpleLogRecord {
+  /** Log message body */
+  body: string;
+  /** Timestamp in milliseconds since epoch */
+  timestampMs: number;
+  /** Log attributes */
+  attributes: Record<string, unknown>;
+  /** Severity number (default: UNSPECIFIED) */
+  severityNumber?: SeverityNumber;
+  /** Severity text (default: 'unspecified') */
+  severityText?: string;
+}
+
+export interface SimpleOTLPHttpLogExporterConfig {
+  /** LiveKit Cloud hostname */
+  cloudHostname: string;
+  /** Resource attributes (e.g., room_id, job_id) */
+  resourceAttributes: Record<string, string>;
+  /** Scope name for the logger */
+  scopeName: string;
+  /** Scope attributes */
+  scopeAttributes?: Record<string, string>;
+}
+
+/**
+ * Simple OTLP HTTP Log Exporter for direct log export
+ *
+ * This is a simplified exporter that doesn't require the full SDK infrastructure.
+ * Use this when you need to send logs directly without LoggerProvider.
+ *
+ * @example
+ * ```typescript
+ * const exporter = new SimpleOTLPHttpLogExporter({
+ *   cloudHostname: 'cloud.livekit.io',
+ *   resourceAttributes: { room_id: 'xxx', job_id: 'yyy' },
+ *   scopeName: 'chat_history',
+ * });
+ *
+ * await exporter.export([
+ *   { body: 'Hello', timestampMs: Date.now(), attributes: { test: true } },
+ * ]);
+ * ```
+ */
+export class SimpleOTLPHttpLogExporter {
+  private readonly config: SimpleOTLPHttpLogExporterConfig;
+  private jwt: string | null = null;
+
+  constructor(config: SimpleOTLPHttpLogExporterConfig) {
+    this.config = config;
+  }
+
+  /**
+   * Export simple log records
+   */
+  async export(records: SimpleLogRecord[]): Promise<void> {
+    if (records.length === 0) return;
+
+    await this.ensureJwt();
+
+    const endpoint = `https://${this.config.cloudHostname}/observability/logs/otlp/v0`;
+    const payload = this.buildPayload(records);
+
+    const response = await fetch(endpoint, {
+      method: 'POST',
+      headers: {
+        Authorization: `Bearer ${this.jwt}`,
+        'Content-Type': 'application/json',
+      },
+      body: JSON.stringify(payload),
+    });
+
+    if (!response.ok) {
+      const text = await response.text();
+      throw new Error(
+        `OTLP log export failed: ${response.status} ${response.statusText} - ${text}`,
+      );
+    }
+  }
+
+  private async ensureJwt(): Promise<void> {
+    if (this.jwt) return;
+
+    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');
+    }
+
+    const token = new AccessToken(apiKey, apiSecret, { ttl: '6h' });
+    token.addObservabilityGrant({ write: true });
+    this.jwt = await token.toJwt();
+  }
+
+  private buildPayload(records: SimpleLogRecord[]): object {
+    const resourceAttrs = Object.entries(this.config.resourceAttributes).map(([key, value]) => ({
+      key,
+      value: { stringValue: value },
+    }));
+
+    if (!this.config.resourceAttributes['service.name']) {
+      resourceAttrs.push({ key: 'service.name', value: { stringValue: 'livekit-agents' } });
+    }
+
+    const scopeAttrs = this.config.scopeAttributes
+      ? Object.entries(this.config.scopeAttributes).map(([key, value]) => ({
+          key,
+          value: { stringValue: value },
+        }))
+      : [];
+
+    const logRecords = records.map((record) => ({
+      timeUnixNano: String(BigInt(Math.floor(record.timestampMs * 1_000_000))),
+      observedTimeUnixNano: String(BigInt(Date.now()) * BigInt(1_000_000)),
+      severityNumber: record.severityNumber ?? SeverityNumber.UNSPECIFIED,
+      severityText: record.severityText ?? 'unspecified',
+      body: { stringValue: record.body },
+      attributes: this.convertAttributes(record.attributes),
+      traceId: '',
+      spanId: '',
+    }));
+
+    return {
+      resourceLogs: [
+        {
+          resource: { attributes: resourceAttrs },
+          scopeLogs: [
+            {
+              scope: {
+                name: this.config.scopeName,
+                attributes: scopeAttrs,
+              },
+              logRecords,
+            },
+          ],
+        },
+      ],
+    };
+  }
+
+  private convertAttributes(
+    attrs: Record<string, unknown>,
+  ): Array<{ key: string; value: unknown }> {
+    return Object.entries(attrs).map(([key, value]) => ({
+      key,
+      value: this.convertValue(value),
+    }));
+  }
+
+  private convertValue(value: unknown): unknown {
+    if (value === null || value === undefined) {
+      return { stringValue: '' };
+    }
+    if (typeof value === 'string') {
+      return { stringValue: value };
+    }
+    if (typeof value === 'number') {
+      return Number.isInteger(value) ? { intValue: String(value) } : { doubleValue: value };
+    }
+    if (typeof value === 'boolean') {
+      return { boolValue: value };
+    }
+    if (Array.isArray(value)) {
+      return { arrayValue: { values: value.map((v) => this.convertValue(v)) } };
+    }
+    if (typeof value === 'object') {
+      return {
+        kvlistValue: {
+          values: Object.entries(value as Record<string, unknown>).map(([k, v]) => ({
+            key: k,
+            value: this.convertValue(v),
+          })),
+        },
+      };
+    }
+    return { stringValue: String(value) };
+  }
+}

package/src/telemetry/pino_otel_transport.ts

@@ -0,0 +1,265 @@
+// SPDX-FileCopyrightText: 2025 LiveKit, Inc.
+//
+// SPDX-License-Identifier: Apache-2.0
+
+/**
+ * Custom Pino OTEL Transport
+ *
+ * Standalone exporter for Pino logs to LiveKit Cloud.
+ * Uses raw HTTP JSON format, bypassing the OTEL SDK.
+ */
+import { SeverityNumber } from '@opentelemetry/api-logs';
+import { AccessToken } from 'livekit-server-sdk';
+
+export interface PinoLogObject {
+  level: number;
+  time: number;
+  msg: string;
+  pid?: number;
+  hostname?: string;
+  [key: string]: unknown;
+}
+
+export interface PinoCloudExporterConfig {
+  cloudHostname: string;
+  roomId: string;
+  jobId: string;
+  loggerName?: string;
+  batchSize?: number;
+  flushIntervalMs?: number;
+}
+
+function mapPinoLevelToSeverity(pinoLevel: number): {
+  severityNumber: SeverityNumber;
+  severityText: string;
+} {
+  if (pinoLevel <= 10) {
+    return { severityNumber: SeverityNumber.TRACE, severityText: 'TRACE' };
+  } else if (pinoLevel <= 20) {
+    return { severityNumber: SeverityNumber.DEBUG, severityText: 'DEBUG' };
+  } else if (pinoLevel <= 30) {
+    return { severityNumber: SeverityNumber.INFO, severityText: 'INFO' };
+  } else if (pinoLevel <= 40) {
+    return { severityNumber: SeverityNumber.WARN, severityText: 'WARN' };
+  } else if (pinoLevel <= 50) {
+    return { severityNumber: SeverityNumber.ERROR, severityText: 'ERROR' };
+  } else {
+    return { severityNumber: SeverityNumber.FATAL, severityText: 'FATAL' };
+  }
+}
+
+const EXCLUDE_FIELDS = new Set(['level', 'time', 'msg', 'pid', 'hostname', 'v']);
+
+function convertValue(value: unknown): unknown {
+  if (value === null || value === undefined) {
+    return { stringValue: '' };
+  }
+  if (typeof value === 'string') {
+    return { stringValue: value };
+  }
+  if (typeof value === 'number') {
+    return Number.isInteger(value) ? { intValue: String(value) } : { doubleValue: value };
+  }
+  if (typeof value === 'boolean') {
+    return { boolValue: value };
+  }
+  if (typeof value === 'object') {
+    return { stringValue: JSON.stringify(value) };
+  }
+  return { stringValue: String(value) };
+}
+
+/**
+ * Standalone Pino log exporter for LiveKit Cloud.
+ *
+ * Collects Pino logs, batches them, and sends via raw HTTP JSON.
+ * No OTEL SDK dependency
+ *
+ * @example
+ * ```typescript
+ * const exporter = new PinoCloudExporter({
+ *   cloudHostname: 'cloud.livekit.io',
+ *   roomId: 'RM_xxx',
+ *   jobId: 'AJ_xxx',
+ * });
+ *
+ * // In Pino formatter hook:
+ * exporter.emit(logObj);
+ *
+ * // On session end:
+ * await exporter.flush();
+ * ```
+ */
+export class PinoCloudExporter {
+  private readonly config: PinoCloudExporterConfig;
+  private readonly loggerName: string;
+  private readonly batchSize: number;
+  private readonly flushIntervalMs: number;
+  private jwt: string | null = null;
+  private pendingLogs: any[] = [];
+  private flushTimer: NodeJS.Timeout | null = null;
+
+  constructor(config: PinoCloudExporterConfig) {
+    this.config = config;
+    this.loggerName = config.loggerName || 'livekit.agents';
+    this.batchSize = config.batchSize || 100;
+    this.flushIntervalMs = config.flushIntervalMs || 5000;
+  }
+
+  emit(logObj: PinoLogObject): void {
+    const record = this.convertToOtlpRecord(logObj);
+    this.pendingLogs.push(record);
+
+    if (!this.flushTimer) {
+      this.flushTimer = setTimeout(() => {
+        this.flush().catch(console.error);
+      }, this.flushIntervalMs);
+    }
+
+    if (this.pendingLogs.length >= this.batchSize) {
+      this.flush().catch(console.error);
+    }
+  }
+
+  private convertToOtlpRecord(logObj: PinoLogObject): any {
+    const { severityNumber, severityText } = mapPinoLevelToSeverity(logObj.level);
+
+    const attributes: any[] = [
+      { key: 'room_id', value: { stringValue: this.config.roomId } },
+      { key: 'job_id', value: { stringValue: this.config.jobId } },
+      { key: 'logger.name', value: { stringValue: this.loggerName } },
+    ];
+
+    if (logObj.pid !== undefined) {
+      attributes.push({ key: 'process.pid', value: { intValue: String(logObj.pid) } });
+    }
+    if (logObj.hostname !== undefined) {
+      attributes.push({ key: 'host.name', value: { stringValue: logObj.hostname } });
+    }
+
+    for (const [key, value] of Object.entries(logObj)) {
+      if (!EXCLUDE_FIELDS.has(key)) {
+        attributes.push({ key, value: convertValue(value) });
+      }
+    }
+
+    return {
+      timeUnixNano: String(BigInt(logObj.time) * BigInt(1_000_000)),
+      observedTimeUnixNano: String(BigInt(Date.now()) * BigInt(1_000_000)),
+      severityNumber,
+      severityText,
+      body: { stringValue: logObj.msg || '' },
+      attributes,
+      traceId: '',
+      spanId: '',
+    };
+  }
+
+  async flush(): Promise<void> {
+    if (this.flushTimer) {
+      clearTimeout(this.flushTimer);
+      this.flushTimer = null;
+    }
+
+    if (this.pendingLogs.length === 0) {
+      return;
+    }
+
+    const logs = this.pendingLogs;
+    this.pendingLogs = [];
+
+    try {
+      await this.sendLogs(logs);
+    } catch (error) {
+      this.pendingLogs = [...logs, ...this.pendingLogs];
+      console.error('[PinoCloudExporter] Failed to flush logs:', error);
+    }
+  }
+
+  private async sendLogs(logRecords: any[]): Promise<void> {
+    await this.ensureJwt();
+
+    const payload = {
+      resourceLogs: [
+        {
+          resource: {
+            attributes: [
+              { key: 'service.name', value: { stringValue: 'livekit-agents' } },
+              { key: 'room_id', value: { stringValue: this.config.roomId } },
+              { key: 'job_id', value: { stringValue: this.config.jobId } },
+            ],
+          },
+          scopeLogs: [
+            {
+              scope: {
+                name: this.loggerName,
+                attributes: [
+                  { key: 'room_id', value: { stringValue: this.config.roomId } },
+                  { key: 'job_id', value: { stringValue: this.config.jobId } },
+                ],
+              },
+              logRecords,
+            },
+          ],
+        },
+      ],
+    };
+
+    const endpoint = `https://${this.config.cloudHostname}/observability/logs/otlp/v0`;
+
+    const response = await fetch(endpoint, {
+      method: 'POST',
+      headers: {
+        Authorization: `Bearer ${this.jwt}`,
+        'Content-Type': 'application/json',
+      },
+      body: JSON.stringify(payload),
+    });
+
+    if (!response.ok) {
+      const text = await response.text();
+      throw new Error(`Log export failed: ${response.status} ${response.statusText} - ${text}`);
+    }
+  }
+
+  private async ensureJwt(): Promise<void> {
+    if (this.jwt) return;
+
+    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');
+    }
+
+    const token = new AccessToken(apiKey, apiSecret, { ttl: '6h' });
+    token.addObservabilityGrant({ write: true });
+    this.jwt = await token.toJwt();
+  }
+
+  async shutdown(): Promise<void> {
+    await this.flush();
+  }
+}
+
+let globalExporter: PinoCloudExporter | null = null;
+
+export function initPinoCloudExporter(config: PinoCloudExporterConfig): void {
+  globalExporter = new PinoCloudExporter(config);
+}
+
+export function getPinoCloudExporter(): PinoCloudExporter | null {
+  return globalExporter;
+}
+
+export function emitToOtel(logObj: PinoLogObject): void {
+  if (globalExporter) {
+    globalExporter.emit(logObj);
+  }
+}
+
+export async function flushPinoLogs(): Promise<void> {
+  if (globalExporter) {
+    await globalExporter.flush();
+  }
+}