agentleFS
TJM-NZTJM-NZ/claude-skills/observability/SKILL.md

observability

Skill0 starsChanged 9 days agoMITView on GitHub

Observability audit - can the team detect, triage and diagnose production problems? Checks logging, error tracking, metrics and SLO alerting, and tracing and correlation. Stack-agnostic and OpenTelemetry-aware. Each finding states what you would fail to see.

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 10 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

We split this skill into the rules it gives an agent

1 rule. 0 are common, 1 is distinctive, and 0 are very specific to this project.

  • 0

    Common

    Most of the 70 edited versions we read keep these.

  • 1

    Distinctive

    This author's own choices. Worth a look.

  • 0

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Every finding states which question it fails and what would go unseen.

    line 14

“Common” is measured: kept by at least 6 in 10 of the 70 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Reliability engineer. Find where the system cannot tell you what is happening in production. Judge the setup against three questions, in this order:

  1. Detect: would we know within minutes that users are affected?
  2. Triage: can we tell how bad, for whom, and which component?
  3. Diagnose: can we find the cause from telemetry alone, without reproducing it?

Every finding states which question it fails and what would go unseen. Code shows what is instrumented, not what is collected, retained or alerted on; say so when a conclusion depends on infrastructure you cannot see.

Scope: logging, error tracking, metrics and alerting, tracing and correlation. Not in scope: retry, timeout and health-probe behaviour (resilience) | secrets and PII exposure beyond logging (security-audit) | performance tuning (perf-check).

Workflow

  1. Context. Load references/method.md. Establish what runs where (service, worker, cron, serverless, browser), what "broken" would look like to users, and who gets paged. Ask only what the repo can't answer.
  2. Detect stack. Glob manifests (package.json, pyproject.toml, requirements.txt, go.mod, Cargo.toml, Gemfile, pom.xml, excluding vendored dirs) plus infra files (Dockerfile, compose, Kubernetes, CI, otel*.yaml, prometheus*.yml, alert rules). Note logger, error tracker, metrics/APM, tracing, and whether OpenTelemetry is present. Read only the matching sections of references/frameworks.md.
  3. Map the signals. For each entry point (HTTP route, job, consumer, cron) and each outbound dependency (database, queue, third-party API), note which signals exist: log, error capture, metric, trace span. The gaps in that table drive the findings.
  4. Scope. Offer: Full (all modules) | Quick (logging, errors, and the alerting half of metrics) | Targeted (user picks). Skip if already specified.
  5. Analyse. Load the chosen modules. Grep hits are leads: read the code and confirm the gap is on a path that matters.
  6. Report in the format below.
ModuleCovers
method.mdDetect/triage/diagnose model, signal map, evidence rules
logging.mdStructured events, levels, context, redaction, volume, retention
errors.mdError capture, context, grouping, release tracking, frontend and worker coverage
metrics-alerting.mdRED/USE signals, cardinality, SLOs, burn-rate alerts, runbooks, business metrics
tracing.mdSpans, context propagation, log-trace correlation, sampling
frameworks.mdOptional vendor and stack notes (OpenTelemetry, Sentry, Prometheus, pino, structlog, slog)

Confidence

LevelMeaning
ConfirmedThe absence or defect is visible in code or config (no capture on a worker, PII field in a log call)
LikelyCode is silent but the platform may supply it (auto-instrumentation, agent, log shipper); name the check
UnknownDepends on collector, retention or alert rules outside the repo; list under "Needs verification"

Severity

By what goes unseen, not by effort:

  • Critical: a failure that affects users would go undetected (no error capture on a core path, no alert on user-facing failures, health or error signal that cannot fail), or secrets/PII are being logged.
  • High: detection works but triage or diagnosis fails (no request or trace ID, no user/tenant context, errors swallowed, alerts on causes not symptoms, no latency distribution).
  • Medium: noise or inefficiency that erodes trust (grouping fragmentation, wrong levels, unbounded metric labels, no runbook).
  • Low: list in one line.

Report format

# Observability Audit: [project]

Stack: logger=[X] errors=[X] metrics=[X] tracing=[X] | Scope: [...]
Findings: Critical X | High Y | Medium Z | Low W   (Confirmed a | Likely b | Unknown c)

## Signal map
| Entry point / dependency | Log | Error capture | Metric | Trace | Alert |

## [SEVERITY] Title   (detect | triage | diagnose) · [confidence]
- Location: `file:line` (+ N other places) or "not present"
- What goes unseen: the concrete incident this would hide or slow down
- Evidence: code, or the absence of it
- Fix: concrete change
- Verify: how to prove it works (trigger a test error, check the dashboard, query by trace ID)

## Needs verification (outside the repo)

Group repeated patterns ("9 catch blocks log and swallow") rather than listing each. Skip test files, vendored code and third-party internals.

After the report

Offer: fix Critical and High findings | add a minimal baseline (structured logger, error capture, request-ID middleware, RED metrics) | draft SLOs and alert rules | re-audit. Make no changes until the user picks.

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.