Service definition file (jpc_program-name_service.xml)

Organization of this page

Format

For JP1/IM agent control base (imagent, imagentproxy, imagentaction) and OSS^# services that do not support the add-on administration funtion

<service>
  <id>service-ID</id>
  <name>display-name-of-the-service</name>
  <description>description</description>
  <workingdirectory>working-directory</workingdirectory>
  <env name="environment-variable-name" value="value"></env>
  <executable>"program-path"</executable>
  <arguments>arguments-of-the-program</arguments>
  <startmode>type-of-startup</startmode>
  <logpath>log-output-directory</logpath>
  <log mode="roll-by-size">
    <sizeThreshold>log-file-size</sizeThreshold>
    <keepFiles>Number of log faces</keepFiles>
  </log>
  <stoptimeout>Termination timeout period</stoptimeout>
</service>

For OSS^# servicesthat support the add-on administration function

<service>
  <id>service-ID</id>
  <name>display-name-of-the-service</name>
  <description>description</description>
  <workingdirectory>working-directory</ workingdirectory>
  <env name="environment-variable-name" value="value"></env>
  <executable>"path-of-OSS-wrapper-program"</executable> 
  <arguments>
    "OSS-program-path"
    arguments-of-the-OSS-program
  </arguments>
  <startmode>startup-type</startmode>
  <logpath>log-output-directory</logpath>
  <log mode="roll-by-size">
    <sizeThreshold>log-file-size</sizeThreshold>
    <keepFiles>Number of log faces</keepFiles>
  </log>
  <stoptimeout>Termination timeout period</stoptimeout>
  <env name="IMA_OSSWRAPPER_RESTART_INTERVAL" value="interval-at-which-OSS-wrapper-restarts-processes"/>
</service>

#: For details about OSS corresponding to add-on administration funciton, see 3.15 Monitoring function by JP1/IM - Agent in the JP1/Integrated Management 3 - Manager Overview and System Design Guide.

To Page Top

File

For a physical host

jpc_program-name_service.xml

jpc_program-name_service.xml.model (model file)
For a logical host

jpc_program-name_service_logical-host-name.xml

To Page Top

Storage directory

■Integrated agent host

For a physical host (Model File storage destination)

Agent-path\conf\
For Physical host and Logical host (storage destination of definition file)

Agent-path\bin\

To Page Top

Description

This is the definition file of the Windows serviced program.

To Page Top

Character code

UTF-8 (without BOM)

To Page Top

Line feed code

CR+LF

To Page Top

When the definitions are applied

If you change <startmode> in the definition file, it will take effect by reinstalling the service. For each JP1/IM agent control base or add-on program service, reinstall the service using the commands listed in the following tables.

Add-on program or JP1/IM agent control base	Service name	Command
Prometheus server	jpc_prometheus_server_service.exe	jpc_prometheus_server_service.exe
Alertmanager	jpc_alertmanager_service.exe	jpc_alertmanager_service.exe
Windows exporter	jpc_windows_exporter_service.exe	jpc_windows_exporter_service.exe
Windows exporter (Hyper-V monitoring)	jpc_windows_exporter_hyperv_service.exe	jpc_windows_exporter_hyperv_service.exe
Blackbox exporter	jpc_blackbox_exporter_service.exe	jpc_blackbox_exporter_service.exe
Yet another cloudwatch exporter	jpc_ya_cloudwatch_exporter_service.exe	jpc_ya_cloudwatch_exporter_service.exe
Promitor	jpc_promitor_scraper_service.exe	jpc_promitor_scraper_service.exe
Promitor	jpc_promitor_resource_discovery_service.exe	jpc_promitor_resource_discovery_service.exe
Script exporter	jpc_script_exporter_service.exe	jpc_script_exporter_service.exe
Fluentd	jpc_fluentd_service.exe	jpc_fluentd_service.exe
Web exporter	jpc_web_exporter_service.exe	jpc_web_exporter_service.exe
VMware exporter	jpc_vmware_exporter_service.exe	jpc_vmware_exporter_service.exe
SQL exporter	sql_exporter_service.exe	sql_exporter_service.exe
imagent	jpc_imagent_service.exe	jpc_imagent_service.exe
imagentproxy	jpc_imagentproxy_service.exe	jpc_imagentproxy_service.exe
imagentaction	jpc_imagentaction_service.exe	jpc_imagentaction_service.exe

If you change the <arguments> or <stoptimeout> of the definition file, it is reflected when the service is restarted.

To Page Top

Information that is specified

Item			Description	Changeability	What You Setup in Your JP1/IM - Agent	JP1/IM - Agent Defaults Value
<service>			Configure the service settings.	--	--	--
	<id>		Specify the ID of the service (the ID that Windows uses internally to identify the service) (required). This identifier must be unique among all services installed on the system and must consist entirely of alphanumeric characters.	N	--	For Prometheus server jpc_prometheus For Alertmanager jpc_alertmanager For Windows exporter jpc_windows_exporter For Blackbox exporter jpc_blackbox_exporter For JP1/IM agent control base (imagent)^# jpc_imagent For JP1/IM agent control base (imagentproxy)^# jpc_imagentproxy For JP1/IM agent control base (imagentaction)^# jpc_imagentaction For Fluentd jpc_fluentd For Yet another cloudwatch exporter: jpc_ya_cloudwatch_exporter For Promitor Scraper: jpc_promitor_scraper For Promitor Resource Discovery: jpc_promitor_resource_discovery For Script exporter: jpc_script_exporter For OracleDB exporter oracledb_exporter_instance name For Web exporter jpc_web_exporter For VMware exporter jpc_vmware_exporter For Windows exporter (Hyper-V monitoring) jpc_windows_exporter_hyperv For SQL exporter sql_exporter
	<name>		Specify a display name for the service (the short display name of the service) (optional). It can contain spaces and other characters. Do not specify a long string, such as <id>. It must also be unique among all services in a particular system.	N	--	For Prometheus server JP1/IM3-Agent Metric forwarder For Alertmanager JP1/IM3-Agent Alert forwarder For Windows exporter JP1/IM3-Agent Windows metric collector For Blackbox exporter JP1/IM3-Agent Synthetic metric collector For JP1/IM agent control base (imagent)^# JP1/IM3-Agent For JP1/IM agent control base (imagentproxy)^# JP1/IM3-Agent proxy For JP1/IM agent control base (imagentaction)^# JP1/IM3-Agent action For Fluentd JP1/IM3-Agent Log trapper For Yet another cloudwatch exporter: JPC YA Cloudwatch exporter For Promitor Scraper: JPC Promitor Scraper For Promitor Resource Discovery: JPC Promitor Resource Discovery For Script exporter: JPC Script exporter For OracleDB exporter OracleDB metric collector instance name For Web exporter JP1/IM3-Agent Synthetic web metric collector For VMware exporter JP1/IM3-Agent VMware metric collector For Windows exporter (Hyper-V monitoring) JP1/IM3-Agent Windows Hyper-V metric collector For SQL exporter SQL Exporter
	<description>		Specify a description (long description) (optional). This description is displayed in the Windows Service Control Manager when the service is selected.	N	--	For Prometheus server Prometheus server For Alertmanager Alertmanager For Windows exporter windows_exporter For Blackbox exporter blackbox_exporter For JP1/IM agent control base (imagent)^# JPC IM-Agent Service For JP1/IM agent control base (imagentproxy)^# JPC IM-Agent Proxy Service For JP1/IM agent control base (imagentaction)^# JPC IM-Agent Action Service For Fluentd Fluentd For Yet another cloudwatch exporter: jpc_ya_cloudwatch_exporter For Promitor Scraper: jpc_promitor_scraper For Promitor Resource Discovery: jpc_promitor_resource_discovery For Script exporter: jpc_script_exporter For OracleDB exporter OracleDB exporter For Web exporter Web exporter For VMware exporter vmware_exporter For Windows exporter (Hyper-V monitoring) jpc_windows_exporter_hyperv For SQL exporter MSSQL metric collector
	<workingdirectory>		Specify the working directory (the current directory of the service).	N	--	For Prometheus server, Alertmanager, Windows exporter, Blackbox exporter and VMware exporter Automatically Setup during set-up. For JP1/IM agent control base (imagent,imagentproxy, and imagentaction), Fluentd and Web exporter `Agent-path\bin`
	<env name="environment-variable-name" value="value">		Specifies the environment-variable-name and its value. This is specified for Promitor Scraper, Promitor Resource Discovery, and OracleDB exporter.	For Promitor Scraper and Promitor Resource Discovery N For OracleDB exporter Y	--	For Promitor Scraper: name="PROMITOR_CONFIG_FOLDER" value="installation-directory/jp1ima/conf/promitor/scraper" For Promitor Resource Discovery: name="PROMITOR_CONFIG_FOLDER" value="installation-directory/jp1ima/conf/promitor/resource-discovery" For OracleDB exporter See the Preparing to add a monitoring target in 1.23.1(4)(a) Adding a monitoring target (required) in the JP1/Integrated Management 3 - Manager Configuration Guide.
	<executable>		Specify the path of the program (the path of the executable file to be launched) (required). You can specify an absolute path or specify the executable file name to search from PATH. Note, however, that services often run under different user accounts, so they may have a different PATH than the shell. Note that specifying an empty string does not result in an error.	N	--	For Prometheus server, Alertmanager, Windows exporter, Windows exporter (Hyper-V monitoring), Yet another cloudwatch exporter, Promitor Scraper, Promitor Resource Discovery, Blackbox exporter, Script exporter, Web exporter, VMware exporter, and Fluentd osswrapper.exe For JP1/IM agent control base (imagent) imagent For JP1/IM agent control base (imagentproxy) imagentproxy For JP1/IM agent control base (imagentaction) imagentaction For OracleDB exporter: `destination-folder\oracledb_exporter_windows\jp1ima\bin\oracledb_exporter.exe` For SQL exporter `destination-folder\sql_exporter_windows\jp1ima\bin\sql_exporter.exe`
	<arguments>		Specify the program arguments (the arguments to be passed to the executable file to be launched). If you want to change the value, restart the service after changing the value.	Y	Change the settings when you want to change the arguments.	For Prometheus server "`Agent-path\bin\prometheus.exe`" `prometheus.exe -parameters` Note: For prometheus.exe parameters, see prometheus command options. For Alertmanager "`Agent-path\bin\alertmanager.exe`" `alertmanager.exe-parameters` Note: About arguments of alertmanager.exe, see alertmanager command options. For Windows exporter "`Agent-path\bin\windows_exporter.exe`" `windows_exporter.exe-parameters` Note: About arguments of windows_exporter.exe, see windows_exporter command options. For Blackbox exporter "`Agent-path\bin\blackbox_exporter.exe`" `blackbox_exporter.exe-parameters` Note: About arguments of blackbox_exporter.exe, see blackbox_exporter command options. For JP1/IM agent control base (imagent, imagentproxy, and imagentaction) ■For normal hosts None ■For cluster environments -hostname `logical host name` - When using the data distribution function to multiple manager hosts and launching JP1/IM agent control base as a secondary^# `-imagid` `imagent-group-identifier` For Fluentd "`Agent-path\lib\ruby\ruby.exe`" `fluentd-command-parameters` Note: For details about the parameters of fluentd command, see fluentd command options For Yet another cloudwatch exporter: "`Agent-path\bin\ya_cloudwatch_exporter.exe`" `ya_cloudwatch_exporter.exe-parameters` Note: For details on the ya_cloudwatch_exporter.exe arguments, see yet-another-cloudwatch-exporter command options. For Promitor Scraper: "`Agent-path\bin\promitor_scraper.exe`" `promitor_scraper.exe-parameters` Note: For details on the promitor_scraper.exe arguments, see promitor_scraper command options. For Promitor Resource Discovery: "`Agent-path\bin\promitor_resource_discovery.exe`" `promitor_resource_discovery.exe-parameters` Note: For details on the promitor_resource_discovery.exe arguments, see promitor_resource_discovery command options. For Script exporter: "`Agent-path\bin\script_exporter.exe`" `script_exporter.exe-parameters` Note: For details on the script_exporter.exe arguments, see script_exporter command options. For OracleDB exporter `oracledb_exporter.exe-parameters` Note: For details about oracledb_exporter.exe arguments, see oracledb_exporter command options. For Web exporter "`Agent-path\bin\web_exporter.exe`" `web_exporter.exe-parameters` Note: For details about web_exporter.exe arguments, see web_exporter command options. For VMware exporter "`Agent-path\bin\vmware_exporter.exe`" `vmware_exporter.exe-parameters` Note: For details about vmware_exporter.exe arguments, see vmware_exporter command options. For Windows exporter (Hyper-V monitoring) `windows_exporter.exe-(Hyper-V monitoring)-parameters` Note: For windows_exporter.exe (Hyper-V monitoring) parameters, see windows_exporter command options (Hyper-V monitoring). For SQL exporter `sql_exporter.exe-parameters` Note: For sql_exporter.exe parameters, see sql_exporter command options.
	<startmode>		Specify the startup type (Windows service start mode) (optional). Specify one of the following values: Automatic Manual If you want to change the value, uninstall the service once, change the value, and then reinstall the service.	Y	For Prometheus server,Alertmanager,Windows exporter,Blackbox exporter, JP1/IM agent control base (imagent, and imagentproxy), Fluentd, OracleDB exporter, Web exporter, VMware exporter, Windows exporter (Hyper-V monitoring), and SQL exporter For clustered operation, specify Manual.	For Prometheus server,Alertmanager,Windows exporter, Blackbox exporter, Yet another cloudwatch exporter, Promitor Scraper, Promitor Resource Discovery, Script exporter, JP1/IM agent control base (imagent, and imagentproxy), Fluentd, Web exporter, VMware exporter, Windows exporter (Hyper-V monitoring), and SQL exporter Automatic
	<logpath>		Specify the log output destination directory (the directory where the log file will be created). If specified, the directory where the configuration file exists is the default. If you want to change the value, restart the service after changing the value.	Y	--	Set up automatically during setup.
	<log mode="roll-by-size">		The log output mode is roll-by-size mode. It operates in the same way as append mode, but if the value set for log file size is exceeded, it will be rolled to myapp.1.out.log, myapp.2.out.log, etc.	N	--	--
		<sizeThreshold>	Specify it in KB when changing the log file size (rotation threshold). If you want to change the value, restart the service after changing the value.	N	Change Setup when you are prompted to change Value from the support desk.	10240 (1024 for imagent, imagentproxy, imagentaction OracleDB exporter only)
		<keepFiles>	Specify this when changing the number of log planes (the number of role files to keep). A log with the specified number of sides + 1 side is created. If you want to change the value, restart the service after changing the value. Value that can be Setup is 7 to 511.	Y	Change Setup when you are prompted to change Value from the support desk.	7 (99 for Fluentd only. 3 for OracleDB exporter. 1 for imagent, imagentproxy, imagentaction.)
	<stoptimeout>		Specifies the wait time to stop the service (the maximum amount of time to wait after issuing a stop request to the program before the service is stopped). If you want to change the value, restart the service after changing the value.	Y	Change the settings when you want to change the waiting time for an outage.	For Prometheus server 110sec For Alertmanager,Windows exporter,Blackbox exporter, Yet another cloudwatch exporter, Promitor Scraper, Promitor Resource Discovery, Script exporter, Fluentd, and OracleDB exporter, Web exporter, VMware exporter, Windows exporter (Hyper-V monitoring), and SQL exporter 60sec For JP1/IM agent control base (imagent) 90sec For JP1/IM agent control base (imagentproxy) 140sec For JP1/IM agent control base (imagentaction) 60sec
	<env name="IMA_OSSWRAPPER_RESTART_INTERVAL" value="`interval-at-which-OSS-wrapper-restarts-processes`">		Specifies in hours the value of the environment-variable IMA_OSSWRAPPER_RESTART_INTERVAL (`interval-at-which-OSS-wrapper-restarts-processes`). Allowed values are: 0... 2160 (90 days). The default value is 0. OSS does not restart processing in the following cases: When this environment variable is not set When 0 is specified as the value of this environment variable Cannot convert the specified value to an integer value When a value outside the specifiable range is specified Restarts OSS process when the default-value or specified-value period elapses, starting immediately before OSS process is started.	Y	--	name="IMA_OSSWRAPPER_RESTART_INTERVAL" value="0"

Legend:: Y: Changeable, N: Not changeable, --: Not applicable
#: For details on the description of service definition file when using the data delivery function to multiple manager hosts, see Service definition file (for Windows) in 3.15.7(5)(c) Configuring secondary service startup in the JP1/Integrated Management 3 - Manager Overview and System Design Guide.

prometheus command options

Item	Description	Changeability	What You Setup in Your JP1/IM - Agent	JP1/IM - Agent Defaults Value
--config.file="jpc_prometheus_server.yml"	Specifies the path to the Prometheus configuration file.	Y	--	--config.file="`Agent-path`/jp1ima/conf/jpc_prometheus_server.yml"
--web.listen-address="0.0.0.0:9090"	Specify the listening port. If you want to limit the listening IP address, also include the host name or IP address. If you specify a host name, you can specify up to 255 bytes. <Configuration example> To accept requests for all IP addresses, set the following: `--web.listen-address="0.0.0.0:20713"` If you want to limit the IP addresses that are accepted, you can specify a host name or an IP address as follows: `--web.listen-address="host-name-or-IP-address:20713"`	Y	Specify this when you want to change the port or limit the listening IP address.	--web.listen-address="0.0.0.0:20713"
--web.read-timeout=5m	Specifies the maximum amount of time before reading requests times out and idle connections are closed.	N	--	--web.read-timeout=5m
--web.max-connections=512	Specifies the maximum number of concurrent connections.	N	--	--web.max-connections=10
--web.enable-lifecycle	Specifies to enable shutdown and reload by HTTP request.	N	--	--web.enable-lifecycle
--storage.tsdb.path="data/"	Specify the path where you want to save the performance data.	N	--	--storage.tsdb.path="data/prometheus_server/"
--storage.tsdb.min-block-duration=2h	Specifies the minimum duration of the block.	N	--	--storage.tsdb.min-block-duration=1h
--storage.tsdb.max-block-chunk-segment-size=512MB	Specifies the maximum size of a single chunk segment in a block.	N	--	--storage.tsdb.max-block-chunk-segment-size=32MB
--storage.tsdb.retention.time=STORAGE.TSDB.RETENTION.TIME	Specify the retention period of performance data in hours or days. Hourly Specify from 1h to 360h. Daily Specify from 1d to 366d. <Configuration example> --storage.tsdb.retention.time=24h	Y	If a range vector selector is used for the alert rule condition, specify a value greater than that range.	--storage.tsdb.retention.time=1h
--storage.remote.flush-deadline=<duration>	Specify the maximum waiting time when stopping when remote lights and alerts cannot be sent.	N	--	--storage.remote.flush-deadline=5s
--rules.alert.for-outage-tolerance=1h	Specifies the maximum Prometheus server outage period for which the alert "pending" state can be restored.	N	--	--rules.alert.for-outage-tolerance=1h
--rules.alert.for-grace-period=10m	Specifies the minimum duration of the "for" state when restored from an alert. Valid only for alerts that have a longer "for" time than this option.	N	--	--rules.alert.for-grace-period=10m
--log.level=info	Only messages above the specified level are logged. You can specify one of the following levels: debug, info, warn, or error.	N	Change Setup when you are prompted to change Value from the support desk. Normally, no change is required.	--log.level=debug

Legend:: Y: Changeable, N: Not changeable, --: Not applicable

alertmanager command options

Item	Description	Changeability	What You Setup in Your JP1/IM - Agent	JP1/IM - Agent Defaults Value
--config.file="jpc_alertmanager.yml"	Specifies the path to the Alertmanager configuration file.	Y	--	--config.file="`Agent-path`/jp1ima/conf/jpc_alertmanager.yml"
--storage.path="data/"	Specify the path where you want to save the administrative data.	N	--	--storage.path="data/alertmanager/"
--data.retention=120h	Specify the retention period for administrative data. Silence information and information about alerts that occurred are saved.	N	--	--data.retention=168h
--alerts.gc-interval=30m	Specifies the interval for the Garbage Collection.	N	--	--alerts.gc-interval=30m
--web.listen-address=":9093"	Specify the listening port. If you want to limit the listening IP address, also include the host name or IP address. If you specify a host name, you can specify up to 255 bytes. If you specify a host name or an IP address for this option, you must set the same host name or IP address as this option for `localhost` listed in the `alerting.alertmanagers.static_configs.targets` in the Prometheus configuration file (`jpc_prometheus_server.yml`) on the same host, and you must restart or reload the Prometheus server. <Configuration example> To accept requests for all IP addresses, setup the following: `--Web.listen-address=":20714"` If you want to limit the IP address that are accepted, you can specify a host name or an IP address as follows: `--Web.listen-address="host-name-or-IP-address:20714"`	Y	Specify this when you want to change the port or limit the listening IP address.	--web.listen-address=":20714"
--web.get-concurrency=0	Specifies the maximum number of GET requests to process simultaneously.	N	--	--web.get-concurrency=0
--web.timeout=0	Specifies the timeout period for HTTP requests.	N	--	--web.timeout=0
--cluster.listen-address="0.0.0.0:9094"	Specify the listen address when running Alertmanager in HA mode. If you set an empty string, HA mode is disabled.	N	--	--cluster.listen-address=""
--log.level=info	Only messages above the specified level are logged. You can specify one of the following levels: debug, info, warn, or error.	N	Change Setup when you are prompted to change Value from the support desk. Normally, no change is required.	--log.level=info
--log.format=logfmt	Specifies the output format of log messages. The available output formats are logfmt or json.	N	--	--log.format=logfmt

Legend:: Y: Changeable, N: Not changeable, --: Not applicable

windows_exporter command options

Item	Description	Changeability	What You Setup in Your JP1/IM - Agent	JP1/IM - Agent Defaults Value
--telemetry.addr	Specify the listening port. If you want to limit the listening IP address, also include the host name or IP address. If you specify a host name, you can specify up to 255 bytes. If you specify a host name for this option, you must set the same host name as this option to the `targets` of Windows exporter discovery configuration file `(jpc_file_sd_config_windows.yml`) on the same host, and you must restart or reload the Prometheus server. If you specify an IP address for this option, you must set the host name that resolves to the same IP address as this option to the `targets` of Windows exporter discovery configuration file (`jpc_file_sd_config_windows.yml`) on the same host, and you must restart or reload the Prometheus server. <Configuration example> To accept requests for all IP addresses, set the following: `--telemetry.addr=":20717"` If you want to limit the IP addresses that are accepted, you can specify a host name or an IP address as follows: `--telemetry.addr="host-name-or-IP-address:20717"`	Y	Specify this when you want to change the port or limit the listening IP address.	--telemetry.addr=":20717"
--config.file	Specifies the path to the Windows exporter configuration file. Values set in this file are overwritten by command line options.	Y	--	--config.file="`Agent-path/`jp1ima`/`conf`/`jpc_windows_exporter.yml"
--log.level	Only messages above the specified level are logged. You can specify one of the following levels: debug, info, warn, or error.	N	--	--log.level=debug

Item

Description

Changeability

What You Setup in Your JP1/IM - Agent

JP1/IM - Agent Defaults Value

--telemetry.addr

Specify the listening port. If you want to limit the listening IP address, also include the host name or IP address. If you specify a host name, you can specify up to 255 bytes.

If you specify a host name for this option, you must set the same host name as this option to the targets of Windows exporter discovery configuration file (jpc_file_sd_config_windows.yml) on the same host, and you must restart or reload the Prometheus server.

If you specify an IP address for this option, you must set the host name that resolves to the same IP address as this option to the targets of Windows exporter discovery configuration file (jpc_file_sd_config_windows.yml) on the same host, and you must restart or reload the Prometheus server.

To accept requests for all IP addresses, set the following:

--telemetry.addr=":20717"

If you want to limit the IP addresses that are accepted, you can specify a host name or an IP address as follows:

--telemetry.addr="host-name-or-IP-address:20717"

Specify this when you want to change the port or limit the listening IP address.

--telemetry.addr=":20717"

--config.file

Specifies the path to the Windows exporter configuration file.

Values set in this file are overwritten by command line options.

--config.file="Agent-path/jp1ima/conf/jpc_windows_exporter.yml"

--log.level

Only messages above the specified level are logged.

You can specify one of the following levels: debug, info, warn, or error.

--log.level=debug

Legend:: Y: Changeable, N: Not changeable, --: Not applicable

windows_exporter command options (Hyper-V monitoring)

Item name	Description	Changeability	What You Set Up with JP1/IM - Agent	JP1/IM - Agent Defaults
--telemetry.addr	Specify the listening port. If you want to limit the listening IP address, also include the host name or IP address. If you specify a host name, you can specify up to 255 bytes. If you specify a host name for this option, you must set the same host name as this option to the `targets` of Windows exporter (Hyper-V monitoring) discovery configuration file (`jpc_file_sd_config_windows_hyperv.yml`) on the same host, and you restart or reload the Prometheus server. If you specify an IP address for this option, you must set the hostname that resolves to the same IP address as this option to the `targets` of Windows exporter (Hyper-V monitoring) discovery configuration file (`jpc_file_sd_config_windows_hyperv.yml`) on the same host, and you restart or reload the Prometheus server. <Configuration example> To accept requests for all IP addresses, set the following: `--telemetry.addr=":20717"` If you want to limit the IP addresses that are accepted, you can specify a hostname or an IP address as follows: `--telemetry.addr="host-name-or-IP-address:20713"`	Y	Specify this when you want to change the port or limit the listening IP address.	20734
--config.file	Windows exporter (Hyper-V monitoring) specifies configuration file pathname. The values set in this file are overridden by command line options.	Y	--	CONFIG.FILE
--log.level	Outputs only messages above the specified level to the log. One of debug, info, warn, error can be specified.	N	--	"debug"

Item name

Description

Changeability

What You Set Up with JP1/IM - Agent

JP1/IM - Agent Defaults

--telemetry.addr

Specify the listening port. If you want to limit the listening IP address, also include the host name or IP address. If you specify a host name, you can specify up to 255 bytes.

If you specify a host name for this option, you must set the same host name as this option to the targets of Windows exporter (Hyper-V monitoring) discovery configuration file (jpc_file_sd_config_windows_hyperv.yml) on the same host, and you restart or reload the Prometheus server.

If you specify an IP address for this option, you must set the hostname that resolves to the same IP address as this option to the targets of Windows exporter (Hyper-V monitoring) discovery configuration file (jpc_file_sd_config_windows_hyperv.yml) on the same host, and you restart or reload the Prometheus server.

To accept requests for all IP addresses, set the following:

--telemetry.addr=":20717"

If you want to limit the IP addresses that are accepted, you can specify a hostname or an IP address as follows:

--telemetry.addr="host-name-or-IP-address:20713"

Specify this when you want to change the port or limit the listening IP address.

20734

--config.file

Windows exporter (Hyper-V monitoring) specifies configuration file pathname.

The values set in this file are overridden by command line options.

CONFIG.FILE

--log.level

Outputs only messages above the specified level to the log.

One of debug, info, warn, error can be specified.

"debug"

Legend: Y: Changeable, N: Not changeable, --: Not applicable

blackbox_exporter command options

Item	Description	Changeability	What You Setup in Your JP1/IM - Agent	JP1/IM - Agent Defaults Value
--config.file	Specifies the path to the Blackbox exporter configuration file.	Y	--	--config.file="`Agent-path`/jp1ima/conf/jpc_blackbox_exporter.yml"
--web.listen-address	Specify the listening port. If you want to limit the listening IP address, also include the host name or IP address. If you specify a host name, you can specify up to 255 bytes. If you specify a host name or an IP address for this option, you must set the same host name or IP address as this option for `localhost` (more than one) listed in the `relabel_config` of scrape jobs for `blackbox_exporter` in the Prometheus configuration file (`jpc_prometheus_server.yml`) on the same host, and you must restart or reload the Prometheus server. <Configuration example> To accept requests for all IP addresses, set the following: `--web.listen-address=":20715"` If you want to limit the IP addresses that are accepted, you can specify a host name or an IP address as follows: `--web.listen-address="host-name-or-IP-address:20715"`	Y	Specify this when you want to change the port or limit the listening IP address.	--web.listen-address=":20715"
--timeout-offset	Specifies the number of seconds to subtract from the Prometheus scrape_timeout value. The Prometheus scrape_timeout value will now time out in seconds minus the value specified for this option.	N	Offset from timeout period (seconds)	--timeout-offset=0.5
--history.limit	Specifies the upper limit of the history of probe results. This history is stored internally blackbox_exporter, and old history is deleted.	N	Maximum number of items in history	--history.limit=100
--log.level	Only messages above the specified level are logged. You can specify one of the following levels: debug, info, warn, or error.	N	Change Setup when you are prompted to change Value from the support desk. Normally, no change is required.	--log.level=info

Legend:: Y: Changeable, N: Not changeable, --: Not applicable

promitor_scraper command options

No specifiable options.
promitor_resource_discovery command options

No specifiable options.

script_exporter command options

Item	Description	Modifiable	Content set by the user in JP1/IM - Agent	Default value in JP1/IM - Agent
-config.file	Path to configuration file.	Y	--	For Windows installation-directory`\jp1ima\conf\jpc_script_exporter.yml` For Linux `/opt/jp1ima/conf/jpc_script_exporter.yml`
-web.listen-address	Specify the listening port. If you want to limit the listening IP address, also include the host name or IP address. If you specify a host name, you can specify up to 255 bytes. <Configuration example> To accept requests for all IP addresses, set the following: `--web.listen-address=":9469"` If you want to limit the IP addresses that are accepted, you specify a host name or an IP address as follows: `--web.listen-address="host-name-or-IP-address:9469"`	Y	Specify this when you want to change the port or limit the listening IP address.	20722
-timeout-offset	Offset to subtract from Prometheus-supplied timeout in seconds. (default 0.5) The system will time out in the sum of the number of seconds specified for this option subtracted from the Prometheus scrape_timeout value.	N	Offset subtracted from the timeout time (seconds)	--timeout-offset=0.5

Item

Description

Modifiable

Content set by the user in JP1/IM - Agent

Default value in JP1/IM - Agent

-config.file

Path to configuration file.

For Windows

installation-directory\jp1ima\conf\jpc_script_exporter.yml
For Linux

/opt/jp1ima/conf/jpc_script_exporter.yml

-web.listen-address

Specify the listening port. If you want to limit the listening IP address, also include the host name or IP address. If you specify a host name, you can specify up to 255 bytes.

To accept requests for all IP addresses, set the following:

--web.listen-address=":9469"

If you want to limit the IP addresses that are accepted, you specify a host name or an IP address as follows:

--web.listen-address="host-name-or-IP-address:9469"

Specify this when you want to change the port or limit the listening IP address.

20722

-timeout-offset

Offset to subtract from Prometheus-supplied timeout in seconds. (default 0.5)

The system will time out in the sum of the number of seconds specified for this option subtracted from the Prometheus scrape_timeout value.

Offset subtracted from the timeout time (seconds)

--timeout-offset=0.5

Legend:: Y: Modifiable, N: Not modifiable, --: Not applicable

fluentd command options

Item		Description	Changeability	What You Setup in Your JP1/IM - Agent	JP1/IM - Agent Defaults Value
-c	--config.file PATH	Specifies configuration file pathname of Fluentd.	Y	For Logical host, you must modify log monitoring common definition file paths that you place in shared folders on Logical host.	Log monitoring common definition file pass of Fluentd
'-i CONFIG_STRING	--enable-input-metrics	Sets the input plug-in metric for Fluentd to Enable.	N	--	None
-G	--conf-encoding ENCODING	Specifies the encoding of the configuration File.	N	--	UTF-8

Legend:: Y: Changeable, N: Not changeable, --: Not applicable

oracledb_exporter command options

Item	Description	Changeability	What You Setup in Your JP1/IM - Agent	JP1/IM - Agent Defaults Value
--web.telemetry-path="/metrics"	Specify scrape spacing.	N	--	"/metrics"
--default.metrics="default-metrics.toml"	Specifies the definition file for the default metric.	N	--	"default_metrics.toml"
--custom.metrics=""	Specifies the definition file for the custom metric.	N	--	""
--query.timeout=5	Specifies the timeout period when oracledb_exporter accesses Oracle Database to retrieve information. Specify in hours from 5 to 60. <Setting example> --query.timeout=5	Y	Specify this option when it takes a long time to retrieve data from Oracle Database.	5
--database.maxIdleConns=0	Specifies the maximum number of idle connections.	N	--	1
--database.maxOpenConns=10	Specifies the maximum number of open connections.	N	--	1
--scrape.interval=0s	Specifies the scrape interval.	N	--	0s
--[no-]web.systemd-socket	Specifies if socket-based activation is used.	N	--	Not specified (not used)
--web.listen-address=:9161	Specify the listening port. If you want to limit the listening IP address, also include the host name or IP address. If you specify a host name, you can specify up to 255 bytes. If you specify a host name or an IP address for this option, you must set the same host name or IP address as this option for `localhost` (more than one) listed in the `relabel_config` of scrape jobs for `oracledb_exporter` in the Prometheus configuration file (`jpc_prometheus_server.yml`) on the same host, and you must restart or reload the Prometheus server. <Configuration example> To accept requests for all IP addresses, set the following: `--web.listen-address=":20729"` If you want to limit the IP addresses that are accepted, you can specify a host name or an IP address as follows: `--web.listen-address="host-name-or-IP-address:20729"`	Y	Specify this when you want to change the port or limit the listening IP address.	--web.listen-address="@@port@@"
--log.level=info	Outputs only messages of the specified level or higher to the log. One of debug, info, warn, error can be specified.	N	Change the setting when the support desk instructs you to change the value. Normally, no change is required.	--log.level=info

Legend:: Y: Changeable, N: Not changeable, --: Not applicable

web_exporter command options

Item	Description	Changeability	What You Setup in Your JP1/IM - Agent	JP1/IM - Agent Defaults Value
--config.file	Web exporter configuration file.	Y	--	--config.file="`Agent-path`/conf/jpc_web_exporter.yml"
--web.listen-address	Specify the listening port as a number. If you want to limit the listening IP address, also include the host name or IP address. If you specify a host name, you can specify up to 255 bytes. If you specify a host name or an IP address for this option, you must set the same host name or IP address as this option for localhost (more than one) listed in the `relabel_config` of scrape jobs for `web_exporter` in the Prometheus configuration file (jpc_prometheus_server.yml) on the same host, and you must restart or reload the Prometheus server. <Configuration example> To accept requests for all IP addresses, set the following: `--web.listen-address="0.0.0.0:20731"` If you want to limit the IP addresses that are accepted, you can specify a host name or an IP address as follows: `--web.listen-address="host-name-or-IP-address:20731"`	Y	Specify this when you want to change the port or limit the listening IP address.	--web.listen-address=":20731"
--timeout-offset	Specifies the number of seconds to subtract from the Prometheus scrape_timeout value. The Prometheus scrape_timeout value will now time out in seconds minus the value specified for this option.	N	Offset from timeout period (seconds)	--timeout-offset=0.5
--log.level	Only messages above the specified level are logged. You can specify one of the following levels: debug, info, warn, or error.	N	Change Setup when you are prompted to change Value from the support desk. Normally, no change is required.	--log.level=info

Legend:: Y: Changeable, N: Not changeable, --: Not applicable

vmware_exporter command options

Item		Description	Changeability	What You Setup in Your JP1/IM - Agent	JP1/IM - Agent Defaults Value
-c	--config	Configuration file	Y	Change the setting when you want to change the location of configuration file.	--config="`Agent-path`/conf/jpc_vmware_exporter.yml"
-a	--address	HTTP address to expose metrics	Y	Specify this when changing the IP address on which the Exporter is started.	None
-p	--port	HTTP port to expose metrics	Y	Specify this when you want to change the port	20732
-l	--loglevel	Set application loglevel INFO, DEBUG	N	Change Setup when you are prompted to change Value from the support desk. Normally, no change is required.	--loglevel=info

Legend:: Y: Changeable, N: Not changeable, --: Not applicable

sql_exporter command options

Item name	Description	Changeability	What You Set Up with JP1/IM - Agent	JP1/IM - Agent Defaults
--config.file	Specifies SQL exporter configuration file path. The values set in this file are overridden by command line options.	N	--	sql_exporter.yml
--log.format	Sets the output format for log messages.	N	--	logfmt
--log.level	Outputs only messages above the specified level to the log. One of debug, info, warn, error can be specified.	N	Normally, no change is required. Change the setting when the support desk instructs you to change the value.	info
-web.listen-address	Specify the listening port. If you want to limit the listening IP address, also include the host name or IP address.	Y	Specify this when you want to change the port or limit the listening IP address.	20735
-web.metrics-path	Specify the path to publish the metric.	N	--	/metrics

Legend: Y: Changeable, N: Not changeable, --: Not applicable

To Page Top