1
0
mirror of https://github.com/minio/docs.git synced 2025-08-06 14:42:56 +03:00
Files
docs/source/operations/monitoring/metrics-v2.rst
Andrea Longo 3458e72e40 Undeprecate v2 metrics (#1375)
Metrics version 2 is not dead. Continue to feature v3, but restore the
v2 info as an alternate version.

Out of scope: 
Updating the Prometheus and InfluxDB procedures. For now, note they are
v2 and deal with it in a separate PR.

Staged

http://192.241.195.202:9000/staging/metrics-v2-not-deprecated/linux/operations/monitoring/metrics-and-alerts.html

http://192.241.195.202:9000/staging/metrics-v2-not-deprecated/linux/reference/minio-mc-admin/mc-admin-prometheus.html
2024-12-05 08:19:18 -07:00

3.9 KiB

Metrics version 2

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.

Version 3 Endpoints

Metrics version 2 provides metrics organized into three categories:

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

Each v2 endpoint returns all metrics for its category. For example, scraping the following endpoint returns all cluster metrics:

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

The base endpoint alone, /minio/v2/metrics/, returns cluster metrics.

For more flexible scraping and a wider range of metrics, use metrics version 3. <minio-metrics-and-alerts>

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

MinIO Grafana dashboard

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

Available version 2 metrics

The following sections describe the version 2 endpoints and metrics.

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

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

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

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.

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