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

Metrics and Alerts

minio

Table of Contents

MinIO publishes cluster and node 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.

MinIO provides scraping endpoints for the following metric groups:

Cluster Metrics

You can scrape cluster-level metrics <minio-available-cluster-metrics> using the following URL endpoint:

http://HOSTNAME:PORT/minio/v2/metrics/cluster

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.

Bucket Metrics

RELEASE.2023-08-31T15-31-16Z

You can scrape bucket-level metrics <minio-available-bucket-metrics> using the following URL endpoint:

http://HOSTNAME:PORT/minio/v2/metrics/bucket

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.

Resource Metrics

RELEASE.2023-10-07T15-07-38Z

You can scrape resource metrics <minio-available-resource-metrics> using the following URL endpoint:

http://HOSTNAME:PORT/minio/v2/metrics/resource

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.

MinIO by default requires authentication for scraping the metrics endpoints. Use the mc admin prometheus generate command to generate the necessary bearer tokens. You can alternatively disable metrics endpoint authentication by setting MINIO_PROMETHEUS_AUTH_TYPE to public.

MinIO Console Metrics Dashboard

The MinIO Console <minio-console-monitoring> provides a point-in-time metrics dashboard by default:

The Console also supports displaying time-series and historical data by querying a Prometheus <prometheus/latest/getting_started/> service configured to scrape data from the MinIO deployment. Specifically, the MinIO Console uses Prometheus query API <prometheus/latest/querying/api/> to retrieve stored metrics data and display the following visualizations:

• Usage - provides historical and on-demand visualization of overall usage and status
• Traffic - provides historical and on-demand visualization of network traffic
• Resources - provides historical and on-demand visualization of resources (compute and storage)
• Info - provides point-in-time status of the deployment

k8s

The MinIO Operator supports deploying a per-tenant Prometheus instance configured to support metrics and visualization.

If you deploy the Tenant with this feature disabled but still want the historical metric views, you can instead configure an external Prometheus service to scrape the Tenant metrics. Once configured, you can update the Tenant to query that Prometheus service to retrieve metric data:

linux or container or macos or windows

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

MinIO Grafana Dashboard

MinIO also publishes two Grafana Dashboards <minio-grafana> for visualizing collected metrics. For more complete documentation on configuring a Prometheus-compatible data source for Grafana, see the Prometheus documentation on Grafana Support <visualization/grafana/>.

Available Metrics

MinIO publishes a number of metrics at the cluster, node, or bucket levels. Each metric includes a label for the MinIO server which generated that metric.

MinIO RELEASE.2023-07-21T21-12-44Z

Bucket metrics have moved to use their own, separate endpoint.

• Cluster Metrics <minio-available-cluster-metrics>
• Bucket Metrics <minio-available-bucket-metrics>
• Resource Metrics <minio-available-resource-metrics>

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