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
oracle
注意別のオプション値を入力すると、モニティリングのデータ収集が正常に動作しない場合があります。
-
db_ip String
モニタリングするデータベースサーバーのIPアドレスを設定します。
-
db_port String
データベースが通信に使用するポート番号を設定します。
データ収集
-
long_run_session_sec Second
既定値
10
設定した時間より長く実行されているセッションをlong runセッションとして処理します。(単位:秒)
-
tables_hour Int
既定値
5
テーブル情報を保存するために情報を収集する時間を設定します。デフォルトは
5
で、午前5時に収集を開始します。
-
tables_min_size Int
既定値
10
テーブル情報を収集する場合、設定した値より小さいサイズのテーブル情報は収集しません。テーブルデータを収集する最小単位は、既定値では10MBです。
-
tables_exclude_sys Boolean
既定値
false
テーブル情報を収集する際に、sys所有のテーブル情報の収集有無を設定します。
true
に設定すると、sys所有のテーブル情報は収集されません。
-
replication_name String
レプリケーション名を設定すると、同じ
replication_name
を持つDBの間にMaster/Slave関係があるものとみなします。レプリケーションセットを定義するオプションとしてマスターノードとスレーブノードの両方に同じ値の
replication_name
オプションを設定するとインスタンスモニタリングでツリー構造で表示されます。また、このオプション値を基準にFlexボードでレプリケーション状態をモニタリングするウィジェットを提供します。
-
skip_whatap_session Int
既定値
0
1
が設定されている場合、WhaTapから収集するためのqueryが実行するセッションをactive session listに表示しません。(既定値:0)
-
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
AWS RDS CloudWatch適用
AWS CloudWatchを使用するエージェント設定に関する説明です。 収集を開始するとメトリクスに含まれ、分析 > メトリクスチャートメニューからdb_oracle_counter
カテゴリで他の指標と一緒に確認することができます。
-
aws_region String
AWSリージョンを設定します。
-
aws_arn String
AWS認証のために適切な権限を持つIAM ROLEのARNを使用することができます。
必須権限
ROLEには、次のアクセス権限(Policy)が必要です。
権限 権限内容 rds:DescribeDBInstances インスタンスクラスの情報収集 rds:DescribeDBClusters autoscale使用時クラスターから情報収集 rds:DescribeDBLogFiles CloudWatchログ収集 rds:DownloadDBLogFilePortion CloudWatchログ収集 ec2:DescribeInstanceTypes インスタンスクラスに対応するcpu数を収集 elasticache:DescribeCacheClusters elasticacheを利用する場合時、インスタンスクラスの情報を収集 cloudwatch:ListMetrics CloudWatch指標一覧を収集 cloudwatch:GetMetricStatistics CloudWatch指標から値を収集 logs:DescribeLogStreams CloudWatchログ収集(掲示されたログ機能を使用する場合) logs:GetLogEvents CloudWatchログ収集(掲示されたログ機能を使用する場合) -
cloud_watch String
CloudWatchモニタリングの使用有無を設定します。 設定値は
on
またはoff
です。 -
cloud_watch_instance String
CloudWatchインスタンス名を設定します。
-
cloud_watch_interval Second
CloudWatchでモニタリング値を取得する間隔を設定します。(単位:秒)
-
cloud_watch_metrics String
CloudWatchに読み込みするモニタリング指標名を設定します。次のように設定できます。
cloud_watch_metrics=CPUUtilization,FreeableMemory,FreeStorageSpace,NetworkTransmitThroughput,NetworkReceiveThroughput
RDS CloudWatch収集の設定例
次のような基本設定を作成することにより、RDS CloudWatchをモニタリングし、データを収集します。
cloud_watch=on
aws_region=ap-northeast-2
# AWS IAMで役割(Role)を作成し、ロールARN(Role ARN)値をコピーして貼り付けてください。
aws_arn=arn:aws:iam::999999999999:role/UpdateApp
cloud_watch_metrics=CPUUtilization,FreeableMemory,FreeStorageSpace,NetworkTransmitThroughput,NetworkReceiveThroughput
#インスタンス名の例
cloud_watch_instance=pg-rds
AES256暗号化の適用
WhaTap DBXエージェントは、収集されたデータを暗号化してサーバーに送信します。データの重要度や設定によって変更できます。基本的にXOR演算とAESアルゴリズムによる暗号化を使用し、平文を128ビット単位に分 割して暗号化、復号を行います。ユーザー設定により、256ビットまで拡張できます。
WhaTap DBXエージェントをインストールしたパスで、whatap.confファイルを次のオプションに追加してください。
cypher_level=256
設定を追加してから、エージェントを再起動してください。