Metrics and alerts

Version 3 Endpoints

For metrics version 3, all metrics are available under the base /minio/metrics/v3 endpoint. You can scrape the base endpoint to collect all metrics in a single operation, or append an optional path to return a specific category.

For example, the following endpoint returns audit metrics:

http://HOSTNAME:PORT/minio/metrics/v3/audit

Replace HOSTNAME:PORT with the FQDN and port of the MinIO deployment. For deployments with a load balancer managing connections between MinIO nodes, specify the address of the load balancer.

By default, MinIO requires authentication to scrape the metrics endpoints. To generate the needed bearer tokens, use mc admin prometheus generate. You can also disable metrics endpoint authentication by setting MINIO_PROMETHEUS_AUTH_TYPE to public.

MinIO provides the following scraping endpoints, relative to the base URL:

For a complete list of metrics for each endpoint, see Available version 3 metrics.

To enable historical data visualization in MinIO Console, set the following environment variables on each node in the MinIO deployment:

• Set MINIO_PROMETHEUS_URL to the URL of the Prometheus service

• Set MINIO_PROMETHEUS_JOB_ID to the unique job ID assigned to the collected metrics

Available version 3 metrics

MinIO publishes a number of metrics for clusters, API requests, buckets, and other aspects of the MinIO service:

• API Metrics

• Audit Metrics

• Cluster Metrics

• Debug Metrics

• ILM Metrics

• Logger webhook Metrics

• Notification Metrics

• Replication Metrics

• Scanner Metrics

• System Metrics

Many metrics include labels identifying the resource which generated that metric and other relevant details.