Scroll to navigation

promtool(1) 2.33.5+ds1 promtool(1)

build user: team+pkg-go@tracker.debian.org
build date: 20220820-12:29:59
go version: go1.18.5
platform: linux/amd64 ""

NAME

promtool - Tooling for the Prometheus monitoring system

SYNOPSIS

DESCRIPTION

Tooling for the Prometheus monitoring system.

OPTIONS

Show context-sensitive help (also try --help-long and --help-man).
Show application version.
Comma separated feature names to enable (only PromQL related). See https://prometheus.io/docs/prometheus/latest/feature_flags/ for the options and more details.

COMMANDS

help [<command>...]

Show help.

check service-discovery [<flags>] <config-file> <job>

Perform service discovery for the given job name and report the results, including relabeling.

The time to wait for discovery results.

check config [<flags>] <config-files>...

Check if the config files are valid or not.

Only check the config file syntax, ignoring file and content validation referenced in the config
Check config file for Prometheus in Agent mode.

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.
Number of scrapes to simulate.

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

Analyze churn, label pair cardinality and compaction efficiency.

How many items to show in each list.
Run extended analysis.

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.

tsdb create-blocks-from rules --start=START [<flags>] <rule-files>...

Create blocks of data for new recording rules.

http://localhost:9090
The URL for the Prometheus API with the data where the rule will be backfilled from.
The time to start backfilling the new rule from. Must be a RFC3339 formatted date or Unix timestamp. Required.
If an end time is provided, all recording rules in the rule files provided will be backfilled to the end time. Default will backfill up to 3 hours ago. Must be a RFC3339 formatted date or Unix timestamp.
Output directory for generated blocks.
How frequently to evaluate rules when backfilling if a value is not set in the recording rule files.
promtool, version