minio/docs/metrics
Nitish Tiwari 6ff12f5f01
Add the dashboard json file (#11028)
This will allow users to contribute to the dashboard as needed.
2020-12-04 16:27:41 -08:00
..
healthcheck remove deprecate readiness from healthcheck docs (#10659) 2020-10-12 18:56:03 -07:00
prometheus Add the dashboard json file (#11028) 2020-12-04 16:27:41 -08:00
README.md fix: rename READY deadline to CLUSTER deadline ENV (#10535) 2020-09-23 09:14:33 -07: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 server exposes Prometheus compatible data on a single endpoint. By default, the endpoint is authenticated.

  • Prometheus data available at /minio/prometheus/metrics

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.