[wrangler] Add observability query string redaction (#15379)

Co-authored-by: OpenCode <noreply@opencode.ai>
Co-authored-by: Build <noreply@cloudflare.com>
Co-authored-by: OpenAI <noreply@openai.com>

Author: 4 people

.changeset/redacted-query-strings.md

@@ -0,0 +1,10 @@
+---
+"@cloudflare/config": minor
+"@cloudflare/deploy-helpers": patch
+"@cloudflare/workers-utils": minor
+"wrangler": minor
+---
+
+Add query string redaction to Workers observability configuration
+
+Set `observability.redact_query_string` in `wrangler.json` or `observability.redactQueryString` in the experimental `cloudflare.config.ts` format to remove query strings from request URLs in logs and traces.

packages/config/src/__tests__/convert.test.ts

@@ -57,6 +57,7 @@ describe("convertToWranglerConfig", () => {
 				observability: {
 					enabled: true,
 					headSamplingRate: 0.5,
+					redactQueryString: true,
 					logs: {
 						enabled: true,
 						headSamplingRate: 0.25,
@@ -75,6 +76,7 @@ describe("convertToWranglerConfig", () => {
 			expect(result.observability).toEqual({
 				enabled: true,
 				head_sampling_rate: 0.5,
+				redact_query_string: true,
 				logs: {
 					enabled: true,
 					head_sampling_rate: 0.25,

packages/config/src/__tests__/schema.test.ts

@@ -463,6 +463,34 @@ describe("InputWorkerSchema", () => {
 			}
 		});
 
+		it("accepts camelCase query string redaction configuration", ({
+			expect,
+		}) => {
+			const result = InputWorkerSchema.safeParse({
+				...baseConfig,
+				observability: {
+					enabled: true,
+					redactQueryString: true,
+				},
+			});
+
+			expect(result.success).toBe(true);
+		});
+
+		it("rejects snake_case query string redaction configuration", ({
+			expect,
+		}) => {
+			const result = InputWorkerSchema.safeParse({
+				...baseConfig,
+				observability: {
+					enabled: true,
+					redact_query_string: true,
+				},
+			});
+
+			expect(result.success).toBe(false);
+		});
+
 		it("rejects unknown keys inside a trigger", ({ expect }) => {
 			const result = InputWorkerSchema.safeParse({
 				...baseConfig,

packages/config/src/convert.ts

@@ -132,6 +132,9 @@ function convertObservability(
 	if (observability.headSamplingRate !== undefined) {
 		out.head_sampling_rate = observability.headSamplingRate;
 	}
+	if (observability.redactQueryString !== undefined) {
+		out.redact_query_string = observability.redactQueryString;
+	}
 	if (observability.logs !== undefined) {
 		const logs: NonNullable<NonNullable<RawConfig["observability"]>["logs"]> =
 			{};

packages/config/src/schema.ts

@@ -426,6 +426,7 @@ const LimitsSchema = z.strictObject({
 const ObservabilitySchema = z.strictObject({
 	enabled: z.boolean().optional(),
 	headSamplingRate: z.number().optional(),
+	redactQueryString: z.boolean().optional(),
 	logs: z
 		.strictObject({
 			enabled: z.boolean().optional(),

packages/config/src/types.ts

@@ -296,6 +296,12 @@ export interface WorkerConfig {
 		enabled?: boolean;
 		/** The sampling rate. */
 		headSamplingRate?: number;
+		/**
+		 * Whether query strings are removed from request URLs in logs and traces.
+		 *
+		 * @default false
+		 */
+		redactQueryString?: boolean;
 		logs?: {
 			enabled?: boolean;
 			/** The sampling rate. */

packages/deploy-helpers/src/deploy/helpers/config-diffs.ts

@@ -286,6 +286,7 @@ function normalizeObservability(
 	const fullObservabilityDefaults = {
 		enabled,
 		head_sampling_rate: 1,
+		redact_query_string: false,
 		logs: {
 			enabled,
 			head_sampling_rate: 1,

packages/workers-utils/src/config/environment.ts

@@ -1854,6 +1854,12 @@ export interface Observability {
 	enabled?: boolean;
 	/** The sampling rate */
 	head_sampling_rate?: number;
+	/**
+	 * Whether query strings are removed from request URLs in logs and traces.
+	 *
+	 * @default false
+	 */
+	redact_query_string?: boolean;
 	logs?: {
 		enabled?: boolean;
 		/** The sampling rate */

packages/workers-utils/src/config/validation.ts

@@ -6800,6 +6800,15 @@ const validateObservability: ValidatorFn = (diagnostics, field, value) => {
 			"number"
 		) && isValid;
 
+	isValid =
+		validateOptionalProperty(
+			diagnostics,
+			field,
+			"redact_query_string",
+			val.redact_query_string,
+			"boolean"
+		) && isValid;
+
 	isValid =
 		validateOptionalProperty(diagnostics, field, "logs", val.logs, "object") &&
 		isValid;
@@ -6817,6 +6826,7 @@ const validateObservability: ValidatorFn = (diagnostics, field, value) => {
 		validateAdditionalProperties(diagnostics, field, Object.keys(val), [
 			"enabled",
 			"head_sampling_rate",
+			"redact_query_string",
 			"logs",
 			"traces",
 		]) && isValid;

packages/workers-utils/tests/config/validation/normalize-and-validate-config.test.ts

@@ -11642,6 +11642,7 @@ describe("normalizeAndValidateConfig()", () => {
 						observability: {
 							notEnabled: "true",
 							head_sampling_rate: true,
+							redact_query_string: "true",
 						},
 					} as unknown as RawConfig,
 					undefined,
@@ -11659,7 +11660,8 @@ describe("normalizeAndValidateConfig()", () => {
 				expect(diagnostics.renderErrors()).toMatchInlineSnapshot(`
 					"Processing wrangler configuration:
 					  - "observability.enabled" or "observability.logs.enabled" or "observability.traces.enabled" is required.
-					  - Expected "observability.head_sampling_rate" to be of type number but got true."
+					  - Expected "observability.head_sampling_rate" to be of type number but got true.
+					  - Expected "observability.redact_query_string" to be of type boolean but got "true"."
 				`);
 			});
 
@@ -11685,6 +11687,7 @@ describe("normalizeAndValidateConfig()", () => {
 						observability: {
 							enabled: true,
 							head_sampling_rate: 1,
+							redact_query_string: true,
 							logs: {
 								enabled: true,
 								head_sampling_rate: 1,