Blackbox exporter設定ファイル（jpc_blackbox_exporter.yml）

Modules

−

〇

−

−

module_name

任意のモジュール名を指定します。

作成済みのモジュールと異なる設定のモジュールを作成したい場合に指定します。モジュールを作成する場合，スクレイプ定義とディスカバリ設定ファイルも作成する必要があります。セットアップ手順については，マニュアル「JP1/Integrated Management 3 - Manager 構築ガイド」で，Windowsの場合は「1.21.2(6)Blackbox exporterの設定」および「1.21.2(3)(c)Blackbox exporterのスクレイプジョブを追加する（Windowsの場合）（オプション）」，Linuxの場合は「2.19.2(7)Blackbox exporterの設定」および「2.19.2(3)(c)Blackbox exporterのスクレイプジョブを追加する（Linuxの場合）（オプション）」を参照してください。

作成済みのモジュールで監視を行う場合は，新たにmodule_nameを定義する必要はなく，作成済みのディスカバリ設定ファイルのtargetsに，監視対象の情報を追加します。

＜設定例＞

modules:

http_2xx:

〇

−

初期設定として定義するモジュールについては，マニュアル「JP1/Integrated Management 3 - Manager 構築ガイド」の「1.21.2(6)Blackbox exporterの設定」および「2.19.2(7)Blackbox exporterの設定」を参照してください。

prober: <prober_string>

プローブを行うプロトコルを指定します。

httpまたはicmpを指定できます。

〇

httpまたはicmpを指定する。

なし

[ http: <http_probe> ]

httpプロトコルの設定を行います。

詳細については，下記の<http_probe>の項目を参照してください。

〇

特定のプロトコルのパラメーターを指定します。

指定なし

[ icmp: <icmp_probe> ]

icmpプロトコルの設定を行います。

詳細については，下記の<icmp_probe>の項目を参照してください。

〇

特定のプロトコルのパラメーターを指定します。

指定なし

<http_probe>

−

−

−

−

[ valid_status_codes: <int>, ... ]

許容するHTTPステータスコードを指定します。

指定を省略した場合や空値を指定した場合は，200番台を許容します。

＜設定例＞

valid_status_codes: [200, 201]

〇

200番台以外のステータスコードを正常と扱う場合に指定します。

指定なし

[ valid_http_versions: <string>, ... ]

許容するHTTPバージョンを指定します。

指定を省略した場合や空を指定した場合は，すべてを許容します。

＜設定例＞

valid_http_versions: ["HTTP/1.1", "HTTP/2"]

〇

許容するHTTPバージョンを限定したい場合に指定します。

指定なし

[ method: <string>]

利用するHTTPメソッドを指定します。

＜設定例＞

method: GET

〇

利用するHTTPメソッドを指定します。

GET

headers: [ <string>: <string> ... ]

HTTPリクエストのヘッダーを指定します。

「Accept-Encoding」ヘッダーを指定している場合は，ompressionの項目も参照してください。

＜設定例＞

headers:

Host: host.example.com

Accept-Language: en-US

〇

HTTPリクエストのヘッダーを指定します。

指定なし

[ compression: <string> ]

レスポンスを解凍するために使用する圧縮アルゴリズムを指定します。

gzip，br，deflate，identityを指定できます。

「Accept-Encoding」ヘッダーを指定する場合は，このオプションで指定した圧縮アルゴリズムが許容される必要があります。

〇

使用する圧縮アルゴリズムを指定します。

""

[ follow_redirects: <boolean>]

HTTPのリダイレクトに従うかどうかを指定します。

trueまたはfalseを指定できます。

〇

有効にする場合trueを指定します。

有効(true)

[ fail_if_ssl: <boolean>]

SSLが提示されたらプローブを失敗させるかどうかを指定します。

trueまたはfalseを指定できます。

〇

有効にする場合trueを指定します。

無効(false)

[ fail_if_not_ssl: <boolean>]

SSLが提示されなかったら失敗させるかどうかを指定します。

trueまたはfalseを指定できます。

〇

有効にする場合trueを指定します。

無効(false)

fail_if_body_matches_regexp:[ - <regex>, ... ]

応答本文にマッチする場合に不正と扱う正規表現を指定します。

応答本文が正規表現にマッチする場合にプローブ失敗となります。

マルチバイト文字は指定できません。

＜設定例＞

fail_if_body_matches_regexp:

- "Could not connect to database"

〇

応答本文の内容によってプローブを失敗させたい場合に指定します。

指定なし

fail_if_body_not_matches_regexp:[ - <regex>, ... ]

応答本文にマッチしない場合に不正と扱う正規表現を指定します。応答本文が正規表現にマッチしない場合にプローブ失敗となります。

マルチバイト文字は指定できません。

＜設定例＞

fail_if_body_not_matches_regexp:

- "Download the latest version here"

〇

応答本文の内容によってプローブを失敗させたい場合に指定します。

指定なし

fail_if_header_matches:[ - <http_header_match_spec>, ... ]

レスポンスヘッダーにマッチする場合に不正と扱う正規表現を指定します。レスポンスヘッダーが正規表現にマッチする場合にプローブ失敗となります。複数の値を持つヘッダーの場合は，少なくとも1つがマッチするときに失敗と扱います。

詳細については，下記の<http_header_match_spec>参照してください。

〇

レスポンスヘッダーの内容によってプローブを失敗させたい場合に指定します。

指定なし

fail_if_header_not_matches:[ - <http_header_match_spec>, ... ]

レスポンスヘッダーにマッチしない場合に不正と扱う正規表現を指定します。レスポンスヘッダーが正規表現にマッチしない場合にプローブ失敗となります。複数の値を持つヘッダーの場合は，すべてにマッチしないときに失敗と扱います。

詳細については，下記の<http_header_match_spec>を参照してください。

〇

レスポンスヘッダーの内容によってプローブを失敗させたい場合に指定します。

指定なし

tls_config:[ <tls_config> ]

HTTPプローブのTLSプロトコルの構成を設定します。

詳細については，下記の<tls_config>を参照してください。

〇

詳細については，<tls_config>の項目を参照してください。

次に示す値を指定します。

insecure_skip_verify: true

basic_auth:

ターゲットのHTTP基本認証の認証情報を設定します。

〇

−

なし

[ username: <string> ]

ターゲットにアクセスするためのユーザー名を指定します。

パスワードは，シークレット管理コマンドを使用して登録する必要があります。

〇

Basic認証の場合に指定します。

なし

[ proxy_url: <string> ]

監視対象への接続に使用するHTTPプロキシサーバを指定します。

形式:

http://ホスト名またはIPアドレス：ポート番号

〇

監視対象に接続するためにプロキシサーバを経由する場合に必要です。

なし

[ skip_resolve_phase_with_proxy: <boolean> ]

HTTPプロキシ（proxy_url）が設定されている場合に，Blackbox exporterが実施するDNS解決とURLの変更をスキップする場合はtrue，スキップしない場合はfalseを指定します。

例えば監視対象がhttps://www.example.com:1234でプロキシを経由する場合に，Blackbox exporterがDNS解決とURLの変更によりhttps://123.45.67.8:1234を使用してプロキシを通過しようとし，プロキシがhttps://www.example.com:1234しか許可しておらず監視対象に接続できない場合，trueを設定することで監視対象に接続できます。

指定がない場合はfalseになります。

【13-00-01以降】○

HTTPプロキシ（proxy_url）が設定されている場合に，DNS解決とURLの変更をスキップする場合はtrue，スキップしない場合はfalseを指定します。

なし

[ proxy_user: <string> ]

監視対象への接続に使用するHTTPプロキシサーバがBasic認証を必要とする場合に，ユーザー名を指定します。

ユーザー名は，URLエンコードしないユーザー名を指定してください。

パスワードは，シークレット管理コマンドを使用して登録する必要があります。

〇

監視対象に接続するために認証ありのプロキシサーバを経由する場合に必要です。

なし

[ preferred_ip_protocol: <string>]

優先するプロトコルを指定します。

ip4だけが指定できます。

◎

ip4を指定します。

なし

[ ip_protocol_fallback: <boolean> ]

優先プロトコルが選べない場合は後退するかどうかを指定します。

falseだけが指定できます。

◎

falseを指定します。

なし

body: [ <string> ]

プローブで使用されるHTTPリクエストの本文を指定します。

◎

プローブで使用されるHTTPリクエストの本文を指定します。

""

<http_header_match_spec>

−

−

−

−

header: <string>,

ヘッダーフィールド名を指定します。

＜設定例＞

fail_if_header_matches: # Verifies that no cookies are set

- header: Set-Cookie

allow_missing: true

regexp: '.*'

◎

ヘッダーフィールド名を指定します。

なし

regexp: <regex>,

比較文字列（正規表現）を指定します。

マルチバイト文字は指定できません。

◎

比較文字列（正規表現）を指定します。

なし

[ allow_missing: <boolean> ]

ヘッダーフィールドがない場合を許容するかどうかを指定します。

〇

有効にする場合trueを指定します。

false

<icmp_probe>

−

−

−

−

[ preferred_ip_protocol: <string>]

優先するプロトコルを指定します。

ip4だけが指定できます。

◎

ip4を指定します。

−

[ ip_protocol_fallback: <boolean> ]

優先プロトコルが選べない場合は後退するかどうかを指定します。

falseだけが指定できます。

◎

falseを指定します。

−

[ source_ip_address: <string> ]

送信元IPアドレスを指定します。

〇

送信元IPアドレスを固定する場合に指定します。

指定なし

[ dont_fragment: <boolean> ]

IPヘッダーのDFビットを指定します。

trueまたはfalseを指定できます。

ip4だけで動作します。

〇

フラグメントさせない場合に指定します。

指定なし

<tls_config>

−

−

−

−

[ insecure_skip_verify: <boolean> ]

ターゲットの証明書の検証を無効にするかどうかを指定します。

trueまたはfalseを指定できます。

次に示すメトリックを監視する場合，falseを指定し，証明書を配置して，証明書ファイルのパスを該当するパラメーターに指定する必要があります。また，trueを指定すると，次に示すメトリックの値は正しい値となりません。

• probe_ssl_last_chain_expiry_timestamp_seconds

なお，Blackbox exporter（HTTP/HTTPS監視）のディスカバリ設定ファイル（jpc_file_sd_config_blackbox_http.yml）のtargetsのURLに，ホスト名ではなくIPアドレスを指定している場合，falseを指定することはできません。

〇

検証を無効にする場合はtrue，有効にする場合はfalseを指定します。

• httpモジュールの場合

  true

• 上記以外の場合

  指定なし

[ ca_file: <filename> ]

ターゲットに使用するCA証明書を指定します。

です。

Insecure_skip_verifyパラメーターをfalseにしている場合は必須で指定します。

次に示すディレクトリ下にファイルを配置してファイルのパスを指定します。

• Linuxの場合

  インストール先ディレクトリ/jp1ima/conf/user/cert/

• Windowsの場合

  インストール先ディレクトリ\jp1ima\conf\user\cert\

詳細については，マニュアル「JP1/Integrated Management 3 - Manager 導入・設計ガイド」の「付録A.4 JP1/IM - Agent」で，統合エージェントホストのJP1/IM - Agentでユーザーが参照・編集できるファイルおよびディレクトリの説明を参照してください。

〇

CA証明書ファイルを指定します。

指定なし

[ cert_file: <filename> ]

ターゲットのクライアント証明書ファイルを指定します。

監視対象がクライアント認証を必要とする場合は必須で指定します。

次に示すディレクトリ下にファイルを配置してファイルのパスを指定します。

• Linuxの場合

  インストール先ディレクトリ/jp1ima/conf/user/cert/

• Windowsの場合

  インストール先ディレクトリ\jp1ima\conf\user\cert\

詳細については，マニュアル「JP1/Integrated Management 3 - Manager 導入・設計ガイド」の「付録A.4 JP1/IM - Agent」で，統合エージェントホストのJP1/IM - Agentでユーザーが参照・編集できるファイルおよびディレクトリの説明を参照してください。

〇

クライアント証明書ファイルを指定します。

−

[ key_file: <filename> ]

ターゲットのクライアント証明書キーファイルを指定します。

監視対象がクライアント認証を必要とする場合は必須で指定します。

次に示すディレクトリ下にファイルを配置してファイルのパスを指定します。

• Linuxの場合

  インストール先ディレクトリ/jp1ima/conf/user/secret/

• Windowsの場合

  インストール先ディレクトリ\jp1ima\conf\user\secret\

詳細については，マニュアル「JP1/Integrated Management 3 - Manager 導入・設計ガイド」の「付録A.4 JP1/IM - Agent」で，統合エージェントホストのJP1/IM - Agentでユーザーが参照・編集できるファイルおよびディレクトリの説明を参照してください。

〇

クライアント証明書キーファイルを指定します。

−

[ server_name: <string> ]

ターゲットのホスト名を確認するために使用するサーバ名を指定します。

〇

サーバ名を指定します。

ターゲットホストのホスト名