Service definition file (jpc_program-name_service.xml)

Organization of this page

Syntax
Content description

Syntax

<service>
  <id>service-ID</id>
  <name>service-display-name</name>
  <description>description</description>
  <workingdirectory>working-directory</workingdirectory>
  <env name="environment-variable-name" value="value"></env>
  <executable>"program-path"</executable>
  <arguments>program-arguments</arguments>
  <startmode>startup-mode</startmode>
  <logpath>log-output-directory</logpath>
  <log mode="roll-by-size">
    <sizeThreshold>log-file-size</sizeThreshold>
    <keepFiles>number-of-log-files</keepFiles>
  </log>
  <stoptimeout>stop-timeout-time</stoptimeout>
</service>

To Page Top

Content description

The following shows only the content descriptions that can be defined in Exporters used with add-on programs provided with IM Exporter (Windows exporter, Yet another cloudwatch exporter, Promitor Scraper, Promitor Resource Discovery, and Script exporter). For details on other service definition files, see Service definition file (jpc_program-name_service.xml) (2. Definition Files) for JP1/IM - Agent.

Item		Description	Modifiable	Content set by the user in JP1/IM - Agent	Default value in JP1/IM - Agent
<service>		Configures service settings.	--	--	--
	<id>	Specifies the service-ID (the internal ID used by Windows to identify the service) (required). This must be a unique ID among all services installed on the system, and must be completely comprised of alphanumeric characters.	N	--	For Windows exporter: jpc_windows_exporter 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
	<name>	Specifies the service-display-name (a short service label) (optional). This display name can contain blank spaces and other characters. Avoid specifying a long character string such as that specified for <id>. In addition, this display name may need to be unique among all services installed within certain systems.	N	--	For Windows exporter: JPC Windows Exporter 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
	<description>	Specifies the description (long descriptive text) (optional). This description is shown in the Windows Service Control Manager for the service selected.	N	--	For Windows exporter: windows_exporter 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
	<env name="environment-variable-name" value="value">	Specifies the environment-variable-name and its value. This is specified for Promitor Scraper and Promitor Resource Discovery.	N	--	For Promitor Scraper: name="PROMITOR_CONFIG_FOLDER" value="installation-directory/jp1pccs/conf/promitor/scraper" For Promitor Resource Discovery: name="PROMITOR_CONFIG_FOLDER" value="installation-directory/jp1pccs/conf/promitor/resource-discovery"
	<executable>	Specifies the program-path (the path of the executable file launched) (required). You can either specify the absolute path, or specify the name of the executable file to retrieve the program path from PATH. However, as the service is often run on other user accounts, it may have a different PATH than the shell. Be aware that an error will not occur even if the program path is left blank.	N	--	For Windows exporter: windows_exporter.exe For Yet another cloudwatch exporter: ya_cloudwatch_exporter.exe For Promitor Scraper: promitor_scraper.exe For Promitor Resource Discovery: promitor_resource_discovery.exe For Script exporter: script_exporter.exe
	<arguments>	Specifies the program-arguments (the arguments passed to the executable file launched). After making changes to this value, restart the service.	Y	Change this setting to change program arguments.	For Windows exporter: For details on the windows_exporter.exe arguments, see windows_exporter command options in Service definition file (jpc_program-name_service.xml) (2. Definition Files) for JP1/IM - Agent. For Yet another cloudwatch exporter: For details on the ya_cloudwatch_exporter.exe arguments, see ya_cloudwatch_exporter command options in Service definition file (jpc_program-name_service.xml) (2. Definition Files) for JP1/IM - Agent. For Promitor Scraper: For details on the promitor_scraper.exe arguments, see promitor_scraper command options. For Promitor Resource Discovery: For details on the promitor_resource_discovery.exe arguments, see promitor_resource_discovery command options. For Script exporter: For details on the script_exporter.exe arguments, see script_exporter command options.
	<startmode>	Specifies the startup-mode (Windows service startup mode) (optional). Specify a value from the following: Automatic Manual When changing this value, first uninstall the service, and after changes are made, reinstall the service.	Y	Specify Manual for cluster use.	Automatic
	<stoptimeout>	Specifies the service stoppage waiting time (the maximum waiting time from when a stop request is sent to the program to when the service stops). After making changes to this value, restart the service.	Y	Change this setting to change the waiting time for service stoppage.	For Windows exporter, Yet another cloudwatch exporter, Promitor Scraper, Promitor Resource Discovery, and Script exporter: 60sec

Legend:: Y: Modifiable, N: Not modifiable, --: 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	--	--config.file="installation-directory/jp1pccs/conf/script_exporter.yml"
-web.listen-address	Specifies the standby port. To limit IP addresses for listening, also specify the host name and IP address. Host names up to 255 bytes in length can be specified. Setting example: To receive requests for all IP addresses, configure the following settings as follows: --web.listen-address=":9469" To limit the IP addresses for which requests can be received, specify the host name or IP address as follows: --web.listen-address="host-name-or-IP-address:9469"	Y	Specify this to change the port, or to limit IP addresses for listening.	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.

--config.file="installation-directory/jp1pccs/conf/script_exporter.yml"

-web.listen-address

Specifies the standby port. To limit IP addresses for listening, also specify the host name and IP address. Host names up to 255 bytes in length can be specified.

Setting example:

To receive requests for all IP addresses, configure the following settings as follows:

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

To limit the IP addresses for which requests can be received, specify the host name or IP address as follows:

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

Specify this to change the port, or to limit IP addresses for listening.

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

To Page Top