minio/docs
1
0
Fork 0
mirror of https://github.com/minio/docs.git synced 2025-08-05 03:41:24 +03:00
Code Activity
Files
remove-recommended-v2-metrics
docs/source/operations/monitoring/metrics-v3.rst
Andrea Longo a5bfd27b80 partial edits
2024-09-27 14:50:06 -06:00

5.4 KiB
Raw Permalink Blame History

Metrics version 3

minio

Table of Contents

For metrics version 3, all metrics are available under the base /minio/metrics/v3 endpoint, optionally 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 v3 types and scraping endpoints, relative to the base URL:

Category Metric type Path

API

api

/api/requests

/bucket/api
Audit audit /audit

Cluster

cluster

/cluster/config

/cluster/erasure-set

/cluster/health

/cluster/iam

/cluster/usage/buckets

/cluster/usage/objects
Debug debug /debug/go
ILM ilm /ilm
Logger webhook logger /logger/webhook
Notification notification /notification

Replication

replication

/replication

/bucket/replication
Scanner scanner /scanner

System

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

You can also access metrics using mc admin prometheus metrics and the metric type for the desired category. For more information, see the MinIO Admin Client reference <mc admin prometheus 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

Available v3 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