1.23.4　SQL exporterの設定

(a)　JP1/IM - Managerのセットアップ

JP1/IM - Manager 13-11以降を新規にインストールした場合は，実施不要です。

JP1/IM - Manager 13-11より前のバージョンからバージョンアップした場合，次の手順を実施します。

(b)　セットアップアーカイブファイルの入手

SQL exporterを使用するためのセットアップアーカイブファイルを取得します。セットアップアーカイブファイルはJP1/IM - Agentのインストール先フォルダに格納されています。

セットアップアーカイブファイルのファイル名は，次のとおりです。

JP1/IM - Agentのインストール先/jp1ima/options/

• sql_exporter_windows_VVRRSS.zip

(c)　JP1/IM - Agentのセットアップ

JP1/IM - Agent 13-11以降を新規にインストールする場合は，実施不要です。

JP1/IM - Agent 13-11より前のバージョンからバージョンアップした場合，次の手順を実施します。

なお，JP1/IM - AgentのホストにMicrosoft SQL Serverのモジュールをインストールする必要はありません。

（略）
   ：
scrape_configs:
   ：
  - job_name: 'jpc_sql'
    scrape_interval: 60s
    scrape_timeout: 30s
 
    metrics_path: /metrics
 
    file_sd_configs:
      - files:
        - 'jpc_file_sd_config_mssql.yml'
 
    relabel_configs:
      - target_label: jp1_pc_nodelabel
        replacement: MSSQL metric collector(SQL exporter)
 
    metric_relabel_configs:
      - source_labels: ['__name__']
        regex: 'mssql_local_time_seconds|mssql_connections|mssql_deadlocks|mssql_user_errors|mssql_kill_connection_errors|mssql_page_life_expectancy_seconds|mssql_batch_requests|mssql_log_growths|mssql_buffer_cache_hit_ratio|mssql_checkpoint_pages_sec|mssql_io_stall_seconds|mssql_io_stall_total_seconds|mssql_resident_memory_bytes|mssql_virtual_memory_bytes|mssql_memory_utilization_percentage|mssql_page_fault_count|mssql_os_memory|mssql_os_page_file|mssql_database_detail_process_count|mssql_global_server_summary_perc_busy|mssql_global_server_summary_packet_errors|mssql_server_detail_blocked_processes|mssql_server_overview_cache_hit|mssql_transaction_log_overview_log_space_used'
        action: 'keep'
      - source_labels: [exported_job]
        target_label: instance
        replacement: ${1}
      - source_labels: [target] 
        target_label: jp1_pc_nodelabel
        replacement: ${1}

promtool check config jpc_prometheus_server.yml

WARNING: file "../conf/jpc_file_sd_config_windows.yml" for file_sd in scrape job "jpc_windows" does not exist

(a)　インストールの前準備

1. 環境変数JP1IMADIRに設定する値を確認する。

   SQL exporterのサービス定義ファイルに環境変数JP1IMADIRを設定する必要があります。JP1/IM - Agentのホストの種類によって次の値となります。

   ホスト種別	環境変数JP1IMADIR
   物理ホスト運用の場合	JP1/IM - Agentのインストール先\jp1ima
   論理ホスト運用の場合	共有フォルダ\jp1ima

2. 物理ホストで運用するか論理ホストで運用するか確認する。

   新しく追加するSQL exporterをスクレイプするJP1/IM - Agentが物理ホスト運用の場合は，SQL exporterも物理ホスト運用となります。

   新しく追加するSQL exporterをスクレイプするJP1/IM - Agentが論理ホスト運用の場合は，SQL exporterも論理ホスト運用となります。

(b)　SQL exporterのインストール

1. SQL exporterを配置する。

   「1.23.4(1)(b) セットアップアーカイブファイルの入手」で入手したセットアップアーカイブファイル^※を任意のフォルダに展開します。展開先フォルダに，JP1/IM - ManagerやJP1/IM - Agentのインストール先フォルダを指定しないでください。

   注※

   sql_exporter_windows_VVRRSS.zip

   SQL exporterを論理ホストで運用する場合は，共有フォルダに配置してください。

2. デフォルトのメトリック定義ファイルを作成する。

   次に示すデフォルトのメトリック定義ファイルのモデルファイルをコピーし，コピー先の定義ファイル名にリネームする。

   コピー元のファイル名：SQL exporterの配置先\sql_exporter_windows\jp1ima\conf\mssql_standard.collector.yml.model

   コピー先のファイル名：SQL exporterの配置先\sql_exporter_windows\jp1ima\conf\mssql_standard.collector.yml

3. サービス定義ファイルを更新する。

   次のファイルが存在することを確認する。

   SQL exporterの配置先\sql_exporter_windows\jp1ima\bin\sql_exporter_service.exe

   SQL exporterの配置先\sql_exporter_windows\jp1ima\bin\sql_exporter_service.xml.model

   サービス定義ファイルの次の値を変更します。

   変更する値	指定する値
   @@sql_exporter_installdir@@	SQL exporterの配置先に置換する。
   @@autostart@@	OS起動時に自動起動させたい場合 "Automatic"に置換する。 自動起動させない場合 "Manual"に置換する。 論理ホストの場合は"Manual"に置換する。

4. サービスを登録する。

   次のコマンドを実行して，SQL exporterサービスをWindowsに登録します。

   • 物理ホスト運用の場合

     sql_exporter_service.exe install

   • 論理ホスト運用の場合

     sql_exporter_論理ホスト名_service.exe install

     論理ホスト運用の場合はクラスタを構成する両ノードで実行してください。

5. SQL exporter設定ファイルに監視対象を設定する。

   SQL exporterの監視対象を，SQL exporter設定ファイル（jpc_sql_exporter.yml）に記載します。

   SQL exporter設定ファイルの詳細については，マニュアル「JP1/Integrated Management 3 - Manager コマンド・定義ファイル・APIリファレンス」の「SQL exporter設定ファイル（jpc_sql_exporter.yml）」（2. 定義ファイル）を参照してください。

6. 監視対象を追加する。

   監視対象の追加の詳細については，「1.23.4(4)(a) 監視対象を追加する（必須）」を参照してください。

7. クラスタソフトにサービスを登録する。

   クラスタ構成の場合は，クラスタソフトにサービスを登録します。

(c)　Prometheusの設定

1. SQL exporterのディスカバリ設定ファイルに監視対象を設定する。

   SQL exporterの監視対象をSQL exporterのディスカバリ設定ファイル（jpc_file_sd_config_mssql.yml）のtargetsに記載します。

   SQL exporterのディスカバリ設定ファイルの詳細については，マニュアル「JP1/Integrated Management 3 - Manager コマンド・定義ファイル・APIリファレンス」の「SQL exporterのディスカバリ設定ファイル（jpc_file_sd_config_mssql.yml）」（2. 定義ファイル）を参照してください。

2. promtoolコマンドで設定内容をチェックする。

   設定内容が正しいことを確認します。

   promtoolコマンドはJP1/IM - Agentのインストール先\jp1ima\toolsフォルダにあります。

   promtool check config jpc_prometheus_server.yml

   エラーが表示された場合は見直しを実施してください。

   なお，次のような警告は表示されても問題はありません。

     WARNING: file "../conf/jpc_file_sd_config_windows.yml" for file_sd in scrape job "jpc_windows" does not exist

3. Prometheusを再起動する。

   変更した内容を反映するためにPrometheusを再起動します。

(a)　監視対象を追加する（必須）

(b)　接続のためのパスワードを変更する（オプション）

運用中にMicrosoft SQL Serverのパスワードを変更した場合，SQL exporterが接続に使用するパスワードを更新する必要があります。

1. SQL exporterを停止する。

2. パスワードを更新する。

   Microsoft SQL Serverへの接続に使用するユーザーのパスワードをjimasecretコマンドで更新します。

   • 物理ホスト運用の場合

   jimasecret -add -key MSSQL.ホスト名.インスタンス名.ユーザー名 -s パスワード

   • 論理ホスト運用の場合

   jimasecret -add -key MSSQL.ホスト名.インスタンス名.ユーザー名 -s パスワード -l 共有フォルダ

   jimasecretコマンドの詳細については，マニュアル「JP1/Integrated Management 3 - Manager コマンド・定義ファイル・APIリファレンス」の「jimasecret」（1. コマンド）を参照してください。

3. SQL exporterを起動する。

(c)　監視対象を削除する（オプション）

(d)　SQL exporterの死活監視を設定する（オプション）

SQL exporterサービスの死活監視はPrometheus server のupメトリックで監視できます。アラート定義でSQL exporterも監視する場合の例を次に示します。

groups:
  - name: exporter_healthcheck
    rules:
    - alert: jp1_pc_exporter_healthcheck
      expr: up{jp1_pc_remote_monitor_instance=""} == 0 or label_replace(up{jp1_pc_exporter="JPC SQL exporter"}, "jp1_pc_nodelabel", "${1}", "jp1_pc_remote_monitor_instance", "^[^:]*:([^:]*)$") == 0 or label_replace(up{jp1_pc_remote_monitor_instance!="", jp1_pc_exporter!="JPC SQL exporter"}, "jp1_pc_nodelabel", "${1}", "jp1_pc_remote_monitor_instance", "^[^:]*:([^:]*)$") == 0
      for: 3m
      labels:
        jp1_pc_product_name: "/HITACHI/JP1/JPCCS2"
        jp1_pc_component: "/HITACHI/JP1/JPCCS/CONFINFO"
        jp1_pc_severity: "Error"
        jp1_pc_metricname: "up"
      annotations:
        jp1_pc_firing_description: "Exporterへの通信に失敗しました。instance={{ $labels.instance }}"
        jp1_pc_resolved_description: "Exporterへの通信に成功しました。instance={{ $labels.instance }}"

(e)　接続のためのユーザーを変更する（オプション）

1. Microsoft SQL Serverに新しいユーザーを追加する。

   新しい監視用ユーザーが必要かつ未登録の場合だけ，この手順を実行してください。

2. SQL exporterを停止する。

3. 変更前のユーザーのパスワードを削除する。

   Microsoft SQL Serverへの接続に使用していたユーザーのパスワードをjimasecretコマンドで削除します。

   • 物理ホスト運用の場合

   jimasecret -rm -key MSSQL.ホスト名.インスタンス名.旧ユーザー名

   • 論理ホスト運用の場合

   jimasecret -rm -key MSSQL.ホスト名.インスタンス名.旧ユーザー名 -l 共有フォルダ

   jimasecretコマンドの詳細については，マニュアル「JP1/Integrated Management 3 - Manager コマンド・定義ファイル・APIリファレンス」の「jimasecret」（1. コマンド）を参照してください。

4. 変更後のユーザーのパスワードを登録する。

   Microsoft SQL Serverへの接続に使用するユーザーのパスワードをjimasecretコマンドで登録します。

   • 物理ホスト運用の場合

   jimasecret -add -key MSSQL.ホスト名.インスタンス名.新ユーザー名 -s パスワード

   • 論理ホスト運用の場合

   jimasecret -add -key MSSQL.ホスト名.インスタンス名.新ユーザー名 -s パスワード -l 共有フォルダ

   jimasecretコマンドの詳細については，マニュアル「JP1/Integrated Management 3 - Manager コマンド・定義ファイル・APIリファレンス」の「jimasecret」（1. コマンド）を参照してください。

5. SQL exporter設定ファイルに記載している接続情報のユーザー名を変更する。

   SQL exporterの接続情報のユーザー名を，SQL exporter設定ファイル（jpc_sql_exporter.yml）から削除します。

   SQL exporter設定ファイルの詳細については，マニュアル「JP1/Integrated Management 3 - Manager コマンド・定義ファイル・APIリファレンス」の「SQL exporter設定ファイル（jpc_sql_exporter.yml）」（2. 定義ファイル）を参照してください。

6. SQL exporterを起動する。

7. Microsoft SQL Serverから変更前のユーザーを削除する。

   変更前のユーザーが不要な場合，Microsoft SQL Serverから変更前のユーザーを削除してください。