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

mongodb

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

db_ip String

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

db_port String

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

クラスター構成

cluster_name String

クラスターセットを定義するオプションで、同じcluster_nameのオプション値を持つデータベースは、ダッシューボード > インスタンスリストメニューでツリー構造で表示されます。マルチインスタンスメニューのエージェント選択オプションでクラスタ別エージェント項目を選択してクラスターを構成するインスタンス同士がダッシュボードに表現され、一目でモニタリングできます。一部のウィジェットは、クラスター単位の情報を提供します。詳細については、次の文書を参照してください。

データ収集

collections Boolean

既定値 true

コレクションサイズ情報の保存有無を設定します。保存しないためには、falseに変更します。

ノート
このオプションに関するDBサイズメニューの詳細については、次の文書を参考にしてください。
collections_hour Int

既定値5

コレクション情報を保存するために情報を収集する時刻を設定します。既定値は5で、午前5時に収集を始めます。

ノート
このオプションに関するDBサイズメニューの詳細については、次の文書を参考にしてください。

AWS RDS CloudWatch適用

AWS CloudWatchを使用するエージェント設定に関する説明です。収集を開始するとメトリクスで収集され、管理 > メトリクスチャートメニューのdb_redis_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をモニタリングし、データを収集します。

whatap.conf
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 

ノート

役割ARN(Role ARN)の詳細については、次のリンクを参照してください。
IAM ROLEのARN値を利用せずに、EC2にRDS CloudWatch Metricの収集権限を付与して、データを収集する方法は次の文書を参照してください。

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

基本オプション​

クラスター構成​

データ収集​

AWS RDS CloudWatch適用​

RDS CloudWatch収集の設定例​

AES256暗号化の適用​

エージェント名の設定​

自動設定する​

手動設定する​