2018-11-18 16:05:37 +00:00
|
|
|
# process collector
|
|
|
|
|
|
|
|
|
|
The process collector exposes metrics about processes
|
|
|
|
|
|
2018-11-18 21:26:38 +00:00
|
|
|
|||
|
|
|
|
|
-|-
|
|
|
|
|
Metric name prefix | `process`
|
2020-03-24 21:39:46 +00:00
|
|
|
Data source | Perflib
|
|
|
|
|
Counters | `Process`
|
2018-11-18 16:05:37 +00:00
|
|
|
Enabled by default? | No
|
|
|
|
|
|
|
|
|
|
## Flags
|
|
|
|
|
|
2020-03-24 21:39:46 +00:00
|
|
|
### `--collector.process.whitelist`
|
2018-11-18 16:05:37 +00:00
|
|
|
|
2020-03-24 21:39:46 +00:00
|
|
|
Regexp of processes to include. Process name must both match whitelist and not
|
|
|
|
|
match blacklist to be included. Recommended to keep down number of returned
|
|
|
|
|
metrics.
|
2018-11-18 16:05:37 +00:00
|
|
|
|
2020-03-24 21:39:46 +00:00
|
|
|
### `--collector.process.blacklist`
|
2018-11-18 16:05:37 +00:00
|
|
|
|
2020-03-24 21:39:46 +00:00
|
|
|
Regexp of processes to exclude. Process name must both match whitelist and not
|
|
|
|
|
match blacklist to be included. Recommended to keep down number of returned
|
|
|
|
|
metrics.
|
|
|
|
|
|
|
|
|
|
### Example
|
|
|
|
|
To match all firefox processes: `--collector.process.whitelist="firefox.+"`.
|
|
|
|
|
Note that multiple processes with the same name will be disambiguated by
|
2020-04-03 19:05:05 +00:00
|
|
|
Windows by adding a number suffix, such as `firefox#2`. Your [regexp](https://en.wikipedia.org/wiki/Regular_expression) must take
|
2020-03-24 21:39:46 +00:00
|
|
|
these suffixes into consideration.
|
2018-11-18 16:05:37 +00:00
|
|
|
|
2020-04-03 19:05:05 +00:00
|
|
|
:warning: The regexp is case-sensitive, so `--collector.process.whitelist="FIREFOX.+"` will **NOT** match a process named `firefox` .
|
|
|
|
|
|
|
|
|
|
To specify multiple names, use the pipe `|` character:
|
|
|
|
|
```
|
|
|
|
|
--collector.process.whitelist="firefox.+|FIREFOX.+|chrome.+"
|
|
|
|
|
```
|
|
|
|
|
This will match all processes named `firefox`, `FIREFOX` or `chrome` .
|
|
|
|
|
|
2018-11-18 16:05:37 +00:00
|
|
|
## Metrics
|
|
|
|
|
|
|
|
|
|
Name | Description | Type | Labels
|
|
|
|
|
-----|-------------|------|-------
|
|
|
|
|
`wmi_process_start_time` | _Not yet documented_ | gauge | `process`, `process_id`, `creating_process_id`
|
|
|
|
|
`wmi_process_cpu_time_total` | _Not yet documented_ | counter | `process`, `process_id`, `creating_process_id`
|
|
|
|
|
`wmi_process_handle_count` | _Not yet documented_ | gauge | `process`, `process_id`, `creating_process_id`
|
|
|
|
|
`wmi_process_io_bytes_total` | _Not yet documented_ | counter | `process`, `process_id`, `creating_process_id`
|
|
|
|
|
`wmi_process_io_operations_total` | _Not yet documented_ | counter | `process`, `process_id`, `creating_process_id`
|
|
|
|
|
`wmi_process_page_faults_total` | _Not yet documented_ | counter | `process`, `process_id`, `creating_process_id`
|
|
|
|
|
`wmi_process_page_file_bytes` | _Not yet documented_ | gauge | `process`, `process_id`, `creating_process_id`
|
|
|
|
|
`wmi_process_pool_bytes` | _Not yet documented_ | gauge | `process`, `process_id`, `creating_process_id`
|
|
|
|
|
`wmi_process_priority_base` | _Not yet documented_ | gauge | `process`, `process_id`, `creating_process_id`
|
|
|
|
|
`wmi_process_private_bytes` | _Not yet documented_ | gauge | `process`, `process_id`, `creating_process_id`
|
|
|
|
|
`wmi_process_thread_count` | _Not yet documented_ | gauge | `process`, `process_id`, `creating_process_id`
|
|
|
|
|
`wmi_process_virtual_bytes` | _Not yet documented_ | gauge | `process`, `process_id`, `creating_process_id`
|
|
|
|
|
`wmi_process_working_set` | _Not yet documented_ | gauge | `process`, `process_id`, `creating_process_id`
|
|
|
|
|
|
|
|
|
|
### Example metric
|
|
|
|
|
_This collector does not yet have explained examples, we would appreciate your help adding them!_
|
|
|
|
|
|
|
|
|
|
## Useful queries
|
|
|
|
|
_This collector does not yet have any useful queries added, we would appreciate your help adding them!_
|
|
|
|
|
|
|
|
|
|
## Alerting examples
|
|
|
|
|
_This collector does not yet have alerting examples, we would appreciate your help adding them!_
|
