`mc admin prometheus generate`

描述

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

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

Starting with MinIO ServerRELEASE.2024-07-15T19-02-30Z和 MinIO ClientRELEASE.2024-07-11T18-01-28Z, metrics version 3 (v3)提供额外的端点和指标。要生成 v3 版本的抓取配置，请使用--api_version v3选项。

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

使用mc admin仅限 MinIO 部署

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

EXAMPLE

以下命令生成一个 Prometheus 抓取配置，用于从部署中收集版本 2 存储桶指标别名 myminio:

mc admin prometheus generate myminio bucket

SYNTAX

该命令具有以下语法：

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

Brackets[]表示可选参数。
共享同一行的参数是相互依赖的。
使用竖线分隔的参数|操作符是互斥的。

将示例复制到文本编辑器中，根据需要修改，然后在终端/Shell中运行命令。

参数

ALIAS: 必需
Thealias已配置的 MinIO 部署，该命令会为其生成兼容 Prometheus 的配置文件。

--api-version

可选

生成一个抓取配置用于v3 指标include an--api-version v3parameter.v3是唯一接受的值。

省略--api-versionto generate av2 指标configuration.

--bucket

可选

仅对 v3 指标有效。

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

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

api
replication

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

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

TYPE

可选

要抓取的指标类型。

指标版本 3 的有效取值为：

api

audit

cluster

debug

ilm

logger

notification

replication

scanner

system

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

指标版本 2 的有效值为：

bucket

cluster

node

resource

如果未指定，v2命令返回集群指标。集群指标包括某些节点指标的汇总数据。

全局标志

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

示例

生成默认的 metrics v3 配置 ```yaml # 默认指标配置 metrics: version: 3 enabled: true # 指标收集设置 collection: interval: 30s timeout: 10s # 导出器配置 exporters: - type: prometheus

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

mc admin prometheus generate ALIAS --api-version v3

替换ALIAS随着aliasMinIO 部署的。

输出类似于以下内容：

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随着aliasMinIO 部署的。

输出类似于以下内容：

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 存储桶复制指标配置

以下示例生成存储桶 v3 复制指标的抓取配置mybucket:

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

替换ALIAS随着aliasMinIO 部署的。

输出类似于以下内容：

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 API 指标生成抓取配置mybucket:

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

替换ALIAS随着aliasMinIO 部署的。

输出类似于以下内容：

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

生成默认的 metrics v2 配置 ```yaml apiVersion: v1 kind: ConfigMap metadata: name: default-metrics-v2 namespace: kube-system data: config.yaml: | apiVersion: metrics-server/v1beta1 kind: Config metrics: - name:

默认情况下，mc admin prometheus generate生成 v2 集群指标的抓取配置：

mc admin prometheus generate ALIAS

替换ALIAS随着aliasMinIO 部署的。

输出类似于以下内容：

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