本文へスキップ

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

    cubrid

    注意

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

  • db String

    モニタリングするDB名を設定してください。

  • db_ip String

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

CUBRID専用オプション

  • db_port Int

    既定値0

    アプリケーション接続情報に使用するブローカーのポート情報です。ブローカー設定ファイル(cubrid_broker.conf)にBROKER_PORT項目に定義された値を入力してください。(CUBRIDの既定値 BROKER_PORT: 33000)

  • cms_port Int

    既定値 8001

    CUBRID Managerが使用するポートです。CUBRID Manager設定ファイル(cm.conf)のcm_port`項目に定義された値を入力してください。モニタリング情報をCUBRID Managerのapiを使用して読み込むために必要です。

  • cms_token_file String

    ユーザーが生成したDBが複数ある場合、WhaTapエージェントをDB数だけインストールして設定する必要があります。この場合、エージェント間でトークンを共有するには、cms_token_fileパスが必要です。_{エージェントインストールパス}/cms_token_に設定してください。

    例) agent2をインストールした場合、agent1のcms_token_fileパスを共有するために次のように設定してください。

    whtap.conf
    cms_token_file=/agent1/cms_token
  • broker String

    既定値 broker1query_editor

    CUBRIDをインストールするとbroker1query_editorでブローカーがデフォルトで実行されます。ユーザーが任意にブローカー名を変更したり、追加で起動したりした場合は、変更を入力します。

    ノート

    brokerオプションで設定する名前は、cubrid broker statusコマンドで確認できます。

データ収集

  • db_param_enabled Boolean

    既定値 true

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

  • conn_fail_count Int

    既定値 15

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

  • tables_hour Int

    既定値5

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

  • long_run_session_sec Second

    既定値10 (単位:秒)

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

  • tables_min_row Int

    既定値10000

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

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