DBXエージェントの設定

DBXエージェントに必要な設定は、whatap.confファイルに作成されます。 設定できるオプションについては、次を参照してください。

基本オプション

• license String

  エージェントのインストール時にサーバーから付与されたプロジェクトアクセスキーを設定します。プロジェクトアクセスキーには、エージェントが属するプロジェクトとセキュリティ通信のためのパスワードキーが含まれています。

• whatap.server.host String

  既定値127.0.0.1,127.0.0.1

  エージェントが収集したデータを送信するWhaTap収集サーバーのIPアドレスを設定します。収集サーバーの冗長化で2つ以上のIPを所有する場合は、コンマ(,)を区切り文字として使用します。設定したIPアドレスには、収集サーバーproxyデーモンがリスニング状態でサービスされる必要があります。

• whatap.server.port String

  既定値6600

  収集サーバーのポート(port)を設定します。ポートは1つのみ設定ができるので、whatap_server_hostに設定した収集サーバーは同一ポートを使用する必要があります。

• dbms String

  oracle

  注意

  別のオプション値を入力すると、モニタリングのデータ収集が正常に動作しない場合があります。

• db String

  接続するデータベース名です。

• db_ip String

  モニタリングするデータベースサーバーのIPアドレスを設定します。

• db_port String

  データベースが通信に使用するポート番号を設定します。

データ収集

• conn_fail_count Int

  既定値 15

  15回連続connection errorが発生した時に通知を送信します。 希望する回数を入力して、通知の発生基準を調整できます。

• db_param_enabled Boolean

  既定値 true

  DBパラメータの収集有無を設定します。

• event String

  既定値:

  計8つのイベントを見る

  db file scattered read, db file sequential read, direct path read, direct path write,
  enq: TX - row lock contention, latch free, library cache lock, library cache pin

  RAC環境の時は、gc cr block receive time、gc current block receive timeの2つの指標を基にさらに収集します。

  v$system_eventで上記の指標に該当する値を収集します。 db_oracle_counterカテゴリで確認でき、イベントごとに次の3つの値を収集します。

  • time waited : 当該イベントで待ち受けた総時間(単位: 1/100秒). 例) db file sequential read time waited
  • timeouts : タイムアウトに終わった待機回数 例) db file sequential read total timeouts
  • total waits : 当該イベントが発生した総回数 例) db file sequential read total waits

  cf.) Oracle Proでは、event+=といった方法で作成すると、基本のほかに追加の指標を設定できますが、この製品では対応していません。

• interval_sec Boolean DBX agent v1.7.3 or later

  既定値 true

  エージェントで5秒単位で収集したデータを、秒単位(delta1秒値)に換算して報告するオプションです。

• ora_bind_saving Boolean

  既定値 true

  SQL実行時間が5秒以上の場合v$sql_bind_captureで該当SQLのbind値を収集します。 (sysアカウント除外)

  cf.) oracle proでは、bind_interval、bind_max_count、bind_elapseにオプションが分かれています。

• ora_plan_saving Boolean

  既定値 true

  SQL planが変更またはSQL実行時間が5秒以上の場合v$sql_planでplan情報を収集します。 (sysアカウント除外)

  cf.) oracle proではplan_change、plan_elapseにオプションが分かれています。

• ora_ratio Boolean DBX agent v1.6.11 or later

  既定値false

  各種ratio指標を追加で収集できます。 収集する指標は次のとおりです。

  • buffer cache hit ratio
  • soft parse ratio
  • hard parse ratio
  • library cache hit ratio
  • library cache pin hit ratio
  • library cache get hit ratio
  • latch hit ratio
  • shared pool free mem ratio

• segments Boolean

  既定値 true

  セグメントサイズの情報を収集します。 統計/レポート > テーブルスペース容量増減メニューからデータベースまたはテーブルスペースを選択すると、サイズ情報を確認できます。

• segments_exclude_sys Boolean

  既定値 true

  sysに該当するアカウントを除いて、サイズ情報を収集します。

• segments_hour Int

  既定値5

  セグメントサイズの情報を収集する時刻を設定します。 既定値は5であり、午前5時に収集を始めます。

• segments_max_count Int

  既定値50

  テーブルスペースごとにサイズの大きいセグメント50個だけを収集して保存します。

• segments_min_size Int

  既定値10

  セグメントサイズの情報を収集する最小単位の既定値は10MBです。 セグメントサイズ情報を収集する時に設定した値よりも小さいサイズのセグメントサイズ情報は収集しません。

• segments_sys String

  既定値:

  計18個のアカウントを表示

  SYS, OUTLN, SYSTEM, AUDSYS, DBSNMP, GSMADMIN_INTERNAL,
  XDB, WMSYS, OJVMSYS, CTXSYS, ORDSYS, ORDDATA,
  MDSYS, LBACSYS, DVSYS, DBSFWUSER, APPQOSSYS, OLAPSYS

  sysに該当するアカウントの一覧です。 上記のアカウントに追加したい場合はsegments_sys='xxx','xxx','xxx'で上記の内容を含めて追加で書いてください。

• stat String

  既定値:

  計22の指標を見る

  consistent gets, cpu used by this session, db block changes, db block gets, db time,
  data blocks consistent reads - undo records applied, enqueue waits, execute count,
  logons current, opened cursors current, parse count (hard), parse count (total),
  physical reads, physical writes, redo entries, rollback changes - undo records applied,
  session logical reads, sorts (disk), sorts (memory), transaction tables consistent reads - undo records applied, user commits, user rollbacks

  v$sysstatで上記の指標に該当する値を収集します。 db_oracle_counterカテゴリで確認できます。

  cf.) Oracle Proでは、stat+=といった方法で作成すると、基本のほかに追加の指標を設定できますが、この製品では対応していません。

• xview_min_sec Int

  既定値0

  xview収集時、クエリの実行時間が設定された時間よりも長くかかる場合にのみ収集します。 デフォルト設定では、実行時間が0秒以上のすべてのクエリを収集します。

ユーザーメトリック収集 (SQLMON)

SQLMON は、ユーザー定義の SQL 結果を定期的に収集し、メトリクスとして保存します。 数値を返し、負荷が低いクエリに適しています。

• sqlmon Int

  既定値: 1

  • 1: dbx と sqlmon を同時に実行
  • 2: sqlmon のみ実行

  対応バージョン: 2.3.5 以上

設定

1. dbx エージェント配下に sqlmon ディレクトリを作成し、収集したいクエリを <filename>.sql ファイルとして作成します。

dbx/
└── sqlmon/
    ├── active_sessions.sql
    └── lock_count.sql

2. 収集するクエリを <filename>.sql ファイルとして保存します。

.sql ファイルの1行目に実行オプションを、2行目以降に SQL 文を記述します。

オプション形式

周期(分);動作時間;タグ名
SQL文

項目	説明	例
周期	実行周期（分単位）、最小値 1	1 → 1分ごとに実行
動作時間	HHMM-HHMM 形式、カンマ（,）で複数の時間帯を指定可能。0 の場合は常時実行	0900-1100 → 09:00〜11:00のみ実行
タグ名	メトリクスに保存するタグ名。省略時はファイル名がタグ名として使用されます	whatap

例：1分周期、09:00〜11:00動作、タグ名 whatap

1;0900-1100;whatap
SELECT count(*) FROM active_sessions

例：1分周期、常時動作、タグ名はファイル名を使用

1;0
SELECT count(*) FROM active_sessions

ノート

• 動作時間は日付をまたいで設定できます。（例：2300-0100 → 23:00〜翌日01:00）
• タグ名を省略する場合、動作時間の後にセミコロン（;）を付けないでください。
• SQL 文の末尾にセミコロン（;）を付けないでください。

3. whatap.conf で SQLMON を有効化します。

4. エージェントを再起動します。

5. サイトマップ > メトリクス照会 メニューで、sqlmon カテゴリを確認します。

# whatap.conf
sqlmon=1

AES256暗号化の適用

WhaTap DBXエージェントは、収集されたデータを暗号化してサーバーに送信します。データの重要度や設定によって変更できます。基本的にXOR演算とAESアルゴリズムによる暗号化を使用し、平文を128ビット単位に分割して暗号化、復号を行います。ユーザー設定により、256ビットまで拡張できます。

WhaTap DBXエージェントをインストールしたパスで、whatap.confファイルを次のオプションに追加します。

whatap.conf

cypher_level=256

設定を追加してから、エージェントを再起動してください。

エージェント名の設定

自動設定する

エージェント設定(whatap.conf)で名前を設定しないと、エージェント名はIP アドレスとポート番号が結合されて自動指定されます。例えば、IPアドレスが10.11.12.13であり、ポート番号が3000であれば、エージェント名はDBX-12-13-3000に設定されます。

エージェント名を決定する主な変数については、以下を参照してください。

設定	説明
{type}	DBX値を使います。
{ip0}	IPv4アドレスのうち、第1オクテットを使用します。(例：10.11.12.13のうち10)
{ip1}	IPv4アドレスのうち、第2オクテットを使用します。(例：10.11.12.13のうち11)
{ip2}	IPv4アドレスのうち、第3オクテットを使用します。(例：10.11.12.13のうち12)
{ip3}	IPv4アドレスのうち、第4オクテットを使用します。(例：10.11.12.13のうち13)
{port}	データベースサーバのポート

ノート

RDSのようにIPアドレスが数字でなければDBX-{ip0}-{hash}-{port}形式で名前が設定されます。ここで{hash}値は、IPアドレスを4桁の16進数に変換した値です。

手動設定する

エージェント名を直接設定したい場合は、whatap.confファイルでwhatap.nameまたはobject_nameオプションに目的の名前を入力します。ユーザーが入力した名前がエージェント名として設定されます。

whatap.conf

whatap.name=agent-1234
# or
object_name=agent-1234