Hitachi

JP1 Version 13 JP1/Integrated Management 3 - Manager Command, Definition File and API Reference


Blackbox exporter (ICMP monitoring) discovery configuration file (jpc_file_sd_config_blackbox_icmp.yml)

Organization of this page

Format

Write in YAML format.

- targets:
  - Host name or IP address of the monitored host
  ...
  labels:
    jp1_pc_exporter: JPC Blackbox Exporter
    jp1_pc_category: platform
    jp1_pc_trendname: blackbox_exporter
    jp1_pc_remote_monitor_instance: install-host-name: Synthetic metric collector(Blackbox exporter)

File

jpc_file_sd_config_blackbox_icmp.yml

jpc_file_sd_config_blackbox_icmp.yml.model (model file)

file_sd_config_blackbox_module-name-start-with-icmp.yml (user-created)

Storage 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/

Description

This file configures the Blackbox exporter that Prometheus server scrapes with ICMP monitoring.

If you have newly defined a module in Process exporter configuration file (jpc_blackbox_exporter.yml) ICMP monitoring, create a discovery configuration file with the following name and Copy the model File for this discovery configuration file, depending on the target:

file_sd_config_blackbox_module-name.yml

For details on Blackbox exporter monitoring setup, see 1.21.2(6) Setup of Blackbox exporter in the JP1/Integrated Management 3 - Manager Configuration Guide.

Character code

UTF-8 (without BOM)

Line feed code

In Windows: CR+LF

In Linux: LF

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.

Information that is specified

- Host name or IP address of the monitored host

Specifies the host name or IP address of the monitored host in characters other than 1 to 2,595 control characters. You can also specify the FQDN format. "localhost" cannot be specified.

When displayed in the Integrated Operations Viewer, the string specified for the host name or internet address of the monitored host is displayed as the label of the IM management node of the agent host SID. If you want to specify an IP address for the host to be monitored and display the host name in the label of the IM management node, set the host name definition file (imdd_host_name.conf) of JP1/IM - Manager and map the IP address to the host name. For details about the host name definition file, see Host name definition file (imdd_host_name.conf).

Example definition

- targets:
  - hostB
  - hostC
  labels:
    jp1_pc_exporter: JPC Blackbox Exporter
    jp1_pc_category: platform
    jp1_pc_trendname: blackbox_exporter
    jp1_pc_remote_monitor_instance: hostA: Synthetic metric collector(Blackbox exporter)