@ -0,0 +1,208 @@

`mc admin prometheus metrics`

描述

命令 mc admin prometheus metrics 会打印集群的 Prometheus 指标.

输出包括每个度量的附加信息，例如其值是 counter 还是 gauge 。

有关将 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

以下命令会打印 :term: alias myminio 部署的群集度量值:

mc admin prometheus metrics myminio cluster

SYNTAX

命令语法如下:

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

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

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

参数

ALIAS: Required
配置的 MinIO 部署的 alias，命令会打印该部署的度量值.

--api-version

Optional

要打印 version 3 (v3) 指标，请包含一个 --api-version v3 参数。 v3 是唯一可接受的值。

省略 --api-version 以打印 version 2 (v2) 指标。

--bucket

Optional

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

- bucket 适用于以下 v3 度量类型:

api
replication

下面的示例会打印 mybucket 桶的 API 指标:

mc admin prometheus metrics 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 命令将返回群集度量值。群集度量包括某些节点度量的卷积.

Global Flags

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

Examples

打印 v3 指标

使用 mc admin prometheus metrics --api-version v3 打印 MinIO 部署的所有可用 v3 指标及其当前值:

mc admin prometheus metrics ALIAS --api-version v3

将 ALIAS 替换为 MinIO 部署的 alias 。

要打印特定类型的度量值，请包含 TYPE 。下面将打印部署的所有扫描仪指标:

mc admin prometheus metrics ALIAS scanner --api-version v3

打印 v3 应用程序接口或数据桶复制指标

某些 v3 指标类型接受 --bucket 参数，用于指定打印指标的数据桶。下面的示例将打印 mybucket 的 v3 复制指标:

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

用 MinIO 部署的 alias 替换 ALIAS 。

要打印水桶的 API 指标，请将 replication 替换为 api 。

打印 v2 集群指标

默认情况下， mc admin prometheus metrics 会打印 v2 群集度量值:

将 ALIAS 替换为 MinIO 部署的 alias 。

打印其他类型的 v2 指标

要打印其他类型的 v2 指标，请指定所需的 TYPE 。下面的示例将打印 v2 桶指标:

mc admin prometheus metrics ALIAS bucket

接受的值有: bucket 、 cluster 、 node 和 resource 。

商业支持购买咨询