@ -0,0 +1,118 @@

`mc admin prometheus generate`

描述

mc admin prometheus generate 命令会生成一个指标搜索配置文件，供 Prometheus 使用.

有关将 MinIO 与 Prometheus 结合使用的更完整文档, 参考 How to monitor MinIO server with Prometheus

从 MinIO 服务器 RELEASE.2024-07-15T19-02-30Z 和 MinIO 客户端 https://github.com/minio/mc/releases/tag/RELEASE.2024-07-11T18-01-28Z 开始，metrics version 3 (v3) 提供了额外的端点和指标。要生成 v3 刮擦配置，请使用 --api_version v3 选项。

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

Use mc admin on MinIO Deployments Only

MinIO 不支持与其他声称与 MinIO 部署兼容的 S3 兼容服务一起使用 mc admin 命令。

EXAMPLE

以下命令会生成一个 Prometheus scrape 配置，从 :term: alias myminio 的部署中收集版本 2 的桶指标 :

mc admin prometheus 生成 myminio bucket

SYNTAX

命令语法如下:

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

方括号 [] 表示可选参数。
参数在同一行表示它们是相互依赖的。
使用管道 | 运算符分隔的参数是相互排斥的。

在终端/壳中运行命令之前，将示例复制到文本编辑器中并按需进行修改。

参数

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

--api-version

Optional

要为 v3 metrics 生成刮擦配置，请包含一个 --apiversion v3 参数。 v3 是唯一可接受的值。

省略 --apiversion 可生成 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

要搜索的指标类型.

指标版本 3 的有效值是:

api

audit

cluster

debug

ilm

logger

notification

replication

scanner

system

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

指标版本 2 的有效值是:

bucket

cluster

node

resource

如果未指定， v2 命令将返回群集度量值。集群指标包括某些节点指标的滚动。

全局标志

此命令支持任何全局标志。

Examples

生成默认度量标准 v3 配置

使用 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 指标配置

要为另一种度量类型生成配置，请指定该类型。下面将生成 v3 群集度量的配置:

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']

要为 :mc-cmd:` 不同度量类型 <mc admin prometheus generate TYPE>` 生成配置，请将 cluster 替换为所需类型。

生成 v3 水桶复制度量配置

下面的示例为 mybucket 的 v3 复制指标生成了一个 scrape 配置 :

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

用 MinIO 部署的 alias 替换 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 配置

默认情况下，mc admin prometheus generate 会生成 v2 群集度量的配置:

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 桶度量的配置:

mc admin prometheus generate ALIAS bucket

商业支持购买咨询