agent-inspect 1.2.0 → 1.3.0

package/packages/core/dist/index.cjs

@@ -193,6 +193,51 @@ function isPersistedInspectEvent(value) {
   return true;
 }
 
+// packages/core/src/correlation-metadata.ts
+var TRACE_CORRELATION_KEYS = [
+  "correlationId",
+  "requestId",
+  "decisionId",
+  "groupId"
+];
+function isNonEmptyString2(value) {
+  return typeof value === "string" && value.length > 0;
+}
+function extractCorrelationMetadata(record) {
+  if (!record) {
+    return void 0;
+  }
+  const out = {};
+  let found = false;
+  for (const key of TRACE_CORRELATION_KEYS) {
+    const value = record[key];
+    if (isNonEmptyString2(value)) {
+      out[key] = value;
+      found = true;
+    }
+  }
+  return found ? out : void 0;
+}
+function buildRunStartedMetadata(options) {
+  if (!options) {
+    return void 0;
+  }
+  const merged = options.metadata !== void 0 ? { ...options.metadata } : {};
+  if (isNonEmptyString2(options.correlationId)) {
+    merged.correlationId = options.correlationId;
+  }
+  if (isNonEmptyString2(options.requestId)) {
+    merged.requestId = options.requestId;
+  }
+  if (isNonEmptyString2(options.decisionId)) {
+    merged.decisionId = options.decisionId;
+  }
+  if (isNonEmptyString2(options.groupId)) {
+    merged.groupId = options.groupId;
+  }
+  return Object.keys(merged).length > 0 ? merged : void 0;
+}
+
 // packages/core/src/persisted/from-trace-event.ts
 function sanitizeIdPart(value) {
   return value.replace(/[^a-zA-Z0-9_-]/g, "_");
@@ -299,9 +344,14 @@ function traceEventToPersistedInspectEvent(event, options) {
   switch (event.event) {
     case "run_started": {
       const tsStart = toIsoTimestamp(event.startTime);
+      const correlation = extractCorrelationMetadata(event.metadata);
       const attributes = compactAttributes({
         legacyEvent: "run_started",
         metadata: event.metadata !== void 0 ? { ...event.metadata } : void 0,
+        correlationId: correlation?.correlationId,
+        requestId: correlation?.requestId,
+        decisionId: correlation?.decisionId,
+        groupId: correlation?.groupId,
         invalidTimestamp: tsMain.invalidTimestamp || tsStart.invalidTimestamp ? true : void 0
       });
       return {
@@ -1138,7 +1188,7 @@ function stableHash(value) {
   const h = crypto__default.default.createHash("sha256").update(value, "utf8").digest("hex");
   return h.slice(0, 8);
 }
-function compileRules(rules) {
+function compileRules(rules, extraKeys) {
   const out = /* @__PURE__ */ new Map();
   const set = (r) => {
     const k = toKey(r.key);
@@ -1147,6 +1197,11 @@ function compileRules(rules) {
   for (const k of DEFAULT_REDACT_KEYS) {
     set({ key: k, strategy: "full" });
   }
+  for (const k of extraKeys ?? []) {
+    if (typeof k === "string" && k.length > 0) {
+      set({ key: k, strategy: "full" });
+    }
+  }
   for (const r of rules ?? []) {
     if (typeof r === "string") {
       set({ key: r, strategy: "full" });
@@ -1164,7 +1219,7 @@ function compileRules(rules) {
 var Redactor = class {
   #rules;
   constructor(options) {
-    this.#rules = compileRules(options?.rules);
+    this.#rules = compileRules(options?.rules, options?.extraKeys);
   }
   redactValue(key, value) {
     const k = toKey(key);
@@ -1869,6 +1924,91 @@ function warn(message, error) {
   }
   console.warn(`${base}: ${formatError(error).message}`);
 }
+
+// packages/core/src/redaction-profiles.ts
+var SHARE_PROFILE_EXTRA_KEYS = [
+  "userEmail",
+  "customerEmail",
+  "phone",
+  "phoneNumber",
+  "address",
+  "ip",
+  "ipAddress",
+  "sessionId",
+  "requestId",
+  "correlationId",
+  "decisionId",
+  "groupId",
+  "customerId",
+  "userId",
+  "accountId",
+  "tenantId",
+  "orgId",
+  "organizationId",
+  "traceId",
+  "spanId",
+  "parentSpanId"
+];
+var STRICT_PROFILE_EXTRA_KEYS = [
+  "prompt",
+  "completion",
+  "input",
+  "output",
+  "inputPreview",
+  "outputPreview",
+  "message",
+  "messages",
+  "transcript",
+  "context",
+  "document",
+  "documents",
+  "chunk",
+  "chunks",
+  "retrieval",
+  "query"
+];
+function resolveRedactionProfile(profile = "local") {
+  switch (profile) {
+    case "local":
+      return { profile: "local", extraKeys: [] };
+    case "share":
+      return {
+        profile: "share",
+        extraKeys: SHARE_PROFILE_EXTRA_KEYS,
+        maxMetadataValueLengthCap: 500,
+        maxPreviewLengthCap: 200
+      };
+    case "strict":
+      return {
+        profile: "strict",
+        extraKeys: [...SHARE_PROFILE_EXTRA_KEYS, ...STRICT_PROFILE_EXTRA_KEYS],
+        maxMetadataValueLengthCap: 200,
+        maxPreviewLengthCap: 80
+      };
+    default:
+      return { profile: "local", extraKeys: [] };
+  }
+}
+function isPreviewKey(key) {
+  return key.toLowerCase().includes("preview");
+}
+function applyProfileMetadataCaps(maxMetadataValueLength, maxPreviewLength, resolved) {
+  let meta = maxMetadataValueLength;
+  let preview = maxPreviewLength;
+  if (resolved.maxMetadataValueLengthCap !== void 0) {
+    meta = Math.min(meta, resolved.maxMetadataValueLengthCap);
+  }
+  if (resolved.maxPreviewLengthCap !== void 0) {
+    preview = Math.min(preview, resolved.maxPreviewLengthCap);
+  }
+  return { maxMetadataValueLength: meta, maxPreviewLength: preview };
+}
+function truncateStringForProfile(value, key, maxMetadataValueLength, maxPreviewLength) {
+  const max = isPreviewKey(key) ? maxPreviewLength : maxMetadataValueLength;
+  if (max <= 0) return "\u2026";
+  if (value.length <= max) return value;
+  return `${value.slice(0, max)}\u2026`;
+}
 function isRecord7(value) {
   return typeof value === "object" && value !== null && !Array.isArray(value);
 }
@@ -2072,7 +2212,7 @@ var DEFAULT_MAX_EVENT_BYTES = 65536;
 function isRecord8(value) {
   return typeof value === "object" && value !== null && !Array.isArray(value);
 }
-function isPreviewKey(key) {
+function isPreviewKey2(key) {
   return key.toLowerCase().includes("preview");
 }
 function truncateString(value, maxLen) {
@@ -2095,11 +2235,28 @@ function resolveTraceSafetyOptions(options) {
     redactEnabled = true;
     redactionRules = redact.rules;
   }
+  const profile = options?.redactionProfile ?? "local";
+  const resolvedProfile = resolveRedactionProfile(profile);
+  const userMaxMetadata = typeof options?.maxMetadataValueLength === "number" && Number.isFinite(options.maxMetadataValueLength) && options.maxMetadataValueLength >= 0 ? Math.floor(options.maxMetadataValueLength) : void 0;
+  const userMaxPreview = typeof options?.maxPreviewLength === "number" && Number.isFinite(options.maxPreviewLength) && options.maxPreviewLength >= 0 ? Math.floor(options.maxPreviewLength) : void 0;
+  let maxMetadataValueLength = userMaxMetadata ?? DEFAULT_MAX_METADATA_VALUE_LENGTH;
+  let maxPreviewLength = userMaxPreview ?? DEFAULT_MAX_PREVIEW_LENGTH;
+  if (redactEnabled && profile !== "local") {
+    const capped = applyProfileMetadataCaps(
+      maxMetadataValueLength,
+      maxPreviewLength,
+      resolvedProfile
+    );
+    maxMetadataValueLength = capped.maxMetadataValueLength;
+    maxPreviewLength = capped.maxPreviewLength;
+  }
   return {
     redactEnabled,
     redactionRules,
-    maxMetadataValueLength: typeof options?.maxMetadataValueLength === "number" && Number.isFinite(options.maxMetadataValueLength) && options.maxMetadataValueLength >= 0 ? Math.floor(options.maxMetadataValueLength) : DEFAULT_MAX_METADATA_VALUE_LENGTH,
-    maxPreviewLength: typeof options?.maxPreviewLength === "number" && Number.isFinite(options.maxPreviewLength) && options.maxPreviewLength >= 0 ? Math.floor(options.maxPreviewLength) : DEFAULT_MAX_PREVIEW_LENGTH,
+    redactionProfile: profile,
+    profileExtraKeys: redactEnabled ? resolvedProfile.extraKeys : [],
+    maxMetadataValueLength,
+    maxPreviewLength,
     maxEventBytes: typeof options?.maxEventBytes === "number" && Number.isFinite(options.maxEventBytes) && options.maxEventBytes > 0 ? Math.floor(options.maxEventBytes) : DEFAULT_MAX_EVENT_BYTES
   };
 }
@@ -2107,7 +2264,7 @@ function boundMetadataValue(key, value, opts, seen, depth) {
   if (depth > 32) return "[MaxDepth]";
   if (value === null || typeof value !== "object") {
     if (typeof value === "string") {
-      const max = isPreviewKey(key) ? opts.maxPreviewLength : opts.maxMetadataValueLength;
+      const max = isPreviewKey2(key) ? opts.maxPreviewLength : opts.maxMetadataValueLength;
       return truncateString(value, max);
     }
     return value;
@@ -2133,7 +2290,10 @@ function boundMetadataValue(key, value, opts, seen, depth) {
 }
 function redactMetadata(metadata, opts) {
   if (!opts.redactEnabled) return { ...metadata };
-  const redactor = new Redactor({ rules: opts.redactionRules });
+  const redactor = new Redactor({
+    rules: opts.redactionRules,
+    extraKeys: opts.profileExtraKeys
+  });
   return redactor.redactRecord(metadata);
 }
 function prepareMetadataForDisk(metadata, opts) {
@@ -2305,6 +2465,13 @@ function getCurrentRunId() {
     return void 0;
   }
 }
+function getCurrentCorrelationMetadata() {
+  try {
+    return extractCorrelationMetadata(storage.getStore()?.metadata);
+  } catch {
+    return void 0;
+  }
+}
 function getCurrentRunName() {
   try {
     return storage.getStore()?.runName;
@@ -3948,12 +4115,13 @@ async function inspectRun(name, fn, options) {
   const runId = createRunId();
   const traceDir = resolveTraceDir({ dir: options?.traceDir });
   const traceSafety = resolveTraceSafetyOptions(options);
+  const runMetadata = buildRunStartedMetadata(options);
   const context = {
     runId,
     runName,
     traceDir,
     silent: options?.silent ?? false,
-    metadata: options?.metadata
+    metadata: runMetadata
   };
   return runWithContext(context, async () => {
     const startTime = Date.now();
@@ -3969,7 +4137,7 @@ async function inspectRun(name, fn, options) {
         runId,
         name: runName,
         startTime,
-        ...options?.metadata !== void 0 ? { metadata: options.metadata } : {}
+        ...runMetadata !== void 0 ? { metadata: runMetadata } : {}
       };
       await writeTraceEvent(
         prepareTraceEventForDisk(started, traceSafety),
@@ -4254,6 +4422,134 @@ function observe(agent, options) {
 // packages/core/src/exporters/types.ts
 var EXPORT_PAYLOAD_VERSION = "0.1.2";
 
+// packages/core/src/exporters/redact-export.ts
+function isRecord10(value) {
+  return typeof value === "object" && value !== null && !Array.isArray(value);
+}
+function deepClone(value) {
+  if (value === null || typeof value !== "object") {
+    return value;
+  }
+  if (Array.isArray(value)) {
+    return value.map((item) => deepClone(item));
+  }
+  const out = {};
+  for (const [k, v] of Object.entries(value)) {
+    out[k] = deepClone(v);
+  }
+  return out;
+}
+function boundAttributeValues(record, maxMetadataValueLength, maxPreviewLength, seen, depth) {
+  if (depth > 32) {
+    return { truncated: true, reason: "maxDepth" };
+  }
+  const out = {};
+  for (const [key, value] of Object.entries(record)) {
+    out[key] = boundValue(value, key, maxMetadataValueLength, maxPreviewLength, seen, depth);
+  }
+  return out;
+}
+function boundValue(value, key, maxMetadataValueLength, maxPreviewLength, seen, depth) {
+  if (value === null || typeof value !== "object") {
+    if (typeof value === "string") {
+      return truncateStringForProfile(
+        value,
+        key,
+        maxMetadataValueLength,
+        maxPreviewLength
+      );
+    }
+    return value;
+  }
+  if (seen.has(value)) return "[Circular]";
+  seen.add(value);
+  if (Array.isArray(value)) {
+    return value.slice(0, 50).map(
+      (item, index) => boundValue(
+        item,
+        String(index),
+        maxMetadataValueLength,
+        maxPreviewLength,
+        seen,
+        depth + 1
+      )
+    );
+  }
+  return boundAttributeValues(
+    value,
+    maxMetadataValueLength,
+    maxPreviewLength,
+    seen,
+    depth + 1
+  );
+}
+function redactEventAttributes(attrs, redactor, maxMetadataValueLength, maxPreviewLength) {
+  if (!attrs || Object.keys(attrs).length === 0) {
+    return attrs;
+  }
+  const redacted = redactor.redactRecord(attrs);
+  const seen = /* @__PURE__ */ new WeakSet();
+  const bounded = boundAttributeValues(
+    redacted,
+    maxMetadataValueLength,
+    maxPreviewLength,
+    seen,
+    0
+  );
+  const err = bounded.error;
+  if (isRecord10(err) && typeof err.message === "string") {
+    bounded.error = {
+      ...err,
+      message: truncateStringForProfile(
+        err.message,
+        "message",
+        maxMetadataValueLength,
+        maxPreviewLength
+      ),
+      ...typeof err.stack === "string" ? {
+        stack: truncateStringForProfile(
+          err.stack,
+          "stack",
+          maxMetadataValueLength,
+          maxPreviewLength
+        )
+      } : {}
+    };
+  }
+  return bounded;
+}
+function redactRunTreeForExport(tree, options) {
+  const profile = options?.redactionProfile ?? "local";
+  if (profile === "local") {
+    return deepClone(tree);
+  }
+  const resolved = resolveRedactionProfile(profile);
+  const { maxMetadataValueLength, maxPreviewLength } = applyProfileMetadataCaps(
+    2e3,
+    500,
+    resolved
+  );
+  const redactor = new Redactor({ extraKeys: resolved.extraKeys });
+  const clone = deepClone(tree);
+  function walk(nodes) {
+    for (const node of nodes) {
+      if (node.event.attributes !== void 0) {
+        node.event.attributes = redactEventAttributes(
+          node.event.attributes,
+          redactor,
+          maxMetadataValueLength,
+          maxPreviewLength
+        );
+      }
+      if (node.children.length > 0) {
+        walk(node.children);
+      }
+    }
+  }
+  walk(clone.children);
+  return clone;
+}
+
 // packages/core/src/exporters/html-exporter.ts
 function renderTreeHtml(nodes, ulClass = "tree") {
   if (nodes.length === 0) return "";
@@ -4990,20 +5286,22 @@ function mergeExportDefaults(options) {
     includeErrors: options.includeErrors ?? true,
     pretty: options.pretty ?? true,
     redacted: options.redacted ?? true,
-    maxAttributeLength: options.maxAttributeLength ?? 500
+    maxAttributeLength: options.maxAttributeLength ?? 500,
+    redactionProfile: options.redactionProfile ?? "local"
   };
 }
 function exportRunTree(tree, options) {
   const opts = mergeExportDefaults(options);
+  const exportTree = opts.redactionProfile === "local" ? tree : redactRunTreeForExport(tree, { redactionProfile: opts.redactionProfile });
   switch (opts.format) {
     case "markdown":
-      return exportMarkdown(tree, opts);
+      return exportMarkdown(exportTree, opts);
     case "html":
-      return exportHtml(tree, opts);
+      return exportHtml(exportTree, opts);
     case "openinference":
-      return exportOpenInference(tree, opts);
+      return exportOpenInference(exportTree, opts);
     case "otlp-json":
-      return exportOtlpJson(tree, opts);
+      return exportOtlpJson(exportTree, opts);
     default: {
       const _x = opts.format;
       throw new Error(`Unsupported export format: ${String(_x)}`);
@@ -5062,6 +5360,7 @@ exports.formatError = formatError;
 exports.formatTerminalName = formatTerminalName;
 exports.formatTimestamp = formatTimestamp;
 exports.getCurrentContext = getCurrentContext;
+exports.getCurrentCorrelationMetadata = getCurrentCorrelationMetadata;
 exports.getCurrentDepth = getCurrentDepth;
 exports.getCurrentRunId = getCurrentRunId;
 exports.getCurrentRunName = getCurrentRunName;
@@ -5110,12 +5409,14 @@ exports.printStepComplete = printStepComplete;
 exports.printStepStart = printStepStart;
 exports.readTraceEvents = readTraceEvents;
 exports.readTraceFile = readTraceFile;
+exports.redactRunTreeForExport = redactRunTreeForExport;
 exports.renderErrorLine = renderErrorLine;
 exports.renderRunDiff = renderRunDiff;
 exports.renderRunSummary = renderRunSummary;
 exports.renderRunTree = renderRunTree;
 exports.renderRunTrees = renderRunTrees;
 exports.renderStepLine = renderStepLine;
+exports.resolveRedactionProfile = resolveRedactionProfile;
 exports.resolveTraceDir = resolveTraceDir;
 exports.resolveTraceSafetyOptions = resolveTraceSafetyOptions;
 exports.runWithContext = runWithContext;