mcpField
D
distributed-logging

distributed-logging

github.com/proyecto26Cloud & DevOps113312 installsUpdated 1d ago
Repository

About distributed-logging

A design skill for planning distributed log pipelines, aimed at system designers handling logs from multiple processes. It guides decisions across collection, buffering, indexing, retention, and failure behavior.

Key features

  1. 01Log collection and transport choices
  2. 02Index and storage trade-offs
  3. 03Retention and tiering guidance
  4. 04Backpressure and overload handling
  5. 05Structured events and trace correlation

Use cases

  1. 01Centralizing logs from multiple services
  2. 02Correlating requests across services
  3. 03Planning retention for compliance
  4. 04Handling log spikes without blocking apps

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/proyecto26/system-design-skills --skill distributed-logging

After installing, type/distributed-loggingin Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with SKILL.md.

references/
deep-dive.md
references/providers/
aws.md
azure.md
gcp.md
generic.md

Details

From the project README

Distributed logging

Move logs from thousands of processes into one searchable place, fast enough to debug a live incident and cheap enough to keep for months. Getting it wrong is a classic "ignore failure" miss: the logging pipeline is itself a distributed system that buckles under the exact traffic spike you most need it during, and a naive design either drops the evidence or takes down the app it instruments.

When to reach for this

More than one process emits logs and someone needs to search them together; an incident requires correlating a request across services; log volume has outgrown grep on a box; or compliance demands retention. The pipeline buys central search, cross-service correlation, and a durable record decoupled from any single host.

When NOT to

A single service on one host where journald + log rotation is enough — a full pipeline is pure operational overhead (YAGNI). Numeric time-series questions ("what is p99 latency", "is error rate up") belong to metrics, not log scans — that is observability's job; logs answer "what exactly happened to this request". Don't ship every debug line at full volume before a number shows the volume justifies the cost; sample first.

Clarify first

  • Volume and peak — lines/sec and bytes/sec, average and peak (→ back-of-the-envelope). This sizes every stage.
  • Structured or free-text — can producers emit JSON now, or is there legacy text to parse?
  • Query latency need — interactive search in seconds (hot index) vs. occasional forensic/audit reads (cold archive)?
  • Retention + compliance — how long hot, how long cold, any legal hold or PII redaction requirement?
  • Loss tolerance — may logs be dropped/sampled under overload, or is every line evidence (audit/financial)?

The options

Collection (agent on the host)

  • Sidecar/node agent (Fluentd, Fluent Bit, Vector, Filebeat): tails files or reads stdout, adds metadata, ships out. Use when apps log to files/stdout and you want app code untouched — the default.
  • Direct-to-bus SDK: the app writes structured events straight to a transport. Use when you control the code and want exact structure, accepting tighter coupling.

Transport / buffer (the shock absorber)

  • Agent-side buffer + direct ship to indexer: simplest; agent disk-buffers and retries. Use at low-to-moderate volume with one consumer.
  • Durable log bus (messaging-streaming, e.g. Kafka): producers write to a partitioned bus; indexers consume at their own pace. Use at high volume or when multiple sinks (search, archive, analytics) read the same stream.

Index / store (the search backend)

  • Full-text index (Elasticsearch/OpenSearch — the "E" in ELK/EFK): rich queries, expensive RAM/disk. Use when interactive field search matters.
  • Label-indexed store (Loki): indexes only labels, stores log bodies compressed; much cheaper, grep-style queries. Use for high volume where you mostly filter by service/label then scan.

Retention / tiering

  • Hot index → cold object store (blob-store): keep days of searchable data hot, roll older data to compressed objects. Use whenever retention exceeds the hot window economically (almost always).

Trade-offs

OptionWhat it solvesWhat it worsensChange it when
Node agent (Fluent Bit/Vector)No app changes; central metadata + routingOne more daemon per host; parsing CPU; agent can lagYou need exact structure → emit structured events from the app
Direct-to-bus SDKClean structured events, no file parseCouples app to transport; app blocks/loses logs if bus is downCoupling/availability hurts → go back to agent + local buffer
Agent buffer → direct indexerFewest moving partsIndexer backpressure hits producers; no replay; one sinkVolume spikes or you need >1 sink → add a log bus
Durable log bus (Kafka)Absorbs spikes, decouples, replay, fan-outExtra system to run; ordering only per-partition; costVolume is low and single-sink → drop the bus
Full-text index (ES/OpenSearch)Fast rich field searchRAM/disk hungry; mapping explosions; costly at scaleCost dominates and queries are label-filtered → Loki
Label-indexed (Loki)Cheap storage at high volumeWeak full-text; slow on high-cardinality scansYou truly need arbitrary field search → full-text index
Hot index + cold archiveCheap long retentionCold reads are slow/manual to rehydrateForensic reads on old data must be fast → widen hot window

Behavior under stress

The pipeline's failure mode is that incidents generate log spikes — an outage emits floods of errors and stack traces exactly when the pipeline is busiest, so it must degrade without amplifying the outage.

  • Producer backpressure: if the indexer slows and agents ship synchronously, log calls can block the app. Mitigate: bounded local buffer with drop-newest / sample on overflow, never block the request path. A durable bus moves the backlog off the hosts (backpressure + DLQ semantics are owned by messaging-streaming).
  • Volume amplification: one bad deploy logging at debug can 100× volume and blow the index. Mitigate: per-service rate caps at the agent (rate limiting is owned by resilience-failure), dynamic sampling, alerts on ingest bytes/sec.
  • Index hot-shard / mapping explosion: high-cardinality fields (raw user IDs as index fields) or one fat shard wrecks the cluster. Mitigate: time-based indices, bounded field mappings, label discipline.
  • Ordering: the bus only orders within a partition; merged multi-host streams interleave. Mitigate: sort by event timestamp at query time; carry a monotonic sequence or trace span order, don't trust arrival order.
  • Losing the evidence: dropping logs silently hides the very failure under investigation. Mitigate: meter and alert on drop/sample rate so loss is visible.

Monitor: ingest bytes/sec and lines/sec, end-to-end ship lag, bus consumer lag, agent buffer fullness + drop rate, index queue/rejection rate, query latency.

How to apply

  1. Clarify the inputs — pin volume (avg + peak bytes/sec), structured-vs-text, query-latency need, retention, and loss tolerance (see Clarify first). If volume is tiny and single-host, stop — host-local logs suffice (YAGNI).
  2. Pick stages from the trade-off table — choose a collector, decide whether a durable bus is warranted (volume/spike/multi-sink), pick the index backend by the query need, and choose the hot window + cold tier.
  3. Set the key knobs — mandate a structured schema with a correlation/trace ID on every line, set agent buffer size + overflow policy, sampling rates, index rollover (time-based) and shard sizing, and the retention/tiering policy.
  4. Stress-test the choice — walk each item in Behavior under stress (producer backpressure, a debug-flood deploy, hot shard, ordering, silent drops) and confirm the pipeline degrades by sampling/buffering, never by blocking the app.
  5. Size it with numbers — multiply lines/sec × bytes/line × peak factor × retention to get hot index GB and cold archive GB/month; confirm the bus partition count and indexer fleet cover peak ingest (→ Numbers that matter).
  6. Pick a provider — default to the generic recipe; open a provider file only if the user named a cloud (see Choosing a provider).
  7. Show the trade-off in the answer — give a Decision | Solves | Worsens | Change it when… table with one row per choice you made here (e.g. the option, its store, its failure policy); the last column is a concrete trigger (a number or observable signal). Then name what breaks first.

Dos and don'ts

Do

  • Emit structured logs (JSON) with a correlation/trace ID stamped at the edge and propagated, so a request is one query.
  • Put a bounded buffer between producers and the indexer and drop/sample on overflow rather than block the app.
  • Use a durable log bus once volume spikes or more than one sink reads the stream.
  • Tier aggressively: short hot window for search, compressed cold archive for retention.
  • Meter ingest rate, ship lag, and drop rate, and alert on them — invisible loss is the trap.

Don't

  • Don't let a logging call block or crash the request path; logging is best-effort by default.
  • Don't index high-cardinality free-form fields — it explodes the cluster; keep labels bounded.
  • Don't trust arrival order for causality; sort by event time / sequence (→ sequencer).
  • Don't re-teach metrics/alerting here or set SLOs in logs — that's observability.
  • Don't keep everything hot forever to avoid cold reads; size the hot window to the debugging window.

Numbers that matter

Size the pipeline from volume: lines/sec × bytes/line gives ingest bytes/sec; a few KB/line at tens of thousands of lines/sec is already 100s of MB/s and TBs/day. Hot index storage ≈ daily bytes × hot-days × (1 + replica + overhead); cold archive ≈ daily bytes × retention-days, compressed ~5–10×. Apply a peak multiplier for incident floods. Don't restate latency/QPS/storage rules of thumb here — pull them from back-of-the-envelope.

Interface sketch

A log line is a contract: a structured event, not a string. Minimum fields:

{ "ts": "2026-05-29T12:00:00.123Z", "level": "ERROR", "service": "checkout",
  "host": "pod-7", "trace_id": "abc123", "span_id": "f9", "msg": "charge failed",
  "user_id": "u42", "err": "timeout", "latency_ms": 812 }

ts is the event time (sort key at query); trace_id/span_id correlate across services; level and service are bounded index labels; high-cardinality values (user_id) stay as searchable body fields, not index keys. The bus partition key is usually service or trace_id to keep a request's lines ordered together.

Choosing a provider

Default to the generic recipe above. If the user names a cloud, read references/providers/<provider>.md for the managed-service mapping, quotas/limits, and provider-specific trade-offs. If no file exists for that provider, the generic recipe is the answer.

Diagram

To visualize the pipeline (producers → agents → bus → indexer/search + archive sink) or the overflow/degradation path, use the in-plugin architecture-diagram skill — draw the durable bus as the buffer between producers and sinks, the cold-archive sink with a blob-store color, and the drop-on-overflow path as a dashed arrow.

Related building blocks

  • observability — owned-concept lives in the three-pillars view: metrics, traces, alerting, and SLO/SLIs are taught there; logs are one pillar, and what to alert on is its job, not this skill's.
  • messaging-streaming — depends on it for the durable log bus: delivery guarantees, ordering, backpressure, and DLQ semantics are owned there; this skill just uses the bus as transport.
  • blob-store — feeds into it for cold log archival: durability, tiering, and lifecycle of the compressed cold objects live there.
  • sequencer — pairs with this when ordering across hosts matters; monotonic IDs and clock-skew handling are owned there.
  • system-design — owned-concept lives in the orchestrator: the reasoning loop, the trade-off method, and the ten failure modes. Feeds into the wider design.

References

  • references/deep-dive.md — buffering and backpressure mechanics, sampling strategies, structured-logging + correlation-ID propagation, index lifecycle/rollover, ordering, and cold tiering. Read when designing the pipeline in detail.
  • references/providers/{generic,aws,azure,gcp}.md — service mappings, limits, and pitfalls per environment.

Comments

Markdown supported