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

情報

この文書は、CUBRIDモニタリングV2を基準に作成されました。 CUBRIDモニタリングV1文書については、次の文書を参照してください。

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

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

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

プロジェクト作成

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

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

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

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

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

   

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

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

ノート

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

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

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

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

構成図の確認

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

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

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

CUBRIDをモニタリングするためには、DBアカウントとCUBRID Managerアカウントの両方が必要です。DBアカウントはdbaを使います。CUBRID Managerアカウントは、次のコマンドを利用します。

CUBRID Manager account

cm_admin adduser whatap whatap

ノート

エージェントごとに異なる名前のアカウントを使用する必要があります。

アクセスキーの確認

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

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

ノート

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

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

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

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

  BASH

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

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

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

BASH

tar -zxvf whatap.agent.database.tar.gz

ノート

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

DBXエージェントの設定

エージェントのインストール画面のガイドに従って、エージェントの設定を進めます。 画面に各項目ごとに必要な情報を入力すると、設定内容とコマンドが自動的に完成されます。

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=cubrid
db={DB_Name}
db_ip={DB_Server_IP}
db_port={DB_Server_Port} 
cmd_port=8001 # CUBRID Manager server port number, default 8001
broker=query_editor,broker1

• db: モニタリング対象データベース名であり、 $CUBRID_DATABASES/databases.txt ファイルのdb_name値段です。

• db_ip: モニタリング対象のデータベースサーバーに接続可能なIPアドレスです。

• db_port: ブローカー設定ファイル(cubrid_broker.conf)でBROKER_PORT項目に定義された値を入力します。 (CUBRIDの既定値BROKER_PORT: 33000)

• cms_port: CUBRID Managerが使用するポートです。 CUBRID Manager設定ファイル(cm.conf)のcm_port項目に定義された値を入力してください。

• broker: CUBRIDを設置するとbroker1、query_editorでブローカーがデフォルトで実行されます。 ユーザーが任意にブローカーの名前を変更または、追加で移動を行った場合は、変更を入力してください。

ノート

• whatap.confファイル設定の詳細は次の文書を参照してください。

• CUBRID環境の_databases.txt_ファイルの詳細は次のリンクを参照してください。

• CUBRIDのブローカー(broker)設定の詳細は次のリンクを参照してください。

JDBCダウンロード

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

情報

データベースサーバーのオペレーティングシステムとバージョンに合わせたJDBCドライバーをダウンロードするには、次のリンクを参照します。

ノート

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

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

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

CUBRID環境におけるユーザーファイルは、ユーザーDB(dba)とCUBRID Manager(admin)を対象にすべて実行する必要があります。

Linux

BASH

./uid.sh dba {DB_Password}
./cmsuid.sh admin {Admin_Password}

Windows

CMD

./uid.bat "dba" "DB_Password"
./cmsuid.bat "admin" "Admin_Password"

ノート

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

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

• Linux環境でDB_USERまたはDB_PASSWORDに特殊文字が含まれる場合、特殊文字の前にEscape Character(\)を一緒に入力します。

  Example

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

XCUBエージェント設定

XCUBエージェントは、データベースサーバーに別途のプロセスを実行し、sql textとメトリクスを収集します。XOSエージェントと一緒にインストールすることをお勧めします。

whatap.confファイルの設定

whatap.confファイルに次のようにエージェントオプションを設定します。

whatap.conf

xcub=1
xcub_port=3002

DBXエージェントのインストールパス内に_xcub_フォルダ(/圧縮解除ファイル/xcub/)をデータベースのサーバーにコピーします。

ノート

XOSエージェントを一緒にインストールすると、XOSポートを共有するためxcub_portオプションは設定する必要ありません。

xcub.confファイルの設定

データベースサーバーのxcubフォルダパスにあるxcub.confファイルにDBXエージェントサーバー情報を入力し、追加オプションを設定します。

db=demodb@127.0.0.1
dba_pwd={dba_password}
dbx_ip={DB_Agent_IP}
dbx_port=3002

• db: dbname@dbサーバーIP形式で入力します。

• dba_pwd: パスワードを設定すると、最初の実行時にxcub.pwdファイルを作成します。以降xcub.confファイルではdba_pwd項目を削除します。

• dbx_ip: DBXエージェントをインストールしたサーバーのIPアドレスを入力しんます。

• dbx_port: DBXエージェントと通信するポートを設定します。DBXエージェントとはUDPで通信します。該当ポートにファイアウォールを設定した場合は、UDP通信のためにファイアウォールを解除します。

ノート

XCUBエージェント設定の詳細については次の文書を参照してください。

XCUBエージェント実行権限の付与

XCUBエージェントに実行権限を付与します。

chmod +x ./whatap.agent.xcub*

XCUBエージェント実行

データベースのサーバーでXCUBエージェントプロセスを実行します。

./start.sh

ノート

XCUBエージェントをバックグラウンドで実行するには、_./startd.sh_ファイルを実行します。

モニタリングの開始

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

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環境にのみ適用されます。

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

• 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)に追加オプションを設定します。 詳細については、次の文書を参照してください。

  XCUBエージェント設定の詳細については次の文書を参照してください。

• モニタリングの開始

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