Prometheus 监测系统的工具。
选项 | Description |
-h, --help | 显示上下文相关的帮助（也可尝试 --help-long 和 --help-man）。 |
--version | 显示应用程序版本。 |
--experimental | 启用实验命令。 |
--enable-feature | 逗号分隔的要启用的功能名称（仅与 PromQL 相关和 no-default-scrape-port）。请参阅 https://prometheus.io/docs/prometheus/latest/feature_flags/ 了解选项和更多详情。 |
命令 | 描述 |
help | 显示帮助信息。 |
check | 检查资源的有效性。 |
query | 针对 Prometheus 服务器运行查询。 |
debug | 获取调试信息。 |
push | 向 Prometheus 服务器推送。 |
test | 单元测试。 |
tsdb | 运行 tsdb 命令。 |
promql | PromQL 格式化和编辑。需要使用 --experimental 标志。 |
显示帮助信息。
参数 | 描述 |
command | 根据 command 显示帮助 |
检查资源的有效性。
选项 | 描述 |
--extended | 打印与指标基数相关的扩展信息。 |
为给定的任务名称执行服务发现并报告结果，包括重新标记。
选项 | 描述 | 默认值 |
--timeout | 等待发现结果的时间。 | 30s |
参数 | 描述 | 必填 |
config-file | prometheus 配置文件。 | 是 |
job | 为其运行服务发现的任务。 | 是 |
检查配置文件是否有效。
选项 | 描述 | 默认值 |
--syntax-only | 只检查配置文件语法，忽略配置中引用的文件和内容验证 | |
--lint | 对配置中指定的规则进行的过筛检查。可用选项包括：all, duplicate-rules, none。使用 --lint=none 可禁用着色检查 | duplicate-rules |
--lint-fatal | 使 lint 错误以退出代码 3 退出。 | false |
--agent | 检查代理模式下 Prometheus 的配置文件。 |
参数 | 描述 | 必填 |
config-files | 要检查的配置文件。 | 是 |
检查 Web 配置文件是否有效。
参数 | 描述 | 必填 |
web-config-files | 要检查的配置文件。 | 是 |
检查 Prometheus 服务器是否健康。
选项 | 描述 | 默认值 |
--http.config.file | 用于 promtool 连接到 Prometheus 的 HTTP 客户端配置文件。 | |
--url | Prometheus 服务器的 URL。 | http://localhost:9090 |
检查 Prometheus 服务器是否准备就绪。
选项 | 描述 | 默认值 |
--http.config.file | 用于 promtool 连接到 Prometheus 的 HTTP 客户端配置文件。 | |
--url | Prometheus 服务器的 URL。 | http://localhost:9090 |
检查规则文件是否有效。
选项 | 描述 | 默认值 |
--lint | 要应用的过筛检查。可用选项包括：all, duplicate-rules, none。使用 --lint=none 可禁用 lint 检查。 | duplicate-rules |
--lint-fatal | 使 lint 错误以退出代码 3 退出。 | false |
参数 | 描述 |
rule-files | 要检查的规则文件，默认从标准输入读取。 |
通过 stdin 传递 Prometheus 指标，以检查其一致性和正确性。
示例：
$ cat metrics.prom | promtool check metrics
$ curl -s http://localhost:9090/metrics | promtool check metrics
对 Prometheus 服务器运行查询。
选项 | 描述 | 默认值 |
-o, --format | 查询的输出格式。 | promql |
--http.config.file | 用于 promtool 连接到 Prometheus 的 HTTP 客户端配置文件。 |
运行即时查询。
选项 | 描述 |
--time | 查询评估时间（RFC3339 或 Unix 时间戳）。 |
参数 | 描述 | 必填 |
server | 要查询的 Prometheus 服务器。 | 是 |
expr | PromQL 查询表达式。 | 是 |
运行范围查询。
选项 | 描述 |
--header | 向服务器发送的额外标头。 |
--start | 查询范围开始时间（RFC3339 或 Unix 时间戳）。 |
--end | 查询范围结束时间（RFC3339 或 Unix 时间戳）。 |
--step | 查询步长（持续时间）。 |
参数 | 描述 | 必填 |
server | 要查询的 Prometheus 服务器。 | 是 |
expr | PromQL 查询表达式。 | 是 |
运行系列查询。
选项 | 描述 |
--match | 系列选择器。可多次指定。 |
--start | 开始时间（RFC3339 或 Unix 时间戳）。 |
--end | 结束时间（RFC3339 或 Unix 时间戳）。 |
参数 | 描述 | 必填 |
server | 要查询的 Prometheus 服务器。 | 是 |
运行标签查询。
选项 | 描述 |
--start | 开始时间（RFC3339 或 Unix 时间戳）。 |
--end | 结束时间（RFC3339 或 Unix 时间戳）。 |
--match | 系列选择器。可多次指定。 |
参数 | 描述 | 必填 |
server | 要查询的 Prometheus 服务器。 | 是 |
name | 提供标签值的标签名称。 | 是 |
针对 Prometheus 运行查询，分析某些指标的使用模式。
选项 | 描述 | 默认值 |
--server | 要查询的 Prometheus 服务器。 | |
--type | 指标类型：直方图。 | |
--duration | 分析的时间范围。 | 1h |
--time | 查询时间（RFC3339 或 Unix 时间戳），默认为现在。 | |
--match | 系列选择器。可多次指定。 |
获取调试信息。
获取调试信息。
参数 | 描述 | 必填 |
server | 从 Prometheus 服务器获取 pprof 文件。 | 是 |
获取指标调试信息。
参数 | 描述 | 必填 |
server | 从 Prometheus 服务器获取指标。 | 是 |
获取所有调试信息。
参数 | 描述 | 必填 |
server | Prometheus 服务器获取所有调试信息。 | 是 |
推送到 Prometheus 服务器。
选项 | 描述 |
--http.config.file | 用于 promtool 连接到 Prometheus 的 HTTP 客户端配置文件。 |
将指标推送到 prometheus 远程写入（仅用于测试目的）。
选项 | 描述 | 默认值 |
--label | 附加到度量指标的标签。可多次指定。 | job=promtool |
--timeout | 等待推动指标的时间。 | 30s |
--header | Prometheus 远程写入头。 |
参数 | 描述 | 必填 |
remote-write-url | Prometheus 远程写入 url 以推送指标。 | 是 |
metric-files | 要推送的度量文件，默认从标准输入读取。 |
单元测试。
规则的单元测试。
选项 | 描述 | 默认值 |
--run | 如果设置，将只运行名称符合正则表达式的测试组。可多次指定。 | |
--diff | [实验] 打印预期输出与接收输出之间的彩色差分输出。 | false |
参数 | 描述 | 必填 |
test-rule-file | 单元测试文件。 | 是 |
运行 tsdb 命令。
运行基准测试。
运行写入性能基准。
选项 | 描述 | 默认值 |
--out | 设置输出路径。 | benchout |
--metrics | 要读取的指标数量。 | 10000 |
--scrapes | 要模拟的抓取数量。 | 3000 |
参数 | 描述 | 默认值 |
file | 包含样本数据的输入文件，默认为 (../../tsdb/testdata/20kseries.json). | ../../tsdb/testdata/20kseries.json |
分析流失、标签对基数和压缩效率。
选项 | 描述 | 默认值 |
--limit | 在每个列表中显示多少项目。 | 20 |
--extended | 运行扩展分析。 | |
--match | 系列选择器进行分析。现在只支持 1 组匹配器。 |
参数 | 描述 | 默认值 |
db path | 数据库路径（默认为 data/）。 | data/ |
block id | 要分析的区块（默认为最后一个区块）。 |
列出 tsdb 块。
选项 | 描述 |
-r, --human-readable | 打印人可读数值。 |
参数 | 描述 | 默认值 |
db path | 数据库路径（默认为 data/）。 | data/ |
从 TSDB 转存样本。
选项 | 描述 | 默认值 |
--min-time | 转储的最小时间戳。 | -9223372036854775808 |
--max-time | 转储的最大时间戳。 | 9223372036854775807 |
--match | 系列选择器。可多次指定。 | {__name__=~'(?s:.*)'} |
参数 | 描述 | 默认值 |
db path | 数据库路径（默认为 data/）。 | data/ |
[实验性] 将时序数据库中的样本转储为 OpenMetrics 格式。原生直方图不会被转储。
选项 | 描述 | 默认值 |
--min-time | 转储的最小时间戳。 | -9223372036854775808 |
--max-time | 转储的最大时间戳。 | 9223372036854775807 |
--match | 系列选择器。可多次指定。 | {__name__=~'(?s:.*)'} |
参数 | 描述 | 默认值 |
db path | 数据库路径（默认为 data/）。 | data/ |
[实验性] 从输入导入样本并生成时序数据库块。请参考存储文档以获取更多详细信息。
选项 | 描述 |
-r, --human-readable | 打印人类可读的值。 |
-q, --quiet | 不要打印已创建的块。 |
从 OpenMetrics 输入导入样本并生成 TSDB 块。请参考存储文档以获取更多详细信息。
参数 | 描述 | 默认值 | 必填 |
input file | 读取样本的 OpenMetrics 文件。 | 是 | |
output directory | 生成块的输出目录。 | data/ |
为新的记录规则创建数据块。
选项 | 描述 | 默认值 |
--http.config.file | 用于 promtool 连接到 Prometheus 的 HTTP 客户端配置文件。 | |
--url | Prometheus API 的 URL，其中包含将回填规则的数据。 | http://localhost:9090 |
--start | 开始回填新规则的时间。必须是 RFC3339 格式的日期或 Unix 时间戳。必须填写。 | |
--end | 如果提供了结束时间，所提供规则文件中的所有记录规则都将回填到结束时间。默认回填至 3 小时前。必须是 RFC3339 格式的日期或 Unix 时间戳。 | |
--output-dir | 生成块的输出目录。 | data/ |
--eval-interval | 在回填时，如果记录规则文件中没有设置值，评估规则的频率是多少。 | 60s |
参数 | 描述 | 必填 |
rule-files | 一个包含要回填的记录规则的一个或多个文件的列表。文件中列出的所有记录规则都将被回填。警报规则不会被评估。 | 是 |
PromQL 格式化和编辑。需要使用 --experimental 标志。
将 PromQL 查询格式化为漂亮的打印格式。
参数 | 描述 | 必填 |
query | PromQL 查询。 | 是 |
编辑现有 PromQL 查询中的标签匹配器。
设置查询中的标签匹配器。
选项 | 描述 | 默认值 |
-t, --type | 要设置的标签匹配器类型。 | = |
参数 | 描述 | 必填 |
query | PromQL 查询。 | 是 |
name | 要设置的标签匹配器名称。 | 是 |
value | 要设置的标签匹配器的值。 | 是 |
从查询中删除标签。
参数 | 描述 | 必填 |
query | PromQL 查询。 | 是 |
name | 要删除的标签名称。 | 是 |
