User-specific discovery configuration file (user_file_sd_config_any-name.yml)

Format

Write in YAML format.

- targets:
  - monitored host name[:Any string]
  ...
  labels:
[    jp1_pc_exporter: Any exporter name that does not start with "JPC"]
[    jp1_pc_category: IM Management Node Category ID]
[    jp1_pc_trendname: Prometheus Trend Name]
[    jp1_pc_remote_monitor_instance: Installation Hostname:The string to display in the label of the IM Management node]
[    jp1_pc_rm_agent_create_flag: Remote-agent-SID-creation-flag]
[    jp1_pc_agent_create_flag: agent-SID-creation-flag]
[    jp1_pc_multiple_node: condition-for-get-label-set-for-multiple-IM-management-node-creation]

To Page Top

File

user_file_sd_config_any-name.yml

To Page Top

Storage directory

It can be stored in any directory. However, when storing under the directory where the monitoring agent is installed, store it in the following directory.

■Integrated agent host

In Windows:

• For a physical host

  Agent-path\conf\

• For a logical host

  shared-folder\jp1ima\conf\

In Linux:

• For a physical host

  /opt/jp1ima/conf/

• For a logical host

  shared-directory/jp1ima/conf/

To Page Top

Description

This is a file that sets what Prometheus server scrapes. User-created exporters can also be subject to scraping.

To Page Top

Character code

UTF-8 (without BOM)

To Page Top

Line feed code

In Windows: CR+LF

In Linux: LF

To Page Top

When the definitions are applied

When the Prometheus server reload API is executed or restarted, the Prometheus server is subject to scraping. Then, when the jddcreatetree and jddupdatetree commands are executed, the contents of the tree display in the integrated operations viewer are reflected.

To Page Top

Information that is specified

- monitored host name[:Any string]

Specify "monitored host name[:Any string]" as characters other than 1 to 2,574 control characters.

The monitored host name is a character other than 1 to 255 control characters and is specified as required. You can also specify the FQDN format. "localhost" cannot be specified.

Specify any string if other specifications are required in the Exporter specification.

In Prometheus configuration file (jpc_prometheus_server.yml) scrape definition, relabel_configs is Setup and the required string is passed as an argument at scrape time.

If you have more than 2,574 characters, in Prometheus configuration file (jpc_prometheus_server.yml) relabel_configs, replace instance labeled Value with a non-control character from 1 to 2574. Note that instance label Value must be specified in the format of "Monitored Host name: Arbitrary character string" and must not overlap with Value of other instance labels in the same monitoring agent host.

For setup of the relabel_configs, see the section describing Information that is specified in Prometheus configuration file (jpc_prometheus_server.yml).

jp1_pc_exporter: Any exporter name that does not start with "JPC"

For Any exporter name that does not start with "JPC", specify the character string to be displayed in the properties of the jp1_pc_exporter in the property display with characters other than 1 to 255 control characters. If omitted, "Unknown Exporter" is displayed.

jp1_pc_category: category-ID-for-IM-management-node

For the category-ID-for-IM-management-node, specify the IM Management node category identifier of the agent SID in characters other than 1 to 255 control characters.

If the specification is omitted, "otherApplications" is assumed to be specified.

jp1_pc_trendname: Prometheus-trend-name

For Prometheus-trend-name, specify the Prometheus trend name of the metric definition file to be displayed on the IM management node of the agent SID in characters other than 1 to 255 control characters.

If the specification is omitted, job labeled Value is turned Setup.

jp1_pc_remote_monitor_instance: install-host-name-string-to-be-labeled-with-IM-management-node

Specify only for exporters that you want to monitor remotely. A remotely monitored exporter is an exporter that monitors a host other than the one on which the exporter is set up.

For the installation host name, specify the host name on which the exporter was installed, in characters other than 1 to 255 control characters.

The string to be displayed on the label of IM management node is the string to be displayed on the label of IM management node in Remote Monitoring service SID with a control character and a character other than a colon. Because a colon is a delimiter, if specified, the string after the last specified colon is subject to the string labeled IM management node. When URL is encoded, the character string must be 234 bytes or less (the upper limit for multibyte characters is 26).

Specify a colon delimiter between the install Host name and the string labeled in IM management node. If not specified, it performs considering Installed Host name and the text labeled in IM management node identical.

If you omit this option, the utility does not create an Remote Monitoring serviced SID.

jp1_pc_rm_agent_create_flag: Remote agent SIDs Creation Flag

Specify this option only for Exporter monitored by remote. Specify true or false. It is not case sensitive. If no jp1_pc_remote_monitor_instance is specified, this Setup is ignored.

• true

  Create a IM management node for "Remote agent SID" in units of "agent host SID" and "Monitored Host name: Any String".

• false

  Do not create IM management node for "Remote agent SID" in units of "agent host SID" and "Monitored Host name: Any String".

If a character other than true or false is specified, or the specified character is omitted, the utility assumes that true is specified.

jp1_pc_agent_create_flag: creation flag of agent SID

Specify this option only for Exporter is monitoring the host where Exporter is installed. Specify true or false. It is not case sensitive. If the jp1_pc_remote_monitor_instance is specified, this Setup is ignored.

• true

  Create a IM management node for "agent SID" in units of "Monitored Host name: Any String".

• false

  Do not create a IM management node for agent SID in units of "Monitored Host name: Any String".

If a character other than true or false is specified, or the specified character is omitted, the utility assumes that true is specified.

jp1_pc_multiple_node: Condition for Get Label Set for Multiple IM management node Creation

Specifies that more than one IM management node (agent SIDs or Remote agent SIDs) is to be created for the "Monitored Host name: Any String." Specifies the conditions to obtain the labels required to create IM management node from Trend data Management Database.

You can specify only one condition. For details about Value that can be specified, see the description of match parameter in 4.5.18 jp1TrendDataService.getLabelList.

If this option is omitted, the utility does not create more than one IM management node (agent SIDs or Remote agent SIDs) for the "Monitored Host name: Any String".

To Page Top

Example definition

- targets:
  - hostA:9256
  labels:
    jp1_pc_exporter: Process Exporter
    jp1_pc_category: platform
    jp1_pc_trendname: process

To Page Top