@posthog/ai 8.16.1 → 8.16.3

package/README.md

@@ -9,6 +9,18 @@ SDK usage examples and code snippets live in the official documentation so they
 - [AI observability installation docs](https://posthog.com/docs/ai-observability/installation)
 - [AI observability docs](https://posthog.com/docs/ai-observability)
 
+## Privacy mode
+
+Create the client with `new PostHog(key, { privacyMode: true })` to turn on privacy mode for every integration.
+Per-call `privacyMode` settings can turn it on for one call, but cannot turn it off.
+
+In privacy mode, events carry no prompts, outputs, or tool inputs and results.
+`$ai_error` holds only the error class, HTTP status, provider error code, parameter name, request ID, and cause classes.
+Exception autocapture skips these errors, and Vercel AI SDK events omit provider metadata.
+For OpenTelemetry, pass `privacyMode: true` to `PostHogTraceExporter`, or to `PostHogSpanProcessor` when its `client` is not in privacy mode.
+
+Remote MCP tool `headers` and `authorization` values are always replaced with `[REDACTED]`.
+
 ## Gemini Interactions
 
 `PostHogGoogleGenAI.interactions.create` traces foreground model calls with `@google/genai` 2.18 or later in the 2.x series.

package/dist/adk/index.cjs

@@ -3,7 +3,12 @@ let _google_adk = require("@google/adk");
 let uuid = require("uuid");
 let _posthog_core = require("@posthog/core");
 //#region package.json
-var version = "8.16.1";
+var version = "8.16.3";
+//#endregion
+//#region src/typeGuards.ts
+const isObject = (value) => {
+	return value !== null && typeof value === "object" && !Array.isArray(value);
+};
 //#endregion
 //#region src/captureAiEvent.ts
 /** @internal */
@@ -225,6 +230,10 @@ function redactBase64DataUrl(str, mediaType) {
 const sanitize = (data, client) => isFullAiCaptureEnabled(client) ? data : redactor.redact(data);
 const sanitizeGemini = (data, client) => sanitize(data, client);
 //#endregion
+//#region src/privacyMode.ts
+/** Per-call settings can turn redaction on but never off. */
+const isPrivacyModeEnabled = (client, privacyMode = false) => privacyMode === true || client?.privacyMode === true || client?.privacy_mode === true || client?.options?.privacyMode === true;
+//#endregion
 //#region src/utils.ts
 const TOKEN_PROPERTY_KEYS = /* @__PURE__ */ new Set([
 	"$ai_input_tokens",
@@ -348,7 +357,6 @@ const formatResponseGemini = (response, client) => {
 	});
 	return output;
 };
-const isPrivacyModeEnabled = (client, privacyMode) => Boolean(client.privacy_mode || privacyMode);
 const withPrivacyMode = (client, privacyMode, input) => {
 	return isPrivacyModeEnabled(client, privacyMode) ? null : input;
 };
@@ -364,6 +372,7 @@ function sanitizeValues(obj) {
 //#region src/serializeError.ts
 const DEFAULT_MAX_DEPTH = 3;
 const MAX_STACK_LINES = 20;
+const OMITTED_FIELD = "requestBodyValues";
 function serializeError(value, depth = DEFAULT_MAX_DEPTH) {
 	if (depth < 0 || value === null || typeof value !== "object") return value;
 	if (value instanceof Error) {
@@ -372,16 +381,17 @@ function serializeError(value, depth = DEFAULT_MAX_DEPTH) {
 			message: value.message,
 			stack: truncateStack(value.stack)
 		};
-		for (const key of Object.keys(value)) out[key] = serializeError(value[key], depth - 1);
+		for (const key of Object.keys(value)) if (key !== OMITTED_FIELD) out[key] = serializeError(Reflect.get(value, key), depth - 1);
 		if (value.cause !== void 0) out.cause = serializeError(value.cause, depth - 1);
 		return out;
 	}
 	if (Array.isArray(value)) return value.map((item) => serializeError(item, depth - 1));
 	return value;
 }
+const omitRequestBody = (key, value) => key === OMITTED_FIELD ? void 0 : value;
 function stringifyError(error) {
 	try {
-		return JSON.stringify(sanitizeValues(serializeError(error)));
+		return JSON.stringify(sanitizeValues(serializeError(error)), omitRequestBody);
 	} catch {
 		if (error instanceof Error) return JSON.stringify({
 			name: error.name,
@@ -390,6 +400,105 @@ function stringifyError(error) {
 		return JSON.stringify({ message: String(error) });
 	}
 }
+const CLASS_NAME = /^[A-Za-z_$][A-Za-z0-9_$.]{0,127}$/;
+const PROVIDER_CODE = /^[A-Za-z0-9_.:-]{1,64}$/;
+const PARAM = /^[A-Za-z0-9_.[\]-]{1,128}$/;
+const REQUEST_ID = /^[A-Za-z0-9_.:-]{1,128}$/;
+const MAX_CAUSES = 3;
+const readField = (value, key) => {
+	if (value === null || typeof value !== "object" && typeof value !== "function") return;
+	try {
+		return Reflect.get(value, key);
+	} catch {
+		return;
+	}
+};
+const matching = (value, grammar) => typeof value === "string" && grammar.test(value) ? value : void 0;
+const firstMatching = (values, grammar) => {
+	for (const value of values) {
+		const match = matching(value, grammar);
+		if (match !== void 0) return match;
+	}
+};
+const className = (value) => {
+	if (!(value instanceof Error)) return "NonErrorThrown";
+	const name = readField(value, "name");
+	return firstMatching([
+		name === "Error" ? void 0 : name,
+		readField(readField(value, "constructor"), "name"),
+		name
+	], CLASS_NAME) ?? "Error";
+};
+const httpStatus = (error) => {
+	for (const key of ["status", "statusCode"]) {
+		const value = readField(error, key);
+		if (typeof value === "number" && Number.isInteger(value) && value >= 100 && value <= 599) return value;
+	}
+};
+const unwrapEnvelope = (body) => {
+	const inner = readField(body, "error");
+	return inner !== null && typeof inner === "object" ? inner : body;
+};
+const parsedResponseBody = (error) => {
+	const responseBody = readField(error, "responseBody");
+	if (typeof responseBody !== "string") return;
+	try {
+		return unwrapEnvelope(JSON.parse(responseBody));
+	} catch {
+		return;
+	}
+};
+const causeNames = (error) => {
+	const names = [];
+	let cause = readField(error, "cause");
+	while (cause !== void 0 && cause !== null && names.length < MAX_CAUSES) {
+		names.push(className(cause));
+		cause = readField(cause, "cause");
+	}
+	return names;
+};
+const describeError = (error) => {
+	const sources = [
+		error,
+		unwrapEnvelope(readField(error, "error")),
+		parsedResponseBody(error)
+	];
+	const codes = /* @__PURE__ */ new Set();
+	for (const source of sources) for (const key of [
+		"code",
+		"type",
+		"status"
+	]) {
+		const code = matching(readField(source, key), PROVIDER_CODE);
+		if (code !== void 0) codes.add(code);
+	}
+	const status = httpStatus(error);
+	const param = firstMatching(sources.map((source) => readField(source, "param")), PARAM);
+	const requestId = firstMatching([readField(error, "requestID"), readField(error, "request_id")], REQUEST_ID);
+	const causes = causeNames(error);
+	let summary = className(error);
+	if (status !== void 0) summary += `: ${status}`;
+	for (const code of codes) summary += ` ${code}`;
+	if (param !== void 0) summary += ` param=${param}`;
+	if (requestId !== void 0) summary += ` request_id=${requestId}`;
+	if (causes.length > 0) summary += ` (caused by ${causes.join(", ")})`;
+	return summary;
+};
+/**
+* Describes an error for `$ai_error` without its message, stack, or arbitrary fields, which
+* routinely echo the prompt. Only structured fields that pass a strict grammar are kept.
+* The format matches the Python SDK.
+*/
+function summarizeErrorForPrivacy(error) {
+	try {
+		return describeError(error);
+	} catch {
+		return error instanceof Error ? "Error" : "NonErrorThrown";
+	}
+}
+function formatAiError(error, privacyMode) {
+	return privacyMode ? summarizeErrorForPrivacy(error) : stringifyError(error);
+}
 function truncateStack(stack) {
 	if (!stack) return stack;
 	const lines = stack.split("\n");
@@ -397,6 +506,33 @@ function truncateStack(stack) {
 	return [...lines.slice(0, MAX_STACK_LINES), "... (truncated)"].join("\n");
 }
 //#endregion
+//#region src/mcpCredentials.ts
+const MCP_CREDENTIAL_FIELDS = ["headers", "authorization"];
+const MCP_PROVIDER_TOOL_IDS = /* @__PURE__ */ new Set([
+	"openai.mcp",
+	"xai.mcp",
+	"google.mcp_server"
+]);
+const isMcpProviderTool = (tool) => (tool.type === "provider" || tool.type === "provider-defined") && typeof tool.id === "string" && MCP_PROVIDER_TOOL_IDS.has(tool.id);
+const withoutMcpCredentials = (config) => {
+	const redacted = { ...config };
+	for (const field of MCP_CREDENTIAL_FIELDS) if (field in redacted) redacted[field] = "[REDACTED]";
+	return redacted;
+};
+/** Hides the credentials of a remote MCP tool definition; everything else is kept as sent. */
+function redactMcpToolDefinition(tool) {
+	if (!isObject(tool)) return tool;
+	if (tool.type === "mcp") return withoutMcpCredentials(tool);
+	if (isMcpProviderTool(tool) && isObject(tool.args)) return {
+		...tool,
+		args: withoutMcpCredentials(tool.args)
+	};
+	return tool;
+}
+function redactMcpToolCredentials(tools) {
+	return Array.isArray(tools) ? tools.map(redactMcpToolDefinition) : tools;
+}
+//#endregion
 //#region src/gatewayWarning.ts
 const POSTHOG_AI_GATEWAY_HOSTS = [
 	"gateway.posthog.com",
@@ -459,13 +595,15 @@ const captureAiGeneration = async (client, options) => {
 			}
 			let exceptionId;
 			if (client.options?.enableExceptionAutocapture) {
-				exceptionId = (0, _posthog_core.uuidv7)();
-				client.captureException(options.error, void 0, { $ai_trace_id: traceId }, exceptionId);
+				if (!shouldRedact) {
+					exceptionId = (0, _posthog_core.uuidv7)();
+					client.captureException(options.error, void 0, { $ai_trace_id: traceId }, exceptionId);
+				}
 				if (typeof options.error === "object") options.error.__posthog_previously_captured_error = true;
 			}
 			errorData = {
 				$ai_is_error: true,
-				$ai_error: stringifyError(options.error),
+				$ai_error: formatAiError(options.error, shouldRedact),
 				$exception_event_id: exceptionId
 			};
 		}
@@ -506,7 +644,7 @@ const captureAiGeneration = async (client, options) => {
 			$ai_tokens_source: getTokensSource(options.properties),
 			...options.distinctId ? {} : { $process_person_profile: false },
 			...options.stopReason ? { $ai_stop_reason: options.stopReason } : {},
-			...options.tools ? { $ai_tools: options.tools } : {},
+			...options.tools ? { $ai_tools: redactMcpToolCredentials(options.tools) } : {},
 			...options.completionId ? { $ai_completion_id: options.completionId } : {},
 			...options.providerMetadata && Object.keys(options.providerMetadata).length > 0 ? { $ai_provider_metadata: options.providerMetadata } : {},
 			...errorData,
@@ -806,7 +944,7 @@ var PostHogADKPlugin = class extends _google_adk.BasePlugin {
 			...context.agentName ? { $ai_agent_name: context.agentName } : {},
 			...error ? {
 				$ai_is_error: true,
-				$ai_error: stringifyError(error)
+				$ai_error: formatAiError(error, isPrivacyModeEnabled(this._client, this._privacyMode))
 			} : {}
 		});
 	}