agentleFS
PradnyeshpPradnyeshp/Claude-Skills/.claude/skills/healthcheck/SKILL.md

healthcheck

Skill2 starsChanged 4 months agoMITView on GitHub

Add health, readiness, and liveness check endpoints to a service — verifying dependencies (db, cache, queues) — matching the project's framework, for load balancers and orchestrators. Use when the user says "add a health check", "add a /health endpoint", "add readiness/liveness probes", "health endpoint for Kubernetes", or "how do I check if the service is up".

40 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use discord-e2e, openclaw-repair-sweep 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.
  • friuns2Skill

    discord-e2e

    Test Discord with Convex-leased QA bots: check credentials without a Gateway, exercise owned messages, or prove OpenClaw replies, files, threads, reactions, streaming, and typing. Distinguish API and Gateway evidence from manual user interactions.

    Also in 10 projects that use this

  • friuns2Skill

    openclaw-repair-sweep

    Run scoped OpenClaw issue/PR repair campaigns: coordinate workers, prove root causes, and land or close verified work under the requested authority.

    Also in 10 projects that use this

  • openclawSkill

    creative-project

    Design or revise branding, visual identities, logos, posters, illustrations, and social-media assets using project artwork or image references. Inspect the existing visual language, choose references, and iterate on named candidates.

    Also in 5 projects that use this

  • openclawSkill

    labs-graduation

    Move a feature out of Control UI Labs, either on by default or still off by default. Use when asked to promote, graduate or ship a Labs feature.

    Also in 5 projects that use this

  • hkyutongSkill

    node-connect

    Diagnose OpenClaw node connection and pairing failures for Android, iOS, and macOS companion apps. Use when QR/setup code/manual connect fails, local Wi-Fi works but VPS/tailnet does not, or errors mention pairing required, unauthorized, bootstrap token invalid or expired, gateway.bind, gateway.remote.url, Tailscale, or plugins.entries.device-pair.config.publicUrl.

    Also in 18 projects that use this

  • clawdbotSkill

    openclaw-performance

    Performance work in OpenClaw: a slow or heavy flow (latency, CPU, memory, SQL, RPC, renders), writing or reviewing a perf PR, or adding a cache. Count the work, delete waste first, cache last.

    Also in 8 projects that use this

  • +2 more from friuns2

The file

We split this skill into the rules it gives an agent

5 rules. 0 are common, 2 are distinctive, and 3 are very specific to this project.

  • 0

    Common

    Most of the 39 edited versions we read keep these.

  • 2

    Distinctive

    This author's own choices. Worth a look.

  • 3

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Add health check endpoint(s) to this service per $ARGUMENTS.

    line 17
  2. Very specific:

    Check real dependencies, cheaply: Use a lightweight probe per dependency (SELECT 1, a Redis PING, a fast head request) with a short timeout …

    line 25
  3. Distinctive:

    Every dependency probe needs a timeout.

    line 32
  4. Distinctive:

    Don't leak sensitive detail (secrets, internal topology, exact versions) in the response or expose an internal-only check publicly without …

    line 33
  5. Very specific:

    After adding, summarize the endpoints, what each checks, the status codes, and the probe configuration to use (e.g.

    line 35

“Common” is measured: kept by at least 6 in 10 of the 39 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

Service & dependency signals

!grep -rilE "express|fastify|koa|nestjs|flask|fastapi|django|gin|echo|actix|rails|spring" package.json pyproject.toml go.mod Gemfile 2>/dev/null | head

!grep -rilE "createConnection|DataSource|pg|mongoose|redis|prisma|sqlalchemy|database_url" --include='*.*' . 2>/dev/null | grep -vE 'node_modules|\.git|dist|build|test' | head -8

Instructions

Add health check endpoint(s) to this service per $ARGUMENTS. Match the project's framework and how it registers routes — don't introduce a new server or router.

Method

  1. Detect the framework and an existing route to copy registration style, middleware, and conventions (Express/Fastify/Nest, Flask/FastAPI/Django, Gin/Echo, Rails, Spring). Mirror it.
  2. Distinguish liveness from readiness — they answer different questions, so prefer two endpoints:
    • Liveness (/livez or /health) — is the process up? Cheap, no dependency calls; returns 200 unless the process is broken. Orchestrators restart on failure, so it must not fail just because a dependency is down.
    • Readiness (/readyz or /health/ready) — can it serve traffic right now? Checks critical dependencies (db, cache, queue, required downstreams) and returns 503 when any is unavailable so the load balancer stops routing to it.
  3. Check real dependencies, cheaply. Use a lightweight probe per dependency (SELECT 1, a Redis PING, a fast head request) with a short timeout so a hung dependency can't hang the check. Run them concurrently where the language makes it easy.
  4. Return a useful, safe body. A JSON payload with overall status and per-dependency up/down + latency aids debugging — but don't leak connection strings, credentials, internal hostnames, or versions to an unauthenticated endpoint. Set the right status code (200 healthy / 503 not ready) since probes key on it.
  5. Wire it up following the project's routing, and note any config (the path, whether it should bypass auth/rate-limiting, the orchestrator probe settings to point at it).

Rules

  1. Liveness must not depend on external services — tying it to the db means a db blip triggers pointless restarts. Keep dependency checks in readiness.
  2. Every dependency probe needs a timeout; a health check that can hang is worse than none.
  3. Don't leak sensitive detail (secrets, internal topology, exact versions) in the response or expose an internal-only check publicly without auth.
  4. Reuse the app's existing db/cache clients and config — don't open new connections per request or hardcode endpoints.
  5. After adding, summarize the endpoints, what each checks, the status codes, and the probe configuration to use (e.g. Kubernetes livenessProbe/readinessProbe).

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.