本文へスキップ

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

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

構成図の確認​

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

別途サーバーにインストールDBサーバーに直接インストール

アカウント生成​

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

  • 一般的な場合

    SQL
    create user {DB_User} identified by {DB_Password};
    grant create session to {DB_User};
    grant select any dictionary to {DB_User};

  • マルチテナントDB(Oracle 12c以降)で基本モニタリングを使用する場合: c##アカウント作成

    SQL
    create user c##{DB_User} identified by "{DB_Password}";
    grant create session to c##{DB_User};
    grant select any dictionary to c##{DB_User};
    alter user c##{DB_User} set container_data = ALL container = CURRENT;

  • kill sessionを使用する場合

    SQL
    grant alter system to {DB_User}

  • マルチテナントDBでkill session機能を使用する場合: c##アカウントで実行

    SQL
    grant alter system to c##whatap container=all;

  • ヒドゥンパラメータを照会する場合

    SQL
    create view sys.whatap_vw_ksppi as select * from sys.x$ksppi;
    grant select on sys.whatap_vw_ksppi to {DB_User};  
    create synonym {DB_User}.whatap_vw_ksppi for sys.whatap_vw_ksppi;

    create view sys.whatap_vw_ksppcv as select * from sys.x$ksppcv;
    grant select on sys.whatap_vw_ksppcv to {DB_User};
    create synonym {DB_User}.whatap_vw_ksppcv for sys.whatap_vw_ksppcv;

  • 接続分析機能を使用する場合

    SQL
    grant select on sys.v_$session to {Appication_service_account};
権限による対応機能を確認する

基本権限外の権限は、ユーザーの環境によって付与する必要はありません。ただし、一部の機能が動作しないことがあります。

権限command (Single DB)command (マルチテナント DB)メニューと機能詳細履歴
基本権限grant create session to whatap;grant create session to c##whatap;접속-
grant select any dictionary to whatap;grant select any dictionary to c##whatap;インスタンスモニタリング / マルチインスタンス / SQL統計個別権限の付与時、次の表の内容を参照
-alter user c##whatap set container_data = ALL container = CURRENT;マルチテナントDBを使用する場合(12C以降) pdb照会のための必須権限である
セッション中止grant alter system to whatap;grant alter system to c##whatap container=all;アクティブセッション > セッション中止-
ヒドゥンパラメータの照会create view sys.whatap_vw_ksppi as select * from sys.x$ksppi;
grant select on sys.whatap_vw_ksppi to DB_User;
create synonym DB_User.whatap_vw_ksppi for sys.whatap_vw_ksppi;		パラメータ照会メニューにヒドゥンパラメータの内容を含むヒドゥンパラメータを照会するには、別のビュー/シノニムの生成および権限付与が必要
create view sys.whatap_vw_ksppcv as select * from sys.x$ksppcv;
grant select on sys.whatap_vw_ksppcv to DB_User;
create synonym DB_User.whatap_vw_ksppcv for sys.whatap_vw_ksppcv;

select any dictionaryの代わりに、次の権限を個別に付与しても構いません。

権限command (Single DB)command (マルチテナント DB)
アクティブセッション / ロックツリー / メトリクス情報grant select on v_$sqlarea to whatap;grant select on v_$sqlarea to c##whatap;
grant select on v_$transaction to whatap;grant select on v_$transaction to c##whatap;
grant select on v_$instance to whatap;grant select on v_$instance to c##whatap;
grant select on v_$sysstat to whatap;grant select on v_$sysstat to c##whatap;
grant select on v_$lock to whatap;grant select on v_$lock to c##whatap;
grant select on v_$sesstat to whatap;grant select on v_$sesstat to c##whatap;
grant select on v_$event_name to whatap;grant select on v_$event_name to c##whatap;
grant select on v_$session to whatap;grant select on v_$session to c##whatap;
grant select on v_$sql to whatap;grant select on v_$sql to c##whatap;
grant select on v_$process to whatap;grant select on v_$process to c##whatap;
grant select on v_$statname to whatap;grant select on v_$statname to c##whatap;
grant select on v_$system_event to whatap;grant select on v_$system_event to c##whatap;
grant select on v_$osstat to whatap;grant select on v_$osstat to c##whatap;
grant select on v_$px_session to whatap;grant select on v_$px_session to c##whatap;
grant select on v_$sga to whatap;grant select on v_$sga to c##whatap;
-grant select on v_$con_sysstat to c##whatap;
パラメータ情報grant select on v_$parameter to whatap;grant select on v_$parameter to c##whatap;
Wait情報/Event情報grant select on v_$event_name to whatap;grant select on v_$event_name to c##whatap;
grant select on v_$system_event to whatapgrant select on v_$con_system_event to c##whatap;
grant select on v_$system_wait_class to whatap;grant select on v_$system_wait_class to c##whatap;
-grant select on v_$con_system_wait_class to c##whatap;
Tablespace情報grant select on dba_data_files to whatap;grant select on cdb_data_files to c##whatap;
grant select on dba_free_space to whatap;grant select on cdb_free_space to c##whatap;
grant select on dba_temp_files to whatap;grant select on v_$sort_segment to c##whatap;
grant select on v_$temp_extent_pool to whatap;grant select on v_$tempfile to c##whatap;
grant select on v_$containers to whatap; (12c以上)grant select on v_$containers to c##whatap;
ノート

  • 既に存在するアカウントを使用する場合は、DBユーザーファイルの作成に進みます。権限がない場合は、モニタリングを開始できません。

  • コード例でwhatapは、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=oracle&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=oracle
db={DB_Name(SID)}
db_ip={DB_Server_IP}
db_port={DB_Server_Port} 

exclude_background=3

JDBCダウンロード​

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

情報

Oracle 10g R2バージョン以降：https://www.oracle.com/database/technologies/appdev/jdbc-downloads.html

ノート

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

DBユーザーの作成とパスワードの変更​

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

Tips

パスワードを変更する場合も、変更するパスワードを入力して同じ方法で進めてください。

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

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

デフォルトプランユーザーファイル作成時、エージェントが事前定義された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.confファイルに次のオプションを設定します。

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.conf)ファイルにオプションを適用して、モニタリングのための様々な機能を提供します。 詳細については、次の文書を参照してください。

    データベースのサーバーリソースを追加で監視するには、追加のエージェント(XOS)に追加オプションを設定します。 詳細については、次の文書を参照してください。

  • クラウド設定

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

  • モニタリングの開始

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

最終修正：