本文へスキップ

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

    mssql

    注意

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

  • db String

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

  • db_ip String

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

  • db_port String

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

データ収集​

  • db_param_enabled Boolean

    既定値 true

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

  • conn_fail_count Int

    既定値 15

    15回連続コネクションエラーが発生した時に通知を送信します。希望する回数を入力して、通知の発生基準を調整できます。

  • long_run_session_sec Second

    既定値10 (単位：秒)

    設定した時間より長く実行されているセッションを、long runセッションで処理します。

  • tables Boolean

    既定値 true

    テーブルサイズ情報を収集します。統計/レポート > DBサイズメニューでそのデータベースを選択すると、テーブルサイズ情報が確認できます.

  • tables_hour Int

    既定値5

    テーブルサイズ情報を保存するために、情報を収集する時刻を設定します。既定値は5であり、午前5時に収集を始めます。

  • tables_min_row Int

    既定値10000

    テーブル情報を収集する場合、設定した値より小さいrow番号のテーブル情報は収集しません。

  • skip_whatap_session Int

    既定値0

    1の場合、WhaTapがデータ収集で実行するクエリのセッションをactive session listに表示しません。(既定値：0)

  • filegroup Boolean

    既定値 true

    ファイルグループ(filegroup) サイズの収集可否を設定します。

  • filegroup_interval Int

    既定値60 (単位：秒、sec)

    ファイルグループ(filegroup) サイズ収集間隔を設定します。

  • procedure_stats Boolean

    既定値 true

    プロシージャ統計情報の収集可否を設定します。

  • procedure_interval Int

    既定値1 (単位：時間、hour)

    プロシージャ統計情報の収集間隔を設定します。

  • procedure_stat_row_limit Int

    既定値10000

    プロシージャ統計情報の収集条件を設定します。平均実行時間順、上位10000件(既定値)を基準に収集します。

  • query_stats Boolean

    既定値 true

    クエリ統計情報の収集可否を設定します。

  • query_interval Int

    既定値1 (単位：時間、hour)

    クエリ統計情報の収集間隔を設定します。

  • query_stat_row_limit Int

    既定値10000

    クエリ統計情報の収集条件を設定します。平均実行時間順、上位10000件(既定値)を基準に収集します。

  • backup_row_limit Int

    既定値50

    バックアップ履歴の収集件数を50件(既定値)に制限します。

  • restore_row_limit Int

    既定値50

    復旧履歴の収集件数を50件(既定値)に制限します。

  • job_info_row_limit Int

    既定値50

    Job実行履歴の収集件数を50件(既定値)に制限します。

  • job_history_row_limit Int

    既定値50

    Job履歴の収集件数を50件(既定値)に制限します。

ユーザーメトリック収集 (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
  1. 収集するクエリを <filename>.sql ファイルとして保存します。

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

オプション形式
周期(分);動作時間;タグ名
SQL文
項目説明例
周期実行周期（分単位）、最小値 11 → 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 文の末尾にセミコロン（;）を付けないでください。

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

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

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

# whatap.conf
sqlmon=1

デッドロック(Deadlock) の関連オプション​

次はxp_ReadErrorLogコマンドからエラーログを読み込み、デッドロック(Deadlock) 情報を確認できるエージェントオプションです。

  • mslog Boolean

    既定値 true

    xp_ReadErrorLogコマンドを実行して、エラーログを照会します。

  • mslog_interval Int

    既定値1 (単位：分、min)

    以前のサイクルから現在のサイクルまでのログを照会します。

Tips

デッドロック(Deadlock) ログを記録するためのDB設定

デッドロック(Deadlock) ログを記録するには、Trace Flag 1204が有効になっている必要があります。 Trace Flagはサーバーの動作に影響を及ぼす可能性があるため、設定及び解除作業は慎重に行う必要があります。

  • 設定確認の方法

    Trace Flag 1204の有効可否を確認するには、次のコマンドを実行します。 追跡フラグの設定状態がON(1)なのか、OFF(0)なのか確認できます。

    DBCC TRACESTATUS;

  • Trace Flag 1204有効化(ON)

    Trace Flag 1204を有効にするには、次のコマンドを実行します。

    DBCC TRACEON (1204, -1);

    • 1204：Deadlock情報を記録するTrace Flag

    • -1：サーバー全体に適用(グローバル設定)

  • Trace Flag 1204無効化(OFF)

    Trace Flag 1204を無効にするには、以下のコマンドを実行します：

    DBCC TRACEOFF (1204, -1);
ノート

  • デッドロック(Deadlock) 関連エージェントオプションは、DBXエージェント2.2.2バージョン 以降でサポートします。

  • xp_ReadErrorLogはMicrosoft SQL Serverで提供する拡張保存プロシージャであり、SQL Serverのエラーログやエージェントログの内容を照会できるようにサポートします。 これにより、SQL Serverのステータス、エラーメッセージ、アラート、または特定のイベントを素早く確認できます。

  • DBCC TRACESTATUSコマンドについての詳細は、次のリンクを参照してください。

  • DBCC TRACEONコマンドについての詳細は、次のリンクを参照してください。

  • DBCC TRACEOFFコマンドについての詳細は、次のリンクを参照してください。

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
最終修正：