本文へスキップ

エージェントのインストール

WhaTapデータベースモニタリングサービスを使用するための基本的なインストール方法について説明します。

構成図の確認​

DBXエージェントは、別のサーバーにインストールするか、DBサーバーにインストールできます。 インストールする方法を選択し、構成とファイアウォールを確認します。

別途サーバーにインストールDBサーバーに直接インストール

モニタリングのアカウントを作成​

CUBRIDをモニタリングするためには、DBアカウントとCUBRID Managerアカウントの両方が必要です。DBアカウントはdbaを使います。CUBRID Managerアカウントは、次のコマンドを利用します。

CUBRID Manager account
cm_admin adduser whatap whatap
ノート

エージェントごとに異なる名前のアカウントを使用する必要があります。

DBXエージェントダウンロード​

DBXエージェントファイルをダウンロードします。 次の2つの方法を利用します。

  • wgetコマンドを使用してダウンロードできます。

    BASH
    wget -O whatap.agent.database.tar.gz "https://service.whatap.io/download/dbx_agent?type=cubrid&format=tar.gz"

  • コマンドでダウンロードできない場合は、WhaTapモニタリングサービス画面でダウンロードボタンを選択します。

DBXエージェントファイルをダウンロードして圧縮を解凍してください。

BASH
tar -zxvf whatap.agent.database.tar.gz
ノート

セキュリティ設定によりTAR形式のファイルをダウンロードできないユーザーのためにZIP形式のファイルも一緒に提供します。 インストール画面で.zip ダウンロードボタンを選択します。

DBXエージェントの設定​

エージェントのインストール画面のガイドに従って、エージェントの設定を進めます。 画面に各項目ごとに必要な情報を入力すると、設定内容とコマンドが自動的に完成されます。

whatap.conf設定​

圧縮を解除したフォルダに移動し、whatap.confファイルを確認します。 whatap.conf ファイルに、プロジェクトのアクセスキー情報、WhaTapサーバー情報、DB接続情報を入力します。

whatap.conf
license={AccessKey}
whatap.server.host=13.124.11.223/13.209.172.35 # WhaTap server information
dbms=cubrid
db={DB_Name}
db_ip={DB_Server_IP}
db_port={DB_Server_Port} 
cmd_port=8001 # CUBRID Manager server port number, default 8001
broker=query_editor,broker1

  • db: モニタリング対象データベース名であり、 $CUBRID_DATABASES/databases.txt ファイルのdb_name値です。

  • db_ip: モニタリング対象のデータベースサーバーに接続可能なIPアドレスです。

  • db_port: ブローカー設定ファイル(cubrid_broker.conf)でBROKER_PORT項目に定義された値を入力します。 (CUBRIDの既定値BROKER_PORT: 33000)

  • cms_port: CUBRID Managerが使用するポートです。 CUBRID Managerの設定ファイル(cm.conf)でcm_port項目に定義された値を入力します。

  • broker: CUBRIDをインストールするとbroker1、query_editorでブローカーがデフォルトで実行されます。 ユーザーからブローカーの名前を変更または、追加で移動を行った場合は、変更内容を入力します。

ノート

  • whatap.confファイル設定の詳細は次の文書を参照してください。

  • CUBRID環境の_databases.txt_ファイルの詳細は次のリンクを参照してください。

  • CUBRIDのブローカー(broker)設定の詳細は次のリンクを参照してください。

JDBCダウンロード​

圧縮ファイルを解凍したパスのjdbcフォルダーにデータベースサーバーのオペレーションシステムとバージョンに合うJDBCドライバーをダウンロードします。 /圧縮を解凍したフォルダ/jdbc

情報

データベースサーバーのオペレーティングシステムとバージョンに合わせたJDBCドライバーをダウンロードするには、次のリンクを参照します。

ノート

/解凍されたフォルダ/jdbc/README.mdファイルで各データベースのJDBCドライバのインストールパスを確認することができます。

DBユーザーの作成とパスワードの変更​

データベース接続用に暗号化されたUIDを作成します。usernameとpasswordを入力し、シェルスクリプト(またはバッチファイル)を実行してください。

Tips

パスワードを変更する場合も、変更するパスワードを入力して同じ方法で進めてください。

CUBRID環境におけるユーザーファイルは、ユーザーDB(dba)とCUBRID Manager(admin)を対象にすべて実行する必要があります。

BASH
./uid.sh dba {DB_Password}
./cmsuid.sh admin {Admin_Password}
ノート

  • 一度の設定で暗号化されたUIDを使用してモニタリング対象データベースサーバーからデータを収集します。

  • DBユーザーファイルを生成するには、プロジェクトアクセスキーをwhatap.confファイルに入力する必要があります。アクセスキーの確認

  • Linux環境でDB_USERまたはDB_PASSWORDに特殊文字が含まれる場合、特殊文字の前にEscape Character(\)を一緒に入力します。

    Example
    ./uid.sh whatap whatap\!pwd

    # 特殊文字が2つ以上の場合、それぞれエスケープ文字を追加
    ./uid.sh whatap whatap\!\@pwd

  • Windowsでは、パスワードの特殊文字にEscape Character(\)が必要ありません。ただし、パスワードに大きな引用符(")を使用する場合には必要です。

デフォルトプランを照会する​

デフォルトプランユーザーファイル作成時、エージェントが事前定義されたDB情報を使用してプランを自動的に照会するように設定できます。

  1. エージェント設定(whatap.conf)ファイルにplan_dbオプションを追加し、DB名を入力します。

    whatap.conf
    plan_db=(dbname)

  2. DB設定後planuid.shスクリプトを使用してユーザーとパスワードを設定します。

    ./planuid.sh user pwd
    ノート

    ユーザー(user)とパスワード(pwd)に特殊文字が含まれている場合、各特殊文字の前にバックスラッシュ(\)を追加します。

    例、 user$example → user\$example

XCUBエージェント設定​

XCUBエージェントは、データベースサーバーに別途のプロセスを実行し、sql textとメトリクスを収集します。XOSエージェントと一緒にインストールすることをお勧めします。

whatap.confファイルの設定​

whatap.confファイルに次のようにエージェントオプションを設定します。

whatap.conf
xcub=1
xcub_port=3002

DBXエージェントのインストールパス内に_xcub_フォルダ(/圧縮解除ファイル/xcub/)をデータベースのサーバーにコピーします。

ノート

XOSエージェントを一緒にインストールすると、XOSポートを共有するためxcub_portオプションは設定する必要ありません。

xcub.confファイルの設定​

データベースサーバーのxcubフォルダパスにあるxcub.confファイルにDBXエージェントサーバー情報を入力し、追加オプションを設定します。

db=demodb@127.0.0.1
dba_pwd={dba_password}
dbx_ip={DB_Agent_IP}
dbx_port=3002

  • db: dbname@dbサーバーIP形式で入力します。

  • dba_pwd: パスワードを設定すると、最初の実行時にxcub.pwdファイルを作成します。以降xcub.confファイルではdba_pwd項目を削除します。

  • dbx_ip: DBXエージェントをインストールしたサーバーのIPアドレスを入力しんます。

  • dbx_port: DBXエージェントと通信するポートを設定します。DBXエージェントとはUDPで通信します。該当ポートにファイアウォールを設定した場合は、UDP通信のためにファイアウォールを解除します。

ノート

XCUBエージェント設定の詳細については次の文書を参照してください。

XCUBエージェント実行権限の付与​

XCUBエージェントに実行権限を付与します。

chmod +x ./whatap.agent.xcub*

XCUBエージェント実行​

データベースのサーバーでXCUBエージェントプロセスを実行します。

./start.sh
ノート

XCUBエージェントをバックグラウンドで実行するには、_./startd.sh_ファイルを実行します。

モニタリングの開始​

エージェントをインストールしたパスからシェルスクリプト(またはバッチファイル)を実行してください。

./start.sh

デーモンのように使用する場合、次のコマンドを実行してください。ただし、nohupをインストールした環境のみで動作します。

./startd.sh

データベースモニタリングのエージェントのインストールが完了しました。次の文書でインストール後、チェックリストを確認してください。

XOSエージェントのインストール(選択事項)​

データベースサーバーのリソースをさらにモニタリングする場合は、データベースサーバーに別のXOSエージェントを実行してデータを収集できます。

ノート

  • x86アーキテクチャで動作するOS環境にのみ適用されます。

  • 追加エージェントのインストールは、必須ではなく選択事項です。

  • XOSエージェント設定オプションの詳細については、次の文書を参照してください。

whatap.confファイルを設定する​

DBXエージェントがインストールされたパスのwhatap.confファイルに次のオプションを設定します。

whatap.conf
xos=1
xos_port=3002

xosフォルダー(/解凍されたフォルダ/xos/)をデータベースサーバーに移動してください。

xos.confファイルを設定する​

データベースサーバーに移動し、xosパスのxos.confファイルに次のオプションを設定します。

xos.conf
dbx_ip={DB_Agent_IP}
dbx_port=3002 # default 3002
cpu_limit=0
mem_limit=10240
Tips

エージェントインストールメニューのDB Agent IP、DB Agent Port項目にDB情報を入力すると、エージェントオプションを自動生成できます。

XOSエージェントを実行する​

XOSエージェントを実行します。

./start.sh
ノート

  • DBXエージェントでモニタリングしたデータを転送するためにdbx_portに設定したポート(default 3002)が開いている必要があります。 (UDP Outbound)

  • XOSエージェントをバックグラウンドで実行するには*./startd.sh*ファイルを実行します。

次のステップ​

  • インストールの点検

    プロジェクトの作成やエージェントのインストール、基本エージェントのオプションまですべて適用した場合は、次の文書で点検事項を確認します。

  • インストール問題の解決

    エージェントをインストールする際に発生する可能性がある問題と、これを解決するための具体的なガイドを提供します。 詳細については、次の文書を参照してください。

  • エージェント設定

    エージェント設定(whatap.conf)ファイルにオプションを適用して、モニタリングのための様々な機能を提供します。 詳細については、次の文書を参照してください。

    データベースのサーバーリソースを追加で監視するには、追加のエージェント(XOS)に追加オプションを設定します。 詳細については、次の文書を参照してください。

    XCUBエージェント設定の詳細については次の文書を参照してください。

  • モニタリングの開始

    すべての設定を完了したら、エージェントがデータベースサーバーのメトリクスに対する情報収集を開始します。 まず、インスタンスリストメニューでモニタリングデータが収集されていることを確認します。 インスタンスリストの詳細については、次の文書を参照してください。

最終修正：