本文へスキップ

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

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

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

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

プロジェクト作成​

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

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

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

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

  4. プロジェクト名、データサーバーリージョン、プロジェクトタイムゾーン項目を順番に設定します。

    プロジェクトの生成

  5. 通知言語の設定で、警告通知メッセージの言語を選択します。

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

ノート

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

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

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

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

構成図の確認​

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

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

アカウント生成​

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

ノート

  • 権限を持つアカウントがある場合は、このステップを省略して次の段階に移ります。

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

  • コード例のDB_Passwordには、ユーザーパスワードを入力します。

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

  • PostgreSQL 10バージョン以降

    SQL
    create user DB_User with password 'DB Password'; 
    grant pg_monitor to DB_User;

  • PostgreSQL 10バージョン未満

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

  • Kill sessionを使用する場合

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

    SQL
    grant pg_signal_backend to DB_User;

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

    SQL
    grant usage on schema {schema_name} to DB_User;

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

    SQL
    grant select on all tables in schema {schema_name} to DB_User;
権限による対応機能を確認する

基本権限外の権限は、ユーザーの環境によって付与する必要はありません。ただし、一部の機能が動作しないことがあります。

権限commandメニューと機能詳細履歴
基本権限grant pg_monitor to whatap;インスタンスモニタリング / マルチインスタンス / SQL統計grant pg_read_all_stats,pg_read_all_settings to DB_User;と同一
詳細権限grant usage on schema {schema_name} to whatap;DBサイズ / テーブルサイズ(トップ50)当該DBのすべてのスキーマに対して権限が必要
grant select on all tables in schema {schema_name} to whatap;テーブルレイアウトを照会-
grant pg_read_all_settings to whatap;パラメータ照会特定のパラメータ値が見えないことがある
セッション中止grant pg_signal_backend to whatap;アクティブセッション > セッション中止PostgreSQL 9.6バージョン以下はsuperuser権限が必要

アクセスキーの確認​

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

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

ノート

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

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

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

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

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

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

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

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

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

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エージェント経路にデータベースサーバーのオペレーションシステムとバージョンに合うJDBCドライバーをダウンロードします。 /圧縮を解凍したフォルダ/jdbc

情報

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

ノート

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

データベースユーザーファイルの生成​

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

BASH
./uid.sh {DB_USER} {DB_PASSWORD}
ノート

  • 最初1回の設定で暗号化された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_ファイルを実行します。

次の段階​

  • インストールの点検

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

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

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

  • エージェント設定

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

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

  • モニタリングの開始

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