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

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

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

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

プロジェクト作成

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

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

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

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

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

   

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

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

ノート

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

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

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

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

プロジェクトアクセスキーの確認

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

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

Tips

プロジェクトを作成すると、自動的にエージェントインストールページに移動します。エージェントインストールページが表示されない場合は、左側のメニューから全プロジェクトを選択し、新しく作成したプロジェクトを選択します。

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

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

   • WhaTapモニタリングサービス画面でDownloadボタンをクリックしてダウンロードすることができます。

   • Linux wget方式でダウンロードできます。次のコマンドを使用してください。

   ノート

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

2. ダウンロードしたファイルを分析するサーバーにコピーし、解凍してください。(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.jar	Tracerプログラムは、データベースサーバーの情報を収集し、収集した情報をサーバーに送信するプログラムです。
   jdbc	データベースサーバー接続のために参照するライブラリを収集するディレクトリです。エージェントをデータベースサーバーに接続するためのライブラリを直接ダウンロードし、javaのclasspathオプションにパスを設定して使用します。
   xos/	データベースサーバーのプロセス使用量をモニタリングできるオプションのエージェントを含むディレクトリです。
   ⎿ xos.conf	データベースサーバーのプロセス使用状況のデータを収集およびデータ転送をするためのエージェントサーバーのアドレスと通信ポートを入力するファイルです。
   * xcub/	CUBRIDデータベースのSQLテキスト収集と指標計算を実行する追加のエージェントファイルが含まれているディレクトリです。
   ⎿ * xcub.conf	CUBRIDデータベースおよび追加のエージェント接続情報を入力するファイルです。

   ノート

   ^*: xcubパスのファイルは、CUBRIDモニタリングの専用ファイルです。

3. 圧縮して解凍したフォルダに入り、whatap.confファイルを確認してください。 whatap.conf ファイルに、プロジェクトのアクセスキー情報、WhaTapサーバー情報、DB接続情報を入力します。

   whatap.conf

   license=プロジェクトアクセスキー
   whatap.server.host=13.124.11.223/13.209.172.35 // WhaTapサーバー情報
   
   db = {$CUBRID_HOME/databases/databases.txtのdb-name}
   db_ip = {DBサーバーのIPアドレス}
   db_port = {$CUBRID_HOME/conf/cubrid_broker.confのBROKER_PORT (default : 33000)}
   cms_port = {$CUBRID_HOME/conf/cm.confのcm_port (default : 8001)}
   cms_token_file = {エージェントインストールパス}/cms_token
   broker = query_editor,broker1
   ノート

   • cms_token_file、brokerオプションの詳細については、次の文書を参照してください。

   • brokerオプションで設定する名前は、cubrid broker statusコマンドで確認できます。

4. 次のディレクトリにJDBCドライバーをダウンロードします。 解凍されたフォルダ/jdbc

   データベースサーバーのOSとバージョンに合わせてJDBCドライバをダウンロードします。 https://www.cubrid.com/downloads

ノート

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

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

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

モニタリングのアカウントを作成

CUBRIDをモニタリングするためには、DBアカウントとCUBRID Managerアカウントの両方が必要です。 通常は、DBのデフォルトdbaアカウント(dba)とCUBRID Managerアカウント(admin)を使用します。 別のアカウントを作成して使用することができます。

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

データベース接続用に暗号化されたUIDを作成します。 ユーザーファイルは、ユーザーDB(dba)와 CUBRID Manager(admin)に対してすべて実行する必要があります。 usernameとpasswordを入力し、シェルスクリプト(またはバッチファイル)を実行してください。

• uid.shシェルスクリプトファイル(またはuid.batバッチファイル)は、WhaTapデータベースエージェントをインストールした場所にあります。

• dbaとDB_PASSWORDは、会員登録で使用したユーザー名とパスワードです。

  uid.sh | uid.bat

  ./uid.sh dba DB_PASSWORD
  ./cmsuid.sh admin ADMIN_PASSWORD
  
  # または
  
  ./uid.bat "dba" "DB_PASSWORD"
  ./cmsuid.bat "admin" "ADMIN_PASSWORD"

ノート

• 最初1回の設定で暗号化されたUIDを使用してモニタリング対象データベースサーバーからデータを収集します。

• DBユーザーファイルを生成するには、プロジェクトアクセスキーをwhatap.confファイルに入力する必要があります。 プロジェクトアクセスキーの確認

• Azure Database環境の場合、DB_USERをDB_USER@DB_nameの形式で入力してください。

• dbaまたはDB_PASSWORDに特殊文字が含まれる場合、特殊文字の前にEscape Character(\)を入力してください。

  Example

  ./uid.sh whatap whatap\!pwd
  
  # 特殊文字が2つ以上の場合、それぞれエスケープ文字を追加
  ./uid.sh whatap whatap\!\@pwd

モニタリングの開始

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

Linux

./start.sh

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

./startd.sh

Windows

start.bat

Windowsシステムの起動時、自動的にエージェントを起動するようにサービスに登録できます。次のコマンドを参考にしてください。

# サービス登録時
install_WindowsService.bat create WhatapDBXAgent

# サービス削除時
install_WindowsService.bat delete WhatapDBXAgent

ノート

コントロールパネル > Windowsツール > サービス(services.msc)でWhatapDBXAgent サービスを開始または停止できます。使用するWindowsバージョンによってサービス経路は異なる場合があります。

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

XOSエージェントのインストール(選択事項)

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

ノート

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

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

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_ファイルを実行します。