OpenTelemetry W3C Baggage Header Boundary Sanitization and Ceiling Enforcement

--- description: OpenTelemetry W3C Baggage Header Boundary Sanitization and Ceiling Enforcement - Enforces strict payload size ceilings, allowlist-only propagation, and PII redaction on W3C Baggage headers across untrusted ingress boundaries and message brokers. Blindly forwarding raw baggage tokens introduces memory exhaustion vulnerabilities, header-injection attacks, and severe regulatory data leaks across distributed systems. globs: src/**/tracing/**/*.{ts,js}, src/**/middleware/**/*.{ts,js}, src/**/messaging/**/*.{ts,js}, src/**/telemetry/**/*.{ts,js}, src/**/transport/**/*.{ts,js} alwaysApply: true verified_by: "agentrules.org" license: "CC-BY-4.0" source: "https://agentrules.org/rules/otel-baggage-boundary-sanitization-invariant" --- # OpenTelemetry W3C Baggage Header Boundary Sanitization and Ceiling Enforcement > **Severity**: CRITICAL | **Category**: devops > **Anti-Pattern Warning**: Unvalidated Passthrough of W3C Baggage Context into Asynchronous Message Brokers ## System Constraints You are a Principal Observability and Infrastructure Security Architect enforcing strict W3C Baggage boundary controls. Never permit raw baggage context propagation across untrusted boundaries or into asynchronous message broker payloads without explicit schema validation, strict size ceilings (RFC 7230/W3C limits), key allowlisting, and automated PII pattern elimination. ## Strict Guidelines - Engineers MUST ALWAYS sanitize, prune, and strictly re-encode W3C baggage prior to injecting it into distributed queues (e.g., Kafka, RabbitMQ, SQS). - Engineers MUST NOT propagate raw HTTP headers or inbound `baggage` values into outbound message headers without allowlist filtration. - Services MUST enforce a strict byte ceiling on combined baggage metadata (default: 8192 bytes total, maximum 64 pairs, max 4096 bytes per key-value pair) to prevent transport layer exhaustion. - Components NEVER preserve sensitive user data (PII, tokens, credit card numbers, email addresses) inside BaggageContext; baggage is reserved solely for non-sensitive request tenancy, routing flags, and transaction metadata. - Code SHOULD utilize an explicit allowlist of authorized operational keys (e.g., `tenant.id`, `region.id`, `experiment.id`) and drop all unrecognized dynamically injected keys. ## Bad vs Good Implementations ### Ingress-to-Broker Baggage Passthrough vs. Allowlist Sanitized Reconstitution #### Bad Antipattern (AI Common Hallucination) > **Why it fails**: Directly propagating raw context preserves unvalidated, arbitrarily large, and potentially malicious baggage payloads. It leaks raw client headers directly into Kafka partitions, violating zero-trust boundaries and leaking potential PII. ```typescript import { propagation, context, defaultTextMapSetter, defaultTextMapGetter } from '@opentelemetry/api'; import { ProducerRecord } from 'kafkajs'; export async function produceMessage(rawHeaders: Record<string, string>, payload: unknown): Promise<ProducerRecord> { // VULNERABLE: Direct extraction and blind passthrough of untrusted baggage headers // Allows memory exhaustion, PII leakage into Kafka logs, and header injection const extractedContext = propagation.extract(context.active(), rawHeaders, defaultTextMapGetter); const outgoingHeaders: Record<string, string> = {}; propagation.inject(extractedContext, outgoingHeaders, defaultTextMapSetter); return { topic: 'orders.events', messages: [{ value: JSON.stringify(payload), headers: outgoingHeaders }] }; } ``` #### Production Standard (Correct) > **Standard**: Implements an explicit allowlist for baggage attributes, verifies value boundaries against PII patterns, strictly limits byte payload size to 4096 bytes, and reconstructs a pristine Baggage context rooted in ROOT_CONTEXT. ```typescript import { propagation, context, ROOT_CONTEXT, defaultTextMapGetter, BaggageEntry } from '@opentelemetry/api'; import { ProducerRecord } from 'kafkajs'; const ALLOWED_BAGGAGE_KEYS = new Set(['tenant.id', 'region.id', 'feature.tier']); const MAX_BAGGAGE_BYTES = 4096; const PII_REGEX = /[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}|\b\d{3}-\d{2}-\d{4}\b/; export async function produceMessage(rawHeaders: Record<string, string>, payload: unknown): Promise<ProducerRecord> { const activeContext = propagation.extract(ROOT_CONTEXT, rawHeaders, defaultTextMapGetter); const sourceBaggage = propagation.getBaggage(activeContext); let sanitizedBaggage = propagation.createBaggage(); let cumulativeSize = 0; if (sourceBaggage) { for (const [key, entry] of sourceBaggage.getAllEntries()) { const serializedPairLength = Buffer.byteLength(`${key}=${entry.value}`); if (ALLOWED_BAGGAGE_KEYS.has(key) && !PII_REGEX.test(entry.value)) { if (cumulativeSize + serializedPairLength <= MAX_BAGGAGE_BYTES) { sanitizedBaggage = sanitizedBaggage.setEntry(key, entry); cumulativeSize += serializedPairLength; } } } } const sanitizedContext = propagation.setBaggage(ROOT_CONTEXT, sanitizedBaggage); const outgoingHeaders: Record<string, string> = {}; propagation.inject(sanitizedContext, outgoingHeaders); return { topic: 'orders.events', messages: [{ value: JSON.stringify(payload), headers: outgoingHeaders }] }; } ```

Architectural Specification & Invariant Rationale

Architectural Invariant Design: OpenTelemetry W3C Baggage Header Boundary Sanitization and Ceiling Enforcement

OpenTelemetry W3C Baggage Header Boundary Sanitization and Ceiling Enforcement defines an industrial-grade behavioral standard for devops engineering. Enforces strict payload size ceilings, allowlist-only propagation, and PII redaction on W3C Baggage headers across untrusted ingress boundaries and message brokers. Blindly forwarding raw baggage tokens introduces memory exhaustion vulnerabilities, header-injection attacks, and severe regulatory data leaks across distributed systems. Modern software architectures require strict adherence to deterministic patterns to guarantee high availability, maintainability, and zero security vulnerabilities.

Framework Paradigm Shift & Drift MechanicsLLMs are trained on millions of open-source repositories containing outdated code, legacy idioms, and unpatched antipatterns. When coding assistants generate implementations for this stack, they default to common statistical tokens: Unvalidated Passthrough of W3C Baggage Context into Asynchronous Message Brokers Without an explicit system instruction file, developers spend hours debugging silent failures.

Failure Modes & Production Blast Radius

Hazard Analysis: What Breaks Without This Rule

The following failure modes have been cataloged from hundreds of hours of production code reviews where AI assistants produced non-compliant implementations:

Failure Mode	AI Symptom (The Anti-Pattern)	Severity	Production Impact & Remedy
AI Hallucination & Deprecation Drift	Unvalidated Passthrough of W3C Baggage Context into Asynchronous Message Brokers	Critical	Violating this industrial standard introduces regression bugs, security risks, and unexpected runtime failures in production. Enforce explicit behavioral system directives across all AI coding assistants in your repository.
Silent Architecture Inconsistency	AI assistants produce mixed paradigms across files, creating fragmented codebase conventions.	Medium	Increases cognitive load during code reviews and leads to maintenance debt across engineering teams. Pin project conventions in .cursor/rules, CLAUDE.md, and AGENTS.md so all team agents follow identical guardrails.

Architectural Directives in Detail

Step-by-Step Production Directives

Each rule constraint below is injected into the AI agent's system prompt to establish deterministic boundaries:

Engineers MUST ALWAYS sanitize, prune, and strictly re-encode W3C baggage prior to injecting it into distributed queues (e.g., Kafka, RabbitMQ, SQS).

Rationale:AI models frequently generate unconstrained code here because statistical language distributions lack project-specific architectural context. Mandating this directive ensures that generated code adheres to verified industrial production requirements.