History

Shubhendu d96d696841 Dont use deprecated angular (#19396 ) Support for Angular would be stopped with newer versions of grafana Signed-off-by: Shubhendu Ram Tripathi <shubhendu@minio.io>		2024-04-03 19:01:53 -07:00
..
healthcheck	remove deprecated Content-Security-Policy (#17580 )	2023-07-06 09:18:38 -07:00
prometheus	Dont use deprecated angular (#19396 )	2024-04-03 19:01:53 -07:00
README.md	Re-organized grafana dashboards (#19157 )	2024-02-29 10:35:20 -08:00
v3.md	feat: Add Metrics V3 API (#19068 )	2024-03-10 01:15:15 -08:00

README.md

MinIO Monitoring Guide

MinIO server exposes monitoring data over endpoints. Monitoring tools can pick the data from these endpoints. This document lists the monitoring endpoints and relevant documentation.

Healthcheck Probe

MinIO server has two healthcheck related un-authenticated endpoints, a liveness probe to indicate if server is responding, cluster probe to check if server can be taken down for maintenance.

Liveness probe available at /minio/health/live
Cluster probe available at /minio/health/cluster

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

Prometheus Probe

MinIO allows reading metrics for the entire cluster from any single node. This allows for metrics collection for a MinIO instance across all servers. Thus, metrics collection for instances behind a load balancer can be done without any knowledge of the individual node addresses. The cluster wide metrics can be read at <Address for MinIO Service>/minio/v2/metrics/cluster.

The additional node specific metrics which include additional go metrics or process metrics are exposed at <Address for MinIO Node>/minio/v2/metrics/node.

The additional bucket specific metrics which include additional go metrics or process metrics are exposed at <Address for MinIO Node>/minio/v2/metrics/bucket.

The additional resource specific metrics which include additional go metrics or process metrics are exposed at <Address for MinIO Node>/minio/v2/metrics/resource.

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

Deprecated metrics monitoring

Prometheus' data available at /minio/prometheus/metrics is deprecated