Open-Source Wikis

/

MinIO

/

API

/

Health and metrics

minio/minio

Health and metrics

Health

Path Meaning
/minio/health/live Process is up (HTTP listener responsive).
/minio/health/ready All server pools have write quorum and accept writes.
/minio/health/cluster Stricter readiness for distributed setups (read + write quorum across all sets).
/minio/health/cluster/read Cluster has read quorum.

Implementations are in cmd/healthcheck-handler.go; the router is cmd/healthcheck-router.go. These endpoints are unauthenticated by default; you can lock them behind SigV4 with the MINIO_BROWSER_REDIRECT and related env vars (see internal/config/browser/).

Metrics

Two coexisting Prometheus endpoints:

Path Format Source
/minio/metrics/v2 Prometheus text exposition; one giant collector. cmd/metrics-v2.go
/minio/metrics/v3/... Prometheus text exposition; grouped collectors. cmd/metrics-v3*.go

The v3 sub-paths (one per concern) are listed in Metrics, audit, and tracing.

Auth

By default both endpoints are open. Set MINIO_PROMETHEUS_AUTH_TYPE=jwt to require a Prometheus JWT (signed by the cluster); set it to public to keep them open.

Bucket-level metrics

Per-bucket families live under v2 with the bucket label and under cmd/metrics-v3-bucket-replication.go for replication-specific data.

Realtime

mc admin metrics subscribes to a streaming subset implemented in cmd/metrics-realtime.go. Useful for dashboards that want sub-second granularity without scraping the full Prometheus endpoint.

See also

Built by Factory AutoWiki from public repository content. It is a generated preview for codebase exploration, not source-maintained documentation.

Health and metrics – MinIO wiki | Factory