DOKK / manpages / debian 11 / prometheus / promtool.1.en
promtool(1) 2.24.1+ds promtool(1)

build user: pkg-go-maintainers@lists.alioth.debian.org
build date: 20210804-20:00:23
go version: go1.15.9
platform: linux/amd64 ""

promtool - Tooling for the Prometheus monitoring system

Tooling for the Prometheus monitoring system.

Show context-sensitive help (also try --help-long and --help-man).
Show application version.

help [<command>...]

Show help.

check config <config-files>...

Check if the config files are valid or not.

check web-config <web-config-files>...

Check if the web config files are valid or not.

check rules <rule-files>...

Check if the rule files are valid or not.

check metrics

Pass Prometheus metrics over stdin to lint them for consistency and correctness.

examples:

$ cat metrics.prom | promtool check metrics

$ curl -s http://localhost:9090/metrics | promtool check metrics

query instant [<flags>] <server> <expr>

Run instant query.

Query evaluation time (RFC3339 or Unix timestamp).

query range [<flags>] <server> <expr>

Run range query.

Extra headers to send to server.
Query range start time (RFC3339 or Unix timestamp).
Query range end time (RFC3339 or Unix timestamp).
Query step size (duration).

query series --match=MATCH [<flags>] <server>

Run series query.

Series selector. Can be specified multiple times.
Start time (RFC3339 or Unix timestamp).
End time (RFC3339 or Unix timestamp).

query labels [<flags>] <server> <name>

Run labels query.

Start time (RFC3339 or Unix timestamp).
End time (RFC3339 or Unix timestamp).

debug pprof <server>

Fetch profiling debug information.

debug metrics <server>

Fetch metrics debug information.

debug all <server>

Fetch all debug information.

test rules <test-rule-file>...

Unit tests for rules.

tsdb bench write [<flags>] [<file*>]

Run a write performance benchmark.

Set the output path.
Number of metrics to read.

tsdb analyze [<flags>] [<db path*>] [<block id>]

Analyze churn, label pair cardinality.

How many items to show in each list.

tsdb list [<flags>] [<db path*>]

List tsdb blocks.

Print human readable values.

tsdb dump [<flags>] [<db path*>]

Dump samples from a TSDB.

Minimum timestamp to dump.
Maximum timestamp to dump.

tsdb create-blocks-from openmetrics <input file> [<output directory*>]

Import samples from OpenMetrics input and produce TSDB blocks. Please refer to the storage docs for more details.

promtool, version