agentleFS
caiaffacaiaffa/claude-code-ultimate-engineering-system/skills/observability/SKILL.md

observability

Skill17 starsChanged 58 days agoMITView on GitHub

Design high-value telemetry using OpenTelemetry for diagnostics, trace continuity, metrics quality, SLOs, and incident response.

87 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use gitops, background-jobs and 9 more.

Other files people use alongside this one.

Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
  • kcns008Skill

    gitops

    GitOps Agent (Flow) — manages ArgoCD applications, Helm charts, Kustomize overlays, deployment strategies (canary, blue-green, rolling), multi-cluster GitOps, and drift detection for Kubernetes and OpenShift clusters.

    Also in 4 projects that use this

  • YepAPISkill

    background-jobs

    Queue workers with BullMQ/Inngest/Trigger.dev, job retries, dead letter queues, concurrency.

    Also in 4 projects that use this

  • Mushfiqur-Rahman-RobinSkill

    rag-systems

    Best practices for building Retrieval-Augmented Generation systems — chunking, embedding, hybrid retrieval, reranking, indexing, caching, evaluation, observability — plus a catalog of RAG patterns and when each applies.

    Also in 3 projects that use this

  • YepAPISkill

    data-pipelines

    ETL patterns, cron scheduling, queue-based processing, and batch jobs with Inngest/BullMQ.

    Also in 4 projects that use this

  • wpankSkill

    caching

    Caching strategies, invalidation, eviction policies, HTTP caching, distributed caching, and anti-patterns. Use when designing cache layers, choosing eviction policies, debugging stale data, or optimizing read-heavy workloads.

    Also in 5 projects that use this

  • JohnJBorenSkill

    ci-cd

    CI/CD pipeline design, GitHub Actions, testing automation, and deployment strategies

    Also in 13 projects that use this

The file

Files
SKILL.md

Mission

Instrument systems so real production behavior becomes explainable, actionable, and operationally useful.

When to use

  • Designing instrumentation strategy.
  • Reviewing spans, metrics, and logs.
  • Improving incident diagnosability.
  • Defining SLIs, SLOs, and alerts.
  • Correlating APIs, jobs, DB calls, and external dependencies.

Handoff

  • Receives from: backend-platform-engineer (feature implementation) or reliability-engineer (production gap identified).
  • Hands off to: production-readiness (dashboards/alerts), release-commander (monitoring for rollout).

The 3 pillars — when to use each

PillarUse whenExample
TracesUnderstanding request flow across services"Why was this API call slow?" → trace shows DB query took 2s
MetricsMonitoring aggregate health over time"Is error rate increasing?" → counter shows 5xx rate at 2%
LogsUnderstanding specific events with context"What was the payload that caused this error?" → structured log with request ID

Span design rules

  • Name spans by operation, not by function name (order.create not handleRequest).
  • Add business-relevant attributes (order.id, customer.tier, payment.method).
  • Keep cardinality low — don't put user IDs as metric labels (use trace attributes instead).
  • Propagate context across async boundaries (queue producer → consumer must share trace ID).
  • Mark errors with proper status codes and error messages on the span.

SLI/SLO design

SLI: "Proportion of requests that complete in < 500ms with non-5xx status"
SLO: "99.5% of requests meet the SLI, measured over 30 days"
Error budget: "0.5% of requests can fail per 30 days ≈ 2160 bad requests at 300K/day"
Alert: "Burn rate > 3x (consuming error budget 3x faster than sustainable)"

Async trace continuity

For queue-based flows, context must survive:

Producer: inject trace context into job metadata
Consumer: extract trace context from job metadata, create child span
Result: trace shows: API call → enqueue → queue wait → process → DB write

Red flags

  • "We have monitoring" but can't trace a single request end-to-end.
  • Metrics with label cardinality > 1000 (cost explosion, aggregation useless).
  • Alerts on raw error counts instead of error rates (scales with traffic).
  • Logs without request/trace/correlation IDs.
  • Queue processing has no span linking to the original request.
  • Dashboard has 30 panels but doesn't answer "is the system healthy?"

Output format

  1. Telemetry strategy (what to trace, what to meter, what to log)
  2. Instrumentation plan (specific spans, metrics, log events)
  3. Missing correlations (async gaps, cross-service blind spots)
  4. SLI/SLO proposals (with concrete numbers)
  5. Alert recommendations (signal, threshold, runbook pointer)
  6. Cardinality assessment (high-risk labels identified)

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.