本文へスキップ

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

情報

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

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

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

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

プロジェクト作成​

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

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

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

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

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

    プロジェクトの生成

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

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

ノート

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

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

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

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

構成図の確認​

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

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

アカウント生成​

データベースモニタリングをするために必要な権限を持つアカウントを作成します。root(admin) アカウントでログインしてアカウントを作成してください。

create login DB_User with password='DB Password';
create user DB_User for login DB_User;
grant connect any database to DB_User;
grant view server state to DB_User;
grant view any definition to DB_User;

  • Kill session使用時の追加権限

    grant alter any connection to DB_User;

  • Azure SQL Database環境でKill session使用時の追加権限

    grant kill database connection to DB_User;

  • ジョブ遂行内訳とバックアップ/復旧履歴メニュー機能を利用する際に必要な権限

    msdbデータベースにアクセスできるように権限を付与してください。

    USE msdb;
    CREATE USER DB_User FOR LOGIN DB_User;
    GRANT SELECT to DB_User;

  • オブジェクト情報照会時の必要権限

    2014バージョン以下の場合は、モニタリング対象DBごとに接続して権限を付与してください。

    grant view any definition to DB_User;

  • プラン照会時の必要権限

    各DBごとに接続して実行してください。

    grant showplan to DB_User;
ノート

  • 権限を持つアカウントがある場合は、このステップを省略して次の段階に移ります。

  • サンプルコードのDB_User は、DBのユーザーアカウント名です。ユーザーが利用するユーザーアカウント名に変更してください。

  • コード例のDB_Passwordには、ユーザーパスワードを入力します。

アクセスキーの確認​

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

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

ノート

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

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

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

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

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

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

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

BASH
tar -zxvf whatap.agent.database.tar.gz
ノート

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

DBXエージェントの設定​

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

whatap.conf設定​

圧縮を解除したフォルダに移動し、whatap.conファイルを確認します。 whatap.con ファイルに、プロジェクトのアクセスキー情報、WhaTapサーバー情報、DB接続情報を入力します。

whatap.conf
license={AccessKey}
whatap.server.host=13.124.11.223/13.209.172.35

dbms=mssql
db=master
db_ip=127.0.0.1
db_port=1433
ノート

SSL認証問題が発生する場合

SSL認証に関する問題が発生したら、whatap.conファイルに次のオプションを設定します。

whatap.conf
connect_option=encrypt=true;trustServerCertificate=true

JDBCダウンロード​

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

情報

MS SQL 2005バージョン以降

圧縮ファイルをダウンロードして解凍すると_jars_フォルダが作成されます。 使用中のJavaバージョンと互換性のある_.jar_ファイルを選択した後、エージェントインストールフォルダ/jdbcに入れます。

例、mssql-jdbc-12.8.1.jre8.jar

ノート

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

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

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

BASH
./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

デフォルトプランを照会する​

デフォルトプランユーザーファイル作成時、エージェントが事前定義されたDB情報を使用してプランを自動的に照会するように設定できます。

  1. エージェント設定(whatap.conf)ファイルにplan_dbオプションを追加し、DB名を入力します。

    whatap.conf
    plan_db=(dbname)

  2. DB設定後planuid.shスクリプトを使用してユーザーとパスワードを設定します。

    ./planuid.sh user pwd
    ノート

    ユーザー(user)とパスワード(pwd)に特殊文字が含まれている場合、各特殊文字の前に逆スラッシュ(\)を追加します。

    例、 user$example → user\$example

モニタリングの開始​

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

./start.sh

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

./startd.sh

XOSエージェントのインストール及びその他のオプションを適用する​

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

ノート

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

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

  • XOSエージェント設定オプションの詳細については、次の文書を参照してください。
  • クラウドサービスが提供するモニタリングメトリクスを、データベースプロジェクトのダッシュボードで追加で収集してモニタリングするには、次の文書を参照してください。

whatap.confファイルを設定する​

DBXエージェントがインストールされたパスのwhatap.conファイルに次のオプションを設定します。

whatap.conf
xos=1
xos_port=3002

_xos_フォルダー(/解凍されたフォルダ/xos/)をデータベースサーバーに移動してください。

xos.confファイルを設定する​

データベースサーバーに移動し、_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情報を入力すると、エージェントオプションを自動生成できます。

XOSエージェントを実行する​

XOSエージェントを実行します。

./start.sh
ノート

  • DBXエージェントでモニタリングしたデータを転送するためにdbx_portに設定したポート(default 3002)が開いている必要があります。 (UDP Outbound)

  • XOSエージェントをバックグラウンドで実行するには*./startd.sh*ファイルを実行します。

次の段階​

  • インストールの点検

    プロジェクトの作成やエージェントのインストール、基本エージェントのオプションまですべて適用した場合は、次の文書で点検事項を確認します。

  • インストール問題の解決

    エージェントをインストールする際に発生する可能性がある問題と、これを解決するための具体的なガイドを提供します。 詳細については、次の文書を参照してください。

  • エージェント設定

    エージェント設定(whatap.con)ファイルにオプションを適用して、モニタリングのための様々な機能を提供します。 詳細については、次の文書を参照してください。

  • クラウド設定

    クラウドサービスが提供するモニタリングメトリクスを、データベースプロジェクトのダッシュボードで追加で収集してモニタリングするには、次の文書を参照してください。

  • モニタリングの開始

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