AgentRules.org
RulesStacksClientsAuditorPrunerSelf-HealRFCsBenchmarkCLICI/CDAuthorsSubmit
This specification is maintained by the AgentRules Working Group. Have enhancements or want to claim maintainership?Submit Specification →
devopscritical PriorityID: opentelemetry-distributed-tracing

OpenTelemetry (OTel) Distributed Tracing & W3C Context Propagation Standard

Enterprise observability standard for distributed microservices. Mandates W3C traceparent context propagation across HTTP/gRPC boundaries, structured semantic attributes, and error recording with OpenTelemetry SDK.

Prohibited Anti-Pattern: AI creates isolated disconnected spans without propagating parent trace context across network requests.

Export Ready-to-Drop Configuration

Select format below to copy code or download file directly.

---
description: OpenTelemetry (OTel) Distributed Tracing & W3C Context Propagation Standard - Enterprise observability standard for distributed microservices. Mandates W3C traceparent context propagation across HTTP/gRPC boundaries, structured semantic attributes, and error recording with OpenTelemetry SDK.
globs: **/*tracer*.ts, **/*telemetry*.ts, **/*otel*.py
alwaysApply: true
verified_by: "agentrules.org"
license: "CC-BY-4.0"
source: "https://agentrules.org/rules/opentelemetry-distributed-tracing"
---

# OpenTelemetry (OTel) Distributed Tracing & W3C Context Propagation Standard

> **Severity**: CRITICAL | **Category**: devops
> **Anti-Pattern Warning**: AI creates isolated disconnected spans without propagating parent trace context across network requests.

## System Constraints
You are an observability and telemetry architect. When implementing OpenTelemetry tracing, NEVER create disconnected root spans in downstream microservices. Always inject and extract W3C 'traceparent' headers across network calls, record exceptions with span.recordException(), and follow OpenTelemetry semantic conventions.

## Strict Guidelines
- Propagate distributed trace context across all HTTP/gRPC client calls using W3C TraceContext headers ('traceparent').
- Never log errors without recording them on the active span using span.recordException(err) and span.setStatus({ code: SpanStatusCode.ERROR }).
- Use OpenTelemetry standard semantic attributes (e.g., http.request.method, http.response.status_code, db.system); avoid arbitrary ad-hoc key names.
- Configure non-blocking batch span processors (BatchSpanProcessor) with bounded queues to prevent telemetry from impacting application latency.

## Bad vs Good Implementations
### W3C Header Context Propagation vs Disconnected Orphan Spans

#### Bad Antipattern (AI Common Hallucination)
> **Why it fails**: Payment service receives the request with no traceparent header, creating a disconnected orphan trace that frustrates root-cause latency analysis.
```typescript
// ANTI-PATTERN: Downstream call starts isolated root span, breaking distributed trace graph!
import { trace } from "@opentelemetry/api";
import axios from "axios";

const tracer = trace.getTracer("order-service");

async function callPaymentGateway(orderId: string) {
  // Disconnected span: Parent context is LOST because no headers are injected!
  return tracer.startActiveSpan("call-payment", async (span) => {
    const res = await axios.post("https://payment.internal/charge", { orderId });
    span.end();
    return res.data;
  });
}
```

#### Production Standard (Correct)
> **Standard**: propagation.inject() automatically transmits the W3C traceparent header, preserving unified distributed trace graphs across services.
```typescript
// PRODUCTION STANDARD: W3C Context Injection via OpenTelemetry API
import { trace, propagation, context, SpanStatusCode } from "@opentelemetry/api";
import axios from "axios";

const tracer = trace.getTracer("order-service");

async function callPaymentGateway(orderId: string) {
  return tracer.startActiveSpan("payment.process_charge", async (span) => {
    try {
      span.setAttribute("app.order.id", orderId);
      span.setAttribute("peer.service", "payment-service");

      // Inject active trace context into HTTP carrier headers
      const headers: Record<string, string> = {};
      propagation.inject(context.active(), headers);

      const res = await axios.post("https://payment.internal/charge", { orderId }, { headers });

      span.setAttribute("http.response.status_code", res.status);
      span.setStatus({ code: SpanStatusCode.OK });
      return res.data;
    } catch (err: any) {
      span.recordException(err);
      span.setStatus({ code: SpanStatusCode.ERROR, message: err.message });
      throw err;
    } finally {
      span.end();
    }
  });
}
```

### BatchSpanProcessor Setup with OTLP Exporter

#### Bad Antipattern (AI Common Hallucination)
> **Why it fails**: SimpleSpanProcessor sends HTTP requests synchronously on every span.end(), degrading request throughput by 300%.
```typescript
// ANTI-PATTERN: SimpleSpanProcessor blocking main thread on every HTTP export
const provider = new NodeTracerProvider();
provider.addSpanProcessor(new SimpleSpanProcessor(new OTLPTraceExporter()));
```

#### Production Standard (Correct)
> **Standard**: Batches spans asynchronously in memory, offloading traces to the collector without adding latency to user requests.
```typescript
// PRODUCTION STANDARD: Non-blocking BatchSpanProcessor
import { BatchSpanProcessor } from "@opentelemetry/sdk-trace-base";
import { OTLPTraceExporter } from "@opentelemetry/exporter-trace-otlp-grpc";

provider.addSpanProcessor(
  new BatchSpanProcessor(new OTLPTraceExporter(), {
    maxQueueSize: 2048,
    scheduledDelayMillis: 1000,
  })
);
```
Recommended MCP Servers (mcp-serverlist.com)

Equip agent with system tools to verify code for this stack.

OpenTelemetry Collector Inspector
Validate OTLP trace payloads, traceparent headers, and collector routing.
Recommended Agent Skills (askills.dev)

Ready-to-use executable skill functions tailored to this stack.

OpenTelemetry Auto-Instrumentor
Scaffold OTel SDK initialization with W3C propagation and gRPC exporters.
Architectural Specification & Invariant Rationale

Architectural Invariant Design: OpenTelemetry (OTel) Distributed Tracing & W3C Context Propagation Standard

OpenTelemetry (OTel) Distributed Tracing & W3C Context Propagation Standard defines an industrial-grade behavioral standard for devops engineering. Enterprise observability standard for distributed microservices. Mandates W3C traceparent context propagation across HTTP/gRPC boundaries, structured semantic attributes, and error recording with OpenTelemetry SDK. 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: AI creates isolated disconnected spans without propagating parent trace context across network requests. 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 ModeAI Symptom (The Anti-Pattern)SeverityProduction Impact & Remedy
AI Hallucination & Deprecation DriftAI creates isolated disconnected spans without propagating parent trace context across network requests.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 InconsistencyAI 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:

1

Propagate distributed trace context across all HTTP/gRPC client calls using W3C TraceContext headers ('traceparent').

Propagate distributed trace context across all HTTP/gRPC client calls using W3C TraceContext headers ('traceparent').

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.
Enforcement:Integrated into the Agent Pack rule file. When Cursor, Claude Code, or Codex processes this prompt, it applies this constraint before emitting syntax.
2

Never log errors without recording them on the active span using span.recordException(err) and span.setStatus({ code

Never log errors without recording them on the active span using span.recordException(err) and span.setStatus({ code: SpanStatusCode.ERROR }).

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.
Enforcement:Integrated into the Agent Pack rule file. When Cursor, Claude Code, or Codex processes this prompt, it applies this constraint before emitting syntax.
3

Use OpenTelemetry standard semantic attributes (e.g., http.request.method, http.response.status_code, db.system)

Use OpenTelemetry standard semantic attributes (e.g., http.request.method, http.response.status_code, db.system); avoid arbitrary ad-hoc key names.

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.
Enforcement:Integrated into the Agent Pack rule file. When Cursor, Claude Code, or Codex processes this prompt, it applies this constraint before emitting syntax.
4

Configure non-blocking batch span processors (BatchSpanProcessor) with bounded queues to prevent telemetry from impacting application latency.

Configure non-blocking batch span processors (BatchSpanProcessor) with bounded queues to prevent telemetry from impacting application latency.

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.
Enforcement:Integrated into the Agent Pack rule file. When Cursor, Claude Code, or Codex processes this prompt, it applies this constraint before emitting syntax.
Technical Questions & Answers

Frequently Asked Technical Questions

Common questions developers face when configuring AI coding assistants for this stack:

Q:Why is OpenTelemetry (OTel) Distributed Tracing & W3C Context Propagation Standard critical for AI coding assistants?

Enterprise observability standard for distributed microservices. Mandates W3C traceparent context propagation across HTTP/gRPC boundaries, structured semantic attributes, and error recording with OpenTelemetry SDK. Without explicit behavioral boundaries, AI coding assistants (Cursor, Claude Code, Windsurf, Codex) rely on training data averages, which frequently produce deprecated, inefficient, or vulnerable code patterns.

Q:How does adopting this rule prevent AI hallucinations?

This rule explicitly declares what the AI must avoid (AI creates isolated disconnected spans without propagating parent trace context across network requests.) and prescribes verified positive examples. Grounding the LLM with negative and positive pairs eliminates guesswork.

Q:Which AI coding environments are supported?

This specification is multi-platform compatible: Cursor (.cursor/rules/*.mdc & .cursorrules), Anthropic Claude Code (CLAUDE.md), Windsurf (.windsurfrules), Codex / Cline (AGENTS.md), and GitHub Copilot (.github/copilot-instructions.md).

Q:Can I combine this rule with other technology stacks?

Yes. Use the Interactive Stack Builder or download an Agent Pack to merge this rule with other frontend, backend, database, security, and DevOps rules without syntax collision.

Open Specification · CC BY 4.0·Free for Personal, Team & Commercial In-Repo Use

Citation & Open Source Attribution Guidelines

This specification is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0). You are completely free to adapt and share this rule in your workspace. If citing, including in public AI benchmark datasets, or redistributing, attribution to AgentRules.org is required.

Related DEVOPS Rules

View all rules →
devops
86

Kubernetes Gateway API v1 HTTPRoute Canary and ReferenceGrant Invariants

Enforces strict conformance to Kubernetes Gateway API v1 specifications during migration from legacy Ingress controllers. Mandates explicit ReferenceGrant resources for cross-namespace routing, strict relative integer weighting for HTTPRoute canary releases, and explicit backendRef port declarations.

devops
118

ArgoCD ApplicationSet Matrix Generator Invariants & Cascade Deletion Guards

Enforces strict structural constraints on ArgoCD ApplicationSet Matrix generators combining cluster selectors and Git directories. Prevents catastrophic multi-cluster cascade pruning, accidental secret exposure through parameter interpolation, and runaway Application CR explosion via explicit sync policies, preservation finalizers, and parameter validation.

devops
40

Karpenter Resilient Topology, Interruption Queue, and Consolidation Budget Standard

Enforces deterministic disruption budgets, multi-instance-type diversification, and event-driven SQS interruption queue handling across Karpenter NodePools and EC2NodeClasses. Eliminates cascading eviction loops, instance starvation, and availability downtime during AWS Spot rebalances and underutilized node consolidation.

1 Rule in Stack

OpenTelemetry