本文へスキップ

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

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

プロジェクトアクセスキーの確認​

プロジェクトアクセスキーは、WhaTapサービスを有効にするための固有IDです。

インストール手順セクションでプロジェクトアクセスキーの発行ボタンをクリックします。プロジェクトアクセスキーが自動的に発行されると、次の手順に進みます。

Tips

プロジェクトを作成すると、自動的にエージェントインストールページに移動します。エージェントインストールページが表示されない場合は、左側のメニューから全プロジェクトを選択し、新しく作成したプロジェクトを選択します。

WhaTapデータベースエージェントのダウンロード​

  1. エージェントファイルをダウンロードしてください。次の2つの方法を利用してください。

    • WhaTapモニタリングサービス画面でDownloadボタンをクリックしてダウンロードすることができます。

    • Linux wget方式でダウンロードできます。次のコマンドを使用してください。

      wget -O whatap.agent.database.tar.gz "https://service.whatap.io/download/dbx_agent?type=tibero&format=tar.gz"
    ノート

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

  2. ダウンロードしたファイルを分析するサーバーにコピーし、解凍してください。(Windows、Linux共通)

    エージェント構成ファイル
    ファイル名説明
    whatap.confデータベースサーバーのデータを収集する収集サーバーのアドレスとサーバーのプロジェクトアクセスキーを入力するファイルです。エージェント設定の詳細については、次の文書を参照してください。
    alert/alert.conf収集するモニタリング項目にしきい値を設定するファイルです。しきい値を超えると通知イベントが発生します。
    scripts/リモートでSQLスクリプトを実行できるスクリプトのディレクトリです。
    ps.shプロセスIDを読み込むスクリプトです。エージェントプロセスを終了する場合は、そのIDを参照します。
    stop.shエージェントプロセスを終了するときに使用するスクリプトです。
    uid.sh (uid.bat)データベースの接続情報を組み合わせて暗号化されたUIDを生成するためのシェルスクリプトファイルです。db.userファイルを作成します。最初に一度だけ設定すると、暗号化されたUIDを通じてモニタリング対象データベースサーバーからデータが収集されます。
    モニタリング用アカウント作成の詳細については、次の文書を参照ください。
    start.sh (start.bat)エージェント実行用のシェルスクリプトファイルです。エージェントを実行すると、データベースサーバーからのモニタリング情報の収集が開始されます。
    startd.sh (startd.bat)エージェント実行用のシェルスクリプトファイルでバックグラウンドで実行できます。
    whatap.agent.dbx-X.Y.Z.jarTracerプログラムは、データベースサーバーの情報を収集し、収集した情報をサーバーに送信するプログラムです。
    jdbcデータベースサーバー接続のために参照するライブラリを収集するディレクトリです。エージェントをデータベースサーバーに接続するためのライブラリを直接ダウンロードし、javaのclasspathオプションにパスを設定して使用します。
    xos/データベースサーバーのプロセス使用量をモニタリングできるオプションのエージェントを含むディレクトリです。
    ⎿ xos.confデータベースサーバーのプロセス使用状況のデータを収集およびデータ転送をするためのエージェントサーバーのアドレスと通信ポートを入力するファイルです。
    * xcub/CUBRIDデータベースのSQLテキスト収集と指標計算を実行する追加のエージェントファイルが含まれているディレクトリです。
    ⎿ * xcub.confCUBRIDデータベースおよび追加のエージェント接続情報を入力するファイルです。
    ノート

    *: xcubパスのファイルは、CUBRIDモニタリングの専用ファイルです。

  1. 解凍したフォルダの中からwhatap.confファイルを確認してください。whatap.confファイルにプロジェクトのアクセスキー情報、WhaTapサーバー情報、DB接続情報を入力します。

    whatap.conf
    license=プロジェクトアクセスキー
    whatap.server.host=13.124.11.223/13.209.172.35 // WhaTapのサーバー情報

    dbms=tibero
    db=データベース名(sid)
    db_ip=データベースのIPアドレス
    db_port=データベースのポート番号

  2. 次のディレクトリにJDBCドライバーをダウンロードしてください。/圧縮を解凍したフォルダ/jdbc

    データベースサーバーのOSとバージョンに合わせてJDBCドライバをダウンロードします。

    Tibero JDBC Drivers: {$TB_HOME}/client/lib/jar/tibero{Version}-jdbc.jar

ノート

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

アカウント生成​

データベースモニタリングをするために必要な権限を持つアカウントを作成します。root(admin) アカウントでログインしてアカウントを作成してください。

ノート

  • 既に存在するアカウントを使用する場合は、DBユーザーファイルの作成に進みます。権限がない場合は、モニタリングを開始できません。

  • コード例でwhatapは、DBユーザーアカウント名です。ユーザーが利用するユーザーアカウント名に変更してください。

  • コード例のDB_Passwordには、ユーザーパスワードを入力します。
create user whatap identified by 'DB_PASSWORD'; ## パスワードを入力します。
grant create session to whatap;
grant select any dictionary to whatap;
 
## kill session 使用時
grant alter system to whatap;

DBユーザーファイル作成​

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

uid.shシェルスクリプトファイル(またはuid.batバッチファイル)は、WhaTapデータベースエージェントをインストールしたパスで見つけることができます。userのいないパスワードしかない場合は、DB_USERをdefaultに設定します。

./uid.sh DB_USER DB_PASSWORD
ノート

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

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

  • Azure Database環境の場合、DB_USERをDB_USER@DB_nameの形式で入力します。

  • DB_USERまたはDB_PASSWORDに特殊文字が含まれている場合、特殊文字の前にEscape Character(\)を入力します。

    Example
    ./uid.sh whatap whatap\!pwd

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

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

デフォルトプランユーザーファイル作成時、エージェントが事前定義された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

モニタリングの開始​

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

./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*ファイルを実行します。

最終修正：