@livekit/agents 1.0.17 → 1.0.19

package/dist/telemetry/trace_types.js

@@ -0,0 +1,113 @@
+const ATTR_SPEECH_ID = "lk.speech_id";
+const ATTR_AGENT_LABEL = "lk.agent_label";
+const ATTR_START_TIME = "lk.start_time";
+const ATTR_END_TIME = "lk.end_time";
+const ATTR_RETRY_COUNT = "lk.retry_count";
+const ATTR_PARTICIPANT_ID = "lk.participant_id";
+const ATTR_PARTICIPANT_IDENTITY = "lk.participant_identity";
+const ATTR_PARTICIPANT_KIND = "lk.participant_kind";
+const ATTR_JOB_ID = "lk.job_id";
+const ATTR_AGENT_NAME = "lk.agent_name";
+const ATTR_ROOM_NAME = "lk.room_name";
+const ATTR_SESSION_OPTIONS = "lk.session_options";
+const ATTR_USER_INPUT = "lk.user_input";
+const ATTR_INSTRUCTIONS = "lk.instructions";
+const ATTR_SPEECH_INTERRUPTED = "lk.interrupted";
+const ATTR_CHAT_CTX = "lk.chat_ctx";
+const ATTR_FUNCTION_TOOLS = "lk.function_tools";
+const ATTR_RESPONSE_TEXT = "lk.response.text";
+const ATTR_RESPONSE_FUNCTION_CALLS = "lk.response.function_calls";
+const ATTR_FUNCTION_TOOL_NAME = "lk.function_tool.name";
+const ATTR_FUNCTION_TOOL_ARGS = "lk.function_tool.arguments";
+const ATTR_FUNCTION_TOOL_IS_ERROR = "lk.function_tool.is_error";
+const ATTR_FUNCTION_TOOL_OUTPUT = "lk.function_tool.output";
+const ATTR_TTS_INPUT_TEXT = "lk.input_text";
+const ATTR_TTS_STREAMING = "lk.tts.streaming";
+const ATTR_TTS_LABEL = "lk.tts.label";
+const ATTR_EOU_PROBABILITY = "lk.eou.probability";
+const ATTR_EOU_UNLIKELY_THRESHOLD = "lk.eou.unlikely_threshold";
+const ATTR_EOU_DELAY = "lk.eou.endpointing_delay";
+const ATTR_EOU_LANGUAGE = "lk.eou.language";
+const ATTR_USER_TRANSCRIPT = "lk.user_transcript";
+const ATTR_TRANSCRIPT_CONFIDENCE = "lk.transcript_confidence";
+const ATTR_TRANSCRIPTION_DELAY = "lk.transcription_delay";
+const ATTR_END_OF_TURN_DELAY = "lk.end_of_turn_delay";
+const ATTR_LLM_METRICS = "lk.llm_metrics";
+const ATTR_TTS_METRICS = "lk.tts_metrics";
+const ATTR_REALTIME_MODEL_METRICS = "lk.realtime_model_metrics";
+const ATTR_GEN_AI_OPERATION_NAME = "gen_ai.operation.name";
+const ATTR_GEN_AI_REQUEST_MODEL = "gen_ai.request.model";
+const ATTR_GEN_AI_USAGE_INPUT_TOKENS = "gen_ai.usage.input_tokens";
+const ATTR_GEN_AI_USAGE_OUTPUT_TOKENS = "gen_ai.usage.output_tokens";
+const ATTR_GEN_AI_USAGE_INPUT_TEXT_TOKENS = "gen_ai.usage.input_text_tokens";
+const ATTR_GEN_AI_USAGE_INPUT_AUDIO_TOKENS = "gen_ai.usage.input_audio_tokens";
+const ATTR_GEN_AI_USAGE_INPUT_CACHED_TOKENS = "gen_ai.usage.input_cached_tokens";
+const ATTR_GEN_AI_USAGE_OUTPUT_TEXT_TOKENS = "gen_ai.usage.output_text_tokens";
+const ATTR_GEN_AI_USAGE_OUTPUT_AUDIO_TOKENS = "gen_ai.usage.output_audio_tokens";
+const EVENT_GEN_AI_SYSTEM_MESSAGE = "gen_ai.system.message";
+const EVENT_GEN_AI_USER_MESSAGE = "gen_ai.user.message";
+const EVENT_GEN_AI_ASSISTANT_MESSAGE = "gen_ai.assistant.message";
+const EVENT_GEN_AI_TOOL_MESSAGE = "gen_ai.tool.message";
+const EVENT_GEN_AI_CHOICE = "gen_ai.choice";
+const ATTR_EXCEPTION_TRACE = "exception.stacktrace";
+const ATTR_EXCEPTION_TYPE = "exception.type";
+const ATTR_EXCEPTION_MESSAGE = "exception.message";
+const ATTR_LANGFUSE_COMPLETION_START_TIME = "langfuse.observation.completion_start_time";
+export {
+  ATTR_AGENT_LABEL,
+  ATTR_AGENT_NAME,
+  ATTR_CHAT_CTX,
+  ATTR_END_OF_TURN_DELAY,
+  ATTR_END_TIME,
+  ATTR_EOU_DELAY,
+  ATTR_EOU_LANGUAGE,
+  ATTR_EOU_PROBABILITY,
+  ATTR_EOU_UNLIKELY_THRESHOLD,
+  ATTR_EXCEPTION_MESSAGE,
+  ATTR_EXCEPTION_TRACE,
+  ATTR_EXCEPTION_TYPE,
+  ATTR_FUNCTION_TOOLS,
+  ATTR_FUNCTION_TOOL_ARGS,
+  ATTR_FUNCTION_TOOL_IS_ERROR,
+  ATTR_FUNCTION_TOOL_NAME,
+  ATTR_FUNCTION_TOOL_OUTPUT,
+  ATTR_GEN_AI_OPERATION_NAME,
+  ATTR_GEN_AI_REQUEST_MODEL,
+  ATTR_GEN_AI_USAGE_INPUT_AUDIO_TOKENS,
+  ATTR_GEN_AI_USAGE_INPUT_CACHED_TOKENS,
+  ATTR_GEN_AI_USAGE_INPUT_TEXT_TOKENS,
+  ATTR_GEN_AI_USAGE_INPUT_TOKENS,
+  ATTR_GEN_AI_USAGE_OUTPUT_AUDIO_TOKENS,
+  ATTR_GEN_AI_USAGE_OUTPUT_TEXT_TOKENS,
+  ATTR_GEN_AI_USAGE_OUTPUT_TOKENS,
+  ATTR_INSTRUCTIONS,
+  ATTR_JOB_ID,
+  ATTR_LANGFUSE_COMPLETION_START_TIME,
+  ATTR_LLM_METRICS,
+  ATTR_PARTICIPANT_ID,
+  ATTR_PARTICIPANT_IDENTITY,
+  ATTR_PARTICIPANT_KIND,
+  ATTR_REALTIME_MODEL_METRICS,
+  ATTR_RESPONSE_FUNCTION_CALLS,
+  ATTR_RESPONSE_TEXT,
+  ATTR_RETRY_COUNT,
+  ATTR_ROOM_NAME,
+  ATTR_SESSION_OPTIONS,
+  ATTR_SPEECH_ID,
+  ATTR_SPEECH_INTERRUPTED,
+  ATTR_START_TIME,
+  ATTR_TRANSCRIPTION_DELAY,
+  ATTR_TRANSCRIPT_CONFIDENCE,
+  ATTR_TTS_INPUT_TEXT,
+  ATTR_TTS_LABEL,
+  ATTR_TTS_METRICS,
+  ATTR_TTS_STREAMING,
+  ATTR_USER_INPUT,
+  ATTR_USER_TRANSCRIPT,
+  EVENT_GEN_AI_ASSISTANT_MESSAGE,
+  EVENT_GEN_AI_CHOICE,
+  EVENT_GEN_AI_SYSTEM_MESSAGE,
+  EVENT_GEN_AI_TOOL_MESSAGE,
+  EVENT_GEN_AI_USER_MESSAGE
+};
+//# sourceMappingURL=trace_types.js.map

package/dist/telemetry/trace_types.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/telemetry/trace_types.ts"],"sourcesContent":["// SPDX-FileCopyrightText: 2025 LiveKit, Inc.\n//\n// SPDX-License-Identifier: Apache-2.0\n\n// LiveKit custom attributes\nexport const ATTR_SPEECH_ID = 'lk.speech_id';\nexport const ATTR_AGENT_LABEL = 'lk.agent_label';\nexport const ATTR_START_TIME = 'lk.start_time';\nexport const ATTR_END_TIME = 'lk.end_time';\nexport const ATTR_RETRY_COUNT = 'lk.retry_count';\n\nexport const ATTR_PARTICIPANT_ID = 'lk.participant_id';\nexport const ATTR_PARTICIPANT_IDENTITY = 'lk.participant_identity';\nexport const ATTR_PARTICIPANT_KIND = 'lk.participant_kind';\n\n// session start\nexport const ATTR_JOB_ID = 'lk.job_id';\nexport const ATTR_AGENT_NAME = 'lk.agent_name';\nexport const ATTR_ROOM_NAME = 'lk.room_name';\nexport const ATTR_SESSION_OPTIONS = 'lk.session_options';\n\n// assistant turn\nexport const ATTR_USER_INPUT = 'lk.user_input';\nexport const ATTR_INSTRUCTIONS = 'lk.instructions';\nexport const ATTR_SPEECH_INTERRUPTED = 'lk.interrupted';\n\n// llm node\nexport const ATTR_CHAT_CTX = 'lk.chat_ctx';\nexport const ATTR_FUNCTION_TOOLS = 'lk.function_tools';\nexport const ATTR_RESPONSE_TEXT = 'lk.response.text';\nexport const ATTR_RESPONSE_FUNCTION_CALLS = 'lk.response.function_calls';\n\n// function tool\nexport const ATTR_FUNCTION_TOOL_NAME = 'lk.function_tool.name';\nexport const ATTR_FUNCTION_TOOL_ARGS = 'lk.function_tool.arguments';\nexport const ATTR_FUNCTION_TOOL_IS_ERROR = 'lk.function_tool.is_error';\nexport const ATTR_FUNCTION_TOOL_OUTPUT = 'lk.function_tool.output';\n\n// tts node\nexport const ATTR_TTS_INPUT_TEXT = 'lk.input_text';\nexport const ATTR_TTS_STREAMING = 'lk.tts.streaming';\nexport const ATTR_TTS_LABEL = 'lk.tts.label';\n\n// eou detection\nexport const ATTR_EOU_PROBABILITY = 'lk.eou.probability';\nexport const ATTR_EOU_UNLIKELY_THRESHOLD = 'lk.eou.unlikely_threshold';\nexport const ATTR_EOU_DELAY = 'lk.eou.endpointing_delay';\nexport const ATTR_EOU_LANGUAGE = 'lk.eou.language';\nexport const ATTR_USER_TRANSCRIPT = 'lk.user_transcript';\nexport const ATTR_TRANSCRIPT_CONFIDENCE = 'lk.transcript_confidence';\nexport const ATTR_TRANSCRIPTION_DELAY = 'lk.transcription_delay';\nexport const ATTR_END_OF_TURN_DELAY = 'lk.end_of_turn_delay';\n\n// metrics\nexport const ATTR_LLM_METRICS = 'lk.llm_metrics';\nexport const ATTR_TTS_METRICS = 'lk.tts_metrics';\nexport const ATTR_REALTIME_MODEL_METRICS = 'lk.realtime_model_metrics';\n\n// OpenTelemetry GenAI attributes\n// OpenTelemetry specification: https://opentelemetry.io/docs/specs/semconv/registry/attributes/gen-ai/\nexport const ATTR_GEN_AI_OPERATION_NAME = 'gen_ai.operation.name';\nexport const ATTR_GEN_AI_REQUEST_MODEL = 'gen_ai.request.model';\nexport const ATTR_GEN_AI_USAGE_INPUT_TOKENS = 'gen_ai.usage.input_tokens';\nexport const ATTR_GEN_AI_USAGE_OUTPUT_TOKENS = 'gen_ai.usage.output_tokens';\n\n// Unofficial OpenTelemetry GenAI attributes, recognized by LangFuse\n// https://langfuse.com/integrations/native/opentelemetry#usage\n// but not yet in the official OpenTelemetry specification.\nexport const ATTR_GEN_AI_USAGE_INPUT_TEXT_TOKENS = 'gen_ai.usage.input_text_tokens';\nexport const ATTR_GEN_AI_USAGE_INPUT_AUDIO_TOKENS = 'gen_ai.usage.input_audio_tokens';\nexport const ATTR_GEN_AI_USAGE_INPUT_CACHED_TOKENS = 'gen_ai.usage.input_cached_tokens';\nexport const ATTR_GEN_AI_USAGE_OUTPUT_TEXT_TOKENS = 'gen_ai.usage.output_text_tokens';\nexport const ATTR_GEN_AI_USAGE_OUTPUT_AUDIO_TOKENS = 'gen_ai.usage.output_audio_tokens';\n\n// OpenTelemetry GenAI event names (for structured logging)\nexport const EVENT_GEN_AI_SYSTEM_MESSAGE = 'gen_ai.system.message';\nexport const EVENT_GEN_AI_USER_MESSAGE = 'gen_ai.user.message';\nexport const EVENT_GEN_AI_ASSISTANT_MESSAGE = 'gen_ai.assistant.message';\nexport const EVENT_GEN_AI_TOOL_MESSAGE = 'gen_ai.tool.message';\nexport const EVENT_GEN_AI_CHOICE = 'gen_ai.choice';\n\n// Exception attributes\nexport const ATTR_EXCEPTION_TRACE = 'exception.stacktrace';\nexport const ATTR_EXCEPTION_TYPE = 'exception.type';\nexport const ATTR_EXCEPTION_MESSAGE = 'exception.message';\n\n// Platform-specific attributes\nexport const ATTR_LANGFUSE_COMPLETION_START_TIME = 'langfuse.observation.completion_start_time';\n"],"mappings":"AAKO,MAAM,iBAAiB;AACvB,MAAM,mBAAmB;AACzB,MAAM,kBAAkB;AACxB,MAAM,gBAAgB;AACtB,MAAM,mBAAmB;AAEzB,MAAM,sBAAsB;AAC5B,MAAM,4BAA4B;AAClC,MAAM,wBAAwB;AAG9B,MAAM,cAAc;AACpB,MAAM,kBAAkB;AACxB,MAAM,iBAAiB;AACvB,MAAM,uBAAuB;AAG7B,MAAM,kBAAkB;AACxB,MAAM,oBAAoB;AAC1B,MAAM,0BAA0B;AAGhC,MAAM,gBAAgB;AACtB,MAAM,sBAAsB;AAC5B,MAAM,qBAAqB;AAC3B,MAAM,+BAA+B;AAGrC,MAAM,0BAA0B;AAChC,MAAM,0BAA0B;AAChC,MAAM,8BAA8B;AACpC,MAAM,4BAA4B;AAGlC,MAAM,sBAAsB;AAC5B,MAAM,qBAAqB;AAC3B,MAAM,iBAAiB;AAGvB,MAAM,uBAAuB;AAC7B,MAAM,8BAA8B;AACpC,MAAM,iBAAiB;AACvB,MAAM,oBAAoB;AAC1B,MAAM,uBAAuB;AAC7B,MAAM,6BAA6B;AACnC,MAAM,2BAA2B;AACjC,MAAM,yBAAyB;AAG/B,MAAM,mBAAmB;AACzB,MAAM,mBAAmB;AACzB,MAAM,8BAA8B;AAIpC,MAAM,6BAA6B;AACnC,MAAM,4BAA4B;AAClC,MAAM,iCAAiC;AACvC,MAAM,kCAAkC;AAKxC,MAAM,sCAAsC;AAC5C,MAAM,uCAAuC;AAC7C,MAAM,wCAAwC;AAC9C,MAAM,uCAAuC;AAC7C,MAAM,wCAAwC;AAG9C,MAAM,8BAA8B;AACpC,MAAM,4BAA4B;AAClC,MAAM,iCAAiC;AACvC,MAAM,4BAA4B;AAClC,MAAM,sBAAsB;AAG5B,MAAM,uBAAuB;AAC7B,MAAM,sBAAsB;AAC5B,MAAM,yBAAyB;AAG/B,MAAM,sCAAsC;","names":[]}

package/dist/telemetry/traces.cjs

@@ -0,0 +1,196 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var traces_exports = {};
+__export(traces_exports, {
+  setTracerProvider: () => setTracerProvider,
+  setupCloudTracer: () => setupCloudTracer,
+  tracer: () => tracer
+});
+module.exports = __toCommonJS(traces_exports);
+var import_api = require("@opentelemetry/api");
+var import_exporter_trace_otlp_http = require("@opentelemetry/exporter-trace-otlp-http");
+var import_otlp_exporter_base = require("@opentelemetry/otlp-exporter-base");
+var import_resources = require("@opentelemetry/resources");
+var import_sdk_trace_node = require("@opentelemetry/sdk-trace-node");
+var import_semantic_conventions = require("@opentelemetry/semantic-conventions");
+var import_livekit_server_sdk = require("livekit-server-sdk");
+class DynamicTracer {
+  tracerProvider;
+  tracer;
+  instrumentingModuleName;
+  constructor(instrumentingModuleName) {
+    this.instrumentingModuleName = instrumentingModuleName;
+    this.tracerProvider = import_api.trace.getTracerProvider();
+    this.tracer = import_api.trace.getTracer(instrumentingModuleName);
+  }
+  /**
+   * Set a new tracer provider. This updates the underlying tracer instance.
+   * @param provider - The new tracer provider to use
+   */
+  setProvider(provider) {
+    this.tracerProvider = provider;
+    this.tracer = this.tracerProvider.getTracer(this.instrumentingModuleName);
+  }
+  /**
+   * Get the underlying OpenTelemetry tracer.
+   * Use this to access the full Tracer API when needed.
+   */
+  getTracer() {
+    return this.tracer;
+  }
+  /**
+   * Start a span manually (without making it active).
+   * You must call span.end() when done.
+   *
+   * @param options - Span configuration including name
+   * @returns The created span
+   */
+  startSpan(options) {
+    const ctx = options.context || import_api.context.active();
+    const span = this.tracer.startSpan(
+      options.name,
+      {
+        attributes: options.attributes
+      },
+      ctx
+    );
+    return span;
+  }
+  /**
+   * Start a new span and make it active in the current context.
+   * The span will automatically be ended when the provided function completes (unless endOnExit=false).
+   *
+   * @param fn - The function to execute within the span context
+   * @param options - Span configuration including name
+   * @returns The result of the provided function
+   */
+  async startActiveSpan(fn, options) {
+    const ctx = options.context || import_api.context.active();
+    const endOnExit = options.endOnExit === void 0 ? true : options.endOnExit;
+    const opts = { 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();
+          }
+        }
+      });
+    });
+  }
+  /**
+   * Synchronous version of startActiveSpan for non-async operations.
+   *
+   * @param fn - The function to execute within the span context
+   * @param options - Span configuration including name
+   * @returns The result of the provided function
+   */
+  startActiveSpanSync(fn, options) {
+    const ctx = options.context || import_api.context.active();
+    const endOnExit = options.endOnExit === void 0 ? true : options.endOnExit;
+    const opts = { attributes: options.attributes };
+    return this.tracer.startActiveSpan(options.name, opts, ctx, (span) => {
+      try {
+        return fn(span);
+      } finally {
+        if (endOnExit) {
+          span.end();
+        }
+      }
+    });
+  }
+}
+const tracer = new DynamicTracer("livekit-agents");
+class MetadataSpanProcessor {
+  metadata;
+  constructor(metadata) {
+    this.metadata = metadata;
+  }
+  onStart(span, _parentContext) {
+    span.setAttributes(this.metadata);
+  }
+  onEnd(_span) {
+  }
+  shutdown() {
+    return Promise.resolve();
+  }
+  forceFlush() {
+    return Promise.resolve();
+  }
+}
+function setTracerProvider(provider, options) {
+  if (options == null ? void 0 : options.metadata) {
+    provider.addSpanProcessor(new MetadataSpanProcessor(options.metadata));
+  }
+  tracer.setProvider(provider);
+}
+async function setupCloudTracer(options) {
+  const { roomId, jobId, cloudHostname } = options;
+  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 cloud tracing");
+  }
+  const token = new import_livekit_server_sdk.AccessToken(apiKey, apiSecret, {
+    identity: "livekit-agents-telemetry",
+    ttl: "6h"
+  });
+  token.addObservabilityGrant({ write: true });
+  try {
+    const jwt = await token.toJwt();
+    const headers = {
+      Authorization: `Bearer ${jwt}`
+    };
+    const metadata = {
+      room_id: roomId,
+      job_id: jobId
+    };
+    const resource = new import_resources.Resource({
+      [import_semantic_conventions.ATTR_SERVICE_NAME]: "livekit-agents",
+      room_id: roomId,
+      job_id: jobId
+    });
+    const spanExporter = new import_exporter_trace_otlp_http.OTLPTraceExporter({
+      url: `https://${cloudHostname}/observability/traces/otlp/v0`,
+      headers,
+      compression: import_otlp_exporter_base.CompressionAlgorithm.GZIP
+    });
+    const tracerProvider = new import_sdk_trace_node.NodeTracerProvider({
+      resource,
+      spanProcessors: [new MetadataSpanProcessor(metadata), new import_sdk_trace_node.BatchSpanProcessor(spanExporter)]
+    });
+    tracerProvider.register();
+    setTracerProvider(tracerProvider);
+  } catch (error) {
+    console.error("Failed to setup cloud tracer:", error);
+    throw error;
+  }
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  setTracerProvider,
+  setupCloudTracer,
+  tracer
+});
+//# sourceMappingURL=traces.cjs.map

package/dist/telemetry/traces.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/telemetry/traces.ts"],"sourcesContent":["// SPDX-FileCopyrightText: 2025 LiveKit, Inc.\n//\n// SPDX-License-Identifier: Apache-2.0\nimport {\n  type Attributes,\n  type Context,\n  type Span,\n  type SpanOptions,\n  type Tracer,\n  type TracerProvider,\n  context as otelContext,\n  trace,\n} from '@opentelemetry/api';\nimport { OTLPTraceExporter } from '@opentelemetry/exporter-trace-otlp-http';\nimport { CompressionAlgorithm } from '@opentelemetry/otlp-exporter-base';\nimport { Resource } from '@opentelemetry/resources';\nimport type { ReadableSpan, SpanProcessor } from '@opentelemetry/sdk-trace-base';\nimport { BatchSpanProcessor, NodeTracerProvider } from '@opentelemetry/sdk-trace-node';\nimport { ATTR_SERVICE_NAME } from '@opentelemetry/semantic-conventions';\nimport { AccessToken } from 'livekit-server-sdk';\n\nexport interface StartSpanOptions {\n  /** Name of the span */\n  name: string;\n  /** Optional parent context to use for this span */\n  context?: Context;\n  /** Attributes to set on the span when it starts */\n  attributes?: Attributes;\n  /** Whether to end the span when the function exits (default: true) */\n  endOnExit?: boolean;\n}\n\n/**\n * A dynamic tracer that allows the tracer provider to be changed at runtime.\n */\nclass DynamicTracer {\n  private tracerProvider: TracerProvider;\n  private tracer: Tracer;\n  private readonly instrumentingModuleName: string;\n\n  constructor(instrumentingModuleName: string) {\n    this.instrumentingModuleName = instrumentingModuleName;\n    this.tracerProvider = trace.getTracerProvider();\n    this.tracer = trace.getTracer(instrumentingModuleName);\n  }\n\n  /**\n   * Set a new tracer provider. This updates the underlying tracer instance.\n   * @param provider - The new tracer provider to use\n   */\n  setProvider(provider: TracerProvider): void {\n    this.tracerProvider = provider;\n    this.tracer = this.tracerProvider.getTracer(this.instrumentingModuleName);\n  }\n\n  /**\n   * Get the underlying OpenTelemetry tracer.\n   * Use this to access the full Tracer API when needed.\n   */\n  getTracer(): Tracer {\n    return this.tracer;\n  }\n\n  /**\n   * Start a span manually (without making it active).\n   * You must call span.end() when done.\n   *\n   * @param options - Span configuration including name\n   * @returns The created span\n   */\n  startSpan(options: StartSpanOptions): Span {\n    const ctx = options.context || otelContext.active();\n    const span = this.tracer.startSpan(\n      options.name,\n      {\n        attributes: options.attributes,\n      },\n      ctx,\n    );\n\n    return span;\n  }\n\n  /**\n   * Start a new span and make it active in the current context.\n   * The span will automatically be ended when the provided function completes (unless endOnExit=false).\n   *\n   * @param fn - The function to execute within the span context\n   * @param options - Span configuration including name\n   * @returns The result of the provided function\n   */\n  async startActiveSpan<T>(fn: (span: Span) => Promise<T>, options: StartSpanOptions): Promise<T> {\n    const ctx = options.context || otelContext.active();\n    const endOnExit = options.endOnExit === undefined ? true : options.endOnExit; // default true\n    const opts: SpanOptions = { attributes: options.attributes };\n\n    return new Promise((resolve, reject) => {\n      this.tracer.startActiveSpan(options.name, opts, ctx, async (span) => {\n        try {\n          const result = await fn(span);\n          resolve(result);\n        } catch (error) {\n          reject(error);\n        } finally {\n          if (endOnExit) {\n            span.end();\n          }\n        }\n      });\n    });\n  }\n\n  /**\n   * Synchronous version of startActiveSpan for non-async operations.\n   *\n   * @param fn - The function to execute within the span context\n   * @param options - Span configuration including name\n   * @returns The result of the provided function\n   */\n  startActiveSpanSync<T>(fn: (span: Span) => T, options: StartSpanOptions): T {\n    const ctx = options.context || otelContext.active();\n    const endOnExit = options.endOnExit === undefined ? true : options.endOnExit; // default true\n    const opts: SpanOptions = { attributes: options.attributes };\n\n    return this.tracer.startActiveSpan(options.name, opts, ctx, (span) => {\n      try {\n        return fn(span);\n      } finally {\n        if (endOnExit) {\n          span.end();\n        }\n      }\n    });\n  }\n}\n\n/**\n * The global tracer instance used throughout the agents framework.\n * This tracer can have its provider updated at runtime via setTracerProvider().\n */\nexport const tracer = new DynamicTracer('livekit-agents');\n\nclass MetadataSpanProcessor implements SpanProcessor {\n  private metadata: Attributes;\n\n  constructor(metadata: Attributes) {\n    this.metadata = metadata;\n  }\n\n  onStart(span: Span, _parentContext: Context): void {\n    span.setAttributes(this.metadata);\n  }\n\n  onEnd(_span: ReadableSpan): void {}\n\n  shutdown(): Promise<void> {\n    return Promise.resolve();\n  }\n\n  forceFlush(): Promise<void> {\n    return Promise.resolve();\n  }\n}\n\n// TODO(brian): PR4 - Add MetadataLogProcessor for structured logging\n\n// TODO(brian): PR4 - Add ExtraDetailsProcessor for structured logging\n\n/**\n * Set the tracer provider for the livekit-agents framework.\n * This should be called before agent session start if using custom tracer providers.\n *\n * @param provider - The tracer provider to use (must be a NodeTracerProvider)\n * @param options - Optional configuration with metadata property to inject into all spans\n *\n * @example\n * ```typescript\n * import { NodeTracerProvider } from '@opentelemetry/sdk-trace-node';\n * import { setTracerProvider } from '@livekit/agents/telemetry';\n *\n * const provider = new NodeTracerProvider();\n * setTracerProvider(provider, {\n *   metadata: { room_id: 'room123', job_id: 'job456' }\n * });\n * ```\n */\nexport function setTracerProvider(\n  provider: NodeTracerProvider,\n  options?: { metadata?: Attributes },\n): void {\n  if (options?.metadata) {\n    provider.addSpanProcessor(new MetadataSpanProcessor(options.metadata));\n  }\n\n  tracer.setProvider(provider);\n}\n\n/**\n * Setup OpenTelemetry tracer for LiveKit Cloud observability.\n * This configures OTLP exporters to send traces to LiveKit Cloud.\n *\n * @param options - Configuration for cloud tracer with roomId, jobId, and cloudHostname properties\n *\n * @internal\n */\nexport async function setupCloudTracer(options: {\n  roomId: string;\n  jobId: string;\n  cloudHostname: string;\n}): Promise<void> {\n  const { roomId, jobId, cloudHostname } = options;\n\n  const apiKey = process.env.LIVEKIT_API_KEY;\n  const apiSecret = process.env.LIVEKIT_API_SECRET;\n\n  if (!apiKey || !apiSecret) {\n    throw new Error('LIVEKIT_API_KEY and LIVEKIT_API_SECRET must be set for cloud tracing');\n  }\n\n  const token = new AccessToken(apiKey, apiSecret, {\n    identity: 'livekit-agents-telemetry',\n    ttl: '6h',\n  });\n  token.addObservabilityGrant({ write: true });\n\n  try {\n    const jwt = await token.toJwt();\n\n    const headers = {\n      Authorization: `Bearer ${jwt}`,\n    };\n\n    const metadata: Attributes = {\n      room_id: roomId,\n      job_id: jobId,\n    };\n\n    const resource = new Resource({\n      [ATTR_SERVICE_NAME]: 'livekit-agents',\n      room_id: roomId,\n      job_id: jobId,\n    });\n\n    // Configure OTLP exporter to send traces to LiveKit Cloud\n    const spanExporter = new OTLPTraceExporter({\n      url: `https://${cloudHostname}/observability/traces/otlp/v0`,\n      headers,\n      compression: CompressionAlgorithm.GZIP,\n    });\n\n    const tracerProvider = new NodeTracerProvider({\n      resource,\n      spanProcessors: [new MetadataSpanProcessor(metadata), new BatchSpanProcessor(spanExporter)],\n    });\n    tracerProvider.register();\n\n    // Metadata processor is already configured in the constructor above\n    setTracerProvider(tracerProvider);\n\n    // TODO(brian): PR4 - Add logger provider setup here for structured logging\n    // Similar to Python's setup: LoggerProvider, OTLPLogExporter, BatchLogRecordProcessor\n  } catch (error) {\n    console.error('Failed to setup cloud tracer:', error);\n    throw error;\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAGA,iBASO;AACP,sCAAkC;AAClC,gCAAqC;AACrC,uBAAyB;AAEzB,4BAAuD;AACvD,kCAAkC;AAClC,gCAA4B;AAgB5B,MAAM,cAAc;AAAA,EACV;AAAA,EACA;AAAA,EACS;AAAA,EAEjB,YAAY,yBAAiC;AAC3C,SAAK,0BAA0B;AAC/B,SAAK,iBAAiB,iBAAM,kBAAkB;AAC9C,SAAK,SAAS,iBAAM,UAAU,uBAAuB;AAAA,EACvD;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,YAAY,UAAgC;AAC1C,SAAK,iBAAiB;AACtB,SAAK,SAAS,KAAK,eAAe,UAAU,KAAK,uBAAuB;AAAA,EAC1E;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,YAAoB;AAClB,WAAO,KAAK;AAAA,EACd;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,UAAU,SAAiC;AACzC,UAAM,MAAM,QAAQ,WAAW,WAAAA,QAAY,OAAO;AAClD,UAAM,OAAO,KAAK,OAAO;AAAA,MACvB,QAAQ;AAAA,MACR;AAAA,QACE,YAAY,QAAQ;AAAA,MACtB;AAAA,MACA;AAAA,IACF;AAEA,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,MAAM,gBAAmB,IAAgC,SAAuC;AAC9F,UAAM,MAAM,QAAQ,WAAW,WAAAA,QAAY,OAAO;AAClD,UAAM,YAAY,QAAQ,cAAc,SAAY,OAAO,QAAQ;AACnE,UAAM,OAAoB,EAAE,YAAY,QAAQ,WAAW;AAE3D,WAAO,IAAI,QAAQ,CAAC,SAAS,WAAW;AACtC,WAAK,OAAO,gBAAgB,QAAQ,MAAM,MAAM,KAAK,OAAO,SAAS;AACnE,YAAI;AACF,gBAAM,SAAS,MAAM,GAAG,IAAI;AAC5B,kBAAQ,MAAM;AAAA,QAChB,SAAS,OAAO;AACd,iBAAO,KAAK;AAAA,QACd,UAAE;AACA,cAAI,WAAW;AACb,iBAAK,IAAI;AAAA,UACX;AAAA,QACF;AAAA,MACF,CAAC;AAAA,IACH,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,oBAAuB,IAAuB,SAA8B;AAC1E,UAAM,MAAM,QAAQ,WAAW,WAAAA,QAAY,OAAO;AAClD,UAAM,YAAY,QAAQ,cAAc,SAAY,OAAO,QAAQ;AACnE,UAAM,OAAoB,EAAE,YAAY,QAAQ,WAAW;AAE3D,WAAO,KAAK,OAAO,gBAAgB,QAAQ,MAAM,MAAM,KAAK,CAAC,SAAS;AACpE,UAAI;AACF,eAAO,GAAG,IAAI;AAAA,MAChB,UAAE;AACA,YAAI,WAAW;AACb,eAAK,IAAI;AAAA,QACX;AAAA,MACF;AAAA,IACF,CAAC;AAAA,EACH;AACF;AAMO,MAAM,SAAS,IAAI,cAAc,gBAAgB;AAExD,MAAM,sBAA+C;AAAA,EAC3C;AAAA,EAER,YAAY,UAAsB;AAChC,SAAK,WAAW;AAAA,EAClB;AAAA,EAEA,QAAQ,MAAY,gBAA+B;AACjD,SAAK,cAAc,KAAK,QAAQ;AAAA,EAClC;AAAA,EAEA,MAAM,OAA2B;AAAA,EAAC;AAAA,EAElC,WAA0B;AACxB,WAAO,QAAQ,QAAQ;AAAA,EACzB;AAAA,EAEA,aAA4B;AAC1B,WAAO,QAAQ,QAAQ;AAAA,EACzB;AACF;AAwBO,SAAS,kBACd,UACA,SACM;AACN,MAAI,mCAAS,UAAU;AACrB,aAAS,iBAAiB,IAAI,sBAAsB,QAAQ,QAAQ,CAAC;AAAA,EACvE;AAEA,SAAO,YAAY,QAAQ;AAC7B;AAUA,eAAsB,iBAAiB,SAIrB;AAChB,QAAM,EAAE,QAAQ,OAAO,cAAc,IAAI;AAEzC,QAAM,SAAS,QAAQ,IAAI;AAC3B,QAAM,YAAY,QAAQ,IAAI;AAE9B,MAAI,CAAC,UAAU,CAAC,WAAW;AACzB,UAAM,IAAI,MAAM,sEAAsE;AAAA,EACxF;AAEA,QAAM,QAAQ,IAAI,sCAAY,QAAQ,WAAW;AAAA,IAC/C,UAAU;AAAA,IACV,KAAK;AAAA,EACP,CAAC;AACD,QAAM,sBAAsB,EAAE,OAAO,KAAK,CAAC;AAE3C,MAAI;AACF,UAAM,MAAM,MAAM,MAAM,MAAM;AAE9B,UAAM,UAAU;AAAA,MACd,eAAe,UAAU,GAAG;AAAA,IAC9B;AAEA,UAAM,WAAuB;AAAA,MAC3B,SAAS;AAAA,MACT,QAAQ;AAAA,IACV;AAEA,UAAM,WAAW,IAAI,0BAAS;AAAA,MAC5B,CAAC,6CAAiB,GAAG;AAAA,MACrB,SAAS;AAAA,MACT,QAAQ;AAAA,IACV,CAAC;AAGD,UAAM,eAAe,IAAI,kDAAkB;AAAA,MACzC,KAAK,WAAW,aAAa;AAAA,MAC7B;AAAA,MACA,aAAa,+CAAqB;AAAA,IACpC,CAAC;AAED,UAAM,iBAAiB,IAAI,yCAAmB;AAAA,MAC5C;AAAA,MACA,gBAAgB,CAAC,IAAI,sBAAsB,QAAQ,GAAG,IAAI,yCAAmB,YAAY,CAAC;AAAA,IAC5F,CAAC;AACD,mBAAe,SAAS;AAGxB,sBAAkB,cAAc;AAAA,EAIlC,SAAS,OAAO;AACd,YAAQ,MAAM,iCAAiC,KAAK;AACpD,UAAM;AAAA,EACR;AACF;","names":["otelContext"]}

package/dist/telemetry/traces.d.cts

@@ -0,0 +1,97 @@
+import { type Attributes, type Context, type Span, type Tracer, type TracerProvider } from '@opentelemetry/api';
+import { NodeTracerProvider } from '@opentelemetry/sdk-trace-node';
+export interface StartSpanOptions {
+    /** Name of the span */
+    name: string;
+    /** Optional parent context to use for this span */
+    context?: Context;
+    /** Attributes to set on the span when it starts */
+    attributes?: Attributes;
+    /** Whether to end the span when the function exits (default: true) */
+    endOnExit?: boolean;
+}
+/**
+ * A dynamic tracer that allows the tracer provider to be changed at runtime.
+ */
+declare class DynamicTracer {
+    private tracerProvider;
+    private tracer;
+    private readonly instrumentingModuleName;
+    constructor(instrumentingModuleName: string);
+    /**
+     * Set a new tracer provider. This updates the underlying tracer instance.
+     * @param provider - The new tracer provider to use
+     */
+    setProvider(provider: TracerProvider): void;
+    /**
+     * Get the underlying OpenTelemetry tracer.
+     * Use this to access the full Tracer API when needed.
+     */
+    getTracer(): Tracer;
+    /**
+     * Start a span manually (without making it active).
+     * You must call span.end() when done.
+     *
+     * @param options - Span configuration including name
+     * @returns The created span
+     */
+    startSpan(options: StartSpanOptions): Span;
+    /**
+     * Start a new span and make it active in the current context.
+     * The span will automatically be ended when the provided function completes (unless endOnExit=false).
+     *
+     * @param fn - The function to execute within the span context
+     * @param options - Span configuration including name
+     * @returns The result of the provided function
+     */
+    startActiveSpan<T>(fn: (span: Span) => Promise<T>, options: StartSpanOptions): Promise<T>;
+    /**
+     * Synchronous version of startActiveSpan for non-async operations.
+     *
+     * @param fn - The function to execute within the span context
+     * @param options - Span configuration including name
+     * @returns The result of the provided function
+     */
+    startActiveSpanSync<T>(fn: (span: Span) => T, options: StartSpanOptions): T;
+}
+/**
+ * The global tracer instance used throughout the agents framework.
+ * This tracer can have its provider updated at runtime via setTracerProvider().
+ */
+export declare const tracer: DynamicTracer;
+/**
+ * Set the tracer provider for the livekit-agents framework.
+ * This should be called before agent session start if using custom tracer providers.
+ *
+ * @param provider - The tracer provider to use (must be a NodeTracerProvider)
+ * @param options - Optional configuration with metadata property to inject into all spans
+ *
+ * @example
+ * ```typescript
+ * import { NodeTracerProvider } from '@opentelemetry/sdk-trace-node';
+ * import { setTracerProvider } from '@livekit/agents/telemetry';
+ *
+ * const provider = new NodeTracerProvider();
+ * setTracerProvider(provider, {
+ *   metadata: { room_id: 'room123', job_id: 'job456' }
+ * });
+ * ```
+ */
+export declare function setTracerProvider(provider: NodeTracerProvider, options?: {
+    metadata?: Attributes;
+}): void;
+/**
+ * Setup OpenTelemetry tracer for LiveKit Cloud observability.
+ * This configures OTLP exporters to send traces to LiveKit Cloud.
+ *
+ * @param options - Configuration for cloud tracer with roomId, jobId, and cloudHostname properties
+ *
+ * @internal
+ */
+export declare function setupCloudTracer(options: {
+    roomId: string;
+    jobId: string;
+    cloudHostname: string;
+}): Promise<void>;
+export {};
+//# sourceMappingURL=traces.d.ts.map

package/dist/telemetry/traces.d.ts

@@ -0,0 +1,97 @@
+import { type Attributes, type Context, type Span, type Tracer, type TracerProvider } from '@opentelemetry/api';
+import { NodeTracerProvider } from '@opentelemetry/sdk-trace-node';
+export interface StartSpanOptions {
+    /** Name of the span */
+    name: string;
+    /** Optional parent context to use for this span */
+    context?: Context;
+    /** Attributes to set on the span when it starts */
+    attributes?: Attributes;
+    /** Whether to end the span when the function exits (default: true) */
+    endOnExit?: boolean;
+}
+/**
+ * A dynamic tracer that allows the tracer provider to be changed at runtime.
+ */
+declare class DynamicTracer {
+    private tracerProvider;
+    private tracer;
+    private readonly instrumentingModuleName;
+    constructor(instrumentingModuleName: string);
+    /**
+     * Set a new tracer provider. This updates the underlying tracer instance.
+     * @param provider - The new tracer provider to use
+     */
+    setProvider(provider: TracerProvider): void;
+    /**
+     * Get the underlying OpenTelemetry tracer.
+     * Use this to access the full Tracer API when needed.
+     */
+    getTracer(): Tracer;
+    /**
+     * Start a span manually (without making it active).
+     * You must call span.end() when done.
+     *
+     * @param options - Span configuration including name
+     * @returns The created span
+     */
+    startSpan(options: StartSpanOptions): Span;
+    /**
+     * Start a new span and make it active in the current context.
+     * The span will automatically be ended when the provided function completes (unless endOnExit=false).
+     *
+     * @param fn - The function to execute within the span context
+     * @param options - Span configuration including name
+     * @returns The result of the provided function
+     */
+    startActiveSpan<T>(fn: (span: Span) => Promise<T>, options: StartSpanOptions): Promise<T>;
+    /**
+     * Synchronous version of startActiveSpan for non-async operations.
+     *
+     * @param fn - The function to execute within the span context
+     * @param options - Span configuration including name
+     * @returns The result of the provided function
+     */
+    startActiveSpanSync<T>(fn: (span: Span) => T, options: StartSpanOptions): T;
+}
+/**
+ * The global tracer instance used throughout the agents framework.
+ * This tracer can have its provider updated at runtime via setTracerProvider().
+ */
+export declare const tracer: DynamicTracer;
+/**
+ * Set the tracer provider for the livekit-agents framework.
+ * This should be called before agent session start if using custom tracer providers.
+ *
+ * @param provider - The tracer provider to use (must be a NodeTracerProvider)
+ * @param options - Optional configuration with metadata property to inject into all spans
+ *
+ * @example
+ * ```typescript
+ * import { NodeTracerProvider } from '@opentelemetry/sdk-trace-node';
+ * import { setTracerProvider } from '@livekit/agents/telemetry';
+ *
+ * const provider = new NodeTracerProvider();
+ * setTracerProvider(provider, {
+ *   metadata: { room_id: 'room123', job_id: 'job456' }
+ * });
+ * ```
+ */
+export declare function setTracerProvider(provider: NodeTracerProvider, options?: {
+    metadata?: Attributes;
+}): void;
+/**
+ * Setup OpenTelemetry tracer for LiveKit Cloud observability.
+ * This configures OTLP exporters to send traces to LiveKit Cloud.
+ *
+ * @param options - Configuration for cloud tracer with roomId, jobId, and cloudHostname properties
+ *
+ * @internal
+ */
+export declare function setupCloudTracer(options: {
+    roomId: string;
+    jobId: string;
+    cloudHostname: string;
+}): Promise<void>;
+export {};
+//# sourceMappingURL=traces.d.ts.map

package/dist/telemetry/traces.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"traces.d.ts","sourceRoot":"","sources":["../../src/telemetry/traces.ts"],"names":[],"mappings":"AAGA,OAAO,EACL,KAAK,UAAU,EACf,KAAK,OAAO,EACZ,KAAK,IAAI,EAET,KAAK,MAAM,EACX,KAAK,cAAc,EAGpB,MAAM,oBAAoB,CAAC;AAK5B,OAAO,EAAsB,kBAAkB,EAAE,MAAM,+BAA+B,CAAC;AAIvF,MAAM,WAAW,gBAAgB;IAC/B,uBAAuB;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,mDAAmD;IACnD,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,mDAAmD;IACnD,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,sEAAsE;IACtE,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AAED;;GAEG;AACH,cAAM,aAAa;IACjB,OAAO,CAAC,cAAc,CAAiB;IACvC,OAAO,CAAC,MAAM,CAAS;IACvB,OAAO,CAAC,QAAQ,CAAC,uBAAuB,CAAS;gBAErC,uBAAuB,EAAE,MAAM;IAM3C;;;OAGG;IACH,WAAW,CAAC,QAAQ,EAAE,cAAc,GAAG,IAAI;IAK3C;;;OAGG;IACH,SAAS,IAAI,MAAM;IAInB;;;;;;OAMG;IACH,SAAS,CAAC,OAAO,EAAE,gBAAgB,GAAG,IAAI;IAa1C;;;;;;;OAOG;IACG,eAAe,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,IAAI,EAAE,IAAI,KAAK,OAAO,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,CAAC,CAAC;IAqB/F;;;;;;OAMG;IACH,mBAAmB,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,IAAI,EAAE,IAAI,KAAK,CAAC,EAAE,OAAO,EAAE,gBAAgB,GAAG,CAAC;CAe5E;AAED;;;GAGG;AACH,eAAO,MAAM,MAAM,eAAsC,CAAC;AA4B1D;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,iBAAiB,CAC/B,QAAQ,EAAE,kBAAkB,EAC5B,OAAO,CAAC,EAAE;IAAE,QAAQ,CAAC,EAAE,UAAU,CAAA;CAAE,GAClC,IAAI,CAMN;AAED;;;;;;;GAOG;AACH,wBAAsB,gBAAgB,CAAC,OAAO,EAAE;IAC9C,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;IACd,aAAa,EAAE,MAAM,CAAC;CACvB,GAAG,OAAO,CAAC,IAAI,CAAC,CAwDhB"}