1.21.1 JP1/IM - Agentのサービスの設定
- 〈この項の構成〉
(1) アドオンプログラムの有効化・無効化
アドオンプログラムの有効化・無効化について説明します。JP1/IM - Agentは,複数のアドオンプログラムを含んでおり,有効化したサービスだけを起動できます。
なお,ログメトリクス機能は,Fluentdのプラグインであるため,ログメトリクス機能そのものを起動・停止する方法はありません。ログメトリクス機能の起動・停止は,Fluentdの起動・停止に準じます。
(a) アドオンプログラムの有効化
■インストール時に設定する場合
インストール時に使用する初期設定コマンドで,有効化したいアドオンプログラムを選択します。
詳細については,マニュアル「JP1/Integrated Management 3 - Manager 導入・設計ガイド」の「3.15.9 初期設定コマンド」の説明を参照してください。
なお,バージョンアップインストール時は,既存の設定を引き継ぎます。ただし,新バージョンで新たに追加されたアドオンプログラムは無効化された状態となります。
■インストール後に設定する場合
JP1/IM - Agentのアドオンプログラムのサービスを有効化する手順を,次に示します。
-
サービスが起動中の場合は,次のコマンドを実行して停止する。
Agentパス\tools\jpc_service_stop -s all
-
次のコマンドを実行して,サービスを有効化する。
Agentパス\tools\jpc_service -on [JP1/IM - Agentのサービスキー]
-
サービスに対応するディスカバリ設定ファイルを移動する。
次に示すサービスに対応するディスカバリ設定ファイルを,Agentパス\conf\jpc_file_sd_config_offフォルダからAgentパス\confフォルダに移動します。
サービス
ディスカバリ設定ファイル
prometheus_server
なし
alertmanager
なし
windows_exporter
jpc_file_sd_config_windows.yml
blackbox_exporter
-
jpc_file_sd_config_blackbox_http.yml
-
jpc_file_sd_config_blackbox_icmp.yml
ya_cloudwatch_exporter
jpc_file_sd_config_cloudwatch.yml
fluentd
なし
promitor
jpc_file_sd_config_promitor.yml
script_exporter
なし
-
-
サービスが有効化されたことを確認する。
コマンドプロンプトで「services.msc」を実行すると,管理コンソールでサービスを確認できます。該当するサービスが存在する場合,そのサービスは有効です。
(b) アドオンプログラムの無効化
JP1/IM - Agentのアドオンプログラムのサービスを無効化する手順を,次に示します。
-
サービスが起動中の場合は,次のコマンドを実行して停止する。
Agentパス\tools\jpc_service_stop -s all
-
次のコマンドを実行して,サービスを無効化する。
Agentパス\tools\jpc_service -off [JP1/IM - Agentのサービスキー]
-
サービスに対応するディスカバリ設定ファイルを移動する。
次に示すサービスに対応するディスカバリ設定ファイルを,Agentパス\confフォルダからAgentパス\conf\jpc_file_sd_config_offフォルダに移動します。
サービス
ディスカバリ設定ファイル
prometheus_server
なし
alertmanager
なし
windows_exporter
jpc_file_sd_config_windows.yml
blackbox_exporter
-
jpc_file_sd_config_blackbox_http.yml
-
jpc_file_sd_config_blackbox_icmp.yml
ya_cloudwatch_exporter
jpc_file_sd_config_cloudwatch.yml
fluentd
なし
promitor
jpc_file_sd_config_promitor.yml
script_exporter
なし
-
-
サービスが無効化されたことを確認する。
コマンドプロンプトで「services.msc」を実行すると,管理コンソールでサービスを確認できます。該当するサービスが存在しない場合,そのサービスは無効です。
(2) 自動起動の有効化・無効化
(a) 自動起動の有効化
OS起動時のサービス自動起動を有効にする手順を,次に示します。
-
次のコマンドを実行して,JP1/IM - Agentのすべてのサービスの自動起動を有効にする。
jpc_service_autostart -on
(b) 自動起動の無効化
OS起動時のサービス自動起動を無効にする手順を,次に示します。
-
次のコマンドを実行して,JP1/IM - Agentのすべてのサービスの自動起動を無効にする。
jpc_service_autostart -off
(c) 自動起動および自動停止の確認方法
コマンドプロンプトで「services.msc」を実行すると,管理コンソールでサービスを確認できます。
該当するサービスのプロパティを開き,「スタートアップの種類」が「自動」または「自動(遅延)」であれば有効です。それ以外であれば無効です。サービス名については,マニュアル「JP1/Integrated Management 3 - Manager 導入・設計ガイド」の「2.9 JP1/IM - Agentのサービス」を参照してください。
(d) OSシャットダウン時の自動停止についての注意事項
Windowsをシャットダウンする前に,統合エージェントのすべてのサービスを手動で停止してください。Windowsのシャットダウンは,サービスの停止完了を待たないため,サービスが稼動中にWindowsをシャットダウンするとサービスが正常に停止できない場合があります。この場合,イベントログにエラーや警告が出力され,OSシャットダウンした前後の統合エージェントのログの内容が不正になることがあります。また,次回のサービスの起動に時間がかかることがあります。
(3) 手動で起動・停止する方法
JP1/IM - Agentを手動で起動・停止する場合は,次のコマンドを使用します。
コマンド |
説明 |
---|---|
jpc_service_start |
エージェントサービスを起動します。 |
jpc_service_stop |
エージェントサービスを停止します |
コマンドの詳細については,マニュアル「JP1/Integrated Management 3 - Manager コマンド・定義ファイル・APIリファレンス」を参照してください。
(4) サービスの起動状態の確認方法
コマンドプロンプトで「services.msc」を実行すると,管理コンソールでサービスを確認できます。対象のサービスの状態を確認します。
(5) 設定ファイルの配置場所
インストール時に,imagent,imagentproxy,imagentaction,および各アドオンプログラムのサービス定義ファイルを,次の場所に配置します。
サービス定義ファイルの詳細については,マニュアル「JP1/Integrated Management 3 - Manager コマンド・定義ファイル・APIリファレンス」の「サービス定義ファイル(jpc_プログラム名_service.xml)」(2. 定義ファイル)を参照してください。
配置場所(パス) |
用途 |
配置方法 |
---|---|---|
Agentパス\conf\ (物理ホストの場合) |
モデルファイル(サービス定義ファイルの雛型) モデルファイルは編集しないでください。 |
インストーラーで配置します。 |
共有ディスク\jp1ima\conf\ (論理ホストの場合) |
モデルファイル(サービス定義ファイルの雛型) モデルファイルは編集しないでください。 |
手動で配置します。 |
Agentパス\bin\ |
サービス定義ファイル本体 このファイルを編集してください。 |
物理ホスト用は初期設定コマンドで,論理ホスト用は手動で配置します。 |
(6) 設定ファイルの編集
サービスの設定を変更したい場合は,サービス定義ファイルを編集します。サービス定義ファイルを編集した場合,定義の反映方法は,変更したパラメーターに応じて異なり,次のどれかになります。
-
サービスをアンインストール(jpc_service disableコマンドを実行)して再インストール(jpc_service enableコマンドを実行)する
-
サービスを再起動する
-
サービス定義ファイルを保存する
詳細については,マニュアル「JP1/Integrated Management 3 - Manager コマンド・定義ファイル・APIリファレンス」の「サービス定義ファイル(jpc_プログラム名_service.xml)」(2. 定義ファイル)の「定義の反映時期」を参照してください。
(7) サービス自動起動の設定変更に関する注意事項
サービス定義ファイルの<startmode>で,サービス自動起動の設定を行うことができます。ただし,jpc_service_autostartコマンドやWindowsサービスの設定を直接変更することで,サービス自動起動の設定を変更できるため,必ずしもサービス定義ファイルに指定した<startmode>の設定と現在のサービス自動起動の設定が一致しているとは限りません。
(8) サービスの無効化に関する注意事項
jpc_service disableコマンドを実行してサービスを無効化する場合,サービス定義ファイルが存在しない,または,サービス定義ファイルの内容が不正だったときは,無効化に失敗することがあります。その場合は,次のコマンドを管理者権限で実行してください。
SC Delete サービス名