docs/source/operations/monitoring/metrics-and-alerts.rst

Metrics and alerts

minio

Table of Contents

MinIO publishes metrics using the Prometheus Data Model <concepts/data_model/>. You can use any scraping tool to pull metrics data from MinIO for further analysis and alerting.

Starting with MinIO Server RELEASE.2024-07-15T19-02-30Z and MinIO Client RELEASE.2024-07-11T18-01-28Z, metrics version 3 provides additional endpoints. MinIO recommends version 3 for new deployments.

Metrics version 2

Existing deployments can continue to use version 2 metrics <minio-metrics-v2> and Grafana dashboards <minio-grafana>.

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.

Important

The V3 metrics on this page may have gaps, inaccuracies, or incorrect information. Reference the minio/minio repository and review the source code for the most accurate representation of metrics as available.

For example, the following endpoint returns audit metrics:

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

Replace HOSTNAME:PORT with the FQDN (Fully Qualified Domain Name) 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:

Category	Path
API	/api/requests /bucket/api
Audit	/audit
Cluster	/cluster/config /cluster/erasure-set /cluster/health /cluster/iam /cluster/usage/buckets /cluster/usage/objects
Debug	/debug/go
ILM	/ilm
Logger webhook	/logger/webhook
Notification	/notification
Replication	/replication /bucket/replication
Scanner	/scanner
System	/system/drive /system/memory /system/cpu /system/network/internode /system/process

For a complete list of metrics for each endpoint, see Available version 3 metrics <minio-metrics-and-alerts-available-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 <minio-available-v3-api-metrics>
• Audit Metrics <minio-available-v3-audit-metrics>
• Cluster Metrics <minio-available-v3-cluster-metrics>
• Debug Metrics <minio-available-v3-debug-metrics>
• ILM Metrics <minio-available-v3-ilm-metrics>
• Logger webhook Metrics <minio-available-v3-logger-webhook-metrics>
• Notification Metrics <minio-available-v3-notification-metrics>
• Replication Metrics <minio-available-v3-replication-metrics>
• Scanner Metrics <minio-available-v3-scanner-metrics>
• System Metrics <minio-available-v3-system-metrics>

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

/operations/monitoring/collect-minio-metrics-using-prometheus /operations/monitoring/monitor-and-alert-using-influxdb /operations/monitoring/metrics-v2