prometheus-process-exporter(1)

prometheus-process-exporter1

Prometheus exporter which mines procfs to report on selected processes.

Usage

prometheus-process-exporter [option ...]

Overview

Some apps are impractical to instrument directly, either because you don't control the code or they're written in a language that isn't easy to instrument with Prometheus. This exporter solves that issue by mining process metrics from procfs.

The recommended option is to use a config file, but for convenience and backwards compatibility the -procnames / -namemapping options exist as an alternative.

The -children option (default:true) makes it so that any process that otherwise isn't part of its own group becomes part of the first group found (if any) when walking the process tree upwards. In other words, resource usage of subprocesses is added to their parent's usage unless the subprocess identifies as a different group name.

Options

-children

If a proc is tracked, track with it any children that aren't part of their own group (default true).

-config.path string

Path to YAML config file.

-debug

Log debugging information to stdout.

-man

Print manual.

-namemapping string

Comma-separated list, alternating process name and capturing regex to apply to cmdline.

-procfs string

Path to read proc data from (default "/proc").

-procnames string

Comma-separated list of process names to monitor.

-recheck Re-check process names on each scrape.
-web.config.file string

Path to YAML web config file.

-web.listen-address string

Address on which to expose metrics and web interface. (default ":9256").

-web.telemetry-path string

Path under which to expose metrics. (default "/metrics").

Releases

4 releases since Debian 10 (Buster); the text changed 2 times.

  1. 10
  2. 11
  3. 12–13

-children since Debian 11 (Bullseye); -config.path since Debian 11 (Bullseye); -debug since Debian 11 (Bullseye); -man since Debian 11 (Bullseye); -namemapping since Debian 11 (Bullseye); -procfs since Debian 11 (Bullseye); -procnames since Debian 11 (Bullseye); -web.config.file since Debian 12 (Bookworm); -web.listen-address since Debian 11 (Bullseye); -web.telemetry-path since Debian 11 (Bullseye).

Author

Nick Cabatoff <[email protected]>

From prometheus-process-exporter 0.8.5-1 in Debian 13 (Trixie). Parsed by carta from the page's man source.