Hitachi

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


[Figure]Web exporter discovery configuration file (jpc_file_sd_config_web.yml)

Organization of this page

Format

Write in YAML format.

- targets:
  - monitored hostname:IM management node label name:Web scenario filename
  labels:
    jp1_pc_exporter: JPC Web exporter
    jp1_pc_category: serviceResponse
    jp1_pc_trendname: web_exporter
    jp1_pc_remote_monitor_instance: install-host-name:Synthetic web metric collector(Web exporter)

File

jpc_file_sd_config_web.yml

jpc_file_sd_config_web.yml.model (model file)

file_sd_config_web_any-name.yml (created by user)

Storage directory

- Integrated agent host

In Windows:

  • For a physical host (difinition file or model file)

    Agent-path\conf\

  • For a logical host (difinition file)

    shared-folder\jp1ima\conf\

Description

This is a file that configures the Web exporter that Prometheus server scrapes.

If you have added a new scrape job in Prometheus configuration file to monitor Web scenarios, copy the model file for this file and create a discovery configuration file with the following name:

file_sd_config_web_any-name.yml

Character code

UTF-8 (without BOM)

Line feed code

CR+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

- Monitored hostname:IM management node label name:Web scenario filename

Specify the monitored hostname, IM management node label name, and Web scenario filename separated by ":" (colon).

The monitored hostname is a character other than 1 to 255 control characters and specifies the host name of the monitored Web servers. You can also specify FQDN format. "localhost" cannot be specified. In targets, the same name cannot be described more than once in IM management node label name and Web scenario filename. When creating a user-specific Web exporter discovery configuration file (file_sd_config_web_any-name.yml), the same name as IM management node label name and Web scenario filename described in the targets of the another Web exporter discovery configuration file cannot be described.

The IM management node label name is ":" (colon) and a character that does not contain any control characters, and specifies the string to be displayed in the label name of IM management node in integrated operation viewer. When URL is encoded, the character string must be 234 bytes or less (the upper limit for multibyte characters is 26).

The Web scenario filename specifies Web scenario file to use for testing.

Specify "Monitored hostname:IM management node label name:Web scenario filename" in characters other than 1 to 2,574 control characters.

Example definition

- targets:
  - web1:Web2ApplicationA:webscena1.spec.ts
  - web2:Web2ApplicationB:webscena2.spec.ts
  labels:
    jp1_pc_exporter: JPC Web exporter
    jp1_pc_category: serviceResponse
    jp1_pc_trendname: web_exporter
    jp1_pc_remote_monitor_instance: hostname1:Synthetic web metric collector(Web exporter)