Process exporter configuration file (jpc_process_exporter.yml)
- Organization of this page
Syntax
Written in YAML format.
process_names: - name: "{{.ExeBase}};{{.Username}};{{.Matches.cmdline}}" cmdline: - (?P<cmdline>.*)
File
jpc_process_exporter.yml
jpc_process_exporter.yml.model (Model file)
Storage directory
- For Windows
-
- When using a physical host
-
Agent-path\conf\
- When using a logical host
-
shared-folder\jp1ima\conf\
- For Linux
-
- When using a physical host
-
/opt/jp1ima/conf/
- When using a logical host
-
shared-directory/jp1ima/conf/
Description
The configuration file that determines the behavior of Process exporter.
Character encoding
UTF-8 (without BOM)
Linefeed code
In Windows: CR+LF
In Linux: LF
Timing in which definitions are reflected
When Process exporter is restarted.
Content description
Item# |
Description |
Modifiable |
Content set by the user in JP1/IM - Agent |
Default value in JP1/IM - Agent |
||
---|---|---|---|---|---|---|
process_names |
-- |
-- |
-- |
-- |
||
- |
[name] |
Each item in process_names gives a recipe for identifying and naming processes. The optional name tag defines a template to use to name matching processes; if not specified, name defaults to {{.ExeBase}}.
|
Y |
Specify this to change the process name to a value other than the default value (executable file name). |
{{.ExeBase}};{{.Username}};{{.Matches.cmdline}} |
|
<selector> |
comm, exe or cmdline. If more than one selector is present, they must all match. |
REQ |
Monitored process selector |
cmdline |
||
- |
<any> |
For "comm" and "exe", the list of strings is an OR, meaning any process matching any of the strings will be added to the item's group. For "cmdline", the list of regexes is an AND, meaning they all must match. Any capturing groups in a regexp must use the ?P<name> option to assign a name to the capture, which is used to populate ".Matches".
|
REQ |
Monitored process selector value |
- (?P<cmdline>.*) |
- Legend:
-
REQ: Required setting, Y: Modifiable, --: Not applicable
- #
-
Brackets ([]) denote optional items.
-
process_exporter command options
Item
Description
Modifiable
Content set by the user in JP1/IM - Agent
Default value in JP1/IM - Agent
-web.listen-address
Address on which to expose metrics and web interface.
If omitted, this is specified as :9256.
Y
Specify this to change the port, or to limit IP addresses for listening.
20721
-procnames
comma-separated list of process names to monitor
Specify the comm field value in /proc//stat as the process name. Process names cut off at 15 characters.
Y
--
None
-procfs
path to read proc data from
If omitted, this is specified as /proc.
Y
--
None
-namemapping
comma-separated list, alternating process name and capturing regex to apply to cmdline
Renamed names that are not in the procnames list are ignored.
Setting example:
-namemapping "python2,([^/]+).py,java,-jar\s+([^/]+).jar"
Y
--
None
-config.path
path to YAML config file
Y
--
installation-directory/jp1ima/conf/jpc_process_exporter.yml
- Legend:
-
Y: Modifiable, --: Not applicable