Hitachi

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


Windows exporter configuration file (jpc_windows_exporter.yml)

Organization of this page

Format

Write in YAML format.

collectors:
  enabled: cache,cpu,logical_disk,memory,net,system,cs,process,service#
collector:
  logical_disk:
    volume-whitelist: ".+"
    volume-blacklist: ""
  net:
    nic-whitelist: ".+"
    nic-blacklist: ""
  process:
    process-whitelist: ""
    process-blacklist: ""
  service:#
    services-where: "Name=''"
scrape:
  timeout-margin: 0.5
#

Parameters for service monitoring that are set in the model file by JP1/IM - Agent 13-01 or later installer.

If you want to use the service monitoring feature by upgrading from JP1/IM - Agent 13-00 to 13-01 or later, you can manually set and edit the service monitoring parameters. For details, see the instructions for configuring service monitoring in 1.21.2(5)(b) Modify metric to Collect (Optional) in the JP1/Integrated Management 3 - Manager Configuration Guide.

File

jpc_windows_exporter.yml

jpc_windows_exporter.yml.model (model file)

Storage directory

■Integrated agent host
  • For a physical host

    Agent-path\conf\

  • For a logical host

    shared-folder\jp1ima\conf\

Description

This is a configuration file that specifies the operation of Windows exporter.

Character code

UTF-8 (without BOM)

Line feed code

In Windows: CR+LF

In Linux: LF

When the definitions are applied

It will take effect when you restart Windows exporter.

Information that is specified

Item

Description

Changeability

What You Setup in Your JP1/IM - Agent

JP1/IM - Agent Defaults Value

collectors

--

--

--

--

enabled

Specify the collectors to use, separated by commas.

  • For 13-00

    N

  • For 13-01 or later

Y

--

  • For 13-00

    collectors:

    enabled:cache,cpu,logical_disk,memory,net,system,cs,process

  • For 13-01 or later

    collectors:

enabled:cache,cpu,logical_disk,memory,net,system,cs,process,service

dfsr

--

--

--

--

exchange

--

--

--

--

mssql

--

--

--

--

collector

--

--

--

--

iis

--

--

--

--

logical_disk

--

--

--

--

volume-whitelist

Set the volume to be collected using a regular expression.

Volumes that fall into both volume-whitelist and volume-blacklist are not collected (volume-blacklist takes precedence).

Y

Specify the volume to the whitelist with a regular expression.

collector:

logical_disk:

volume-whitelist: ".+"

volume-blacklist

Set the volumes not to be collected by regular expression.

Volumes that fall into both volume-whitelist and volume-blacklist are not collected (volume-blacklist takes precedence).

Y

Specify the volume to the blacklist with a regular expression.

collector:

logical_disk:

volume-blacklist: ""

msmq

--

--

--

--

net

--

--

--

--

nic-whitelist

Set the NICs to be collected using regular expressions.

NICs that fall into both nic-whitelist and nic-blacklist are not collected (nic-blacklist takes precedence).

The name of the NIC specified in this item must be the value obtained by the following command.

wmic path Win32_PerfRawData_Tcpip_NetworkInterface get name

Note that this item is treated as a regular expression, so if you want to specify a special character of the regular expression, you need to escape it with a backslash. In this case, the backslash is treated as a special character in YAML, so it is necessary to write the backslash twice.

(Example description)

If you want to specify "Intel[R] Dual Band Wireless-AC 8265" as an exact match

nic-whitelist: "Intel\\[R\\] Dual Band Wireless-AC 8265"

Y

Specify the NICs to the whitelist as a regular expression.

collector:

net:

nic-whitelist: ".+"

nic-blacklist

Set the NICs not to be collected using regular expressions.

NICs that fall into both nic-whitelist and nic-blacklist are not collected (nic-blacklist takes precedence).

This entry is specified in the same way as nic-whitelist.

Y

Specify the NICs to the blacklist with regular expressions.

collector:

net:

nic-blacklist: ""

process

--

--

--

--

whitelist

Regexp of volumes to whitelist.

Volume name must both match whitelist and not match blacklist to be included.

If omitted, this is specified as ".+".

Y

--

collector:

process:

whitelist: ""

blacklist

Regexp of volumes to blacklist.

Volume name must both match whitelist and not match blacklist to be included.

If omitted, this is specified as "".

Y

--

collector:

process:

blacklist: ""

service

--

--

--

--

services-where

Specifies 'where' phrase for WQL to use in WMI metric queries.

(Example of specification when monitoring multiple services)

services-where: "Name='jpc_imagent' OR Name='jpc_imagentproxy' OR Name='jpc_imagentaction'"

#

If an invalid character string is specified, the service is not monitored. For details about the log output, see 12.5.1(4) node_exporter log in the JP1/Integrated Management 3 - Manager Administration Guide.

Y

Specifies the service name to monitor.

services-where: "Name=''"

smtp

--

--

--

--

textfile

--

--

--

--

log

--

--

--

--

scrape

--

--

--

--

timeout-margin

Specifies the number of seconds to subtract from the Prometheus scrape_timeout value (specify a value that is less than the Prometheus scrape_timeout value).

It will time out in seconds after subtracting the value specified for this item from the value of the Prometheus scrape_timeout.

For Prometheus scrape_timeout values, see the scrape_timeout in Information that is specified of Prometheus configuration file (jpc_prometheus_server.yml).

Y

Tolerance for overhead or high load is usually not required. Use to tune to allow for overhead or high load.

scrape:

timeout-margin: 0.5

Legend:

Y: Changeable, N: Not changeable, --: Not applicable