minio/docs
1
0
Fork 0
mirror of https://github.com/minio/docs.git synced 2025-09-02 00:02:14 +03:00
Code Activity
Files
b79934f11db023955819e2398aab28d5778374b9
docs/source/operations/monitoring/metrics-and-alerts.rst
Andrea Longo 343e54d402 Metrics v3 (#1289) 
Add metrics v3 to the Metrics and Alerts page and other relevant
locations, deprecate metrics v2.

- Updated the metrics extract script to parse the [list of v3 metrics
from
GitHub](https://github.com/minio/minio/blob/master/docs/metrics/v3.md).
- Remove references to MinIO Console metrics.
- Make `:mc-release:` show friendly release name text like
`:minio-release:` does.

Staged:

Linux

http://192.241.195.202:9000/staging/DOCS-1266/linux/operations/monitoring/metrics-and-alerts.html

k8s

http://192.241.195.202:9000/staging/DOCS-1266/k8s/operations/monitoring/metrics-and-alerts.html

fixes https://github.com/minio/docs/issues/1266
2024-08-02 17:58:59 -06:00

6.0 KiB
Raw Blame History

Metrics and Alerts

minio

Table of Contents

Metrics Version 2 Deprecated

Starting with MinIO Server RELEASE.2024-07-15T19-02-30Z and MinIO Client RELEASE.2024-07-11T18-01-28Z, metrics version 3 replaces the deprecated metrics version 2 <minio-metrics-v2>.

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.

For metrics version 3, all metrics are available under the base /minio/metrics/v3 endpoint by appending an additional path for each category.

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 Metrics <minio-metrics-and-alerts-available-metrics>.

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.

  • 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>

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