文档

mc admin prometheus generate

描述

The mc admin prometheus generate 命令为与 Prometheus 一起使用生成一个指标抓取配置文件。

有关将 MinIO 与 Prometheus 一起使用的更完整文档,请参阅 如何使用 Prometheus 监控 MinIO 服务器

仅在 MinIO 部署上使用 mc admin

MinIO 不支持将 mc admin 命令与其他与 S3 兼容的服务一起使用,无论它们声称与 MinIO 部署的兼容性如何。

以下命令生成一个 Prometheus 抓取配置,它从 别名myminio 的部署中收集存储桶指标

mc admin prometheus generate myminio bucket

该命令具有以下语法

mc [GLOBALFLAGS] admin prometheus generate  \
                                  ALIAS     \
                                  [TYPE]
  • 方括号 [] 表示可选参数。

  • 在同一行中共享的参数是相互依赖的。

  • 使用管道 | 运算符分隔的参数是互斥的。

将示例复制到文本编辑器中,并在终端/shell中运行命令之前根据需要进行修改。

参数

ALIAS
必需

已配置的 MinIO 部署的 alias,该命令为其生成与 Prometheus 兼容的配置文件。

TYPE
可选

要抓取的指标类型。

在版本 RELEASE.2023-10-07T15-07-38Z 中更改: resource 指标已添加

有效值为

  • bucket

  • cluster

  • node

  • resource

如果未指定,则该命令将返回集群指标。集群指标还包括节点指标。

全局标志

此命令支持任何 全局标志

示例

生成用于存储桶指标的抓取配置

使用 mc admin prometheus generate 生成用于收集 MinIO 部署的存储桶指标的抓取配置

   mc admin prometheus generate ALIAS bucket
  • ALIAS 替换为 MinIO 部署的 alias

输出类似于以下内容

scrape_configs:
- job_name: minio-job-bucket
  bearer_token: [auth token]
  metrics_path: /minio/v2/metrics/bucket
  scheme: http
  static_configs:
  - targets: ['localhost:9000']