@ai-sdk/otel 1.0.0-beta.59 → 1.0.0-beta.60

package/src/supplemental-attributes.ts

@@ -0,0 +1,151 @@
+import type { Attributes, Tracer } from '@opentelemetry/api';
+import type { TelemetryOptions } from 'ai';
+import { selectAttributes, type AttributeSpecMap } from './select-attributes';
+
+type SupplementalAttributeOption =
+  | 'usage'
+  | 'providerMetadata'
+  | 'embedding'
+  | 'reranking'
+  | 'runtimeContext'
+  | 'headers'
+  | 'toolChoice'
+  | 'schema';
+
+export type SupplementalAttributeOptions = Record<
+  SupplementalAttributeOption,
+  boolean
+>;
+
+export type OpenTelemetryOptions = {
+  /**
+   * The tracer to use for the telemetry data.
+   */
+  tracer?: Tracer;
+
+  /**
+   * Emit AI SDK usage details that are not represented by GenAI SemConv.
+   */
+  usage?: boolean;
+
+  /**
+   * Emit provider metadata on response spans.
+   */
+  providerMetadata?: boolean;
+
+  /**
+   * Emit embedding input and output values.
+   */
+  embedding?: boolean;
+
+  /**
+   * Emit reranking input documents and output ranking.
+   */
+  reranking?: boolean;
+
+  /**
+   * Emit runtime context values.
+   */
+  runtimeContext?: boolean;
+
+  /**
+   * Emit request headers.
+   */
+  headers?: boolean;
+
+  /**
+   * Emit selected tool choice information.
+   */
+  toolChoice?: boolean;
+
+  /**
+   * Emit object generation schema information.
+   */
+  schema?: boolean;
+};
+
+const disabledSupplementalAttributes: SupplementalAttributeOptions = {
+  usage: false,
+  providerMetadata: false,
+  embedding: false,
+  reranking: false,
+  runtimeContext: false,
+  headers: false,
+  toolChoice: false,
+  schema: false,
+};
+
+export function normalizeSupplementalAttributes(
+  options: OpenTelemetryOptions,
+): SupplementalAttributeOptions {
+  return {
+    ...disabledSupplementalAttributes,
+    usage: options.usage ?? false,
+    providerMetadata: options.providerMetadata ?? false,
+    embedding: options.embedding ?? false,
+    reranking: options.reranking ?? false,
+    runtimeContext: options.runtimeContext ?? false,
+    headers: options.headers ?? false,
+    toolChoice: options.toolChoice ?? false,
+    schema: options.schema ?? false,
+  };
+}
+
+export function getRuntimeContextAttributes(
+  context: Record<string, unknown> | undefined,
+): AttributeSpecMap {
+  return Object.fromEntries(
+    Object.entries(context ?? {})
+      .filter(([, value]) => value != null)
+      .map(([key, value]) => [`ai.settings.context.${key}`, value]),
+  ) as AttributeSpecMap;
+}
+
+export function getHeaderAttributes(
+  headers: Record<string, string | undefined> | undefined,
+): AttributeSpecMap {
+  return Object.fromEntries(
+    Object.entries(headers ?? {})
+      .filter(([, value]) => value != null)
+      .map(([key, value]) => [`ai.request.headers.${key}`, value]),
+  ) as AttributeSpecMap;
+}
+
+export function getDetailedUsageAttributes(usage: {
+  inputTokenDetails?: {
+    noCacheTokens?: number | undefined;
+  };
+  outputTokenDetails?: {
+    textTokens?: number | undefined;
+    reasoningTokens?: number | undefined;
+  };
+}): AttributeSpecMap {
+  return {
+    'ai.usage.inputTokenDetails.noCacheTokens':
+      usage.inputTokenDetails?.noCacheTokens,
+    'ai.usage.outputTokenDetails.textTokens':
+      usage.outputTokenDetails?.textTokens,
+    'ai.usage.outputTokenDetails.reasoningTokens':
+      usage.outputTokenDetails?.reasoningTokens,
+  };
+}
+
+export function selectSupplementalAttributes(
+  telemetry: TelemetryOptions | undefined,
+  enabledAttributes: SupplementalAttributeOptions,
+  attributes: Partial<Record<SupplementalAttributeOption, AttributeSpecMap>>,
+): Attributes {
+  const result: Attributes = {};
+
+  for (const [key, value] of Object.entries(attributes) as Array<
+    [SupplementalAttributeOption, AttributeSpecMap | undefined]
+  >) {
+    if (!enabledAttributes[key] || value == null) {
+      continue;
+    }
+
+    Object.assign(result, selectAttributes(telemetry, value));
+  }
+
+  return result;
+}