COREDNS-HEALTH(7)

πŸ“¦
version 1.15.0 Β· 2 versions
, in nixpkgs unstable, opensuse-leap 16.0

πŸ’– NAME πŸ’–

okay so this is COREDNS-HEALTH(7) from the CoreDNS Plugins collection, and the plugin is health β€” it enables a health check endpoint. that’s the whole vibe, bestie πŸ’…

🌸 DESCRIPTION 🌸

This plugin enables a process-wide health endpoint. When CoreDNS is up and running, it returns a 200 OK HTTP status code. By default, health is exported on 8080/health.

✨ SYNTAX ✨

health [ADDRESS]

It optionally takes an ADDRESS; the default is :8080. The health path is fixed to /health β€” no custom paths, periodt. The health endpoint returns a 200 response code and the word "OK" when this server is healthy.

An extra option can be set with this extended syntax:

health [ADDRESS] {
    lameduck DURATION
}
  • lameduck DURATION β€” this will delay shutdown for DURATION. /health will still answer 200 OK.
⚠️ Note: The ready plugin will not answer OK while CoreDNS is in lame duck mode prior to shutdown.

If you have multiple Server Blocks, health can only be enabled in one of them (as it is process wide). If you really need multiple endpoints, you must run health endpoints on different ports:

com {
    whoami
    health :8080
}

net {
    erratic
    health :8081
}

Doing this is supported but both endpoints ":8080" and ":8081" will export the exact same health.

πŸ”₯ METRICS πŸ”₯

If monitoring is enabled (via the prometheus plugin) then the following metrics are exported:

  • coredns_health_request_duration_seconds{} β€” the health plugin performs a self health check once per second on the /health endpoint. This metric is the duration to process that request. As this is a local operation it should be fast. A (large) increase in this duration indicates the CoreDNS process is having trouble keeping up with its query load.
  • coredns_health_request_failures_total{} β€” the number of times the self health check failed.
πŸ’‘ Note that these metrics do not have a server label, because being overloaded is a symptom of the running process, not a specific server.

πŸŽ€ EXAMPLES πŸŽ€

Run another health endpoint on http://localhost:8091 (the original also shows ⟨http://localhost:8091⟩ β€” same URL, iykyk).

. {
    health localhost:8091
}

Set a lame duck duration of 1 second:

. {
    health localhost:8092 {
        lameduck 1s
    }
}

Source/version: CoreDNS β€” date: March 2026 β€” manual: COREDNS-HEALTH(7). stay healthy, bestie πŸ’…βœ¨πŸ«Ά

πŸ“¦ where this page comes from