エージェントのインストール
WhaTapデータベースモニタリングサービスを使用するための基本的なインストール方法について説明します。
WhaTapモニタリングサービスを使用するには、会員登録後にプロジェクトを作成し、対象サーバーにエージェントをインストールする必要があります。会員登録に関する詳細については、次の文書を参照してください。
次の動画ガイドを参照してください。
プロジェクト作成
エージェントをインストールする前にプロジェクトを作成してください。
-
WhaTapモニタリングサービスに移動し、ログインします。
-
プロジェクトを作成するには、画面左サイドメニューからプロジェクト全体 > + Projectボタンを選択してください。
-
商品選択 画面でプロジェクトにインストールする製品を選択してください。
-
プロジェクト名, データサーバーリージョン, プロジェクトタイムゾーン項目を順番に設定してください。
-
通知言語の設定で、警告通知メッセージの言語を選択してください。
-
すべての設定を完了した後は プロジェクトを作成する ボタンを選択してください。
-
データサーバーリージョンは、リージョン(クラウドサービスを提供するためにインストールしたデータセンターのグループ)を意味します。特定のリージョンを選択すると、そのリージョンに所属するデータセンターにユーザーのデータが保存されます。
-
プロジェクトタイムゾーンは通知とレポートを生成する基準時間です。
-
複数のプロジェクトをグループで管理する場合は、プロジェクトグループからグループを選択するか、グループを追加してください。 グループの詳細については、次の文書を参照してください。
-
組織を選択してプロジェクトを追加する場合は、組織下位のグループを必須に設定する必要があります。
構成図の確認
DBXエージェントは、別途サーバーにインストールするか、DBサーバーにインストールすることができます。インストールする方法を選択し、構成とファイアウォールを確認してください。
別途サーバーにインストール | DBサーバーに一緒にインストール |
---|---|
アカウント生成
データベースモニタリングをするために必要な権限を持つアカウントを作成します。root(admin) アカウントでログインしてアカウントを作成してください。
-
既に存在するアカウントを使用する場合は、DBユーザーファイルの作成へ移動してください。権限がない場合は、モニタリングを開始できません。
-
例示コードから
whatap
は、DBユーザーアカウント名です。ユーザーが利用するユーザーアカウント名に変更してください。 -
例示コードの
DB Password
には、ユーザーパスワードを入力してください。
機能と使用環境に応じて追加権限を付与してください。
-
PostgreSQL 10バージョン以降
SQLcreate user whatap with password 'DB Password';
grant pg_read_all_stats to whatap; -
PostgreSQL 10バージョン未満
SQLcreate user whatap with password 'DB Password';
alter user whatap with superuser; -
Kill sessionを使用する場合
データベースモニタリングでは、進行中のセッションを終了できるKill Session機能を提供します。この機能を使用するには、次のように権限を設定してください。
SQLalter user whatap with superuser;
-
AWS RDS環境でKill session機能を使用する場合
SQLgrant rds_superuser to whatap;
-
wal_countを収集する場合
SQLgrant execute on function pg_ls_dir(text) to whatap; # EDB使用時
alter user whatap with superuser; -
cacheを収集する場合
SQLgrant select on pg_backend_memory_contexts to whatap;
grant execute on function pg_get_backend_memory_contexts to whatap; -
テーブルサイズを収集する場合
SQLgrant usage on schema {schema_name} to whatap;
-
オブジェクト情報を照会する場合(分析 > Topオブジェクト)
SQLgrant select on all tables in schema {schema_name} to whatap;
アクセスキーの確認
アクセスキーは、WhaTapサービスを有効にするための固有IDです。
インストール手順セクションでプロジェクトアクセスキーの発行ボタンをクリックします。 アクセスキーを自動的に発行した後、次のステップを進みます。
プロジェクトを作成すると、自動的にエージェントインストールページに移動します。 エージェントインストールページが移動しない場合は、画面左側のメニューから管理 > エージェントインストールを選択してください。
DBXエージェントダウンロード
DBXエージェントファイルをダウンロードしてください。次の2つの方法を利用してください。
-
wget
コマンドを使用してダウンロードできます。BASHwget -O whatap.agent.database.tar.gz https://dev.whatap.io/download/agent/whata.agent.database.tar.gz
-
コマンドでダウンロードできない場合は、WhaTapモニタリングサービス画面でDownloadボタンを選択してください。
DBXエージェントファイルをダウンロードして圧縮を解凍してください。
tar -zxvf whatap.agent.database.tar.gz
DBXエージェントの設定
エージェントのインストール画面のガイドに従って、エージェントの設定を進めてください。画面に各項目ごとに必要な情報を入力すると、設定内容とコマンドを自動的に完成させることができます。
DBXエージェントの構成ファイルの中で_setup.sh_ファイルを実行して、エージェントの設定を迅速かつ簡単に進めることができます。詳しい内容は次の文書を参考にしてください。
whatap.conf設定
解凍したフォルダの中からwhatap.confファイルを確認してください。whatap.confファイルにプロジェクトのアクセスキー情報、WhaTapサーバー情報、DB接続情報を入力してください。
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ユーザーファイルの作成
データベース接続用に暗号化されたUIDを作成します。usernameとpasswordを入力し、シェルスクリプト(またはバッチファイル)を実行してください。
uid.shシェルスクリプトファイル(またはuid.batバッチファイル)は、WhaTapデータベースエージェントをインストールしたパスで見つけることができます。userなしでパスワードのみある場合は、DB_USER
をdefault
として設定します。
- Linux
- Windows
./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
uid.bat "DB_USER" "DB_PASSWORD"
-
最初に設定すると、暗号化されたUIDを使用してモニタリング対象データベースサーバーからデータを収集します。
-
DBユーザーファイルを生成するには、プロジェクトアクセスキーをwhatap.confファイルに入力する必要があります。アクセスキーの確認
-
Azure Database環境の場合、
DB_USER
をDB_USER@DB_nameの形式で入力する必要があります。 -
DB_USER
またはDB_PASSWORD
に特殊文字が含まれている場合、特殊文字の前にEscape Character(\)を入力してください。Exampleuid.bat whatap whatap\!pwd
# 特殊文字が2つ以上の場合、それぞれエスケープ文字を追加
uid.bat whatap whatap\!\@pwd
モニタリングの開始
エージェントをインストールしたパスからシェルスクリプト(またはバッチファイル)を実行してください。
- Linux
- Windows
./start.sh
デーモンのように使用する場合、次のコマンドを実行してください。ただし、nohupを設置した環境のみで動作します。
./startd.sh
start.bat
Windowsシステムの起動時、自動的にエージェントを起動するようにサービスに登録できます。次のコマンドを参考にしてください。
# サービス登録時
install_WindowsService.bat create WhatapDBXAgent
# サービス削除時
install_WindowsService.bat delete WhatapDBXAgent
コントロールパネル > Windowsツール > サービス(services.msc)でWhatapDBXAgent サービスを開始または停止できます。使用するWindowsバージョンによってサービス経路は異なる場合があります。
データベースモニタリングのエージェントのインストールが完了しました。次の文書でインストール後、チェックリストを確認してください。
付加エージェント(XOS) のインストール及びその他のオプションを適用する
データベースサーバーのリソースをさらにモニタリングする場合は、データベースサーバーに別のXOSエージェントを実行してデータを収集できます。
-
x86アーキテクチャで動作するOS環境にのみ適用されます。
-
付加エージェントのインストール過程は、必須ではなく選択事項です。
- XOSエージェント設定オプションの詳細については、次の文書を参照してください。
- XOS
- RDS : AWS CloudWatch
-
DBXエージェントがインストールされたパスのwhatap.confファイルに次のオプションを設定してください。
whatap.confxos=1
xos_port=3002 -
_xos_フォルダー(
/압축 해제 폴더/xos/
)をデータベースサーバーに移動してください。 -
データベースサーバーに移動した_xos_経路の_xos.conf_ファイルに次のオプションを設定してください。
xos.confdbx_ip={DB_Agent_IP}
dbx_port=3002 # default 3002
cpu_limit=0
mem_limit=10240TipsエージェントインストールメニューのDB Agent IP、DB Agent Port項目にDB情報を入力すると、エージェントオプションを自動生成することができます。
-
XOSエージェントの実行権限を付与してください。
chmod +x ./whatap.agent.xos*