mirror of https://github.com/coredns/coredns.git synced 2025-10-27 00:04:15 -04:00

Files

Miek Gieben 004c5fca9d all: simply registering plugins (#3287 )

Abstract the caddy call and make it simpler.

See #3261 for some part of the discussion.

Go from:

~~~ go
func init() {
       caddy.RegisterPlugin("any", caddy.Plugin{
               ServerType: "dns",
               Action:     setup,
       })
}
~~~

To:

~~~ go
func init() { plugin.Register("any", setup) }
~~~

This requires some external documents in coredns.io to be updated as
well; the old way still works, so it's backwards compatible.

Signed-off-by: Miek Gieben <miek@miek.nl>

2019-09-20 08:02:30 +01:00

health_test.go

return standardized text for ready and health endpoint (#3195 )

2019-08-26 10:31:24 +00:00

health.go

return standardized text for ready and health endpoint (#3195 )

2019-08-26 10:31:24 +00:00

log_test.go

Clean up tests logging (#1979 )

2018-07-19 16:23:06 +01:00

overloaded.go

remove an unused variable (#3278 )

2019-09-16 07:28:42 +01:00

OWNERS

Add OWNERS file (#1486 )

2018-02-08 10:55:51 +00:00

README.md

typo fixes (#3169 )

2019-08-21 16:08:55 -04:00

setup_test.go

Update Caddy to 1.0.1, and update import path (#2961 )

2019-07-03 09:04:47 +08:00

setup.go

all: simply registering plugins (#3287 )

2019-09-20 08:02:30 +01:00

README.md

health

Name

health - enables a health check endpoint.

Description

Enabled process wide health endpoint. When CoreDNS is up and running this returns a 200 OK HTTP status code. The health is exported, by default, on port 8080/health .

Syntax

health [ADDRESS]

Optionally takes an address; the default is :8080. The health path is fixed to /health. 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
}

Where lameduck will make the process unhealthy then wait for DURATION before the process shuts down.

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 directive) then the following metric is exported:

coredns_health_request_duration_seconds{} - duration to process a HTTP query to the local /health endpoint. As this 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.

Note that this metric does 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.

. {
    health localhost:8091
}

Set a lameduck duration of 1 second:

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