storj.io/minio@v0.0.0-20230509071714-0cbc90f649b1/docs/metrics/README.md (about)

     1  ## MinIO Monitoring Guide
     2  
     3  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.
     4  
     5  ### Healthcheck Probe
     6  
     7  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.
     8  
     9  - Liveness probe available at `/minio/health/live`
    10  - Cluster probe available at `/minio/health/cluster`
    11  
    12  Read more on how to use these endpoints in [MinIO healthcheck guide](https://github.com/minio/minio/blob/master/docs/metrics/healthcheck/README.md).
    13  
    14  ### Prometheus Probe
    15  
    16  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
    17  `<Address for MinIO Service>/minio/v2/metrics/cluster`.
    18  
    19  The additional node specific metrics which include additional go metrics or process metrics are exposed at
    20  `<Address for MinIO Node>/minio/v2/metrics/node`.
    21  
    22  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](https://github.com/minio/minio/blob/master/docs/metrics/prometheus/README.md).
    23  
    24  **Deprecated metrics monitoring**
    25  
    26  - Prometheus' data available at `/minio/prometheus/metrics` is deprecated
    27