MyFavMirrors
/
minio
mirror of https://github.com/minio/minio.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
minio/docs/metrics
History
Aditya Manthramurthy b2c5b75efa
feat: Add Metrics V3 API (#19068) 
Metrics v3 is mainly a reorganization of metrics into smaller groups of
metrics and the removal of internal aggregation of metrics received from
peer nodes in a MinIO cluster.

This change adds the endpoint `/minio/metrics/v3` as the top-level metrics
endpoint and under this, various sub-endpoints are implemented. These
are currently documented in `docs/metrics/v3.md`

The handler will serve metrics at any path
`/minio/metrics/v3/PATH`, as follows:

when PATH is a sub-endpoint listed above => serves the group of
metrics under that path; or when PATH is a (non-empty) parent 
directory of the sub-endpoints listed above => serves metrics
from each child sub-endpoint of PATH. otherwise, returns a no 
resource found error

All available metrics are listed in the `docs/metrics/v3.md`. More will
be added subsequently.
 		2024-03-10 01:15:15 -08:00
..
healthcheck remove deprecated Content-Security-Policy (#17580) 2023-07-06 09:18:38 -07:00
prometheus Update metrics list.md with new metrics from RELEASE.2024-01-05 (#19161) 2024-02-29 14:53:54 -08: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