Ping¶
Checking the Health of Your Traefik Instances
Configuration Examples¶
To enable the API handler:
ping: {}
[ping]
--ping=true
Configuration Options¶
The /ping
health-check URL is enabled with the command-line --ping
or config file option [ping]
.
The entryPoint
where the /ping
is active can be customized with the entryPoint
option,
whose default value is traefik
(port 8080
).
Path | Method | Description |
---|---|---|
/ping |
GET , HEAD |
An endpoint to check for Traefik process liveness. Return a code 200 with the content: OK |
Note
The cli
comes with a healthcheck
command which can be used for calling this endpoint.
entryPoint
¶
Optional, Default="traefik"
Enabling /ping on a dedicated EntryPoint.
entryPoints:
ping:
address: ":8082"
ping:
entryPoint: "ping"
[entryPoints]
[entryPoints.ping]
address = ":8082"
[ping]
entryPoint = "ping"
--entryPoints.ping.address=:8082
--ping.entryPoint=ping
manualRouting
¶
Optional, Default=false
If manualRouting
is true
, it disables the default internal router in order to allow one to create a custom router for the ping@internal
service.
ping:
manualRouting: true
[ping]
manualRouting = true
--ping.manualrouting=true
terminatingStatusCode
¶
Optional, Default=503
During the period in which Traefik is gracefully shutting down, the ping handler
returns a 503
status code by default.
If Traefik is behind, for example a load-balancer
doing health checks (such as the Kubernetes LivenessProbe), another code might
be expected as the signal for graceful termination.
In that case, the terminatingStatusCode can be used to set the code returned by the ping
handler during termination.
ping:
terminatingStatusCode: 204
[ping]
terminatingStatusCode = 204
--ping.terminatingStatusCode=204