エージェントのインストール
WhaTapデータベースモニタリングサービスを使用するための基本的なインストール方法について説明します。
WhaTapモニタリングサービスを使用するには、会員登録後にプロジェクトを作成し、対象サーバーにエージェントをインストールする必要があります。会員登録に関する詳細については、次の文書を参照してください。
次の動画ガイドを参照してください。
プロジェクト作成
エージェントをインストールする前にプロジェクトを作成してください。
-
WhaTapモニタリングサービスに移動し、ログインします。
-
プロジェクトを作成するには、画面左サイドメニューからプロジェクト全体 > + Projectボタンを選択してください。
-
商品選択 画面でプロジェクトにインストールする製品を選択してください。
-
プロジェクト 名, データサーバーリージョン, プロジェクトタイムゾーン項目を順番に設定してください。
-
通知言語の設定で、警告通知メッセージの言語を選択してください。
-
すべての設定を完了した後は プロジェクトを作成する ボタンを選択してください。
-
データサーバーリージョンは、リージョン(クラウドサービスを提供するためにインストールしたデータセンターのグループ)を意味します。特定のリージョンを選択すると、そのリージョンに所属するデータセンターにユーザーのデータが保存されます。
-
プロジェクトタイムゾーンは通知とレポートを生成する基準時間です。
-
複数のプロジェクトをグループで管理する場合は、プロジェクトグループからグループを選択するか、グループを追加してください。 グループの詳細については、次の文書を参照してください。
-
組織を選択してプロジェクトを追加する場合は、組織下位のグループを必須に設定する必要があります。
プロジェクトアクセスキーの確認
プロジェクトアクセスキーは、WhaTapサービスを有効にするための固有IDです。
インストール手順セクションでプロジェクトアクセスキーの発行ボタンをクリックします。プロジェクトアクセスキーが自動的に発行されると、次の手順に進みます。
プロジェクトを作成すると、自動的にエージェントインストールページに移動します。エージェントインストールページが表示されない場合は、左側のメニューから全プロジェクトを選択し、新しく作成したプロジェクトを選択します。
WhaTapデータベースエージェントのダウンロード
-
エージェントファイルをダウンロードしてください。次の2つの方法を利用してください。
-
WhaTapモニタリングサービス画面でDownloadボタンをクリックしてダウンロードすることができます。
-
Linux wget方式でダウンロードできます。次のコマンドを使用してください。
wget -O whatap.agent.database.tar.gz https://api.whatap.io/download/agent/whata.agent.database.tar.gz
-
-
ダウンロードしたファイルを分析するサーバーにコピーし、解凍してください。(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.conf CUBRIDデータベースおよび追加のエージェント接続情報を入力するファイルです。 ノート*: xcubパスのファイルは、CUBRIDモニタリングの専用ファイルです。
-
解凍したフォルダの中からwhatap.confファイルを確認してください。whatap.confファイルにプロジェクトのアクセスキー情報、WhaTapサーバー情報、DB接続情報を入力してください。
whatap.conflicense={Access_Key}
whatap.server.host=13.124.11.223/13.209.172.35 # WhaTap server information
dbms=mysql
db_ip={DB_server_IP_address}
db_port={DB_server_port}情報MySQLサーバとエージェントが localhostにインストールする場合(default 3306 port)
whatap.confdbms=mysql
db_ip=127.0.0.1
db_port=3306 -
次のディレクトリにJDBCドライバーをダウンロードします。 解凍されたフォルダ/jdbc
データベースサーバーのオペレーティングシステムとバージョン用のJDBCドライバをダウンロードします。
Mysql & MariaDB 5.5バージョン以降
-
JDBCドライバー8.xバージョン以降を使用する場合は、接続URLに
serverTimezone
設定が必要な場合は、次のようにオプションを設定してください。whatap.confconnect_option=?serverTimezone={SERVER_TIMEZONE}
# ex) connect_option=?serverTimezone=UTC -
SSLを使用する場合は、次のようにオプションを設定してくだ さい。
whatap.confconnect_option=?useSSL=true&verifyServerCertificate=false
アカウント生成
データベースモニタリングをするために必要な権限を持つアカウントを作成します。root(admin) アカウントでログインしてアカウントを作成してください。
-
既に存在するアカウントを使用する場合は、DBユーザーファイルの作成へ移動してください。権限がない場合は、モニタリングを開始できません。
-
例示コードから
whatap
は、DBユーザーアカウント名です。ユーザーが利用するユーザーアカウント名に変更してください。 -
例示コードの
DB Password
には、ユーザーパスワードを入力してください。
- MySQL
- MariaDB
create user whatap identified by 'DB_PASSWORD'; # パスワードを入力してください。
grant process on *.* to whatap;
grant select on performance_schema.* to whatap;
grant show databases on *.* to whatap;
機能と使用環境に応じて追加権限を付与してください。
-
すべてのテーブル情報を収集する場合
grant select on *.* to whatap;
-
特定のDBのテーブルのみモニタリングする場合
grant select on {DB_NAME}.* to whatap;
-
Replicationを使用する場合
grant replication client on *.* to whatap;
grant replication slave on *.* to whatap; -
Kill sessionを使用する場合
grant super on *.* to whatap;
-
AWS RDS環境でkill session機能を使用する場合
grant execute on procedure mysql.rds_kill to whatap;
create user whatap identified by 'DB_PASSWORD'; # パスワードを入力してください。
grant process on *.* to whatap;
grant select on performance_schema.* to whatap;
grant show databases on *.* to whatap;
機能と使用環境に応じて追加権限を付与してください。
-
すべてのテーブル情報を収集する場合
grant select on *.* to whatap;
-
特定のDBのテーブルのみモニタリングする場合
grant select on {DB_NAME}.* to whatap;
-
Replicationを使用する場合
below MariaDB 10.5.1grant replication client, replication slave on *.* to whatap;
MariaDB 10.5.2 ~ 10.5.8grant replication master admin, replication slave admin, binlog monitor on *.* to whatap;
MariaDB 10.5.9 or latergrant replication master admin, replica monitor, binlog monitor on *.* to whatap;
-
Kill sessionを使用する場合
grant super on *.* to whatap;
-
AWS RDS環境でkill session機能を使用する場合
grant execute on procedure mysql.rds_kill to whatap;
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