@cursor/july 0.1.42 → 0.1.43

package/src/internal/otel/collector.ts

@@ -0,0 +1,796 @@
+/**
+ * Maps the durable session event stream onto OTel traces / metrics / logs.
+ *
+ * Attribute names reuse Cursor enterprise wire keys where they overlap
+ * (`cursor.conversation.id`, `cursor.token.*`, `cursor.tool.*`,
+ * `cursor.cost.usage`, `cursor.model.name`) so Agent SDK traces join org
+ * metrics/logs in the same collector. Agent-SDK-only fields use `agent_sdk.*`.
+ */
+
+import {
+  type Context,
+  type Counter,
+  context,
+  type Meter,
+  type Span,
+  SpanKind,
+  SpanStatusCode,
+  trace,
+} from "@opentelemetry/api";
+import { SeverityNumber } from "@opentelemetry/api-logs";
+import type { SessionEvent, SessionInfo } from "../../types.js";
+import { type AttrValue, attrs } from "./attrs.js";
+import type { OtelRuntime } from "./runtime.js";
+
+const CONTENT_MAX = 2_048;
+
+export interface OtelCollector {
+  onEvent(event: SessionEvent, session: SessionInfo): void;
+  close(): void;
+}
+
+interface TurnState {
+  span: Span;
+  tools: Map<string, Span>;
+  subagents: Map<string, Span>;
+  /** True when opened without `turn.started` (restore / direct callTool). */
+  synthetic: boolean;
+}
+
+interface SessionState {
+  span: Span;
+  ctx: Context;
+  turns: Map<string, TurnState>;
+}
+
+export function createOtelCollector(
+  runtime: OtelRuntime,
+  agentName: string,
+  log: (line: string) => void
+): OtelCollector {
+  const sessions = new Map<string, SessionState>();
+  const metrics = runtime.meter ? buildMetrics(runtime.meter) : undefined;
+  const logOpts =
+    runtime.config.logs === false ? undefined : runtime.config.logs;
+
+  return {
+    onEvent(event, session) {
+      try {
+        handle(event, session);
+      } catch (error) {
+        log(
+          `[agent-sdk:otel] collector failed on ${event.type}: ${
+            error instanceof Error ? error.message : String(error)
+          }`
+        );
+      }
+    },
+    close() {
+      for (const [sessionId, state] of sessions) {
+        state.span.setStatus({ code: SpanStatusCode.UNSET });
+        state.span.end();
+        sessions.delete(sessionId);
+      }
+    },
+  };
+
+  function handle(event: SessionEvent, session: SessionInfo): void {
+    const at = Date.parse(event.at);
+    const startTime = Number.isFinite(at) ? at : undefined;
+
+    switch (event.type) {
+      case "session.started": {
+        openSession({
+          sessionId: event.sessionId,
+          session,
+          channelId: event.data.channelId,
+          startTime,
+          restored: false,
+        });
+        return;
+      }
+      case "agent.bound": {
+        const state = ensureSession(event, session, startTime);
+        if (state === undefined) {
+          return;
+        }
+        state.span.setAttribute(
+          "agent_sdk.sdk_agent_id",
+          event.data.sdkAgentId
+        );
+        // URL can identify a deployment; keep it off spans unless opted in.
+        if (logOpts?.toolContent === true && event.data.url !== undefined) {
+          state.span.setAttribute("agent_sdk.sdk_agent_url", event.data.url);
+        }
+        return;
+      }
+      case "message.received": {
+        const state = ensureSession(event, session, startTime);
+        if (state === undefined) {
+          return;
+        }
+        state.span.addEvent(
+          "message.received",
+          attrs({
+            "agent_sdk.event": "message.received",
+            "agent_sdk.user_prompt":
+              logOpts?.userPrompts === true
+                ? truncate(event.data.text)
+                : undefined,
+          }),
+          startTime
+        );
+        emitLog(
+          "message.received",
+          SeverityNumber.INFO,
+          attrs({
+            ...baseLog(event, session),
+            "agent_sdk.user_prompt":
+              logOpts?.userPrompts === true
+                ? truncate(event.data.text)
+                : undefined,
+          })
+        );
+        return;
+      }
+      case "turn.queued": {
+        ensureSession(event, session, startTime)?.span.addEvent(
+          "turn.queued",
+          attrs({
+            "agent_sdk.turn_id": event.turnId,
+            "agent_sdk.queue_position": event.data.position,
+            "agent_sdk.max_running_turns": event.data.maxRunningTurns,
+          }),
+          startTime
+        );
+        return;
+      }
+      case "turn.started": {
+        if (event.turnId === undefined) {
+          return;
+        }
+        const state = ensureSession(event, session, startTime);
+        if (state === undefined) {
+          return;
+        }
+        openTurn({
+          state,
+          sessionId: event.sessionId,
+          turnId: event.turnId,
+          session,
+          startTime,
+          synthetic: false,
+        });
+        return;
+      }
+      case "step.started":
+      case "step.completed": {
+        ensureTurn(event, session, startTime)?.span.addEvent(
+          event.type,
+          attrs({
+            "agent_sdk.step_id": event.data.stepId,
+            "agent_sdk.duration_ms":
+              event.type === "step.completed"
+                ? event.data.durationMs
+                : undefined,
+          }),
+          startTime
+        );
+        return;
+      }
+      case "reasoning.completed": {
+        ensureTurn(event, session, startTime)?.span.addEvent(
+          "reasoning.completed",
+          attrs({
+            "agent_sdk.duration_ms": event.data.durationMs,
+            "agent_sdk.parent_call_id": event.data.parentCallId,
+          }),
+          startTime
+        );
+        return;
+      }
+      case "message.completed": {
+        ensureTurn(event, session, startTime)?.span.addEvent(
+          "message.completed",
+          attrs({
+            "agent_sdk.finish_reason": event.data.finishReason,
+            "agent_sdk.parent_call_id": event.data.parentCallId,
+          }),
+          startTime
+        );
+        return;
+      }
+      case "actions.requested": {
+        const turn = ensureTurn(event, session, startTime);
+        if (turn === undefined) {
+          return;
+        }
+        for (const call of event.data.calls) {
+          const parentCtx = parentCtxFor(
+            turn,
+            event.data.parentCallId ?? call.parentCallId
+          );
+          const span = runtime.tracer.startSpan(
+            "agent_sdk.tool",
+            {
+              kind: SpanKind.INTERNAL,
+              startTime,
+              attributes: attrs({
+                "cursor.conversation.id": event.sessionId,
+                "cursor.tool.name": call.toolName,
+                "cursor.tool.kind": "builtin",
+                "agent_sdk.agent": agentName,
+                "agent_sdk.turn_id": event.turnId,
+                "agent_sdk.call_id": call.callId,
+                "agent_sdk.parent_call_id": call.parentCallId,
+                "agent_sdk.tool_args":
+                  logOpts?.toolContent === true && call.args !== undefined
+                    ? truncate(json(call.args))
+                    : undefined,
+              }),
+            },
+            parentCtx
+          );
+          turn.tools.set(call.callId, span);
+        }
+        return;
+      }
+      case "action.approval_requested": {
+        ensureTurn(event, session, startTime)
+          ?.tools.get(event.data.callId)
+          ?.addEvent("approval_requested", undefined, startTime);
+        emitLog(
+          "action.approval_requested",
+          SeverityNumber.INFO,
+          attrs({
+            ...baseLog(event, session),
+            "cursor.tool.name": event.data.toolName,
+            "agent_sdk.call_id": event.data.callId,
+          })
+        );
+        return;
+      }
+      case "action.approval_resolved": {
+        ensureTurn(event, session, startTime)
+          ?.tools.get(event.data.callId)
+          ?.addEvent(
+            "approval_resolved",
+            attrs({
+              "agent_sdk.decision": event.data.decision,
+              "agent_sdk.decision_by": event.data.by,
+            }),
+            startTime
+          );
+        return;
+      }
+      case "action.result": {
+        const turn = ensureTurn(event, session, startTime);
+        const span = turn?.tools.get(event.data.callId);
+        const status = event.data.isError ? "failure" : "success";
+        if (span !== undefined) {
+          span.setAttribute("cursor.tool.status", status);
+          if (
+            logOpts?.toolContent === true &&
+            event.data.output !== undefined
+          ) {
+            span.setAttribute(
+              "agent_sdk.tool_output",
+              truncate(json(event.data.output))
+            );
+          }
+          if (event.data.isError) {
+            span.setStatus({
+              code: SpanStatusCode.ERROR,
+              message: "tool error",
+            });
+          }
+          span.end(startTime);
+          turn?.tools.delete(event.data.callId);
+        }
+        metrics?.toolCalls.add(1, {
+          "cursor.tool.name": event.data.toolName,
+          "cursor.tool.kind": "builtin",
+          "cursor.tool.status": status,
+          "agent_sdk.agent": agentName,
+        });
+        emitLog(
+          "action.result",
+          event.data.isError ? SeverityNumber.ERROR : SeverityNumber.INFO,
+          attrs({
+            ...baseLog(event, session),
+            "cursor.tool.name": event.data.toolName,
+            "cursor.tool.status": status,
+            "agent_sdk.call_id": event.data.callId,
+          })
+        );
+        // Direct callTool never emits turn.completed — close when idle.
+        if (
+          turn !== undefined &&
+          turn.synthetic &&
+          turn.tools.size === 0 &&
+          turn.subagents.size === 0 &&
+          event.turnId !== undefined
+        ) {
+          turn.span.setStatus({ code: SpanStatusCode.OK });
+          turn.span.end(startTime);
+          sessions.get(event.sessionId)?.turns.delete(event.turnId);
+        }
+        return;
+      }
+      case "subagent.called": {
+        const turn = ensureTurn(event, session, startTime);
+        if (turn === undefined) {
+          return;
+        }
+        const span = runtime.tracer.startSpan(
+          "agent_sdk.subagent",
+          {
+            kind: SpanKind.INTERNAL,
+            startTime,
+            attributes: attrs({
+              "cursor.conversation.id": event.sessionId,
+              "agent_sdk.agent": agentName,
+              "agent_sdk.turn_id": event.turnId,
+              "agent_sdk.call_id": event.data.callId,
+              "agent_sdk.subagent_name": event.data.name,
+              "agent_sdk.subagent_description":
+                logOpts?.toolContent === true &&
+                event.data.description !== undefined
+                  ? truncate(event.data.description)
+                  : undefined,
+            }),
+          },
+          trace.setSpan(context.active(), turn.span)
+        );
+        turn.subagents.set(event.data.callId, span);
+        metrics?.subagents.add(1, {
+          "agent_sdk.agent": agentName,
+          "agent_sdk.subagent_name": event.data.name ?? "unknown",
+        });
+        return;
+      }
+      case "subagent.completed": {
+        const turn = ensureTurn(event, session, startTime);
+        const span = turn?.subagents.get(event.data.callId);
+        if (span !== undefined) {
+          span.end(startTime);
+          turn?.subagents.delete(event.data.callId);
+        }
+        return;
+      }
+      case "artifact.tagged": {
+        ensureSession(event, session, startTime)?.span.addEvent(
+          "artifact.tagged",
+          attrs({
+            "agent_sdk.artifact_id": event.data.id,
+            "agent_sdk.artifact_kind": event.data.kind,
+            "agent_sdk.artifact_key": event.data.key,
+            "agent_sdk.artifact_source": event.data.source,
+          }),
+          startTime
+        );
+        return;
+      }
+      case "turn.completed": {
+        const turn = ensureTurn(event, session, startTime);
+        if (turn === undefined || event.turnId === undefined) {
+          return;
+        }
+        endOpenChildren(turn, startTime);
+        const usage = event.data.usage;
+        const cost = event.data.cost;
+        if (usage !== undefined) {
+          turn.span.setAttributes(
+            attrs({
+              "agent_sdk.usage.input_tokens": usage.inputTokens,
+              "agent_sdk.usage.output_tokens": usage.outputTokens,
+              "agent_sdk.usage.cache_read_tokens": usage.cacheReadTokens,
+              "agent_sdk.usage.cache_write_tokens": usage.cacheWriteTokens,
+              "agent_sdk.usage.reasoning_tokens": usage.reasoningTokens,
+            })
+          );
+          recordTokens(usage);
+        }
+        if (cost !== undefined) {
+          turn.span.setAttributes(
+            attrs({
+              "cursor.model.name": cost.model,
+              "agent_sdk.cost_usd": cost.totalUsd,
+              "agent_sdk.cost_source": cost.source,
+            })
+          );
+          metrics?.cost.add(cost.totalUsd, {
+            "cursor.model.name": cost.model,
+            "agent_sdk.agent": agentName,
+          });
+        }
+        turn.span.setStatus({ code: SpanStatusCode.OK });
+        turn.span.end(startTime);
+        sessions.get(event.sessionId)?.turns.delete(event.turnId);
+        metrics?.turns.add(1, {
+          "agent_sdk.agent": agentName,
+          "agent_sdk.turn_status": "completed",
+        });
+        emitLog(
+          "turn.completed",
+          SeverityNumber.INFO,
+          attrs({
+            ...baseLog(event, session),
+            "agent_sdk.usage.input_tokens": usage?.inputTokens,
+            "agent_sdk.usage.output_tokens": usage?.outputTokens,
+            "agent_sdk.cost_usd": cost?.totalUsd,
+            "cursor.model.name": cost?.model,
+          })
+        );
+        return;
+      }
+      case "turn.failed": {
+        const turn = ensureTurn(event, session, startTime);
+        if (turn === undefined || event.turnId === undefined) {
+          return;
+        }
+        endOpenChildren(turn, startTime);
+        // Failure text can contain secrets/PII — same gate as log payloads.
+        const failureText = gatedContent(event.data.message);
+        turn.span.setStatus({
+          code: SpanStatusCode.ERROR,
+          message: failureText ?? "turn failed",
+        });
+        if (failureText !== undefined) {
+          turn.span.recordException(new Error(failureText));
+        }
+        turn.span.end(startTime);
+        sessions.get(event.sessionId)?.turns.delete(event.turnId);
+        metrics?.turns.add(1, {
+          "agent_sdk.agent": agentName,
+          "agent_sdk.turn_status": "failed",
+        });
+        emitLog(
+          "turn.failed",
+          SeverityNumber.ERROR,
+          attrs({
+            ...baseLog(event, session),
+            "agent_sdk.error_message": failureText,
+          })
+        );
+        return;
+      }
+      case "session.waiting": {
+        ensureSession(event, session, startTime)?.span.addEvent(
+          "session.waiting",
+          undefined,
+          startTime
+        );
+        return;
+      }
+      case "session.completed": {
+        endSession({
+          sessionId: event.sessionId,
+          code: SpanStatusCode.OK,
+          message: undefined,
+          endTime: startTime,
+        });
+        return;
+      }
+      case "session.failed": {
+        const failureText = gatedContent(event.data.message);
+        endSession({
+          sessionId: event.sessionId,
+          code: SpanStatusCode.ERROR,
+          message: failureText ?? "session failed",
+          endTime: startTime,
+        });
+        emitLog(
+          "session.failed",
+          SeverityNumber.ERROR,
+          attrs({
+            ...baseLog(event, session),
+            "agent_sdk.error_message": failureText,
+          })
+        );
+        return;
+      }
+      default:
+        return;
+    }
+  }
+
+  /**
+   * Open a session span on first live event after restore/resume (no
+   * `session.started` in this process). Fresh sessions still use the
+   * dedicated `session.started` case.
+   */
+  function ensureSession(
+    event: SessionEvent,
+    session: SessionInfo,
+    startTime: number | undefined
+  ): SessionState | undefined {
+    const existing = sessions.get(event.sessionId);
+    if (existing !== undefined) {
+      return existing;
+    }
+    return openSession({
+      sessionId: event.sessionId,
+      session,
+      channelId: session.channelId,
+      startTime,
+      restored: true,
+    });
+  }
+
+  function openSession(args: {
+    sessionId: string;
+    session: SessionInfo;
+    channelId: string;
+    startTime: number | undefined;
+    restored: boolean;
+  }): SessionState {
+    const parent = context.active();
+    const span = runtime.tracer.startSpan(
+      "agent_sdk.session",
+      {
+        kind: SpanKind.INTERNAL,
+        startTime: args.startTime,
+        attributes: attrs({
+          "cursor.conversation.id": args.sessionId,
+          "agent_sdk.agent": agentName,
+          "agent_sdk.channel": args.channelId,
+          "agent_sdk.session_mode": args.session.mode,
+          "agent_sdk.session_purpose": args.session.purpose ?? "live",
+          "agent_sdk.session_restored": args.restored ? true : undefined,
+        }),
+      },
+      parent
+    );
+    const state: SessionState = {
+      span,
+      ctx: trace.setSpan(parent, span),
+      turns: new Map(),
+    };
+    sessions.set(args.sessionId, state);
+    if (!args.restored) {
+      metrics?.sessions.add(1, {
+        "agent_sdk.agent": agentName,
+        "agent_sdk.channel": args.channelId,
+      });
+    }
+    return state;
+  }
+
+  /**
+   * Direct `callTool` and post-restore turns may emit tool events without
+   * a prior `turn.started` in this process — open a synthetic turn span.
+   */
+  function ensureTurn(
+    event: SessionEvent,
+    session: SessionInfo,
+    startTime: number | undefined
+  ): TurnState | undefined {
+    if (event.turnId === undefined) {
+      return undefined;
+    }
+    const state = ensureSession(event, session, startTime);
+    if (state === undefined) {
+      return undefined;
+    }
+    const existing = state.turns.get(event.turnId);
+    if (existing !== undefined) {
+      return existing;
+    }
+    return openTurn({
+      state,
+      sessionId: event.sessionId,
+      turnId: event.turnId,
+      session,
+      startTime,
+      synthetic: true,
+    });
+  }
+
+  function openTurn(args: {
+    state: SessionState;
+    sessionId: string;
+    turnId: string;
+    session: SessionInfo;
+    startTime: number | undefined;
+    synthetic: boolean;
+  }): TurnState {
+    const span = runtime.tracer.startSpan(
+      "agent_sdk.turn",
+      {
+        kind: SpanKind.INTERNAL,
+        startTime: args.startTime,
+        attributes: attrs({
+          "cursor.conversation.id": args.sessionId,
+          "agent_sdk.agent": agentName,
+          "agent_sdk.turn_id": args.turnId,
+          "agent_sdk.channel": args.session.channelId,
+          "agent_sdk.turn_synthetic": args.synthetic ? true : undefined,
+        }),
+      },
+      args.state.ctx
+    );
+    const turn: TurnState = {
+      span,
+      tools: new Map(),
+      subagents: new Map(),
+      synthetic: args.synthetic,
+    };
+    args.state.turns.set(args.turnId, turn);
+    return turn;
+  }
+
+  function parentCtxFor(
+    turn: TurnState,
+    parentCallId: string | undefined
+  ): Context {
+    if (parentCallId !== undefined) {
+      const sub = turn.subagents.get(parentCallId);
+      if (sub !== undefined) {
+        return trace.setSpan(context.active(), sub);
+      }
+    }
+    return trace.setSpan(context.active(), turn.span);
+  }
+
+  function endOpenChildren(turn: TurnState, endTime: number | undefined): void {
+    for (const span of turn.tools.values()) {
+      span.end(endTime);
+    }
+    turn.tools.clear();
+    for (const span of turn.subagents.values()) {
+      span.end(endTime);
+    }
+    turn.subagents.clear();
+  }
+
+  function endSession(args: {
+    sessionId: string;
+    code: SpanStatusCode;
+    message: string | undefined;
+    endTime: number | undefined;
+  }): void {
+    const state = sessions.get(args.sessionId);
+    if (state === undefined) {
+      return;
+    }
+    for (const turn of state.turns.values()) {
+      endOpenChildren(turn, args.endTime);
+      turn.span.end(args.endTime);
+    }
+    state.turns.clear();
+    state.span.setStatus(
+      args.message === undefined
+        ? { code: args.code }
+        : { code: args.code, message: args.message }
+    );
+    state.span.end(args.endTime);
+    sessions.delete(args.sessionId);
+  }
+
+  function recordTokens(usage: {
+    inputTokens: number;
+    outputTokens: number;
+    cacheReadTokens: number;
+    cacheWriteTokens: number;
+    reasoningTokens?: number;
+  }): void {
+    if (metrics === undefined) {
+      return;
+    }
+    const agent = agentName;
+    // Wire token types match enterprise export (`cache_creation`, not write).
+    addTokens(usage.inputTokens, "input", agent);
+    addTokens(usage.outputTokens, "output", agent);
+    addTokens(usage.cacheReadTokens, "cache_read", agent);
+    addTokens(usage.cacheWriteTokens, "cache_creation", agent);
+    if (usage.reasoningTokens !== undefined) {
+      // Reasoning is Agent-SDK-only; enterprise wire has no reasoning enum.
+      metrics.tokens.add(usage.reasoningTokens, {
+        "cursor.token.type": "reasoning",
+        "agent_sdk.agent": agent,
+      });
+    }
+  }
+
+  function addTokens(
+    value: number,
+    type: "input" | "output" | "cache_read" | "cache_creation",
+    agent: string
+  ): void {
+    if (metrics === undefined || value === 0) {
+      return;
+    }
+    metrics.tokens.add(value, {
+      "cursor.token.type": type,
+      "agent_sdk.agent": agent,
+    });
+  }
+
+  /** Content opt-in for failure text (same gate as tool payloads). */
+  function gatedContent(value: string): string | undefined {
+    if (logOpts?.toolContent !== true) {
+      return undefined;
+    }
+    return truncate(value);
+  }
+
+  function baseLog(
+    event: SessionEvent,
+    session: SessionInfo
+  ): Record<string, AttrValue | undefined> {
+    return {
+      "cursor.conversation.id": event.sessionId,
+      "agent_sdk.event": event.type,
+      "agent_sdk.agent": agentName,
+      "agent_sdk.channel": session.channelId,
+      "agent_sdk.turn_id": event.turnId,
+    };
+  }
+
+  function emitLog(
+    eventName: string,
+    severity: SeverityNumber,
+    attributes: Record<string, AttrValue>
+  ): void {
+    runtime.logger?.emit({
+      body: eventName,
+      severityNumber: severity,
+      attributes,
+    });
+  }
+}
+
+interface MetricSet {
+  sessions: Counter;
+  turns: Counter;
+  toolCalls: Counter;
+  subagents: Counter;
+  tokens: Counter;
+  cost: Counter;
+}
+
+function buildMetrics(meter: Meter): MetricSet {
+  return {
+    sessions: meter.createCounter("agent_sdk.session.count", {
+      description: "Sessions started",
+      unit: "{session}",
+    }),
+    turns: meter.createCounter("agent_sdk.turn.count", {
+      description: "Turns completed or failed",
+      unit: "{turn}",
+    }),
+    // Wire-aligned name so collectors joining org export see one series family.
+    toolCalls: meter.createCounter("cursor.tool.calls", {
+      description: "Tool calls finished",
+      unit: "{call}",
+    }),
+    subagents: meter.createCounter("agent_sdk.subagent.count", {
+      description: "Subagent invocations",
+      unit: "{call}",
+    }),
+    tokens: meter.createCounter("cursor.token.usage", {
+      description: "Token usage by type",
+      unit: "{token}",
+    }),
+    cost: meter.createCounter("cursor.cost.usage", {
+      description: "Estimated turn cost in USD",
+      unit: "USD",
+    }),
+  };
+}
+
+function truncate(value: string): string {
+  if (value.length <= CONTENT_MAX) {
+    return value;
+  }
+  return `${value.slice(0, CONTENT_MAX)}…`;
+}
+
+function json(value: unknown): string {
+  try {
+    return JSON.stringify(value) ?? String(value);
+  } catch {
+    return String(value);
+  }
+}