.TH promtool 1 promtool, version 2.24.1+ds (branch: debian/sid, revision: 2.24.1+ds-1+b7)
  build user:       pkg-go-maintainers@lists.alioth.debian.org
  build date:       20210804-20:00:23
  go version:       go1.15.9
  platform:         linux/amd64 ""
.SH "NAME"
promtool - Tooling for the Prometheus monitoring system
.SH "SYNOPSIS"
.TP
\fBpromtool [<flags>] <command> [<args> ...]\fR

.SH "DESCRIPTION"
Tooling for the Prometheus monitoring system.
.SH "OPTIONS"
.TP
\fB-h, --help\fR
Show context-sensitive help (also try --help-long and --help-man).
.TP
\fB--version\fR
Show application version.
.SH "COMMANDS"
.SS
\fBhelp [<command>...]\fR
.PP
Show help.
.SS
\fBcheck config <config-files>...\fR
.PP
Check if the config files are valid or not.
.SS
\fBcheck web-config <web-config-files>...\fR
.PP
Check if the web config files are valid or not.
.SS
\fBcheck rules <rule-files>...\fR
.PP
Check if the rule files are valid or not.
.SS
\fBcheck metrics\fR
.PP
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
.SS
\fBquery instant [<flags>] <server> <expr>\fR
.PP
Run instant query.
.TP
\fB--time=TIME\fR
Query evaluation time (RFC3339 or Unix timestamp).
.SS
\fBquery range [<flags>] <server> <expr>\fR
.PP
Run range query.
.TP
\fB--header=HEADER\fR
Extra headers to send to server.
.TP
\fB--start=START\fR
Query range start time (RFC3339 or Unix timestamp).
.TP
\fB--end=END\fR
Query range end time (RFC3339 or Unix timestamp).
.TP
\fB--step=STEP\fR
Query step size (duration).
.SS
\fBquery series --match=MATCH [<flags>] <server>\fR
.PP
Run series query.
.TP
\fB--match=MATCH\fR
Series selector. Can be specified multiple times.
.TP
\fB--start=START\fR
Start time (RFC3339 or Unix timestamp).
.TP
\fB--end=END\fR
End time (RFC3339 or Unix timestamp).
.SS
\fBquery labels [<flags>] <server> <name>\fR
.PP
Run labels query.
.TP
\fB--start=START\fR
Start time (RFC3339 or Unix timestamp).
.TP
\fB--end=END\fR
End time (RFC3339 or Unix timestamp).
.SS
\fBdebug pprof <server>\fR
.PP
Fetch profiling debug information.
.SS
\fBdebug metrics <server>\fR
.PP
Fetch metrics debug information.
.SS
\fBdebug all <server>\fR
.PP
Fetch all debug information.
.SS
\fBtest rules <test-rule-file>...\fR
.PP
Unit tests for rules.
.SS
\fBtsdb bench write [<flags>] [<file*>]\fR
.PP
Run a write performance benchmark.
.TP
\fB--out="benchout"\fR
Set the output path.
.TP
\fB--metrics=10000\fR
Number of metrics to read.
.SS
\fBtsdb analyze [<flags>] [<db path*>] [<block id>]\fR
.PP
Analyze churn, label pair cardinality.
.TP
\fB--limit=20\fR
How many items to show in each list.
.SS
\fBtsdb list [<flags>] [<db path*>]\fR
.PP
List tsdb blocks.
.TP
\fB-r, --human-readable\fR
Print human readable values.
.SS
\fBtsdb dump [<flags>] [<db path*>]\fR
.PP
Dump samples from a TSDB.
.TP
\fB--min-time=-9223372036854775808\fR
Minimum timestamp to dump.
.TP
\fB--max-time=9223372036854775807\fR
Maximum timestamp to dump.
.SS
\fBtsdb create-blocks-from openmetrics <input file> [<output directory*>]\fR
.PP
Import samples from OpenMetrics input and produce TSDB blocks. Please refer to the storage docs for more details.