Documentation

mc admin prometheus

Description

The mc admin prometheus command generates a configuration file for use with Prometheus.

For more complete documentation on using MinIO with Prometheus, see How to monitor MinIO server with Prometheus

Use mc admin on MinIO Deployments Only

MinIO does not support using mc admin commands with other S3-compatible services, regardless of their claimed compatibility with MinIO deployments.

Syntax

mc admin prometheus generate

Generates a JWT bearer token for use with configuring Prometheus metrics collection. The command has the following syntax:

mc admin prometheus generate TARGET TYPE

The command accepts the following arguments:

TARGET

The alias of a configured MinIO deployment for which the command generates a Prometheus-compatible configuration file.

TYPE

The type of metrics to scrape.

Changed in version RELEASE.2023-10-07T15-07-38Z: resource metrics added

Valid values are:

  • bucket

  • cluster

  • node

  • resource

If not specified, the command returns cluster metrics. Cluster metrics also include node metrics.