1.19.3 エージェントとしてJP1/IM - Agentを使用する場合の設定
- 〈この項の構成〉
(1) 統合エージェント管理基盤の設定変更
(a) 共通の設定方法
■ 設定ファイルを編集する(Windowsの場合)
設定ファイルは,次のディレクトリに格納されています。
OS |
格納先 |
---|---|
Windows |
Managerパス\conf\imdd\plugin\jp1pccs\ Managerパス\conf\imdd\imagent\ |
Linux |
/etc/opt/jp1imm/conf/imdd/plugin/jp1pccs/ /etc/opt/jp1imm/conf/imdd/imagent/ |
設定ファイルを変更するには,次の2つの方法があります。
-
統合オペレーション・ビューアーを使用する方法
-
ホストにログインして設定する方法
統合オペレーション・ビューアーを使用する場合に,編集できる設定ファイルについては,マニュアル「JP1/Integrated Management 3 - Manager コマンド・定義ファイル・APIリファレンス」の「定義ファイル一覧」(2. 定義ファイル)で,JP1/IM - Agent(統合エージェント管理基盤)に関する定義ファイルの注記を参照してください。ホストにログインして設定する方法の場合は,すべての設定ファイルを編集できます。
各設定方法の手順を次に示します。
■統合オペレーション・ビューアーを使用する方法
-
統合オペレーション・ビューアーから設定ファイルをダウンロードする。
ファイルを追加する場合は,ダウンロードする必要はありません。
-
ダウンロードしたファイルを編集する。
-
統合オペレーション・ビューアーを使用して,編集したファイルをアップロードする。
アップロードすると自動的に設定が反映されます。
■ホストにログインして設定する方法
-
統合マネージャーホストにログインする。
-
JP1/IM - Managerのサービスを停止する。
サービスの停止方法については,マニュアル「JP1/Integrated Management 3 - Manager 運用ガイド」の「3.2 JP1/IM - Managerを終了する」を参照してください。
-
設定ファイルを編集する。
-
サービスを起動する。
サービスの起動方法については,マニュアル「JP1/Integrated Management 3 - Manager 運用ガイド」の「3.1 JP1/IM - Managerを起動する」を参照してください。
(b) 統合エージェント管理基盤の設定変更(Windowsの場合)
統合エージェント管理基盤(imbase,imbaseproxy)の設定変更の手順を,次に示します。
■ 統合エージェント管理基盤の設定ファイルを変更する
統合エージェント管理基盤の設定ファイルは,imbase設定ファイル(jpc_imbase.json)とimbaseproxy設定ファイル(jpc_imbaseproxy.json)です。
設定ファイルの編集方法については,「1.19.3(1)(a) 共通の設定方法」の「設定ファイルを編集する(Windowsの場合)」を参照してください。
■ 統合エージェント管理基盤のポートを変更する
次の手順を実施します。
-
JP1/IM - Managerを停止する。
-
統合エージェント管理基盤のリッスンポート番号を変更する。
待ち受けポート番号は,統合エージェント管理基盤のimbase設定ファイル(jpc_imbase.json)とimbaseproxy設定ファイル(jpc_imbaseproxy.json)のportメンバーに設定されています。これを新しいポート番号に変更します。
imbase設定ファイルとimbaseproxy設定ファイルの詳細については,マニュアル「JP1/Integrated Management 3 - Manager コマンド・定義ファイル・APIリファレンス」の該当するファイル(2. 定義ファイル)を参照してください。
-
JP1/IM - Managerを開始する。
すでに運用中の環境において統合エージェント管理基盤のリッスンポート番号を変更した場合,統合エージェント制御基盤側の接続先ポートも変更する必要があります。
■ 証明書を設定する
次の手順を実施します。
-
JP1/IM - Managerを停止する。
-
統合エージェント管理基盤のサーバ証明書およびキーファイルを変更する。
リッスンポート番号は,imbase設定ファイル(jpc_imbase.json)やimbaseproxy設定ファイル(jpc_imbaseproxy.json)のcert_fileやkey_fileのメンバーに設定されています。
cert_fileやkey_fileの設定値,または,設定しているファイル自体を更新します。
imbase設定ファイルとimbaseproxy設定ファイルの詳細については,マニュアル「JP1/Integrated Management 3 - Manager コマンド・定義ファイル・APIリファレンス」の「2. 定義ファイル」の,該当するファイルの説明を参照してください。
-
JP1/IM - Managerを開始する。
(c) IM管理ノードのツリー情報の作成と反映(Windowsの場合)(必須)
次に示す手順で,IM管理ノードのツリー情報の作成と反映を行います。
-
統合エージェントホストで行う手順を実施する。
「1.21.2(16) IM管理ノードのツリー情報の作成と反映(Windowsの場合)(必須)」の手順1〜4を実施します。
-
JP1/IM - ManagerのjddcreatetreeコマンドまたはIM管理ノード関連情報の生成APIを実行する。
実行に失敗した場合は,メッセージの内容に従って対処を行い,再度実行します。
-
アドオンプログラム,または,ユーザー独自のPrometheusもしくはFluentdの構成変更や削除を行った場合に,下記の「■IM管理ノード関連ファイルの編集」に記載するIM管理ノード関連ファイルの編集を行う(新規構築時には実施不要です)。
-
JP1/IM - Managerのjddupdatetreeコマンド(構成変更モード)またはIM管理ノード関連情報の反映APIを実行する。
実行に失敗した場合,メッセージの内容に従って対処を行い,再度実行します。
-
統合オペレーション・ビューアーを表示し,正しくIM管理ノードが作成されているか確認する。
正しく作成されていない場合,作成されていない統合エージェント,アドオンプログラム,ユーザー独自のPrometheusまたはFluentdの設定内容を見直し,再度,手順2以降を実施します。
- ■IM管理ノード関連ファイルの編集
-
アドオンプログラム,または,ユーザー独自のPrometheusもしくはFluentdの構成変更(設定変更,または,削除)を行った場合,トレンドデータ管理DBからそれらのサンプルが削除されるまで,構成変更前のIM管理ノードが作成されます。トレンドデータが削除される契機については,マニュアル「JP1/Integrated Management 3 - Manager 導入・設計ガイド」の「2.7.2トレンドデータ管理DB」を参照してください。
構成変更前のIM管理ノードを作成したくない場合,jddcreatetreeコマンドにより出力されたIM管理ノードファイル,および,IM管理ノードツリーファイルを編集します。IM管理ノードツリーファイルについては,マニュアル「JP1/Integrated Management 3 - Manager 導入・設計ガイド」の「3.5.3 IM管理ノード関連ファイル」を参照してください。ファイルをコピーしてバックアップを作成してから編集を行ってください。
- ■IM管理ノードファイルの編集
-
jddcreatetreeコマンドにより出力されたIM管理ノードファイル(ファイル名:imdd_node_HITACHI_JP1_JPCCS_CONFINFO_JP1/IM - Managerのホスト名.json)には,構成変更前のIM管理ノードの情報も出力されます。設定変更の場合,変更前と変更後で構成情報のSIDが同一となり,2つ目以降の構成情報のSIDは,末尾に「-xx」(xxは01〜99までの数字)を付与して出力されます。
構成変更前のIM管理ノードが不要である場合,jddcreatetreeコマンドにより出力されたIM管理ノードファイルを編集して,構成変更前のIM管理ノードのオブジェクトの情報を削除します。IM管理ノードファイルの形式を次に示します。
{ "meta":{ ・・・ }, "simtData": [ IM管理ノードのオブジェクト, ・・・ ] }
IM管理ノードのオブジェクトは,simtDataの配列の要素で,次の形式です。
-
IM管理ノードのオブジェクトの形式
{ "sid": "構成情報のSID", "value": { ・・・ "property": { IM管理ノードのプロパティに表示する値 }, "jp1im_TrendData_labels": { トレンドデータを特定するための値 }, ・・・ } }
IM管理ノードのプロパティに表示する値,および,トレンドデータを特定するための値を確認し,構成変更前のIM管理ノードのオブジェクトを削除します。IM管理ノードのプロパティに表示する値については,マニュアル「JP1/Integrated Management 3 - Manager 導入・設計ガイド」の「3.15.6(1)(f)プロパティ表示」を参照してください。トレンドデータを特定するための値として,次に表に示す値が設定されています。
キー
値の説明
jp1_pc_prome_hostname
Prometheus serverのホスト名
Prometheus設定ファイルのjp1_pc_prome_hostnameに設定されている値です。ログ監視対象のSIDの場合,このキーと値は出力されません。
job
スクレイプジョブ名
Prometheus設定ファイルのjob_nameに設定されている値です。ログ監視対象のSID,または,kubernetesのSIDの場合,このキーと値は出力されません。
instance
インスタンス名
ディスカバリ設定ファイルのtargetsに指定した値です。
jp1_pc_nodelabel
IM管理ノードのラベル名
Prometheus設定ファイルのscrape_configsもしくはmetrics_scrape_configs,または,AWSリソースのjp1_pc_nodelabelタグで設定した値です。
構成情報のSIDの末尾に「-xx」が付与されていないIM管理ノードのオブジェクトを削除し,末尾に「-xx」が付与されているIM管理ノードのオブジェクトを残す場合,残す構成情報のSIDの末尾の「-xx」を削除して保存してください。
Node exporterのポート番号を変更した場合の編集例を,次に示します。
この例では,変更前のポート番号が20716,変更後のポート番号が29999とします。
-
編集前のIM管理ノードファイルの例
{ "meta":{ ・・・ }, "simtData": [ ・・・ { "sid": "_JP1PC-IMB_MHOST/_JP1PC-M_AHOST/_JP1PC-AHOST_AHOST/_HOST_AHOST/_JP1PC-A_Linux%20metric%20collector%28Node%20exporter%29", "value": { "component": "/HITACHI/JP1/JPCCS/CONFINFO", "category": "platform", "visible": true, "label": "Linux metric collector(Node exporter)", "property": { "jp1_pc_prome_hostname": "ahost", "job": "jpc_node", "jp1_pc_exporter": "JPC Node exporter", "jp1_pc_trendname": "node_exporter" }, "jp1im_TrendData_labels": { "jp1_pc_prome_hostname": "ahost", "job": "jpc_node", "instance": "ahost:20716", "jp1_pc_nodelabel": "Linux metric collector(Node exporter)" }, "methods": [ "__metricListGet", "__timeSeriesDataGet" ] } }, { "sid": "_JP1PC-IMB_MHOST/_JP1PC-M_AHOST/_JP1PC-AHOST_AHOST/_HOST_AHOST/_JP1PC-A_Linux%20metric%20collector%28Node%20exporter%29-01", "value": { "component": "/HITACHI/JP1/JPCCS/CONFINFO", "category": "platform", "visible": true, "label": "Linux metric collector(Node exporter)", "property": { "jp1_pc_prome_hostname": "ahost", "job": "jpc_node", "jp1_pc_exporter": "JPC Node exporter", "jp1_pc_trendname": "node_exporter" }, "jp1im_TrendData_labels": { "jp1_pc_prome_hostname": "ahost", "job": "jpc_node", "instance": "ahost:29999", "jp1_pc_nodelabel": "Linux metric collector(Node exporter)" }, "methods": [ "__metricListGet", "__timeSeriesDataGet" ] } }, ・・・ ] }
instanceのキーに「ahost:20716」が設定されているIM管理ノードのオブジェクトを削除し,残す構成情報のSIDの末尾の「-xx」を削除します。編集後のIM管理ノードファイルを,次に示します。
-
編集後のIM管理ノードファイルの例
{ "meta":{ ・・・ }, "simtData": [ ・・・ { "sid": "_JP1PC-IMB_MHOST/_JP1PC-M_AHOST/_JP1PC-AHOST_AHOST/_HOST_AHOST/_JP1PC-A_Linux%20metric%20collector%28Node%20exporter%29", "value": { "component": "/HITACHI/JP1/JPCCS/CONFINFO", "category": "platform", "visible": true, "label": "Linux metric collector(Node exporter)", "property": { "jp1_pc_prome_hostname": "ahost", "job": "jpc_node", "jp1_pc_exporter": "JPC Node exporter", "jp1_pc_trendname": "node_exporter" }, "jp1im_TrendData_labels": { "jp1_pc_prome_hostname": "ahost", "job": "jpc_node", "instance": "ahost:29999", "jp1_pc_nodelabel": "Linux metric collector(Node exporter)" }, "methods": [ "__metricListGet", "__timeSeriesDataGet" ] } }, ・・・ ] }
-
- ■IM管理ノードツリーファイルの編集
-
jddcreatetreeコマンドにより出力されたIM管理ノードツリーファイルを編集します。
構成の削除を行った場合,削除したIM管理ノードのツリーオブジェクトの記述を削除します。
設定変更を行った場合,構成情報のSIDの末尾に「-xx」が付与されている構成情報のSIDの記述を,targetの配列から削除します。
Node exporterの設定を変更した場合の編集例を,次に示します。
-
編集前のIM管理ノードツリーファイルの例
{ "meta":{ ・・・ }, "simtData": [ ・・・ { "sid": "_ROOT_AllSystems/_HOST_AHOST/_CATEGORY_platform/_OBJECT_JP1PC-ALinux%20metric%20collector%28Node%20exporter%29", "value": { "target": [ "_JP1PC-IMB_MHOST/_JP1PC-M_AHOST/_JP1PC-AHOST_AHOST/_HOST_AHOST/_JP1PC-A_Linux%20metric%20collector%28Node%20exporter%29" ], "label": "Linux metric collector(Node exporter)" } }, { "sid": "_ROOT_AllSystems/_HOST_AHOST/_CATEGORY_platform/_OBJECT_JP1PC-ALinux%20metric%20collector%28Node%20exporter%29-01", "value": { "target": [ "_JP1PC-IMB_MHOST/_JP1PC-M_AHOST/_JP1PC-AHOST_AHOST/_HOST_AHOST/_JP1PC-A_Linux%20metric%20collector%28Node%20exporter%29-01" ], "label": "Linux metric collector(Node exporter)" } }, ・・・ ] }
-
編集後のIM管理ノードツリーファイルの例
{ "meta":{ ・・・ }, "simtData": [ ・・・ { "sid": "_ROOT_AllSystems/_HOST_AHOST/_CATEGORY_platform/_OBJECT_JP1PC-ALinux%20metric%20collector%28Node%20exporter%29", "value": { "target": [ "_JP1PC-IMB_MHOST/_JP1PC-M_AHOST/_JP1PC-AHOST_AHOST/_HOST_AHOST/_JP1PC-A_Linux%20metric%20collector%28Node%20exporter%29" ], "label": "Linux metric collector(Node exporter)" } }, ・・・ ] }
-
- ■IM管理ノード関連ファイルの編集しない場合の動作
-
IM管理ノード関連ファイルを編集しない場合,トレンドデータ管理DBから構成変更前のサンプルが削除されるまで,それらのIM管理ノードが作成されます。設定変更の場合,アドオンプログラム,または,ユーザー独自のPrometheusおよびFluentdが発行するJP1イベントは,構成情報のSIDの末尾に「-xx」が付与されていないIM管理ノードにマッピングされます。
(d) 製品プラグインの設定(Windowsの場合)
製品プラグインの設定方法について説明します。
■ トレンド表示するメトリックを定義する(オプション)
統合オペレーション・ビューアーの[トレンド]タブで表示するメトリックを,メトリック定義ファイルに定義します。主要なメトリックは,初期設定されています。メトリック定義ファイルについては,「JP1/Integrated Management 3 - Manager コマンド・定義ファイル・APIリファレンス」の各メトリック定義ファイル(2. 定義ファイル)を参照してください。
■ AWS定義ファイルを設定する(オプション)
Yet another cloudwatch exporterで監視を行う場合,AWS定義ファイルを編集し,Yet another cloudwatch exporterで監視するときに使用するAWSのアカウントIDと,SIDやIM管理ノードのプロパティに設定するアカウント文字列のマッピングを指定します。
AWS定義ファイルの詳細については,マニュアル「JP1/Integrated Management 3 - Manager コマンド・定義ファイル・APIリファレンス」の「AWS定義ファイル(aws_settings.conf)」(2. 定義ファイル)を参照してください。
■ システムノード定義ファイル(imdd_systemnode.conf)を編集する(Yet another cloudwatch exporterを使用する場合だけ必須)
アドオンプログラムのYet another cloudwatch exporterを使用して監視を行い,システムノードを作成する場合,JP1/IM - Managerのシステムノード定義ファイル(imdd_systemnode.conf)を設定します。
この設定は,アドオンプログラムのYet another cloudwatch exporterを使用して監視する場合は,必須の設定となります。
マニュアル「JP1/Integrated Management 3 - Manager 導入・設計ガイド」の「3.15.6(1)(i)ツリーの形式」に示すシステムノードを作成するときは,システムノード定義ファイル(imdd_systemnode.conf)を編集して,次の設定項目を指定します。ここに記載のない設定項目については,任意の値を指定します。
項目名 |
説明 |
---|---|
displayName |
Amazon CloudWatchのメトリクスを発行するサービスの名前※を指定します。 |
type |
AWS名前空間名※を指定します。 スラッシュ(/)は,ハイフン(-)に変更して指定してください。 |
name |
次の文字列を指定します。 [{".*":"regexp"}] |
- 注※
-
Amazon CloudWatchのWebページに記載されている内容を示します。
Yet another cloudwatch exporterのメトリック定義ファイル(metrics_ya_cloudwatch_exporter.conf)の初期設定で監視するAWS名前空間に対して,システム管理ノードの設定する場合に,システムノード定義ファイルの各項目に設定する値の例を,次に示します。
displayName |
type |
name |
---|---|---|
Amazon Simple Storage Service |
JP1PC-AWS-S3 |
[{".*":"regexp"}] |
AWS Lambda |
JP1PC-AWS-LAMBDA |
|
Amazon DynamoDB |
JP1PC-AWS-DYNAMODB |
|
AWS Step Functions |
JP1PC-AWS-STATES |
|
Amazon Simple Queue Service |
JP1PC-AWS-SQS |
|
Amazon Elastic Container Service |
JP1PC-AWS-ECS |
|
Amazon Elastic Block Store |
JP1PC-AWS-EBS |
|
Amazon Elastic File System |
JP1PC-AWS-EFS |
|
FSx File System |
JP1PC-AWS-FSX |
|
Simple Notification Service |
JP1PC-AWS-SNS |
|
Relational Database Service |
JP1PC-AWS-RDS |
上記の内容をシステムノード定義ファイルに設定した場合,次のとおりになります。
{ "meta":{ "version":"2" }, "allSystem":[ { "id":"strageSystem", "displayName":"Amazon Simple Storage Service", "objectRoot":[ { "type":"JP1PC-AWS-S3", "name":[{".*":"regexp"}] } ] }, { "id":"lambda", "displayName":"AWS Lambda", "objectRoot":[ { "type":"JP1PC-AWS-LAMBDA", "name":[{".*":"regexp"}] } ] }, { "id":"dynamodb", "displayName":"Amazon DynamoDB", "objectRoot":[ { "type":"JP1PC-AWS-DYNAMODB", "name":[{".*":"regexp"}] } ] }, { "id":"states", "displayName":"AWS Step Functions", "objectRoot":[ { "type":"JP1PC-AWS-STATES", "name":[{".*":"regexp"}] } ] }, { "id":"sqs", "displayName":"Amazon Simple Queue Service", "objectRoot":[ { "type":"JP1PC-AWS-SQS", "name":[{".*":"regexp"}] } ] }, { "id":"ecs", "displayName":"Amazon Elastic Container Service", "objectRoot":[ { "type":"JP1PC-AWS-ECS", "name":[{".*":"regexp"}] } ] }, { "id":"ebs", "displayName":"Amazon Elastic Block Store", "objectRoot":[ { "type":"JP1PC-AWS-EBS", "name":[{".*":"regexp"}] } ] }, { "id":"efs", "displayName":"Amazon Elastic File System", "objectRoot":[ { "type":"JP1PC-AWS-EFS", "name":[{".*":"regexp"}] } ] }, { "id":"fsx", "displayName":"FSx File System", "objectRoot":[ { "type":"JP1PC-AWS-FSX", "name":[{".*":"regexp"}] } ] }, { "id":"sns", "displayName":"Simple Notification Service", "objectRoot":[ { "type":"JP1PC-AWS-SNS", "name":[{".*":"regexp"}] } ] }, { "id":"rds", "displayName":"Relational Database Service", "objectRoot":[ { "type":"JP1PC-AWS-RDS", "name":[{".*":"regexp"}] } ] } ] }
システムノード定義ファイルの設定を行ったあと,JP1/IM - Managerのjddcreatetreeコマンドを実行して,EC2以外のCloudWatchを作成すると,JP1/IM - Managerの統合オペレーション・ビューアーの[稼働状況]領域で,AWS名前空間名に応じたシステムノードの配下に,IM管理ノードが表示されます。
システムノード定義ファイルの詳細については,マニュアル「JP1/Integrated Management 3 - Manager コマンド・定義ファイル・API リファレンス」の「システムノード定義ファイル(imdd_systemnode.conf)」(2. 定義ファイル)を参照してください。
■ credentialsファイルの配置について
アドオンプログラムのYet another cloudwatch exporterで監視を行う場合,「1.21.2(7) Yet another cloudwatch exporterの設定」の「(b) CloudWatchに接続するための設定を変更する(Windowsの場合)(オプション)」に記載しているcredentialsファイルは,「C:\Windows\System32\config\systemprofile\.aws\」に配置してください。
■ IM管理ノードカテゴリ名称定義ファイル(imdd_category_name.conf)の編集(オプション)
サービス監視機能を使用する場合,次の設定を行います。ただし,JP1/IM - Manager 13-01以降を新規インストールしたときは,インストール時に設定されているため,この設定は不要です。
- IM管理ノードカテゴリ名称定義ファイル(imdd_category_name.conf)に,次の表に示す定義を追加します。サービス監視機能によって作成するエージェントSIDのIM管理ノードは,この表で示した表示カテゴリ名称の値で表示されます。なお,定義を追加しない場合は,IM管理ノードのカテゴリは「service」(指定カテゴリIDの値)となります。すでに指定カテゴリIDに「service」を設定しているときは,この設定は不要です。
-
表1‒9 サービス監視機能のカテゴリ 表示カテゴリ名称
指定カテゴリID
Service
service
この定義ファイルの詳細については,マニュアル「JP1/Integrated Management 3 - Manager コマンド・定義ファイル・API リファレンス」の「IM管理ノードカテゴリ名称定義ファイル(imdd_category_name.conf)」(2. 定義ファイル)を参照してください。