本文へスキップ

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

    redis

    注意

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

  • db_ip String

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

  • db_port String

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

クラスター構成

  • cluster_name String

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

データ収集

  • idle_as_active Second

    既定値1

    セッションが最後のactive状態になってからidle状態を維持した時間(秒)が設定値より小さいセッションをactive sessionとしてみなすオプションです。たとえば、設定値が1の場合、1秒以内にactiveだったセッションがアクティブセッションウィンドウに表示されます。

AWS RDS CloudWatch適用

AWS CloudWatchを使用するエージェント設定に関する説明です。 収集を開始するとメトリクスに含まれ、管理 > メトリクスチャートメニューからdb_redis_counterカテゴリで他の指標と一緒に確認できます。

  • aws_region String

    AWSリージョンを設定します。

  • aws_arn String

    AWS認証のために適切な権限を持つIAM ROLEのARNを使用することができます。

    必須権限

    ROLEには、次のアクセス権限(Policy)が必要です。

    権限権限内容
    rds:DescribeDBInstancesインスタンスクラスの情報収集
    rds:DescribeDBClustersautoscale使用時クラスターから情報収集
    rds:DescribeDBLogFilesCloudWatchログ収集
    rds:DownloadDBLogFilePortionCloudWatchログ収集
    ec2:DescribeInstanceTypesインスタンスクラスに対応するcpu数を収集
    elasticache:DescribeCacheClusterselasticacheを利用する場合時、インスタンスクラスの情報を収集
    cloudwatch:ListMetricsCloudWatch指標一覧を収集
    cloudwatch:GetMetricStatisticsCloudWatch指標から値を収集
    logs:DescribeLogStreamsCloudWatchログ収集(掲示されたログ機能を使用する場合)
    logs:GetLogEventsCloudWatchログ収集(掲示されたログ機能を使用する場合)
  • 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

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

エージェント名の識別

Details

エージェント名を設定する WhaTapモニタリングサービスでは、モニタリング対象を包括的な意味でオブジェクトを使用し、エージェントと同じ意味で使用されることがあります。モニタリング対象のオブジェクトを区別するには、名前を区別する必要があります。WhaTapは、オブジェクト名とオブジェクトIDによって対象を区別します。

ノート
  • オブジェクト(エージェント) 名は、プロジェクトごとに一意である必要があります。
  • オブジェクトID=CRC32(オブジェクト名)です。オブジェクトIDまたは名前が変更されると、以前のデータとリンクされません。

WhaTapはモニタリングは、情報収集対象であるデータベースサーバーを識別するための情報として、データベースサーバーから収集して情報を活用します。基本的な使用情報は、データベースサーバーの種類、IPアドレス、サービスポートなどを組み合わせてデータベースサーバーの固有の識別子として使用します。必要に応じてユーザーが設定した名前を利用するか、パターンを変更して固有の値に変更して利用します。エージェントの名前は必ず固有の値である必要があります。

データベースサーバーから抽出した情報を使用する理由は、データベースサーバーの停止またはネットワークの切断、エージェント問題による収集サーバーとエージェントの通信障害が復旧した場合に再接続したエージェントから送信される情報が既存エージェントから送信された情報との継続性を維持するためです。

  • object_name String

    既定値{type}-{ip2}-{ip3}-{port}

    データベースサーバーを識別するためのエージェント名(ONAME) の構成方法です。ONAMEに基づいてOIDが生成されます。

    設定説明
    {type}whatap.app_nameに設定された値を使用します。
    {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}データベースサーバのポート
    {hostname}ホスト名
  • auto_oname_enabled Boolean

    既定値false

    サーバーに登録するエージェント名(oname)をサーバーから自動受信される機能を有効にします。適用する場合は、-Dwhatap.name、および-Dwhatap.onameオプションは無視されます。収集サーバーとの通信により、onameを与えられた後、エージェントの一般的な動作を開始します。

  • auto_oname_prefix String

    既定値agent

    エージェント名をサーバーから自動的に割り当てる場合、エージェント名のprefixや業務名を使用します。prefixにシリアル番号1~)を付与します。

  • auto_oname_reset Int

    既定値0

    サーバーから新しいエージェント名を付与するために修正します。エージェント名を自動付与すると、whatap.onameというシステム環境変数に設定されます。一度定められたシステムの環境変数は、JAVAインスタンスが再起動するまで維持します。リセットしたいときは、auto_oname_reset値を修正してください。現在の設定値と異なる値に変更すると適用されます。