本文へスキップ

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

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

WhaTapモニタリングサービスを使用するには、会員登録後にプロジェクトを作成し、対象サーバーにエージェントをインストールする必要があります。会員登録に関する詳細については、次の文書を参照してください。

次の動画ガイドを参照してください。

プロジェクト作成​

エージェントをインストールする前にプロジェクトを作成してください。

  1. WhaTapモニタリングサービスに移動し、ログインします。

  2. プロジェクトを作成するには、画面左サイドメニューからプロジェクト全体 > + Projectボタンを選択してください。

  3. 商品選択 画面でプロジェクトにインストールする製品を選択してください。

  4. プロジェクト名、データサーバーリージョン、プロジェクトタイムゾーンなどの項目を設定してください。

  5. すべての設定を完了した後は プロジェクトを作成する ボタンを選択してください。

ノート

  • データサーバーリージョンは、リージョン(クラウドサービスを提供するためにインストールしたデータセンターのグループ)を意味します。特定のリージョンを選択すると、そのリージョンに所属するデータセンターにユーザーのデータが保存されます。

  • プロジェクトタイムゾーンは通知とレポートを生成する基準時間です。

  • 複数のプロジェクトをグループで管理する場合は、プロジェクトグループからグループを選択するか、グループを追加してください。 グループの詳細については、次の文書を参照してください。

  • 組織を選択してプロジェクトを追加する場合は、組織下位のグループを必須に設定する必要があります。

構成図の確認​

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

別途サーバーにインストールDBサーバーに一緒にインストール

アカウント生成​

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

ノート

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

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

  • 例示コードのDB Passwordには、ユーザーパスワードを入力してください。

機能と使用環境に応じて追加権限を付与してください。

  • PostgreSQL 10バージョン以降

    SQL
    create user whatap with password 'DB Password'; 
    grant pg_read_all_stats to whatap;

  • PostgreSQL 10バージョン未満

    SQL
    create user whatap with password 'DB Password';
    alter user whatap with superuser;

  • Kill sessionを使用する場合

    データベースモニタリングでは、進行中のセッションを終了できるKill Session機能を提供します。この機能を使用するには、次のように権限を設定してください。

    SQL
    alter user whatap with superuser;

  • AWS RDS環境でKill session機能を使用する場合

    SQL
    grant rds_superuser to whatap;

  • wal_countを収集する場合

    SQL
    grant execute on function pg_ls_dir(text) to whatap;  # EDB使用時
    alter user whatap with superuser;

  • cacheを収集する場合

    SQL
    grant select on pg_backend_memory_contexts to whatap;
    grant execute on function pg_get_backend_memory_contexts to whatap;

  • テーブルサイズを収集する場合

    SQL
    grant usage on schema {schema_name} to whatap;

  • オブジェクト情報を照会する場合(分析 > Topオブジェクト)

    SQL
    grant select on all tables in schema {schema_name} to whatap;

アクセスキーの確認​

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

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

ノート

プロジェクトを作成すると、自動的にエージェントインストールページに移動します。 エージェントインストールページが移動しない場合は、画面左側のメニューから管理 > エージェントインストールを選択してください。

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

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

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

    BASH
    wget -O whatap.agent.database.tar.gz https://dev.whatap.io/download/agent/whata.agent.database.tar.gz

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

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

BASH
tar -zxvf whatap.agent.database.tar.gz

DBXエージェントの設定​

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

Tips

DBXエージェントの構成ファイルの中で_setup.sh_ファイルを実行して、エージェントの設定を迅速かつ簡単に進めることができます。詳しい内容は次の文書を参考にしてください。

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=postgresql
db=postgres
db_ip={DB_Server_IP}
db_port={DB_Server_Port}

JDBCダウンロード​

圧縮ファイルを解凍したDBXエージェント経路にデータベースサーバーのOSとバージョンに合うJDBCドライバーをダウンロードしてください。/圧縮を解凍したフォルダ/jdbc

情報

PostgreSQL 9.2バージョン以降：https://jdbc.postgresql.org/download

ノート

  • DB構成によっては、whatap.confファイルの追加設定が必要になる場合があります。詳細については、次の文書を参照してください。

  • DBサーバーのリソースを追加でモニタリングするには、XOSエージェントを使用する必要があります。詳細については、次の文書を参照してください。

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

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

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

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

BASH
./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

モニタリングの開始​

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

./start.sh

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

./startd.sh

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

付加エージェント(XOS) のインストール及びその他のオプションを適用する​

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

ノート

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

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

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

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

    whatap.conf
    xos=1
    xos_port=3002

  2. _xos_フォルダー(/압축 해제 폴더/xos/)をデータベースサーバーに移動してください。

  3. データベースサーバーに移動した_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情報を入力すると、エージェントオプションを自動生成することができます。

  4. XOSエージェントの実行権限を付与してください。

    chmod +x ./whatap.agent.xos*

  5. XOSエージェントを実行してください。

    ./start.sh
ノート

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

  • XOSエージェントをバックグラウンドで実行するには、_./startd.sh_ファイルを実行してください。