エージェントのインストール
WhaTapデータベースモニタリングサービスを使用するための基本的なインストール方法について説明します。
WhaTapモニタリングサービスを使用するには、会員登録後にプロジェクトを作成し、対象サーバーにエージェントをインストールする必要があります。会員登録に関する詳細については、次の文書を参照してください。
次の動画ガイドを参照してください。
プロジェクト作成
エージェントをインストールする前にプロジェクトを作成してください。
-
WhaTapモニタリングサービスに移動し、ログインします。
-
プロジェクトを作成するには、左のサイドメニューからプロジェクト全体 > + Projectボタンを選択します。
-
商品選択 画面でプロジェクトにインストールする製品を選択してください。
-
プロジェクト名、データサーバーリージョン、プロジェクトタイムゾーン項目を順番に設定します。
-
通知言語の設定で、警告通知メッセージの言語を選択します。
-
すべての設定を完了した後は プロジェクトを作成する ボタンを選択します。
-
データサーバーリージョンは、リージョン(クラウドサービスを提供するためにインストールしたデータセンターのグループ)を意味します。特定のリージョンを選択すると、そのリージョンに所属するデータセンターにユーザーのデータが保存されます。
-
プロジェクトタイムゾーンは通知とレポートを生成する基準時間です。
-
複数のプロジェクトをグループで管理する場合は、プロジェクトグループからグループを選択するか、グループを追加してください。 グループの詳細については、次の文書を参照してください。
-
組織を選択してプロジェクトを追加する場合は、組織下位のグループを必須に設定する必要があります。
構成図の確認
DBXエージェントは、別のサーバーにインストールするか、DBサーバーにインストールできます。 インストールする方法を選択し、構成とファイアウォールを確認します。
別途サーバーにインストール | DBサーバーに一緒にインストール |
---|---|
アカウント生成
データベースモニタリングをするために必要な権限を持つアカウントを作成します。root(admin) アカウントでログインしてアカウントを作成してください。
-
権限を持つアカウントがある場合は、このステップを省略して次の段階に移ります。
-
コード例で
DB_User
は、DBユーザーアカウント名です。ユーザーが利用するユー ザーアカウント名に変更してください。
- コード例の
DB_Password
には、ユーザーパスワードを入力してください。
機能と使用環境に応じて追加権限を付与してください。
-
PostgreSQL 10バージョン以降
SQLcreate user DB_User with password 'DB Password';
grant pg_monitor to DB_User; -
PostgreSQL 10バージョン未満
SQLcreate user DB_User with password 'DB Password';
alter user DB_User with superuser; -
Kill sessionを使用する場合
データベースモニタリングでは、進行中のセッションを終了できるKill Session機能を提供します。この機能を使用するには、次のように権限を設定してください。
SQLgrant pg_signal_backend to DB_User;
-
テーブルサイズを収集する場合
SQLgrant usage on schema {schema_name} to DB_User;
-
オブジェクト情報を照会する場合(分析 > Topオブジェクト)
SQLgrant 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
コマンドを使用してダウンロード できます。BASHwget -O whatap.agent.database.tar.gz https://api.whatap.io/download/agent/whata.agent.database.tar.gz
-
コマンドでダウンロードできない場合は、WhaTapモニタリングサービス画面でダウンロードボタンを選択します。
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エージェント経路にデータベースサーバーのオペレーションシステムとバージョンに合うJDBCドライバーをダウンロードします。 /圧縮を解凍したフォルダ/jdbc
PostgreSQL 9.2バージョン以降:https://jdbc.postgresql.org/download
DBユーザーファイルの作成
データベース接続用に暗号化されたUIDを作成します。usernameとpasswordを入力し、シェルスクリプト(またはバッチファイル)を実行してください。
uid.shシェルスクリプトファイル(またはuid.batバッチファイル)は、WhaTapデータベースエージェントをインストールしたパスで見つけることができます。userなしでパスワードのみある場合は、DB_USER
をとして設定します。
- Linux
- Windows
./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
uid.bat "DB_USER" "DB_PASSWORD"
-
最初1回の設定で暗号化された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*
-
XOSエージェントを実行してください。
./start.sh
-
DBXエージェントでモニタリングしたデータを転送するために
dbx_port
に設定したポート(default 3002)が開放されている必要があります。 (UDP Outbound) -
XOSエージェントをバックグラウンドで実行するには、_./startd.sh_ファイルを実行してください。
エージェントサーバーにあるwhatap.confファイルに次のオプションを設定してください。 CloudWatch特性上、60秒(cloud_watch_interval
)ごとの呼び出しをお勧めします。
aws_region={AWS_RDS_Region_Name}
aws_arn=arn:aws:iam::999999999999:role/UpdateApp
cloud_watch=on
cloud_watch_instance=RDS_DB_Instance_Name
cloud_watch_interval=60
cloud_watch_metrics=CPUUtilization,FreeableMemory,FreeStorageSpace,NetworkTransmitThroughput,NetworkReceiveThroughput
AWS CloudWatch指標照会のために次のコマンドを実行してください。 DB_Instance_Name
項目を変更してコマンドを実行してください。
aws cloudwatch list-metrics --namespace AWS/RDS --dimensions Name=DBInstanceIdentifier,Value={DB_Instance_Name}
次の段階
-
インストールの点検
プロジェクトの作成やエージェントのインストール、基本エージェントのオプションまですべて適用した場合は、次の文書で点検事項を確認します。
-
インストール問題の解決
エージェントのインストール時に発生する可能性のある様々な問題と、これを解決するための具体的な指針を提供します。 詳細については、次の文書を参照してください。
-
エージェント設定
エージェント設定(whatap.conf)ファイルにオプションを適用して、モニタリングのための様々な機能を提供します。 詳細については、次の文書を参照してください。
データベースのサーバーリソースを追加で監視するには、追加のエージェント(XOS)に追加オプションを設定します。 詳細については、次の文書を参照してください。
-
モニタリングの開始
すべての設定を完了したら、エージェントがデータベースサーバーのメトリクスに対する情報収集を開始します。 まず、インスタンスリストメニューでモニタリングデータが収集されていることを確認します。 インスタンスリストの詳細については、次の文書を参照してください。