Monitor a MinIO Tenant¶

1) Generate a Bearer Token¶

The MinIO scrape endpoint requires authentication. Prometheus supports a bearer token approach to authenticate scrape requests. Use the mc admin prometheus generate command to generate the required bearer token. See https://min.io/download for instructions on downloading mc.

mc alias set <TENANT-NAME> <TENANT-URL> <ACCESS_KEY> <SECRET_KEY>

mc admin prometheus generate <TENANT-NAME>

• Replace <TENANT-NAME> with the name of the MinIO tenant.

• Replace <TENANT-URL> with the endpoint for the MinIO tenant.

• Replace <ACCESS_KEY> and <SECRET_KEY> with the root credentials for the MinIO tenant.

• Add --insecure if using self signed certificates.

The command returns a bearer token similar to the following:

scrape_config:
- job_name: minio-job
  bearer_token: TOKEN
  metrics_path: <PATH>
  scheme: http
  static_configs:
  - targets: ['HOSTNAME:9000']

The value of metrics_path depends on the version of mc is used to generate the bearer token:

• For mc version RELEASE.2021-01-16T02-45-34Z or earlier, metrics_path is /minio/prometheus/metrics. This includes the default MinIO version used by tenants (RELEASE.2020-10-18T21-54-12Z).

• For MinIO tenants using MinIO version RELEASE.RELEASE.2021-01-30T00-50-42Z or later, the metrics_path is /minio/v2/metrics/cluster.

2) Configure Prometheus for Scraping MinIO¶

Prometheus uses the scrape_config section of its configuration file to define endpoints for scraping metrics.

• For existing Prometheus deployments, modify the scrape_config section to include the new job_name element and restart Prometheus.

• For new Prometheus deployments, ensure the scrape_config section includes the MinIO job_name element before starting Prometheus.

The Prometheus service must have access to the MinIO tenant. For Prometheus servers deployed as part of the VCF Tanzu infrastructure, you need to modify the configuration map used to instantiate each Prometheus pods with the new scrape job.

3) Validate Metric Collection¶

Prometheus has a built-in expression browser for ad-hoc queries.

Alternatively, you can use any application which supports querying Prometheus, such as Grafana. MinIO publishes a first-party Grafana Dashboard designed to collect all monitoring stats for MinIO tenants.