SQL exporter設定ファイル（jpc_sql_exporter.yml）

〈このページの構成〉

形式

YAML形式で記述します。

global:
  scrape_timeout: 10s
  scrape_timeout_offset: 500ms
  min_interval: 0s
  max_connections: 3
  max_idle_connections: 3
  max_connection_lifetime: 5m
  JP1IMADIR:JP1/IM - Agentのインストールパス
 
jobs:
  - job_name: 監視対象ホスト名^※1
    collectors: [mssql_*]
    static_configs:
      - targets:^※2
          監視対象の接続情報1^※2
          監視対象の接続情報2^※2
            ：
 
collector_files: 
  - "..\\conf\\mssql_*.collector.yml"

注※1

監視対象となるMicrosoft SQL Serverのホスト名を，ユニークになるよう指定します。

注※2

targetsには，次の形式で監視対象の接続情報を複数記述できます。監視対象インスタンス名は，それぞれユニークになるように指定します。

監視対象インスタンス名: 'sqlserver://ログインユーザ名@監視対象ホスト名:監視対象ポート番号'

ページの先頭へ

ファイル

jpc_sql_exporter.yml

ページの先頭へ

格納先ディレクトリ

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

物理ホストのとき

Windows版のSQL exporterのアーカイブファイル^※の展開先\sql_exporter_windows\jp1ima\conf\

注※: Agentパス\options\sql_exporter_windows_VVRRSS.zip

ページの先頭へ

説明

SQL exporterの動作を規定する設定ファイルです。

ページの先頭へ

文字コード

UTF-8（BOM無し）

ページの先頭へ

改行コード

CR+LF

ページの先頭へ

定義の反映時期

SQL exporterを再起動したときに反映されます。

ページの先頭へ

記述内容

項目名					説明	変更可否	JP1/IM - Agentでユーザーが設定する内容	JP1/IM - Agentのデフォルト値
global:					−	△	−	−
	scrape_timeout:				Microsoft SQL Serverに対するスクレイプ要求のタイムアウト時間を数字と単位で指定します。 0以下（マイナスを含む）の値を指定した場合，Prometheusに対するタイムアウトを設定しない限り，タイムアウトは設定されません。値が不正または未設定の場合は，デフォルト値を使用します。	〇	環境に合わせて調整します。最小値：1s 最大値：9223372036s	`10s`
	scrape_timeout_offset:				Prometheus serverとのタイムアウト時間から差し引くオフセットを数字と単位で指定します。 Prometheusのscrape_timeoutの値からこの項目に指定された値を減算した時間でタイムアウトするようになるため，Prometheusが最初にタイムアウトするのを防ぎます。値がマイナス，不正，または未設定の場合は，デフォルト値を使用します。	〇	環境に合わせて調整します。最小値：1s 最大値：9223372036s	`500ms`
	min_interval:				コレクター実行の最小間隔を数字と単位で指定します。 Prometheusのスクレイプ間隔以下の値を指定した場合，スクレイプに影響を与えません。 Prometheusのスクレイプ間隔を超過した値を指定した場合，このオプションに設定した秒数内には，前回取得した値をスクレイプ結果としてPrometheusに返却します。値がマイナス，不正，または未設定の場合は，デフォルト値を使用します。	〇	SQL exporterは，スクレイプごとにSQL文を実行するため，SQLのデータベースへのアクセス回数を制限したい場合は，この項目で調整してください。	`0s`
	max_connections:				任意の1つのターゲットに対するオープン接続の最大数を指定します。メトリクスのクエリは，スクレイピングと同様に，複数の接続で同時に実行されます。値が不正または0以下（マイナスの値を含む）の値を指定した場合は，デフォルト値を使用します。	〇	環境に合わせて調整します。最小値：1 最大値：9223372036854775807	`3`
	max_idle_connections:				任意の1つのターゲットへのアイドル接続の最大数を指定します。収集間隔を非常に長くする場合以外は，この項目の値を常にmax_connectionsと同じにする必要があります。値が不正または0以下（マイナスの値を含む）の値を指定した場合は，デフォルト値を使用します。	〇	環境に合わせて調整します。最小値：1 最大値：9223372036854775807	`3`
	max_connection_lifetime:				任意の1つのターゲットに対して接続を再利用できる最大時間を数字と単位で指定します。この項目を指定すると，期限切れの接続を，再利用される前に，遅延して閉じることができます。0を指定した場合は，接続の経過時間に左右されず，接続は閉じられません。マイナスの値を指定した場合は，デフォルト値を使用します。	〇	環境に合わせて調整します。最小値：1m 最大値：153722867m	`5m`
	JP1IMADIR:				JP1/IM - Agentのインストールパスを指定します。	◎	JP1/IM - Agentのインストールパスを指定します。	`−`
jobs:					`−`	△	`−`	`−`
	- job_name:				監視対象ホスト名を指定します。	◎	監視対象ホスト名を指定します。	`なし`
		collectors:			ターゲットで実行するコレクター名を指定します。 globパターンを使用できます。	△	[mssql_*]	`−`
		static_configs:			`−`	△	`−`	`−`
			- targets:		`−`	△	`−`	`−`
				監視対象の接続	監視対象の接続情報を次の形式で記述します。監視対象インスタンス名`: 'sqlserver://`ログインユーザ名`@`監視対象ホスト名`:`監視対象ポート番号`'` 監視対象インスタンス名性能監視をする対象のインスタンス名を指定します。 IM管理ノードのノード名として表示されます。 Microsoft SQL Serverの構築時に任意のインスタンス名を指定していない場合，デフォルトのインスタンス名「MSSQLSERVER」を指定してください。ログインユーザ名性能監視をする対象のインスタンスにログイン可能なユーザー名を指定します。監視対象ホスト名性能監視をする対象のホスト名を指定します。監視対象ポート番号性能監視をする対象のポート番号を指定します。 Microsoft SQL ServerとのTLS通信を有効にする場合，次のオプションを付与します。 `encrypt=true` オプションを付与した場合の監視対象の接続情報を次に示します。監視対象インスタンス名`: 'sqlserver://`ログインユーザ名`@`監視対象ホスト名`:`監視対象ポート番号`'?encrypt=true'` 暗号化が有効，かつ，接続情報の監視対象ホスト名がTLSサーバ証明書に登録されたホスト名と一致していない場合，次に示すように，`hostNameInCertificate`オプションを指定する必要があります。監視対象インスタンス名`: 'sqlserver://`ログインユーザ名@監視対象ホスト名:監視対象ポート番号'`?encrypt=true&hostNameInCertificate=`TLSサーバ証明書に登録されたホスト名'	◎	監視対象の接続情報を指定します。	`なし`
collector_files:					`−`	△	`−`	`−`
	- メトリックファイル名				globリストを指定します。一致する各ファイルから1つのコレクター定義が読み取られます。 globパターンを使用できます。	△	`−`	"..¥¥conf¥¥mssql_*.collector.yml"

（凡例）: ◎：設定必須　〇：変更可　×：変更不可　−：該当なし

ページの先頭へ