1.23.1　OracleDB exporterの設定

ここでは，統合エージェントホストのオプション機能であるOracleDB exporterの設定手順について説明します。

〈この項の構成〉

(1)　OracleDB exporterの設定の前準備
(2)　OracleDB exporterのインストール
(3)　OracleDB exporterのアンインストール
(4)　OracleDB exporterの設定
(5)　クラスタ環境

(1)　OracleDB exporterの設定の前準備

OracleDB exporterの設定をする前準備について説明します。

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

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

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

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

oracledb_exporter_windows_VVRRSS.zip（Windows版）
oracledb_exporter_linux_VVRRSS.tar.gz（Linux版）

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

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

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

■ メトリック定義ファイルの配置

論理ホスト運用で，JP1/IM - Manager 13-01より前のバージョンからバージョンアップした場合，次の手順を実施します。

次に示すOracleDB exporterのメトリック定義ファイルをコピーし，コピー先の定義ファイル名にリネームする。
- Windowsの場合
  
  コピー元のファイル名：JP1/IM - Managerのインストール先\jp1imm\conf\imdd\plugin\jp1pccs\metrics_oracledb_exporter.conf.model
  
  コピー先のファイル名：JP1/IM - Managerのインストール先\jp1imm\conf\imdd\plugin\jp1pccs\metrics_oracledb_exporter.conf
- Linuxの場合
  
  コピー元のファイル名：JP1/IM - Managerのインストール先/jp1imm/conf/imdd/plugin/jp1pccs/metrics_oracledb_exporter.conf.model
  
  コピー先のファイル名：JP1/IM - Managerのインストール先/jp1imm/conf/imdd/plugin/jp1pccs/metrics_oracledb_exporter.conf
Linuxの場合は，パーミッションを「600」に設定します。

また，論理ホスト運用の場合，このファイルを次の場所に配置します。
- Windowsの場合
  
  共有フォルダ\jp1imm\conf\imdd\plugin\jp1pccs\
- Linuxの場合
  
  共有ディレクトリ/jp1imm/conf/imdd/plugin/jp1pccs/

■ IMマネージャー更新可能定義ファイルリスト定義ファイルの更新

論理ホスト運用で，JP1/IM - Manager 13-01より前のバージョンからバージョンアップした場合，次の手順を実施します。

次に示すIMマネージャー更新可能定義ファイルリスト定義ファイルをコピーし，コピー先の定義ファイル名にリネームする。
- Windowsの場合
  
  コピー元のファイル名：JP1/IM - Managerのインストール先\jp1imm\conf\imdd\system\fileoperation\imdd_product_deffile_list.json.update
  
  コピー先のファイル名：JP1/IM - Managerのインストール先\jp1imm\conf\imdd\system\fileoperation\imdd_product_deffile_list.json
- Linuxの場合
  
  コピー元のファイル名：JP1/IM - Managerのインストール先/jp1imm/conf/imdd/system/fileoperation/imdd_product_deffile_list.json.update
  
  コピー先のファイル名：JP1/IM - Managerのインストール先/jp1imm/conf/imdd/system/fileoperation/imdd_product_deffile_list.json
また，論理ホスト運用の場合，このファイルを次の場所に配置します。
- Windowsの場合
  
  共有フォルダ\jp1imm\conf\imdd\system\fileoperation\
- Linuxの場合
  
  共有ディレクトリ/jp1imm/conf/imdd/system/fileoperation/

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

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

■ JP1/IM - Agentの停止

JP1/IM - Agentのサービスを停止します。

物理ホストの場合

次のコマンドを実行して，JP1/IM - Agentのサービスを停止します。

jpc_service_stop -s all

論理ホストの場合

クラスタソフトから停止します。

■ OracleDB exporterのスクレイプジョブの設定

バージョンアップ時にPrometheusの設定ファイルのモデルファイルが更新されます。Prometheus設定ファイルのモデルファイル（jpc_prometheus_server.yml.model）の次の内容をPrometheus設定ファイル（jpc_prometheus_server.yml）のscrape_configs配下に記載してください。

論理ホスト運用の場合は，次のファイルを更新します。

Windowsの場合

共有フォルダ\jp1ima\conf\jpc_prometheus_server.yml
Linuxの場合

共有ディレクトリ/jp1ima/conf/jpc_prometheus_server.yml

（略）
   ：
scrape_configs:
   ：
  - job_name: 'jpc_oracledb'
    scrape_interval: 60s
    scrape_timeout: 30s
    metrics_path: /metrics
    file_sd_configs:
      - files:
        - 'jpc_file_sd_config_oracledb.yml'
    relabel_configs:
      - source_labels: [__address__]
        target_label: instance
        regex: ([^:]+):([^:]+):(.*)
        replacement: ${1}:${2}
      - source_labels: [__address__]
        target_label: jp1_pc_nodelabel
        regex: ([^:]+):([^:]+):(.*)
        replacement: ${2}
      - source_labels: [__address__]
        target_label: __address__
        regex: ([^:]+):([^:]+):(.*)
        replacement: @@hostname@@^※:${3}
    metric_relabel_configs:
      - source_labels: ['__name__']
        regex: 'oracledb_sessions_value|oracledb_resource_current_utilization|oracledb_resource_limit_value|oracledb_asm_diskgroup_total|oracledb_asm_diskgroup_free|oracledb_activity_execute_count|oracledb_activity_parse_count_total|oracledb_activity_user_commits|oracledb_activity_user_rollbacks|oracledb_activity_physical_reads_cache|oracledb_activity_consistent_gets_from_cache|oracledb_activity_db_block_gets_from_cache|oracledb_process_count|oracledb_wait_time_administrative|oracledb_wait_time_application|oracledb_wait_time_commit|oracledb_wait_time_concurrency|oracledb_wait_time_configuration|oracledb_wait_time_network|oracledb_wait_time_other|oracledb_wait_time_scheduler|oracledb_wait_time_system_io|oracledb_wait_time_user_io|oracledb_tablespace_bytes|oracledb_tablespace_max_bytes|oracledb_tablespace_free|oracledb_tablespace_used_percent|oracledb_exporter_last_scrape_duration_seconds|oracledb_exporter_last_scrape_error|oracledb_exporter_scrapes_total|oracledb_up'
        action: 'keep'

注※: JP1/IM - Agentのホスト名（論理ホスト運用の場合は，論理ホスト名）を指定します。

■ OracleDB exporterのディスカバリ設定ファイルの配置

次に示すOracleDB exporterの監視対象を定義する定義ファイルのモデルファイルをコピーし，コピー先の定義ファイル名にリネームする。
- Windowsの場合
  
  コピー元のファイル名：JP1/IM - Agentのインストール先\jp1ima\conf\jpc_file_sd_config_oracledb.yml.model
  
  コピー先のファイル名：JP1/IM - Agentのインストール先\jp1ima\conf\jpc_file_sd_config_oracledb.yml
- Linuxの場合
  
  コピー元のファイル名：JP1/IM - Agentのインストール先/jp1ima/conf/jpc_file_sd_config_oracledb.yml.model
  
  コピー先のファイル名：JP1/IM - Agentのインストール先/jp1ima/conf/jpc_file_sd_config_oracledb.yml
Linuxの場合は，パーミッションを「600」に設定します。

また，論理ホスト運用の場合，このファイルを次の場所に配置します。
- Windowsの場合
  
  共有フォルダ\jp1ima\conf\
- Linuxの場合
  
  共有ディレクトリ/jp1ima/conf/

手順1.で作成したjpc_file_sd_config_oracledb.ymlファイルをテキストエディターで開き，次のように編集して上書き保存する。

- targets:
#  - <OracleDB hostname>:<an arbitrary name>:<oracledb_exporter port>
  labels:
    jp1_pc_exporter: JPC OracleDB exporter
    jp1_pc_category: database
    jp1_pc_trendname: oracledb_exporter
    jp1_pc_remote_monitor_instance: @@hostname@@^※:OracleDB collector(OracleDB exporter)

注※: JP1/IM - Agentのホスト名（論理ホスト運用の場合は，論理ホスト名）を指定します。

■ IMエージェント更新可能定義ファイルリスト定義ファイルの更新

IMエージェント更新可能定義ファイルリスト定義ファイルを更新する手順を次に示します。

次に示すIMエージェント更新可能定義ファイルリスト定義ファイルをコピーし，コピー先の定義ファイル名にリネームする。
- Windowsの場合
  
  コピー元のファイル名：JP1/IM - Agentのインストール先\jp1ima\conf\jpc_product_deffile_list.json.update
  
  コピー先のファイル名：JP1/IM - Agentのインストール先\jp1ima\conf\jpc_product_deffile_list.json
- Linuxの場合
  
  コピー元のファイル名：JP1/IM - Agentのインストール先/jp1ima/conf/jpc_product_deffile_list.json.update
  
  コピー先のファイル名：JP1/IM - Agentのインストール先/jp1ima/conf/jpc_product_deffile_list.json
また，論理ホスト運用の場合，このファイルを次の場所に配置します。
- Windowsの場合
  
  共有フォルダ\jp1ima\conf\
- Linuxの場合
  
  共有ディレクトリ/jp1ima/conf/

■ 設定内容のチェック

Prometheus serverの定義ファイルは，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

■ JP1/IM - Agentの起動

JP1/IM - Agentのサービスを起動します。

物理ホストの場合

次のコマンドを実行して，JP1/IM - Agentのサービスを起動します。
```
jpc_service_start -s all
```
論理ホストの場合

クラスタソフトから起動します。

ページの先頭へ

(2)　OracleDB exporterのインストール

OracleDB exporterをインストールする手順について説明します。

(a)　OracleDB exporterの配置

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

注※

Windowsの場合

oracledb_exporter_windows_VVRRSS.zip
Linuxの場合

oracledb_exporter_linux_VVRRSS.tar.gz

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

(b)　デフォルトのメトリック定義ファイルの作成

次に示すデフォルトのメトリック定義ファイルのモデルファイルをコピーし，コピー先の定義ファイル名にリネームする。
- Windowsの場合
  
  コピー元のファイル名：OracleDB exporterの配置先\oracledb_exporter_windows\jp1ima\conf\default-metrics.toml.model
  
  コピー先のファイル名：OracleDB exporterの配置先\oracledb_exporter_windows\jp1ima\conf\default-metrics.toml
- Linuxの場合
  
  コピー元のファイル名：OracleDB exporterの配置先/oracledb_exporter_linux/jp1ima/conf/default-metrics.toml.model
  
  コピー先のファイル名：OracleDB exporterの配置先/oracledb_exporter_linux/jp1ima/conf/default-metrics.toml

(c)　監視対象の追加

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

ページの先頭へ

(3)　OracleDB exporterのアンインストール

OracleDB exporterをアンインストールする手順について説明します。

(a)　監視対象の削除

OracleDB exporterをアンインストールする場合，監視対象をすべて削除したあと，OracleDB exporterを削除してください。監視対象削除の詳細については，「1.23.1(4)(d)　監視対象を削除する（オプション）」を参照してください。

(b)　OracleDB exporterの削除

OracleDB exporterの削除は，「1.23.1(2)(a)　OracleDB exporterの配置」で配置したフォルダを削除してください。

ページの先頭へ

(4)　OracleDB exporterの設定

OracleDB exporterの設定方法について説明します。

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

■ 監視対象を追加するための準備

OracleDB exporterのインスタンス名を決める。

OracleDB exporterは監視対象ごとに起動する必要があります。複数の監視対象がある場合，複数のOracleDB exporterサービスを作成する必要があります。OracleDB exporterサービスを区別するための識別子を「インスタンス名」と呼びます。
- インスタンス名に使用できる文字は英数字だけです。
- インスタンス名の長さは32バイト以内です。
OracleDB exporterのリッスンポートを決める。

OracleDB exporterサービスがリッスンするポート番号を決めます。ほかのサービスやほかのOracleDB exporterサービスで使用していないポート番号にしてください。

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

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

Windowsの場合

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

Linuxの場合

ホスト種別	環境変数JP1IMADIR
物理ホスト運用の場合	`/opt/jp1ima`
論理ホスト運用の場合	共有ディレクトリ`/jp1ima`

環境変数DATA_SOURCE_NAMEに設定する値を確認する。

OracleDB exporterのサービス定義ファイルに設定する環境変数DATA_SOURCE_NAMEには，接続用ユーザーや接続先情報を設定する必要があります。

環境変数DATA_SOURCE_NAMEは，次の書式で指定します。
- Windowsの場合
  
  oracle://ユーザー名@ホスト名:ポート/サービス名?connection timeout=10[&instance name=インスタンス名]
- Linuxの場合
  
  oracle://ユーザー名@ホスト名:ポート/サービス名?connection timeout=10 [&instance name=インスタンス名]
- ユーザー名
  
  Oracle Databaseへの接続に使用するユーザーのユーザー名を指定します。
  
  指定できる文字は，英大文字，数字，アンダースコア，ドル記号，シャープ記号，ピリオド，アットマークです。30字以内で指定してください。
- ホスト名
  
  監視対象のOracleDBホストのホスト名を指定します。
  
  指定できる文字は，英大文字，英小文字，数字，-（ハイフン），.（ピリオド）です。253文字以内で指定してください。
- ポート
  
  Oracleリスナーに接続するためのポート番号を指定します。
- サービス名
  
  Oracleリスナーのサービス名を指定します。
  
  使用できる文字，英大文字，英小文字，数字，_（アンダースコア），-（ハイフン），.（ピリオド）です。64文字以内で指定してください。
- オプション
  
  接続オプションを指定します。複数のオプションがある場合は，Windowsでは「&」，Linuxでは「&」でつなげて指定します。
  
  ・connection timeout=秒数
  
  コネクションタイムアウトを秒数で指定します。このオプションの指定は必須です。
  
  必ず10を指定してください。
  
  10以外の値を指定，およびこのオプションを指定しなかった場合は，Prometheus serverのスクレイプがタイムアウトとなり，OracleDB exporterが稼働している場合でもupメトリックが0になる場合があります。
  
  ・instance name=インスタンス名
  
  接続するインスタンス名を指定します。このオプションの指定は任意です。
ホスト名，ポート，サービス名はOracle Databaseのlsnrctl serviceコマンドで確認できます。下記の例では，ホスト名は「ORAHOST」，ポートは「1521」，サービス名は「orcl.local」，インスタンス名は「orcl」となります。
```
$ lsnrctl service
 
LSNRCTL for 64-bit Windows: Version 19.0.0.0.0 - Production on 13-12月-2023 09:09:34
 
Copyright (c) 1991, 2019, Oracle.  All rights reserved.
 
(DESCRIPTION=(ADDRESS=(PROTOCOL=TCP)(HOST=ORAHOST)(PORT=1521)))に接続中
サービスのサマリー...
  :
  :
サービス"orcl.local"には、1件のインスタンスがあります。
  インスタンス"orcl"、状態READYには、このサービスに対する1件のハンドラがあります...
    ハンドラ:
      "DEDICATED" 確立:10674 拒否:1 状態:ready
         LOCAL SERVER
  :
  :
```
この場合，環境変数DATA_SOURCE_NAMEは，次のようになります。
- Windowsの場合
```
oracle://ユーザー名@ORAHOST:1521/orcl.local?connection timeout=10&amp;instance name=orcl
```
- Linuxの場合
```
oracle://ユーザー名@ORAHOST:1521/orcl.local?connection timeout=10&instance name=orcl
```
インテリジェント統合管理基盤のツリーに表示される監視対象名を決める。

OracleDB exporterの監視対象はインテリジェント統合管理基盤のツリーに次のように表示されます。

監視対象名には任意の名称を指定できるので適切な監視対象名を決めておいてください。
```
All Systems
     ＋ Oracle Databaseホスト名
         ＋ Database
             ＋ 監視対象名１
             ＋ 監視対象名２
```
使用できる文字および文字列の長さについては，マニュアル「JP1/Integrated Management 3 - Manager コマンド・定義ファイル・APIリファレンス」の「OracleDB exporterのディスカバリ設定ファイル（jpc_file_sd_config_oracledb.yml）」（2.　定義ファイル）を参照してください。
物理ホストで運用するか論理ホストで運用するか確認する。

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

新しく追加するOracleDB exporterをスクレイプするJP1/IM - Agentが論理ホスト運用の場合は，OracleDB exporterも論理ホスト運用となります。
監視したいメトリックが取得できることを確認する。

データ取得用のSQL文を接続に使用するユーザーで直接実行し，必要なメトリックが取得できるか確認することを推奨します。

監視したいメトリックが取得できない場合は，Oracle Databaseのサポートに問い合わせて取得できるようにしてください。

■ OracleDB exporterの設定

Windowsサービス化プログラムをコピーし，コピー先のプログラム名にリネームする。

コピー元のファイル名：OracleDB exporterの配置先\oracledb_exporter_windows\jp1ima\bin\oracledb_exporter_@@instance@@_service.exe

コピー先のファイル名：
- 物理ホスト運用の場合
  
  OracleDB exporterの配置先\oracledb_exporter_windows\jp1ima\bin\oracledb_exporter_インスタンス名^※_service.exe
- 論理ホスト運用の場合
  
  OracleDB exporterの配置先\oracledb_exporter_windows\jp1ima\bin\oracledb_exporter_インスタンス名^※_論理ホスト名_service.exe
注※

インスタンス名は，「1.23.1(4)(a)　監視対象を追加する（必須）」の「■監視対象を追加するための準備」で決めた名称を指定します。
サービス定義ファイルを作成する。

コピー元のサービス定義ファイルをコピーし，コピー先のプログラム名にリネームします。

コピー元のファイル名：OracleDB exporterの配置先\oracledb_exporter_windows\jp1ima\bin\oracledb_exporter_@@instance@@_service.xml.model

コピー先のファイル名：
- 物理ホスト運用の場合
  
  OracleDB exporterの配置先\oracledb_exporter_windows\jp1ima\bin\oracledb_exporter_インスタンス名^※_service.xml
- 論理ホスト運用の場合
  
  OracleDB exporterの配置先\oracledb_exporter_windows\jp1ima\bin\oracledb_exporter_インスタンス名^※_論理ホスト名_service.xml
注※

インスタンス名は，「1.23.1(4)(a)　監視対象を追加する（必須）」の「■監視対象を追加するための準備」で決めた名称を指定します。

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

手順2.で作成したサービス定義ファイルの次の値を変更します。

変更する値	指定する値
@@instance@@	物理ホスト運用の場合「1.23.1(4)(a)　監視対象を追加する（必須）」の「■監視対象を追加するための準備」の手順1.で決めた名称に置換する。論理ホスト運用する場合「1.23.1(4)(a)　監視対象を追加する（必須）」の「■監視対象を追加するための準備」の手順1.で決めた名称「_論理ホスト名」を付与した値に置換する。
@@oracledb_exporter_installdir@@	OracleDB exporterの配置先に置換する。
@@autostart@@	OS起動時に自動起動させたい場合 "Automatic" 自動起動させない場合 "Manual" 論理ホストの場合は"Manual"に置換する。
@@port@@	「1.23.1(4)(a)　監視対象を追加する（必須）」の「■監視対象を追加するための準備」の手順2.で決めたポート番号に置換する。論理ホストの場合は論理ホスト名も指定し，`--web.listen-address="`論理ホスト名`:`ポート番号`"`となるように置換する。
@@installdir2@@	「1.23.1(4)(a)　監視対象を追加する（必須）」の「■監視対象を追加するための準備」の手順3.で確認したディレクトリに置換する。
@@data_source_name@@	「1.23.1(4)(a)　監視対象を追加する（必須）」の「■監視対象を追加するための準備」の手順4.で確認した内容に置換する。

サービスを登録する。

手順1.で作成したコマンドを次のように実行します。
- 物理ホスト運用の場合
  
  oracledb_exporter_インスタンス名^※_service.exe install
- 論理ホスト運用の場合
  
  oracledb_exporter_インスタンス名^※_論理ホスト名_service.exe install
  
  論理ホスト運用の場合はクラスタを構成する両ノードで実行してください。
注※

インスタンス名は，「1.23.1(4)(a)　監視対象を追加する（必須）」の「■監視対象を追加するための準備」で決めた名称を指定します。
Oracle Databaseへの接続に使用するユーザーのパスワードを登録する。

Oracle Databaseへの接続に使用するユーザーのパスワードをjimasecretコマンドで登録します。
- 物理ホスト運用の場合
  
  jimasecret -add -key OracleDB.user.ユーザー名 -s パスワード
- 論理ホスト運用の場合
  
  jimasecret -add -key OracleDB.user.ユーザー名 -s パスワード -l 共有フォルダ
同一ユーザー名でパスワードが異なるユーザーを登録したい場合は，ホスト名とサービス名を含むキーを使用することができます。

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

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

コマンドラインまたはWindowsサービスコントロールマネージャーからOracleDB exporterのサービスを起動します。

クラスタ構成の場合はクラスタソフトからサービスを起動します。
OracleDB exporterで性能情報が取得できることを確認する。

curlコマンドやブラウザーで次のURLにアクセスし，性能情報が取得できているか確認してください。
```
http://ホスト名:ポート/metrics
```
ホスト名にはOracleDB exporterを起動しているホスト，ポートにはOracleDB exporterのリッスンポートを指定します。

■ Prometheusの設定

OracleDB exporterのディスカバリ設定ファイルに監視対象を追加する。

OracleDB exporterのディスカバリ設定ファイル（jpc_file_sd_config_oracledb.yml）のtargetsの下に新しいエントリーを追加します。

- targets:
#  - <OracleDB hostname>:<an arbitrary name>:<oracledb_exporter port>
  - Oracle Databaseホスト名:監視対象名1:ポート番号1
  - Oracle Databaseホスト名:監視対象名2:ポート番号2
  - Oracle Databaseホスト名:監視対象名3:ポート番号3
  - Oracle Databaseホスト名:監視対象名4:ポート番号4        ←ここに追加
  labels:
    jp1_pc_exporter: JPC OracleDB exporter
    jp1_pc_category: database
    jp1_pc_trendname: oracledb_exporter
    jp1_pc_remote_monitor_instance: インストール先のホスト名:OracleDB metric collector(OracleDB exporter)

項目	指定する値
Oracle Databaseホスト名	「1.23.1(4)(a)　監視対象を追加する（必須）」の「■監視対象を追加するための準備」の手順4.で確認したホスト名を指定する。
監視対象名	「1.23.1(4)(a)　監視対象を追加する（必須）」の「■監視対象を追加するための準備」の手順5.で決めた監視対象名を指定する。
ポート番号	「1.23.1(4)(a)　監視対象を追加する（必須）」の「■監視対象を追加するための準備」の手順2.で決めたポート番号を指定する。

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

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

promtoolはJP1/IM - Agentインストール先/jp1ima/toolsフォルダにあります。
```
promtool check config jpc_prometheus_server.yml
```
エラーが表示された場合は見直しを実施してください。
Prometheusを再起動する。

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

■ インテリジェント統合管理基盤の設定

すべてのサービスの起動が完了してから数分後にインテリジェント統合管理基盤のツリーの更新を実行する。

統合オペレーション・ビューアーからのツリー情報の生成もしくは反映，または，jddcreatetreeコマンドもしくはjddupdatetreeコマンドを実行してツリーを更新し，次の表示を確認します。
- インテリジェント統合管理基盤のツリーにOracle Databaseの監視対象が表示されていること
- 監視対象を選択し，トレンド表示できること

(b)　OracleDB exporterのポートを変更する（オプション）

OracleDB exporterのリッスンポートとPrometheusがスクレイプするポート番号を，変更する必要があります。

変更する手順を，次に示します。

Prometheusサービスを停止する。
OracleDB exporterサービスを停止する。

次の表に示す定義ファイルのOracleDB exporterのリッスンポートを変更します。

Windowsの場合

ホスト種別	変更対象ファイル
物理ホスト運用の場合	OracleDB exporterの配置先`\oracledb_exporter_windows\jp1ima\bin\oracledb_exporter_`インスタンス名`.xml`
論理ホスト運用の場合	OracleDB exporterの配置先`\oracledb_exporter_windows\jp1ima\bin\oracledb_exporter_`インスタンス名_論理ホスト名`.xml`

Linuxの場合

ホスト種別	変更対象ファイル
物理ホスト運用の場合	`/usr/lib/systemd/system/oracledb_exporter_`インスタンス名`.service`
論理ホスト運用の場合	`/usr/lib/systemd/system/oracledb_exporter_`インスタンス名_論理ホスト名`.service`

Linuxの場合，systemctl daemon-reloadコマンドを実行する。

次の表に示す定義ファイルのPrometheusがスクレイプするOracleDB exporterのポート番号を変更する。

Windowsの場合

ホスト種別	変更対象ファイル
物理ホスト運用の場合	JP1/IM - Managerのインストール先`\JP1IMM\conf\jpc_file_sd_config_oracledb.yml`
論理ホスト運用の場合	共有フォルダ`\jp1imm\conf\jpc_file_sd_config_oracledb.yml`

Linuxの場合

ホスト種別	変更対象ファイル
物理ホスト運用の場合	`/opt/jp1ima/conf/jpc_file_sd_config_oracledb.yml`
論理ホスト運用の場合	共有ディレクトリ`/jp1ima/conf/jpc_file_sd_config_oracledb.yml`

OracleDB exporterサービスを起動する。
Prometheusサービスを起動する。

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

Oracle Databaseのパスワードを変更した場合，OracleDB exporterが接続に使用するパスワードを更新する必要があります。

OracleDB exporterを停止する。
パスワードを更新する。

Oracle Databaseへの接続に使用するユーザーのパスワードをjimasecretコマンドで更新する。
- 物理ホスト運用の場合
  
  jimasecret -add -key OracleDB.user.ユーザー名 -s パスワード
- 論理ホスト運用の場合
  
  jimasecret -add -key OracleDB.user.ユーザー名 -s パスワード -l 共有フォルダ
同一ユーザー名でパスワードが異なるユーザーを登録したい場合は，ホスト名とサービス名を含むキーを使用することができます。
OracleDB exporterを起動する。

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

■ Prometheusの設定

OracleDB exporterのディスカバリ設定ファイル（jpc_file_sd_config_oracledb.yml）から監視対象を削除する。

OracleDB exporterのディスカバリ設定ファイル（jpc_file_sd_config_oracledb.yml）のtargetsに記載されている監視対象を削除します。
Prometheusを再起動する。

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

■ クラスタソフトからOracleDB exporterの削除

論理ホスト運用の場合，クラスタソフトからOracleDB exporterを削除します。必要に応じてサービスの停止なども実施してください。

■ OracleDB exporterの設定

削除する監視対象のOracleDB exporterサービスを停止する。

コマンドラインまたはWindowsサービスコントロールマネージャーからOracleDB exporterのサービスを停止します。
サービスの登録を解除する。

次のコマンドを実行してサービスの登録を解除してください。
- 物理ホスト運用の場合
  
  oracledb_exporter_インスタンス名_service.exe uninstall
- 論理ホスト運用の場合
  
  oracledb_exporter_インスタンス名_論理ホスト名_service.exe uninstall
論理ホスト運用の場合はクラスタを構成する両ノードで実行してください。
Oracle Databaseへの接続に使用するユーザーのパスワードを削除する。

ほかのOracleDB exporterで同じユーザーを使用していない場合は，登録済みのパスワードをjimasecretコマンドで削除します。
- 物理ホスト運用の場合
  
  jimasecret -rm -key OracleDB.user.ユーザー名
- 論理ホスト運用の場合
  
  jimasecret -rm -key OracleDB.user.ユーザー名 -s パスワード -l 共有フォルダ
ホスト名やリスナー名を含むキーを指定して登録した場合は，そのキーを指定してください。
サービス定義ファイルとWindowsサービス化プログラムを削除する。

OracleDB exporterの配置先\oracledb_exporter_windows\jp1ima\binフォルダに存在する次のファイルを削除してください。
- 物理ホスト運用の場合
  
  oracledb_exporter_インスタンス名_service.xml
  
  oracledb_exporter_インスタンス名_service.exe
- 論理ホスト運用の場合
  
  oracledb_exporter_インスタンス名_論理ホスト名_service.xml
  
  oracledb_exporter_インスタンス名_論理ホスト名_service.exe

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

OracleDB exporterサービスの死活監視はPrometheus serverのupメトリックで監視できます。アラート定義でOracleDB 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 OracleDB exporter"}, "jp1_pc_nodelabel", "${1}", "jp1_pc_remote_monitor_instance", "^[^:]*:([^:]*)$") == 0 or label_replace(up{jp1_pc_remote_monitor_instance!="", jp1_pc_exporter!="JPC OracleDB 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 }}"

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

Oracle Databaseに新しいユーザーを追加する。
OracleDB exporterを停止する。
変更前のユーザーのパスワードを削除する。

Oracle Databaseへの接続に使用するユーザーのパスワードをjimasecretコマンドで削除する。
- 物理ホスト運用の場合
  
  jimasecret -rm -key OracleDB.user.旧ユーザー名
- 論理ホスト運用の場合
  
  jimasecret -rm -key OracleDB.user.旧ユーザー名 -l 共有フォルダ
同一ユーザー名でパスワードが異なるユーザーを登録したい場合は，ホスト名とサービス名を含むキーを使用してください。
変更後のユーザーのパスワードを登録する。

Oracle Databaseへの接続に使用するユーザーのパスワードをjimasecretコマンドで登録します。
- 物理ホスト運用の場合
  
  jimasecret -add -key OracleDB.user.新ユーザー名 -s パスワード
- 論理ホスト運用の場合
  
  jimasecret -add -key OracleDB.user.新ユーザー名 -s パスワード -l 共有フォルダ
同一ユーザー名でパスワードが異なるユーザーを登録したい場合は，ホスト名とサービス名を含むキーを使用することができます。
環境変数DATA_SOURCE_NAMEを修正する。

サービス定義ファイルをテキストエディターで開き，環境変数DATA_SOURCE_NAMEに記載されているユーザー名を新しいユーザー名に変更して保存します。
OracleDB exporterを起動する。
Oracle Databaseから変更前のユーザーを削除する。

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

ページの先頭へ

(5)　クラスタ環境

OracleDB exporterをスクレイプするIM-Agentが論理ホスト運用の場合は，OracleDB exporterも論理ホスト運用とする必要があります。

ページの先頭へ

1.23.1 OracleDB exporterの設定

(1) OracleDB exporterの設定の前準備

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

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

■ メトリック定義ファイルの配置

■ IMマネージャー更新可能定義ファイルリスト定義ファイルの更新

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

■ JP1/IM - Agentの停止

■ OracleDB exporterのスクレイプジョブの設定

■ OracleDB exporterのディスカバリ設定ファイルの配置

■ IMエージェント更新可能定義ファイルリスト定義ファイルの更新

■ 設定内容のチェック

■ JP1/IM - Agentの起動

(2) OracleDB exporterのインストール

(a) OracleDB exporterの配置

(b) デフォルトのメトリック定義ファイルの作成

(c) 監視対象の追加

(3) OracleDB exporterのアンインストール

(a) 監視対象の削除

(b) OracleDB exporterの削除

(4) OracleDB exporterの設定

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

■ 監視対象を追加するための準備

■ OracleDB exporterの設定

■ Prometheusの設定

■ インテリジェント統合管理基盤の設定

(b) OracleDB exporterのポートを変更する（オプション）

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

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

■ Prometheusの設定

■ クラスタソフトからOracleDB exporterの削除

■ OracleDB exporterの設定

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

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

(5) クラスタ環境

1.23.1　OracleDB exporterの設定

(1)　OracleDB exporterの設定の前準備

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

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

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

(2)　OracleDB exporterのインストール

(a)　OracleDB exporterの配置

(b)　デフォルトのメトリック定義ファイルの作成

(c)　監視対象の追加

(3)　OracleDB exporterのアンインストール

(a)　監視対象の削除

(b)　OracleDB exporterの削除

(4)　OracleDB exporterの設定

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

(b)　OracleDB exporterのポートを変更する（オプション）

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

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

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

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

(5)　クラスタ環境