Windows exporter metric definition file (metrics_windows_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

See the Format section in Node exporter metric definition file (metrics_node_exporter.conf).

To Page Top

File

metrics_windows_exporter.conf

metrics_windows_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 Windows exporter metric information displayed on the Trends tab of the Integrated Operation Viewer window.

The defined contents are used for the return values of JP1/IM - __metricListGet method and __timeSeriesDataGet method of the 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

It is reflected when metric information is obtained on the [Trend] tab of the Integrated Operation Viewer window or in the REST API.

To Page Top

Information that is specified

See the Information that is specified section in Node exporter metric definition file (metrics_node_exporter.conf).

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 Windows exporter metric definition file are shown below.

cpu_used_rate^#

■Configuration contents (default status)

Member name		Configuration contents (default status)
name		cpu_used_rate
default		true
The promql for metric definition File (including $jp1im_TrendData_labels)		100 - (avg by (instance,job,jp1_pc_nodelabel,jp1_pc_prome_hostname) (irate(windows_cpu_time_total{mode=`\`"idle`\`"}[2m]) and $jp1im_TrendData_labels) * 100)
resource_en	category	platform_windows
	label	CPU used rate
	description	Processor usage. Percentage of elapsed time used by the processor for executing non-idle threads. [Units: %]
	unit	%
resource_ja	category	platform_windows
	label	CPU使用率
	description	プロセッサの使用率。プロセッサが非アイドル状態のスレッドを実行した経過時間の割合。（単位:%）
	unit	%

#: JP1/PFM - Equivalent to the CPU % field in the PI record of the Agent for Platform (Windows).

■Examples of Alert definitions^#

groups:
  - name: windows_exporter
    rules:
    - alert: cpu_used_rate(Windows exporter)
      expr: 80 < 100 - (avg by (instance,job,jp1_pc_nodelabel,jp1_pc_exporter) (irate(windows_cpu_time_total{mode="idle"}[2m])) * 100)
      for: 3m
      labels:
        jp1_pc_product_name: "/HITACHI/JP1/JPCCS2"
        jp1_pc_component: "/HITACHI/JP1/JPCCS/CONFINFO"
        jp1_pc_severity: "Error"
        jp1_pc_eventid: "0401"
        jp1_pc_metricname: "windows_cpu_time_total"
      annotations:
        jp1_pc_firing_description: "CPU utilization exceeded threshold (80%).value={{ $value }}%"
        jp1_pc_resolved_description: "CPU usage has dropped below the threshold (80%)."

#: 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.

memory_unused^#

■Configuration contents (default status)

Member name		Configuration contents (default status)
name		memory_unused
default		false
The promql for metric definition File (including $jp1im_TrendData_labels)		(windows_memory_available_bytes and $jp1im_TrendData_labels) / (1024*1024)
resource_en	category	platform_windows
	label	Memory unused
	description	Available size in the physical memory area. The combined total of zero memory, free memory, and standby memory (cached) that can be immediately allocated to a process or be used by the system. [Units: MB]
	unit	MB
resource_ja	category	platform_windows
	label	空きメモリ量
	description	物理メモリー領域の未使用サイズ。プロセスへの割り当て，またはシステムがすぐに利用できるゼロメモリー，空きメモリー，およびスタンバイメモリー（キャッシュ済み）の領域の合計。（単位:メガバイト）
	unit	メガバイト

#: JP1/PFM - Equivalent to the Available Mbytes field in the PI record of the Agent for Platform (Windows).

■Examples of Alert definitions^#

groups:
  - name: windows_exporter
    rules:
    - alert: memory_unused(Windows exporter)
      expr: 1024 > windows_memory_available_bytes / (1024*1024)
      for: 3m
      labels:
        jp1_pc_product_name: "/HITACHI/JP1/JPCCS2"
        jp1_pc_component: "/HITACHI/JP1/JPCCS/CONFINFO"
        jp1_pc_severity: "Error"
        jp1_pc_eventid: "0402"
        jp1_pc_metricname: "windows_memory_available_bytes"
      annotations:
        jp1_pc_firing_description: "The amount of free memory has fallen below the threshold (1024 megabytes).value={{ $value }}Mb"
        jp1_pc_resolved_description: "The amount of free memory exceeded the threshold (1024 megabytes)."

#: 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.

memory_unused_rate^#

■Configuration contents (default status)

Member name		Configuration contents (default status)
name		memory_unused_rate
default		false
The promql for metric definition File (including $jp1im_TrendData_labels)		(windows_memory_available_bytes and $jp1im_TrendData_labels) / (windows_cs_physical_memory_bytes and $jp1im_TrendData_labels) * 100
resource_en	category	platform_windows
	label	Available memory percentage
	description	Percentage of available physical memory
	unit	%
resource_ja	category	platform_windows
	label	空きメモリ率
	description	物理メモリの空き容量の割合。
	unit	%

#: There are no fields fall under JP1/PFM - Agent for Platform (Windows).

■Examples of Alert definitions^#

groups:
  - name: windows_exporter
    rules:
    - alert: memory_unused_rate(Windows exporter)
      expr: windows_memory_available_bytes / windows_cs_physical_memory_bytes * 100 < 10
      for: 3m
      labels:
        jp1_pc_product_name: "/HITACHI/JP1/JPCCS2"
        jp1_pc_component: "/HITACHI/JP1/JPCCS/CONFINFO"
        jp1_pc_severity: "Error"
        jp1_pc_eventid: "0402"
        jp1_pc_metricname: "windows_memory_available_bytes,windows_cs_physical_memory_bytes"
      annotations:
        jp1_pc_firing_description: "Free-memory ratio has fallen below threshold value (10%). value={{$value}} megabytes"
        jp1_pc_resolved_description: "Free-memory ratio exceeded threshold value (10%). "

#: 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.

disk_unused^#

■Configuration contents (default status)

Member name		Configuration contents (default status)
name		disk_unused
default		false
The promql for metric definition File (including $jp1im_TrendData_labels)		(windows_logical_disk_free_bytes and $jp1im_TrendData_labels) / (1024*1024)
resource_en	category	platform_windows
	label	Unused disk space percentage
	description	Percentage of unused disk space
	unit	MB
resource_ja	category	platform_windows
	label	空きディスク領域
	description	ディスクの未使用領域のサイズ。（単位:メガバイト）
	unit	メガバイト

#: JP1/PFM - Equivalent to the Free Mbytes field in the Agent for Platform (Windows) PI_LOGD record.

■Examples of Alert definitions^#

groups:
  - name: windows_exporter
    rules:
    - alert: disk_unused(Windows exporter)
      expr: 10240 > windows_logical_disk_free_bytes{volume!~"HarddiskVolume.*"} / (1024*1024)
      for: 3m
      labels:
        jp1_pc_product_name: "/HITACHI/JP1/JPCCS2"
        jp1_pc_component: "/HITACHI/JP1/JPCCS/CONFINFO"
        jp1_pc_severity: "Error"
        jp1_pc_eventid: "0403"
        jp1_pc_metricname: "windows_logical_disk_free_bytes"
      annotations:
        jp1_pc_firing_description: "Free disk space has fallen below the threshold (10240 megabytes).value={{ $value }}MB，volume={{ $labels.volume }}"
        jp1_pc_resolved_description: "Free disk space exceeded threshold (10240 megabytes).volume={{ $labels.volume }}"

#: 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.

disk_unused_rate^#

■Configuration contents (default status)

Member name		Configuration contents (default status)
name		disk_unused_rate
default		false
The promql for metric definition File (including $jp1im_TrendData_labels)		(windows_logical_disk_free_bytes and $jp1im_TrendData_labels) / (windows_logical_disk_size_bytes and $jp1im_TrendData_labels) * 100
resource_en	category	platform_windows
	label	Unused disk space percentage
	description	Percentage of unused disk space
	unit	%
resource_ja	category	platform_windows
	label	空きディスク率
	description	ディスクの未使用領域の割合。
	unit	%

#: Equivalent to the % Free Space field in the PI_LOGD record for JP1/PFM - Agent for Platform (Windows).

■Examples of Alert definitions^#

groups:
  - name: windows_exporter
    rules:
    - alert: disk_unused(Windows exporter)
      expr: windows_logical_disk_free_bytes{volume!~"HarddiskVolume.*"} / windows_logical_disk_size_bytes * 100 < 10
      for: 3m
      labels:
        jp1_pc_product_name: "/HITACHI/JP1/JPCCS2"
        jp1_pc_component: "/HITACHI/JP1/JPCCS/CONFINFO"
        jp1_pc_severity: "Error"
        jp1_pc_eventid: "0403"
        jp1_pc_metricname: "windows_logical_disk_free_bytes,windows_logical_disk_size_bytes"
      annotations:
        jp1_pc_firing_description: "Free disk percentage has fallen below threshold value (10%). value={{$value}} megabytes, volume={{$labels.volume}}"
        jp1_pc_resolved_description: "Free disk percentage exceeds threshold value (10%). volume={{$labels.volume}}"

#: 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.

disk_busy_rate^#

■Configuration contents (default status)

Member name		Configuration contents (default status)
name		disk_busy_rate
default		false
The promql for metric definition File (including $jp1im_TrendData_labels)		100 - (rate(windows_logical_disk_idle_seconds_total[2m]) and $jp1im_TrendData_labels)/((rate(windows_logical_disk_write_seconds_total[2m]) and $jp1im_TrendData_labels) + (rate(windows_logical_disk_read_seconds_total[2m]) and $jp1im_TrendData_labels) + (rate(windows_logical_disk_idle_seconds_total[2m]) and $jp1im_TrendData_labels)) * 100
resource_en	category	platform_windows
	label	Disk busy rate
	description	Percentage of time the disk was busy when a read or write request was processed. [Units: %]
	unit	%
resource_ja	category	platform_windows
	label	ディスクビジー率
	description	読み込みおよび書き込み要求の処理でディスクがビジーだった経過時間の割合。（単位:%）
	unit	%

#: JP1/PFM - Equivalent to the % Disk Time field in the Agent for Platform (Windows) PI_PHYD record.

■Examples of Alert definitions^#

groups:
  - name: windows_exporter
    rules:
    - alert: disk_busy_rate(Windows exporter)
      expr: 70 < 100 - rate(windows_logical_disk_idle_seconds_total{volume!~"HarddiskVolume.*"}[2m])/(rate(windows_logical_disk_write_seconds_total[2m]) + rate(windows_logical_disk_read_seconds_total[2m])+rate(windows_logical_disk_idle_seconds_total[2m])) * 100
      for: 3m
      labels:
        jp1_pc_product_name: "/HITACHI/JP1/JPCCS2"
        jp1_pc_component: "/HITACHI/JP1/JPCCS/CONFINFO"
        jp1_pc_severity: "Error"
        jp1_pc_eventid: "0404"
        jp1_pc_metricname: "windows_logical_disk_idle_seconds_total,windows_logical_disk_write_seconds_total,windows_logical_disk_read_seconds_total"
      annotations:
        jp1_pc_firing_description: "Disk busy rate exceeded threshold (70%).value={{ $value }}%，volume={{ $labels.volume }}"
        jp1_pc_resolved_description: "The disk busy rate has fallen below the threshold (70%).volume={{ $labels.volume }}"

#: 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.

disk_read_latency^#

■Configuration contents (default status)

Member name		Configuration contents (default status)
name		disk_read_latency
default		false
The promql for metric definition File (including $jp1im_TrendData_labels)		(rate(windows_logical_disk_read_seconds_total[2m]) and $jp1im_TrendData_labels) / (rate(windows_logical_disk_reads_total[2m]) and $jp1im_TrendData_labels)
resource_en	category	platform_windows
	label	Disk read latency
	description	Average time (in seconds) taken to perform a single disk read operation
	unit	second
resource_ja	category	platform_windows
	label	ディスク読み込みレイテンシー
	description	1回あたりのディスク読み込みにかかった平均時間（秒）。
	unit	秒

#: Equivalent to Avg Disk Secs/Read field in the PI_LOGD record in JP1/PFM - Agent for Platform (Windows).

■Examples of Alert definitions^#

groups:
  - name: windows_exporter
    rules:
    - alert: disk_read_latency(Windows exporter)
      expr: rate(windows_logical_disk_read_seconds_total[2m] / rate(windows_logical_disk_reads_total[2m]) > 0.1 and rate(windows_logical_disk_reads_total[2m]) > 0
      for: 3m
      labels:
        jp1_pc_product_name: "/HITACHI/JP1/JPCCS2"
        jp1_pc_component: "/HITACHI/JP1/JPCCS/CONFINFO"
        jp1_pc_severity: "Error"
        jp1_pc_eventid: "0404"
        jp1_pc_metricname: "windows_logical_disk_read_seconds_total,windows_logical_disk_reads_total"
      annotations:
        jp1_pc_firing_description: "Disk read latency exceeds the threshold Value (0.1 seconds). value={{$value}}%, volume={{$labels.volume}}"
        jp1_pc_resolved_description: "Disc read latency has fallen below threshold value (0.1 seconds). volume={{$labels.volume}}"

#: 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.

disk_write_latency^#

■Configuration contents (default status)

Member name		Configuration contents (default status)
name		disk_write_latency
default		false
The promql for metric definition File (including $jp1im_TrendData_labels)		(rate(windows_logical_disk_write_seconds_total[2m]) and $jp1im_TrendData_labels) / (rate(windows_logical_disk_writes_total[2m]) and $jp1im_TrendData_labels)
resource_en	category	platform_windows
	label	Disk write latency
	description	Average time (in seconds) taken to perform a single disk write operation
	unit	second
resource_ja	category	platform_windows
	label	ディスク書き込みレイテンシー
	description	1回あたりのディスク書き込みにかかった平均時間（秒）。
	unit	秒

#: Equivalent to Avg Disk Secs/Write field in the PI_LOGD record in JP1/PFM - Agent for Platform (Windows).

■Examples of Alert definitions^#

groups:
  - name: windows_exporter
    rules:
    - alert: disk_write_latency(Windows exporter)
      expr: rate(windows_logical_disk_write_seconds_total[2m] / rate(windows_logical_disk_writes_total[2m]) > 0.1 and rate(windows_logical_disk_writes_total[2m]) > 0
      for: 3m
      labels:
        jp1_pc_product_name: "/HITACHI/JP1/JPCCS2"
        jp1_pc_component: "/HITACHI/JP1/JPCCS/CONFINFO"
        jp1_pc_severity: "Error"
        jp1_pc_eventid: "0404"
        jp1_pc_metricname: "windows_logical_disk_write_seconds_total,windows_logical_disk_writes_total"
      annotations:
        jp1_pc_firing_description: "Disc burn latency exceeds the threshold Value (0.1 sec.). value={{$value}}%, volume={{$labels.volume}}"
        The jp1_pc_resolved_description: "Disc burn latency has fallen below the threshold value (0.1 seconds). volume={{$labels.volume}}"

#: 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.

disk_io_latency^#

■Configuration contents (default status)

Member name		Configuration contents (default status)
name		disk_io_latency
default		false
The promql for metric definition File (including $jp1im_TrendData_labels)		((rate(windows_logical_disk_read_seconds_total[2m]) and $jp1im_TrendData_labels) + (rate(windows_logical_disk_write_seconds_total[2m]) and $jp1im_TrendData_labels)) / ((rate(windows_logical_disk_reads_total[2m]) and $jp1im_TrendData_labels) + (rate(windows_logical_disk_writes_total[2m]) and $jp1im_TrendData_labels))
resource_en	category	platform_windows
	label	Disk I/O latency
	description	Average time (in seconds) taken to perform a single disk write and read operation
	unit	second
resource_ja	category	platform_windows
	label	ディスクIOレイテンシー
	description	1回あたりのディスク書き込みと読み込みにかかった平均時間（秒）。
	unit	秒

#: Equivalent to Avg Disk Secs/Xfer field in the PI_LOGD record in JP1/PFM - Agent for Platform (Windows).

■Examples of Alert definitions^#

groups:
  - name: windows_exporter
    rules:
    - alert: disk_io_latency(Windows exporter)
      expr: (rate(windows_logical_disk_read_seconds_total[2m]) + rate(windows_logical_disk_write_seconds_total[2m])) / (rate(windows_logical_disk_reads_total[2m]) + rate(windows_logical_disk_writes_total[2m])) > 0.1 and (rate(windows_logical_disk_writes_total[2m]) > 0 or rate(windows_logical_disk_reads_total[2m]) > 0)
      for: 3m
      labels:
        jp1_pc_product_name: "/HITACHI/JP1/JPCCS2"
        jp1_pc_component: "/HITACHI/JP1/JPCCS/CONFINFO"
        jp1_pc_severity: "Error"
        jp1_pc_eventid: "0404"
        jp1_pc_metricname: "windows_logical_disk_write_seconds_total,windows_logical_disk_writes_total"
      annotations:
        jp1_pc_firing_description: "Disk IO latency exceeded the threshold Value (0.1 seconds). value={{$value}}%、volume={{ $labels.volume }}"
        jp1_pc_resolved_description: "Disk IO latency has fallen below the threshold value (0.1 seconds). volume={{ $labels.volume }}"

#: 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.

network_sent^#

■Configuration contents (default status)

Member name		Configuration contents (default status)
name		network_sent
default		false
The promql for metric definition File (including $jp1im_TrendData_labels)		rate(windows_net_packets_sent_total[2m]) and $jp1im_TrendData_labels
resource_en	category	platform_windows
	label	Network sent
	description	Rate at which packets were sent through the network interface. [Units: packets/second]
	unit	packets/second
resource_ja	category	platform_windows
	label	ネットワークの送信速度
	description	ネットワークインターフェースで送信されるパケットの割合（パケット／秒）。
	unit	パケット/秒

#: JP1/PFM - Equivalent to the Pkts Sent/sec field in the Agent for Platform (Windows) PI_NETI record.

■Examples of Alert definitions^#

groups:
  - name: windows_exporter
    rules:
    - alert: network_sent(Windows exporter)
      expr: 100 < rate(windows_net_packets_sent_total[2m])
      for: 3m
      labels:
        jp1_pc_product_name: "/HITACHI/JP1/JPCCS2"
        jp1_pc_component: "/HITACHI/JP1/JPCCS/CONFINFO"
        jp1_pc_severity: "Error"
        jp1_pc_eventid: "0405"
        jp1_pc_metricname: "windows_net_packets_sent_total"
      annotations:
        jp1_pc_firing_description: "The network transmission speed exceeded the threshold (100 packets per second).value={{ $value }}パケット/秒，nic={{ $labels.nic }}"
        jp1_pc_resolved_description: "The network transmission speed has dropped below the threshold (100 packets per second).nic={{ $labels.nic }}"

#: 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.

network_received^#

■Configuration contents (default status)

Member name		Configuration contents (default status)
name		network_received
default		false
promql for metric definition files (including $jp 1im_TrendData_labels)		rate(windows_net_packets_received_total[2m]) and $jp1im_TrendData_labels
resource_en	category	platform_windows
	label	Network received
	description	Rate at which packets were received through the network interface. [Units: packets/second]
	unit	packets/second
resource_ja	category	platform_windows
	label	ネットワークの受信速度
	description	ネットワークインターフェースで受信されるパケットの割合（パケット／秒）。
	unit	パケット/秒

#: JP1/PFM - Equivalent to the Pkts Rcvd/sec field in the Agent for Platform (Windows) PI_NETI record.

■Examples of Alert definitions^#

groups:
  - name: windows_exporter
    rules:
    - alert: network_received(Windows exporter)
      expr: 100 < rate(windows_net_packets_received_total[2m])
      for: 3m
      labels:
        jp1_pc_product_name: "/HITACHI/JP1/JPCCS2"
        jp1_pc_component: "/HITACHI/JP1/JPCCS/CONFINFO"
        jp1_pc_severity: "Error"
        jp1_pc_eventid: "0406"
        jp1_pc_metricname: "windows_net_packets_received_total"
      annotations:
        jp1_pc_firing_description: "The network receive speed exceeded the threshold (100 packets per second).value={{ $value }}Packets/sec，nic={{ $labels.nic }}"
        jp1_pc_resolved_description: "The network receive speed has dropped below the threshold (100 packets per second).nic={{ $labels.nic }}"

#: 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