ユーザー独自のディスカバリ設定ファイル（user_file_sd_config_任意の名前.yml）

形式

YAML形式で記述します。

- targets:
  - 監視対象ホスト名[:任意の文字列]
  ・・・
  labels:
[    jp1_pc_exporter: 「JPC」から始まらない任意のExporter名]
[    jp1_pc_category: IM管理ノードのカテゴリID]
[    jp1_pc_trendname: Prometheusトレンド名]
[    jp1_pc_remote_monitor_instance: インストールホスト名:IM管理ノードのラベルに表示する文字列]
[    jp1_pc_rm_agent_create_flag: リモートエージェントSID作成フラグ]
[    jp1_pc_agent_create_flag: エージェントSID作成フラグ]
[    jp1_pc_multiple_node: 複数IM管理ノード作成のためのラベルセット取得条件]

ページの先頭へ

ファイル

user_file_sd_config_任意の名前.yml

ページの先頭へ

格納先ディレクトリ

任意のディレクトリに格納できます。ただし，監視エージェントのインストール先ディレクトリ配下に格納する場合は，次のディレクトリ以下に格納してください。

■統合エージェントホスト

Windowsの場合

• 物理ホストのとき

  Agentパス\conf\

• 論理ホストのとき

  共有フォルダ\jp1ima\conf\

Linuxの場合

• 物理ホストのとき

  /opt/jp1ima/conf/

• 論理ホストのとき

  共有ディレクトリ/jp1ima/conf/

ページの先頭へ

説明

Prometheus serverがスクレイプする対象を設定するファイルです。ユーザーが独自に用意したExporterもスクレイプの対象とすることができます。

ページの先頭へ

文字コード

UTF-8（BOM無し）

ページの先頭へ

改行コード

Windowsの場合：CR+LF

Linuxの場合：LF

ページの先頭へ

定義の反映時期

Prometheus serverのリロードAPIを実行，または，再起動したとき，Prometheus serverがスクレイプする対象となります。そのあと，jddcreatetreeコマンドおよびjddupdatetreeコマンドを実行したとき，統合オペレーション・ビューアーのツリーの表示内容に反映されます。

ページの先頭へ

記述内容

- 監視対象ホスト名［:任意の文字列］

「監視対象ホスト名［:任意の文字列］」を，1〜2,574文字の制御文字以外の文字で指定します。

監視対象ホスト名は，1〜255文字の制御文字以外の文字で，必須で指定します。FQDN形式も指定できます。「localhost」は指定できません。

Exporterの仕様で，ほかに必要な指定があれば，任意の文字列を指定します。

Prometheus設定ファイル（jpc_prometheus_server.yml）のスクレイプ定義でrelabel_configsを設定し，必要な文字列をスクレイプ時の引数として渡します。

2,574文字を超える場合は，Prometheus設定ファイル（jpc_prometheus_server.yml）のrelabel_configsで，instanceラベルの値を，1〜2,574文字の制御文字以外の文字列に置き換えてください。なお，instanceラベルの値は，「監視対象ホスト名:任意の文字列」の形式で指定し，同一監視エージェントホスト内のほかのinstanceラベルの値と重複しないようにしてください。

relabel_configsの設定については，「Prometheus設定ファイル（jpc_prometheus_server.yml）」の「記述内容」について説明している個所を参照してください。

jp1_pc_exporter: 「JPC」から始まらない任意のExporter名

「JPC」から始まらない任意のExporter名には，プロパティ表示で，jp1_pc_exporterのプロパティに表示する文字列を，1〜255文字の制御文字以外の文字で指定します。指定を省略した場合，「Unknown Exporter」と表示されます。

jp1_pc_category: IM管理ノードのカテゴリID

IM管理ノードのカテゴリIDには，エージェントSIDのIM管理ノードのカテゴリIDを，1〜255文字の制御文字以外の文字で指定します。

指定を省略した場合，「otherApplications」が指定されたものとします。

jp1_pc_trendname: Prometheusトレンド名

Prometheusトレンド名には，エージェントSIDのIM管理ノードで表示する，メトリック定義ファイルのPrometheusトレンド名を，1〜255文字の制御文字以外の文字で指定します。

指定を省略した場合，jobラベルの値を設定します。

jp1_pc_remote_monitor_instance: インストールホスト名:IM管理ノードのラベルに表示する文字列

リモートで監視するExporterの場合だけ指定します。リモートで監視するExporterとは，Exporterをセットアップしたホストとは別のホストを監視するExporterのことです。

インストールホスト名には，Exporterをインストールしたホスト名を，1〜255文字の制御文字以外の文字で指定します。

IM管理ノードのラベルに表示する文字列には，リモート監視サービスSIDのIM管理ノードのラベルに表示する文字列を制御文字とコロン以外の文字で指定します。コロンは区切り文字のため，指定した場合，最後に指定したコロン以降の文字列がIM管理ノードのラベルに表示する文字列の対象となります。URLをエンコードしたときの文字列が，234バイト以内（すべてマルチバイト文字の場合の上限は26文字）となるようにしてください。

インストールホスト名とIM管理ノードのラベルに表示する文字列の間には，区切り文字のコロンを指定してください。指定しない場合,インストールホスト名とIM管理ノードのラベルに表示する文字列は同一と見なして動作します。

指定を省略した場合，リモート監視サービスSIDを作成しません。

jp1_pc_rm_agent_create_flag: リモートエージェントSID作成フラグ

リモートで監視するExporterの場合だけ指定します。trueまたはfalseを指定します。大文字小文字の区別はありません。jp1_pc_remote_monitor_instanceを指定していない場合，この設定は無効となります。

• true

  「エージェントホストSID」と「監視対象ホスト名:任意の文字列」の単位で，「リモートエージェントSID」のIM管理ノードを作成する。

• false

  「エージェントホストSID」と「監視対象ホスト名:任意の文字列」の単位で，「リモートエージェントSID」のIM管理ノードを作成しない。

trueまたはfalse以外の文字を指定した場合，および指定を省略した場合は，trueを指定したものとして動作します。

jp1_pc_agent_create_flag: エージェントSID作成フラグ

Exporterがインストールされているホストを監視しているExporterの場合だけ指定します。trueまたはfalseを指定します。大文字小文字の区別はありません。jp1_pc_remote_monitor_instanceを指定している場合，この設定は無効となります。

• true

  「監視対象ホスト名:任意の文字列」の単位で，「エージェントSID」のIM管理ノードを作成する。

• false

  「監視対象ホスト名:任意の文字列」の単位で，「エージェントSID」のIM管理ノードを作成しない。

trueまたはfalse以外の文字を指定した場合，および指定を省略した場合は，trueを指定したものとして動作します。

jp1_pc_multiple_node: 複数IM管理ノード作成のためのラベルセット取得条件

「監視対象ホスト名:任意の文字列」に対して，複数のIM管理ノード（エージェントSIDやリモートエージェントSID）を作成する場合に指定します。IM管理ノードを作成するために必要なラベルセットを，トレンドデータ管理DBから取得する条件を指定します。

条件は1つだけ指定できます。指定できる値については，「4.5.18 jp1TrendDataService.getLabelList」のmatchパラメーターの説明を参照してください。

指定を省略した場合は，「監視対象ホスト名:任意の文字列」に対して，複数のIM管理ノード（エージェントSIDやリモートエージェントSID）を作成しません。

ページの先頭へ

定義例

- targets:
  - hostA:9256
  labels:
    jp1_pc_exporter: Process Exporter
    jp1_pc_category: platform
    jp1_pc_trendname: process

ページの先頭へ