`mc admin prometheus generate`

描述

mc admin prometheus generate 命令会生成一个用于 Prometheus 的指标抓取配置文件。

有关 MinIO 与 Prometheus 配合使用的完整文档，请参见 How to monitor MinIO server with Prometheus

从 MinIO Server RELEASE.2024-07-15T19-02-30Z 和 MinIO Client RELEASE.2024-07-11T18-01-28Z 开始，metrics version 3 (v3) 提供了额外的端点和指标。要生成 v3 抓取配置，请使用 --api_version v3 选项。

MinIO 建议新部署使用 version 3 (v3)。现有部署可以继续使用 metrics version 2

仅在 MinIO 部署上使用 mc admin

MinIO 不支持将 mc admin 命令用于其他 S3 兼容服务，无论这些服务声称与 MinIO 部署具有何种兼容性。

示例

以下命令会为 alias myminio 指向的部署生成一个 Prometheus 抓取配置，用于采集 version 2 的存储桶指标：

mc admin prometheus generate myminio bucket

语法

该命令语法如下：

mc [GLOBALFLAGS] admin prometheus generate                                        \
                                  ALIAS                                           \
                                  [TYPE]                                          \
                                  [--api_version v3]                              \
                                  [--bucket <bucket name>]

方括号 [] 表示可选参数。
同一行中的参数彼此相互依赖。
使用管道符 | 分隔的参数彼此互斥。

请先将示例复制到文本编辑器中并按需修改，再在终端 / shell 中运行命令。

参数

ALIAS: Required
已配置 MinIO 部署的 alias，该命令会为该部署生成与 Prometheus 兼容的配置文件。

--api-version

Optional

要为 v3 metrics 生成抓取配置，请添加 --api-version v3 参数。 v3 是唯一接受的值。

省略 --api-version 可生成 v2 metrics 配置。

--bucket

Optional

仅适用于 v3 指标。

对于返回存储桶级指标的 v3 指标类型，请指定存储桶名称。需要 --api-version。

--bucket 适用于以下 v3 指标类型：

api
replication

以下示例为存储桶 mybucket 的 API 指标生成配置：

mc admin prometheus generate ALIAS api --bucket mybucket --api-version v3

TYPE

Optional

要抓取的指标类型。

metrics version 3 的有效值为：

api

audit

cluster

debug

ilm

logger

notification

replication

scanner

system

如果未指定，v3 命令会返回所有指标。

metrics version 2 的有效值为：

bucket

cluster

node

resource

如果未指定，v2 命令返回 cluster 指标。 Cluster 指标包含部分 node 指标的汇总。

全局参数

此命令支持全局标志中的任意选项。

示例

生成默认的 v3 metrics 配置

使用 mc admin prometheus generate --api-version v3 生成一个抓取配置，用于为 MinIO 部署采集所有 v3 指标：

mc admin prometheus generate ALIAS --api-version v3

将 ALIAS 替换为 MinIO 部署的 alias。

输出类似如下：

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

为其他类型生成 v3 metrics 配置

要为其他指标类型生成配置，请指定类型。以下命令会为 v3 cluster 类型指标生成抓取配置：

mc admin prometheus generate ALIAS cluster --api-version v3

将 ALIAS 替换为 MinIO 部署的 alias。

输出类似如下：

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

要为 different metric type 生成配置，请将 cluster 替换为所需类型。

生成 v3 bucket replication metrics 配置

以下示例会为存储桶 mybucket 的 v3 replication 指标生成抓取配置：

mc admin prometheus generate ALIAS replication --bucket mybucket --api-version v3

将 ALIAS 替换为 MinIO 部署的 alias。

输出类似如下：

scrape_configs:
- job_name: minio-job-replication
  bearer_token: [auth token]
  metrics_path: /minio/metrics/v3/bucket/replication/mybucket
  scheme: https
  static_configs:
  - targets: [`localhost:9000`]

生成用于存储桶 API 指标的 v3 配置

以下示例会为存储桶 mybucket 的 v3 API 指标生成抓取配置：

mc admin prometheus generate ALIAS api --bucket mybucket --api-version v3

将 ALIAS 替换为 MinIO 部署的 alias。

输出类似如下：

scrape_configs:
- job_name: minio-job-api
  bearer_token: [auth token]
  metrics_path: /minio/metrics/v3/bucket/api/mybucket
  scheme: https
  static_configs:
  - targets: [`localhost:9000`]

生成默认的 v2 metrics 配置

默认情况下，mc admin prometheus generate 会生成用于 v2 cluster 指标的抓取配置：

mc admin prometheus generate ALIAS

将 ALIAS 替换为 MinIO 部署的 alias。

输出类似如下：

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

为其他指标类型生成 v2 配置

要为其他指标类型生成配置，请指定类型。以下命令会为 v2 bucket 类型指标生成抓取配置：

mc admin prometheus generate ALIAS bucket