promtool - Man Page

Show help.

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

--timeout=30s

The time to wait for discovery results.

Check if the config files are valid or not.

--syntax-only

Only check the config file syntax, ignoring file and content validation referenced in the config

--lint="duplicate-rules"

Linting checks to apply to the rules/scrape configs specified in the config. Available options are: all, duplicate-rules, none, too-long-scrape-interval. Use --lint=none to disable linting

--lint-fatal

Make lint errors exit with exit code 3.

--ignore-unknown-fields

Ignore unknown fields in the rule groups read by the config files. This is useful when you want to extend rule files with custom metadata. Ensure that those fields are removed before loading them into the Prometheus server as it performs strict checks by default.

--agent

Check config file for Prometheus in Agent mode.

Check if the web config files are valid or not.

Check if the Prometheus server is healthy.

--http.config.file=<filename>

HTTP client configuration file, see details at https://prometheus.io/docs/prometheus/latest/configuration/promtool

--url=http://localhost:9090

The URL for the Prometheus server.

Check if the Prometheus server is ready.

--http.config.file=<filename>

HTTP client configuration file, see details at https://prometheus.io/docs/prometheus/latest/configuration/promtool

--url=http://localhost:9090

The URL for the Prometheus server.

Check if the rule files are valid or not.

--lint="duplicate-rules"

Linting checks to apply. Available options are: all, duplicate-rules, none. Use --lint=none to disable linting

--lint-fatal

Make lint errors exit with exit code 3.

--ignore-unknown-fields

Ignore unknown fields in the rule files. This is useful when you want to extend rule files with custom metadata. Ensure that those fields are removed before loading them into the Prometheus server as it performs strict checks by default.

Pass Prometheus metrics over stdin to lint them for consistency and correctness, and optionally perform cardinality analysis.

examples:

$ cat metrics.prom | promtool check metrics

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

$ curl -s http://localhost:9100/metrics | promtool check metrics --extended --lint=none

--extended

Print extended information related to the cardinality of the metrics.

--lint="all"

Linting checks to apply for metrics. Available options are: all, none. Use --lint=none to disable metrics linting.

Run instant query.

--time=TIME

Query evaluation time (RFC3339 or Unix timestamp).

Run range query.

--header=HEADER

Extra headers to send to server.

--start=START

Query range start time (RFC3339 or Unix timestamp).

--end=END

Query range end time (RFC3339 or Unix timestamp).

--step=STEP

Query step size (duration).

Run series query.

--match=MATCH

Series selector. Can be specified multiple times.

--start=START

Start time (RFC3339 or Unix timestamp).

--end=END

End time (RFC3339 or Unix timestamp).

Run labels query.

--start=START

Start time (RFC3339 or Unix timestamp).

--end=END

End time (RFC3339 or Unix timestamp).

--match=MATCH

Series selector. Can be specified multiple times.

Run queries against your Prometheus to analyze the usage pattern of certain metrics.

--server=SERVER

Prometheus server to query.

--type=TYPE

Type of metric: histogram.

--duration=1h

Time frame to analyze.

--time=TIME

Query time (RFC3339 or Unix timestamp), defaults to now.

--match=MATCH

Series selector. Can be specified multiple times.

Fetch profiling debug information.

Fetch metrics debug information.

Fetch all debug information.

Push metrics to a prometheus remote write (for testing purpose only).

--label=job=promtool

Label to attach to metrics. Can be specified multiple times.

--timeout=30s

The time to wait for pushing metrics.

--header=HEADER

Prometheus remote write header.

--protobuf_message="prometheus.WriteRequest"

Protobuf message to use when writing (prometheus.WriteRequest or io.prometheus.write.v2.Request).

Unit tests for rules.

--run=RUN

If set, will only run test groups whose names match the regular expression. Can be specified multiple times.

--debug

Enable unit test debugging.

--diff

[Experimental] Print colored differential output between expected & received output.

--ignore-unknown-fields

Ignore unknown fields in the test files. This is useful when you want to extend rule files with custom metadata. Ensure that those fields are removed before loading them into the Prometheus server as it performs strict checks by default.

Run a write performance benchmark.

--out="benchout"

Set the output path.

--metrics=10000

Number of metrics to read.

--scrapes=3000

Number of scrapes to simulate.

Analyze churn, label pair cardinality and compaction efficiency.

--limit=20

How many items to show in each list.

--extended

Run extended analysis.

--match=MATCH

Series selector to analyze. Only 1 set of matchers is supported now.

List tsdb blocks.

-r,  --human-readable

Print human readable values.

Dump data (series+samples or optionally just series) from a TSDB.

--sandbox-dir-root=SANDBOX-DIR-ROOT

Root directory where a sandbox directory will be created, this sandbox is used in case WAL replay generates chunks (default is the database path). The sandbox is cleaned up at the end.

--min-time=-9223372036854775808

Minimum timestamp to dump, in milliseconds since the Unix epoch.

--max-time=9223372036854775807

Maximum timestamp to dump, in milliseconds since the Unix epoch.

--match={__name__=~'(?s:.*)'}

Series selector. Can be specified multiple times.

--format=prom

Output format of the dump (prom (default) or seriesjson).

[Experimental] Dump samples from a TSDB into OpenMetrics text format, excluding native histograms and staleness markers, which are not representable in OpenMetrics.

--sandbox-dir-root=SANDBOX-DIR-ROOT

Root directory where a sandbox directory will be created, this sandbox is used in case WAL replay generates chunks (default is the database path). The sandbox is cleaned up at the end.

--min-time=-9223372036854775808

Minimum timestamp to dump, in milliseconds since the Unix epoch.

--max-time=9223372036854775807

Maximum timestamp to dump, in milliseconds since the Unix epoch.

--match={__name__=~'(?s:.*)'}

Series selector. Can be specified multiple times.

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

--label=LABEL

Label to attach to metrics. Can be specified multiple times. Example --label=label_name=label_value

Create blocks of data for new recording rules.

--http.config.file=<filename>

HTTP client configuration file, see details at https://prometheus.io/docs/prometheus/latest/configuration/promtool

--url=http://localhost:9090

The URL for the Prometheus API with the data where the rule will be backfilled from.

--start=START

The time to start backfilling the new rule from. Must be a RFC3339 formatted date or Unix timestamp. Required.

--end=END

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-dir="data/"

Output directory for generated blocks.

--eval-interval=60s

How frequently to evaluate rules when backfilling if a value is not set in the recording rule files.

Format PromQL query to pretty printed form.

Set a label matcher in the query.

-t,  --type==

Type of the label matcher to set.

Delete a label from the query.