Blackbox exporter metric definition file (metrics_blackbox_exporter.conf)

Organization of this page

Format
File
Storage directory
Description
Character code
Line feed code
When the definitions are applied
Information that is specified
Model file settings (initial state) and alert definition example

Format

[
  {
    "name":"trend-data-metric-names",
    "default":default-selection-state
    "promql":"PromQL-statement",
    "resource_en":{
      "category":"metric-category-(English)",
      "label":"metric-display-name-(English)",
      "description":"metric-description-(English)",
      "unit":"metric-unit-(English)"
    },
    "resource_ja":{
      "category":"metric-category-(Japanese)",
      "label":"metric-display-name-(Japanese)",
      "description":"metric-description-(Japanese)",
      "unit":"metric-unit-(Japanese)"
    },
    "module": "module name",
    "drop_legend_labels": ["label name", ...]
  }, ...
]^#

#: The number of elements that can be described in [] is 1 to 1,000. If an out-of-range number of elements is described, a KAJY24609-E error message is output.

To Page Top

File

metrics_blackbox_exporter.conf

metrics_blackbox_exporter.conf.model (model file)

To Page Top

Storage directory

■Integrated manager host

In Windows:

For a physical host

Manager-path\conf\imdd\plugin\jp1pccs\
For a logical host

shared-folder\jp1imm\conf\imdd\plugin\jp1pccs\

In Linux:

For a physical host

/etc/opt/jp1imm/conf/imdd/plugin/jp1pccs/
For a logical host

shared-directory/jp1imm/conf/imdd/plugin/jp1pccs/

To Page Top

Description

This file defines the Blackbox exporter metric information displayed on the Trends tab of the Integrated Operation Viewer window.

The defined contents are used for the return values of __metricListGet method and __timeSeriesDataGet method of the JP1/IM - Agent product plug-in.

If JP1/IM - Manager is in a hierarchical configuration and you want to refer to trend data stored in Trend data Management Database of lower manager from Integrated manager, you must add trend data metrics that you want to refer to metric definition file of Integrated manager.

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

This is reflected when metric is acquired on the [Trend] tab of Integrated Operation Viewer window or REST API.

To Page Top

Information that is specified

The following value is setup to module membership. For values that setup to other members, see the Information that is specified section in Node exporter metric definition file (metrics_node_exporter.conf).

Table 2‒96: Value to setup for module members of metric definition File
Member name	Optional	Type	Value to set
module	Yes	string	Set the value of module of the IM management node that returns this metric to a string that matches the forward. This member is optional for Blackbox exporter metrics definition files only. Specify 1~255 characters except control characters (0x00~0x1F, 0x7F~0x9F). If it contains characters that cannot be specified, a KAJY24604-E or KAJY24605-E error message is printed. If omitted, this metric is returned for all remote agent SIDs of the Blackbox exporter. The IM management node's module value is the value specified for module in the Prometheus configuration file (jpc_prometheus_server.yml) scrape job. This value is also displayed in the Module property of the Blackbox exporter's Remote Agent SID. Example 1: http Example 2: ICMP

To Page Top

Model file settings (initial state) and alert definition example

The setting contents (initial state) and alert definition example (alert setting file) of each metric described in the model file of the Blackbox exporter metric definition file are shown below.

probe_success

■Configuration contents (default status)

Member name		Configuration contents (default status)
name		probe_success
default		false
The promql for metric definition File (including $jp1im_TrendData_labels)		probe_success and $jp1im_TrendData_labels
resource_en	category	probe
	label	Probe success or failure
	description	Displays whether or not the probe was a success
	unit	-
resource_ja	category	probe
	label	プローブ成否
	description	プローブが成功したかどうかを表示します。 0：失敗 1：成功
	unit	-
module		Do not specify

■Examples of Alert definitions^#

groups:
  - name: blackbox_exporter
    rules:
    - alert: probe_success(Blackbox exporter)
      expr: 0 == probe_success
      for: 3m
      labels:
        jp1_pc_product_name: "/HITACHI/JP1/JPCCS2"
        jp1_pc_component: "/HITACHI/JP1/JPCCS/CONFINFO"
        jp1_pc_severity: "Error"
        jp1_pc_eventid: "0501"
        jp1_pc_metricname: "probe_success"
      annotations:
        jp1_pc_firing_description: "通信に失敗しました。value={{ $value }}"
        jp1_pc_resolved_description: "通信に成功しました。"

#: If you define more than one alert in the same monitoring agent host, be careful not to specify duplicate "groups:" or duplicate name with the same group-name.

probe_duration_seconds

■Configuration contents (default status)

Member name		Configuration contents (default status)
name		probe_duration_seconds
default		true
The promql for metric definition File (including $jp1im_TrendData_labels)		probe_duration_seconds and $jp1im_TrendData_labels
resource_en	category	probe
	label	Probe period
	description	Returns how long the probe took to complete in seconds
	unit	second
resource_ja	category	probe
	label	プローブ期間
	description	プローブが完了するまでに要した時間を秒単位で返します。
	unit	秒
module		Do not specify

■Examples of Alert definitions^#

groups:
  - name: blackbox_exporter
    rules:
    - alert: probe_duration_seconds(Blackbox exporter)
      expr: 5 < probe_duration_seconds
      for: 3m
      labels:
        jp1_pc_product_name: "/HITACHI/JP1/JPCCS2"
        jp1_pc_component: "/HITACHI/JP1/JPCCS/CONFINFO"
        jp1_pc_severity: "Error"
        jp1_pc_eventid: "0502"
        jp1_pc_metricname: "probe_duration_seconds"
      annotations:
        jp1_pc_firing_description: "プローブ期間がしきい値(5秒)を上回りました。value={{ $value }}秒"
        jp1_pc_resolved_description: "プローブ期間がしきい値(5秒)を下回りました。"

#: If you define more than one alert in the same monitoring agent host, be careful not to specify duplicate "groups:" or duplicate name with the same group-name.

probe_icmp_duration_seconds

■Configuration contents (default status)

Member name		Configuration contents (default status)
name		probe_icmp_duration_seconds
default		true
The promql for metric definition File (including $jp1im_TrendData_labels)		probe_icmp_duration_seconds and $jp1im_TrendData_labels
resource_en	category	probe
	label	ICMP period
	description	Duration of icmp request
	unit	second
resource_ja	category	probe
	label	ICMP期間
	description	フェーズごとのICMP要求の期間
	unit	秒
module		icmp

■Examples of Alert definitions^#

groups:
  - name: blackbox_exporter
    rules:
    - alert: probe_icmp_duration_seconds(Blackbox exporter)
      expr: 3 < probe_icmp_duration_seconds
      for: 3m
      labels:
        jp1_pc_product_name: "/HITACHI/JP1/JPCCS2"
        jp1_pc_component: "/HITACHI/JP1/JPCCS/CONFINFO"
        jp1_pc_severity: "Error"
        jp1_pc_eventid: "0503"
        jp1_pc_metricname: "probe_icmp_duration_seconds"
      annotations:
        jp1_pc_firing_description: "ICMP期間がしきい値(3秒)を上回りました。value={{ $value }}秒，phase={{ $labels.phase }}"
        jp1_pc_resolved_description: "ICMP期間がしきい値(3秒)を下回りました。"

#: If you define more than one alert in the same monitoring agent host, be careful not to specify duplicate "groups:" or duplicate name with the same group-name.

probe_http_duration_seconds

■Configuration contents (default status)

Member name		Configuration contents (default status)
name		probe_http_duration_seconds
default		true
The promql for metric definition File (including $jp1im_TrendData_labels)		probe_http_duration_seconds and $jp1im_TrendData_labels
resource_en	category	probe
	label	HTTP request period
	description	Duration of http request by phase, summed over all redirects
	unit	second
resource_ja	category	probe
	label	HTTPリクエスト期間
	description	フェーズごとのHTTPリクエストの期間，すべてのリダイレクトで合計
	unit	秒
module		http

■Examples of Alert definitions^#

groups:
  - name: blackbox_exporter
    rules:
    - alert: probe_http_duration_seconds(Blackbox exporter)
      expr: 3 < probe_http_duration_seconds
      for: 3m
      labels:
        jp1_pc_product_name: "/HITACHI/JP1/JPCCS2"
        jp1_pc_component: "/HITACHI/JP1/JPCCS/CONFINFO"
        jp1_pc_severity: "Error"
        jp1_pc_eventid: "0504"
        jp1_pc_metricname: "probe_http_duration_seconds"
      annotations:
        jp1_pc_firing_description: "HTTPリクエスト期間がしきい値(3秒)を上回りました。value={{ $value }}秒，phase={{ $labels.phase }}"
        jp1_pc_resolved_description: "HTTPリクエスト期間がしきい値(3秒)を下回りました。"

#: If you define more than one alert in the same monitoring agent host, be careful not to specify duplicate "groups:" or duplicate name with the same group-name.

probe_http_status_code

■Configuration contents (default status)

Member name		Configuration contents (default status)
name		probe_http_status_code
default		false
The promql for metric definition File (including $jp1im_TrendData_labels)		probe_http_status_code and $jp1im_TrendData_labels
resource_en	category	probe
	label	HTTP status
	description	Response HTTP status code
	unit	-
resource_ja	category	probe
	label	HTTPステータス
	description	HTTPレスポンスステータスコード
	unit	-
module		http

■Examples of Alert definitions^#

groups:
  - name: blackbox_exporter
    rules:
    - alert: probe_http_status_code(Blackbox exporter)
      expr: 200 != probe_http_status_code
      for: 3m
      labels:
        jp1_pc_product_name: "/HITACHI/JP1/JPCCS2"
        jp1_pc_component: "/HITACHI/JP1/JPCCS/CONFINFO"
        jp1_pc_severity: "Error"
        jp1_pc_eventid: "0505"
        jp1_pc_metricname: "probe_http_status_code"
      annotations:
        jp1_pc_firing_description: "HTTPステータスが200ではありません。value={{ $value }}"
        jp1_pc_resolved_description: "HTTPステータスが200になりました。"

#: If you define more than one alert in the same monitoring agent host, be careful not to specify duplicate "groups:" or duplicate name with the same group-name.

To Page Top