minio/docs/metrics/README.md

1.1 KiB

MinIO Monitoring Guide

MinIO server exposes monitoring data over un-authenticated endpoints so monitoring tools can pick the data without you having to share MinIO server credentials. This document lists the monitoring endpoints and relevant documentation.

Healthcheck Probe

MinIO server has two healthcheck related endpoints, a liveness probe to indicate if server is working fine and a readiness probe to indicate if server is not accepting connections due to heavy load.

  • Liveness probe available at /minio/health/live
  • Readiness probe available at /minio/health/ready

Read more on how to use these endpoints in MinIO healthcheck guide.

Prometheus Probe

MinIO server exposes Prometheus compatible data on a single endpoint.

  • Prometheus data available at /minio/prometheus/metrics

To use this endpoint, setup Prometheus to scrape data from this endpoint. Read more on how to use Prometheues to monitor MinIO server in How to monitor MinIO server with Prometheus.