DBXエージェントの設定

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

基本オプション

license String

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

既定値127.0.0.1,127.0.1

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

whatap.server.port String

既定値6600

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

mysql

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

db_ip String

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

db_port String

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

データ収集

db_param_enabled Boolean

既定値 true

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

conn_fail_count Int

既定値 15

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

deadlock_interval Int

既定値 60

deadlock情報を読み込む間隔(単位: 分)を設定します。deadlock情報は、設定した間隔で発生した最後のdeadlock情報のみを読み込みます。

long_run_session_sec Second

既定値10 (単位：秒)

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

tables Boolean

既定値 true

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

table_filesize Boolean

既定値 true

テーブルサイズの収集時にinnodb_tablespacesのfile_sizeを一緒に収集します。

tables_hour Int

既定値5

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

tables_min_row Int

既定値10000

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

replication_name String

レプリケーション名を設定すると、同じreplication_nameを持つDBの間にMaster/Slave関係があるものとみなします。

レプリケーションセットを定義するオプションとしてマスターノードとスレーブノードの両方に同じ値のreplication_nameオプションを設定するとインスタンスモニタリングでツリー構造で表示されます。また、このオプション値を基準にFlexボードでレプリケーション状態をモニタリングするウィジェットを提供します。

skip_whatap_session Int

既定値0

1が設定されている場合、WhaTapから収集するためのqueryが実行するセッションをactive session listに表示しません。(既定値：0)

skip_sys_session Int

既定値1

2が設定されている場合、sysセッション(root、system user、event_scheduler)はactive sessionで表示されません。1を設定すると、sysセッションは表示されますが、total runtimeから除外されます。
save_literal_param Boolean

既定値 true

リテラルパラメータの収集有無を設定します。falseに設定するとリテラルパラメータを収集しません。
statements_min_row Int

既定値10000 (row)

MYSQL SQL統計メニューで使用するデータを収集する基準です。performance_schema.events_statements_summary_by_digestを照会し、次の合計値がstatements_min_rowより大きい場合に収集します。

sum_rows_affected + sum_rows_sent + sum_rows_examined

ノート
MYSQL SQL統計メニューについての詳細は、次の文書を参照してください。

xview_min_sec Int

既定値0

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

trx_rseg_history_len Boolean MySQL 5.7 or later DBX agent v1.6.15 or later

既定値false

trx_rseg_history_len指標の収集有無を設定します。trueに設定するとdb_mysql_counterカテゴリで確認できます。
active_transactions Boolean MySQL 5.5 or later DBX agent v1.6.15 or later

既定値false

active_transactions指標の収集有無を設定します。trueに設定するとdb_mysql_counterカテゴリで確認できます。
collect_variables_metric Boolean DBX agent v1.6.15 or later

既定値false

DBパラメータをリアルタイムで収集できます。variables_metricオプションに設定したパラメータを収集します。
variables_metric String DBX agent v1.6.15 or later

uptime、version、read_onlyのようにDBパラメータ名を設定してください。2つ以上の値を設定するには、コンマ(,)を区切り文字として利用してください。collect_variables_metricオプションをtrueに設定してからDBパラメータ名を設定すると、db_mysql_variablesカテゴリで確認できます。
whatap.conf
```
collect_variables_metric=true
variables_metric=uptime,version
```

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

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

sqlmon Int

デフォルト値: 1
- 1: dbx と sqlmon を同時に実行
- 2: sqlmon のみ実行
対応バージョン: 2.3.5 以上

設定

エージェントのインストールパスに sqlmon ディレクトリを作成します。
収集するクエリを .sql ファイルとして保存します。
whatap.conf で SQLMON を有効化します。
エージェントを再起動します。
サイトマップ > メトリクス照会メニューで、sqlmon カテゴリを確認します。

# whatap.conf
sqlmon=1

ロック収集関連設定

モニタリング対象のDB MySQL 8.0以降、DBXエージェント2.53.01以降の場合、ロックモニタリング収集条件を多様に与えることができます。

lock Boolean

既定値 true

ロックの収集有無を指定します。
skip_lock_active_limit Int

既定値150

active_sessions(Threads_running)の個数がskip_lock_active_limit以上の場合、ロックは収集しません。
lock_interval Int

既定値5 (s)

lock収集周期を指定します。
custom_lock_interval String

指定した時間帯のロック収集周期を指定します。

ノート
ex) custom_lock_interval=60;0000-0230 # 00:00から02:30 まではlock収集周期を60秒に指定します。
custom_lock_interval=0;0000-0230 # 00:00から02:30 まではロックを収集しません。

アクティブセッション除外の設定

DBXエージェントは、MySQLのアクティブセッションの一覧を収集しますが、特定のセッションを除外するオプションを提供します。除くセッションはtotal_runtimeを計算する際に含めず、SQL統計メニューでも該当するSQLは表示されません。

limit_active_session Int

既定値200

active sessionを指定した個数まで収集します。0に設定するとlimitなしで収集します。
skip_command String

アクティブセッション収集時、オプション値に設定したcommandに該当するセッションは収集しません。例えば、次のように設定するとDaemonとSleepステータスのセッションは収集から除外できます。
whatap.conf
```
skip_command=Daemon,Sleep
```
ノート
オプション値で設定できるcommandについての詳細は、次のリンクを参照してください。
skip_sys_session Int

既定値1
- 0: sysセッション(root, system user)をアクティブセッションの収集とtotal_runtimeに含みます。
- 1: sysセッションをアクティブセッションの収集には含めますが、total_runtimeからは除外します。
- 2: sysセッションをアクティブセッションの収集とtotal_runtimeから除外します。
skip_user String

オプション値に設定したユーザーのアカウントを、アクティブセッションと'total_runtime'から除外します。例えば、次のように設定すると、root、system user、event_schedulerアカウントの収集を除外できます。
whatap.conf
```
skip_user=root,system user,event_scheduler
```
skip_whatap_session Int

既定値0

オプション値を1に設定すると、WhaTapの収集クエリをアクティブセッションの収集とtotal_runtimeから除外します。

スロークエリー収集設定

スロークエリを収集するには、まずデータベース(DB)を設定した上で、ユーザの環境(オンプレミスまたはAWS RDS/Aurora)によってWhaTapの設定方法が異なります。

ノート

スロークエリー機能はMySQLとPostgreSQLに限って対応します。

注意

データベース設定を確認する

WhaTap設定前、MySQLデータベース(DB)に対してスロウクエリ関連のパラメータを設定する必要があります。スロークエリーログ機能が活性化されていることを確認し、WhaTapの設定を進めます。

slow_query_log=on  
long_query_time=3  # 3秒 

オンプレミス環境

独自のサーバーで運用する場合、WhaTap의 DBX/XOS設定方式を使用します。 DBXエージェントのインストール以外に、DBサーバーにXOSを必ずインストールする必要があります。 XOSエージェントの設定方法は次の文書を参考にしてください。

DBXwhatap.confファイルに'slow_query_log=on'オプションを追加します。
- slow_query_log Boolean
  スロークエリーロギング機能を活性化(on)するか、非活性化(off)します。 MySQLのデフォルト値はonとなります。
XOSがインストールされている場合は、ファイル名を自動認識します。ファイル名が自動的に認識されない場合は、XOSwhatap.confパイルにslow_query=に設定します。

AWS RDS/Aurora環境

AWS RDS/Aurora環境はXOSエージェントをインストールできないので、DBXエージェント設定またはクラウド設定により、スロークエリを収集できます。

DBXエージェントの設定

AWS RDS/Aurora環境からスロークエリを収集するためにDBX whatap.confファイルに次のように設定します。
whatap.conf
```
slow_query_log=on  # クラウド設定
cloud_watch=on
aws_region=
aws_arn=
cloud_watch_metrics=
cloud_watch_instance= 
```
クラウド設定

管理 > クラウド設定メニューで提供されるガイドに従って実行すると、ユーザーのAWS環境で自動的にモニタリングリソースを生成し、スロークエリーデータを収集します. 別途の追加設定は必要ありません。詳しい内容は、次の文書を参照してください。

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

基本オプション​

データ収集​

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

設定​

ロック収集関連設定​

アクティブセッション除外の設定​

スロークエリー収集設定​

オンプレミス環境​

AWS RDS/Aurora環境​

AES256暗号化の適用​

エージェント名の設定​

自動設定する​

手動設定する​