minio/docs/metrics/healthcheck
Nitish Tiwari 9cab0f25e0 Add top level metrics document to summarize monitoring endpoints (#5923)
Minio server supports healthcheck and prometheus related
unauthenticated endpoints. This document summarizes this
information in a single place and add links for more detailed
documentation if needed.
2018-05-15 12:23:21 -07:00
..
README.md Add top level metrics document to summarize monitoring endpoints (#5923) 2018-05-15 12:23:21 -07:00

Minio Healthcheck

Minio server exposes two un-authenticated, healthcheck endpoints - liveness probe and readiness probe at /minio/health/live and /minio/health/ready respectively.

Liveness probe

This probe is used to identify situations where the server is running but may not behave optimally, i.e. sluggish response or corrupt back-end. Such problems can be only fixed by a restart.

Internally, Minio liveness probe handler does a ListBuckets call. If successful, the server returns 200 OK, otherwise 503 Service Unavailable.

When liveness probe fails, Kubernetes like platforms restart the container.

Readiness probe

This probe is used to identify situations where the server is not ready to accept requests yet. In most cases, such conditions recover in some time.

Internally, Minio readiness probe handler checks for total go-routines. If the number of go-routines is less than 1000 (threshold), the server returns 200 OK, otherwise 503 Service Unavailable.

Platforms like Kubernetes do not forward traffic to a pod until its readiness probe is successful.

Configuration example

Sample liveness and readiness probe configuration in a Kubernetes yaml file can be found here.