Java エージェントのインストール
内容
apmdevops96jp
内容
エージェントをインストールする前に
エージェントをインストールする前に、以下の手順に従います。
- Java エージェント デプロイ プロセスを確認します。
- 以下のサポート対象バージョンのアプリケーション サーバがインストールされていることを確認します。注:エージェントのインストール先となるサーバには、ローカルで使用できるサポート対象バージョンの JVM がインストールされている必要があります。 アプリケーション サーバおよび JVM の要件については、「Compatibility Guide」を参照してください。
- Introscope Enterprise Manager および Workstation コンポーネントがインストールされていることを確認します。 エージェントとの接続に使用する Enterprise Manager のホスト名およびポート番号を確認します。エージェントと Enterprise Manager の間の接続状況は ping または telnet を使用して確認できます。
注:
Enterprise Manager、Workstation、および WebView コンポーネントのインストールの詳細については、「CA APM インストールおよびアップグレード ガイド
」を参照してください。Java エージェントをインストールする方法の選択
以下のいずれかの方法で Java エージェントをインストールすることができます。
- グラフィカル ユーザ インターフェース(GUI)またはテキスト ベースのコンソール インストーラを使用する対話モード
- 対話モードを使用せずに、編集済みの応答ファイルを使用するサイレント モード
- 個々のアプリケーション サーバのファイルを抽出および設定する手動モード
コンピュータにローカルでファイルをインストールする際には、ほとんどの場合対話モードのインストーラを使用します。 対話モードでインストールする場合、表示されるプロンプトは、グラフィカル インターフェースでも、テキストベース インターフェースでも同じです。 ただし、GUI またはテキストベースのインストーラを選択するオプションは、インストーラを実行するオペレーティング システムによって異なります。 たとえば、ほとんどの UNIX 環境では GUI またはテキストベースのコンソール インストーラをサポートしていますが、デフォルトではコンソール インストーラが開始されます。
コンピュータにリモートでファイルをインストールするか、事前に設定されたインストール手順に従ってデプロイする場合は、編集済みの応答ファイルを使用して、サイレント インストーラを実行できます。
対話モードまたはサイレント モードのインストーラを使用しない場合は、インストール アーカイブを使用して手動でエージェントのインストールおよび設定を行うことができます。 手動インストールでは、アプリケーション サーバおよびオペレーティング システムに固有のアーカイブからエージェント ファイルの特定のセットを抽出し、展開オプションを手動で設定できます。 CA Technologies はこれらのアーカイブを提供して、同じタイプのアプリケーション サーバおよびオペレーティング システムを共有する多重システム上に Java エージェントのデプロイを促します。
対話モード、サイレント モード、手動でのインストールの詳細については、それぞれのセクションを参照してください。
対話モードでの Java エージェントのインストール
お使いのオペレーティング システムに適した Java エージェント インストーラを選択してから、そのインストーラを起動し、プロンプトに応答することによって、Java エージェントを対話モードでインストールできます。 GUI インストーラを使用する場合は、ドロップダウン メニューやチェック ボックスを使用して、選択を行うことができます。 テキスト ベースのコンソール インストーラでは、テキストを入力することによって選択を行います。
以下の手順に従います。
- お使いのオペレーティング システムに適したインストール アーカイブを選択します。 たとえば、以下の通りです。
- Microsoft Windows にインストールする場合: IntroscopeAgentInstaller<version>windows.zip
- サポート対象の UNIX または Linux オペレーティング システムにインストールする場合: IntroscopeAgentInstaller<version>unix.tar
- IBM z/OS にインストールする場合: IntroscopeAgentInstaller<version>zOS.tar
- IBM OS/400 (IBM i オペレーティング システム)にインストールする場合: IntroscopeAgentInstaller<version>os400.zip
- オペレーティング システムに適したコマンドを使用して、インストール アーカイブ ファイルを解凍します。 たとえば、UNIX または Linux 上では以下のように入力します。tar - xvf IntroscopeAgentInstaller<version>unix.tar
- プロンプトに従ってインストールを開始します。
- アプリケーション サーバのルート ディレクトリの場所を指定します。アプリケーション サーバ ルート ディレクトリの場所を指定しない場合は、デフォルトの応答(Windows は C:\、UNIX は /)をそのまま使用します。
- 有効なアプリケーション サーバのリストから、アプリケーション サーバのタイプを選択します。選択するアプリケーション サーバによって、利用できる追加の監視オプションが決まります。
- Java エージェントのルート インストール ディレクトリを指定します。 ほとんどの場合、アプリケーション サーバ ルート ディレクトリを使用します。ルート インストール ディレクトリ内に、インストーラによって「wily」ディレクトリが作成されます。このディレクトリが<Agent_Home>ディレクトリになります。
- エージェント プロファイルを作成するか、または既存のエージェント プロファイルを使用するかを指定します。エージェント プロファイルを作成する場合は、以下を選択するよう求められます。
- 標準またはフル インスツルメンテーション
- エージェント名およびプロセス名
- Enterprise Manager のホスト名およびポート番号
指定する設定は必要に応じてインストール後に変更できます。その場合は、IntroscopeAgent.profile ファイルを編集します。 - アプリケーション サーバを起動するために使用する Java 実行可能ファイルへのパスを指定します。
- アプリケーションをインスツルメントするための ProbeBuilding を指定します。 ほとんどの場合、JVM AutoProbe を使用します。
- ChangeDetector エージェント拡張機能を有効にするかどうかを指定します。ChangeDetector を有効にする場合は、ChangeDetector エージェントの名前を指定するように求められます。ChangeDetector を有効にしない場合でも、ChangeDetector のファイルは<Agent_Home>/examples ディレクトリにインストールされます。 後で ChangeDetector を有効にする場合は、<Agent_Home>/core/ext ディレクトリにファイルをコピーし、IntroscopeAgent.profile ファイルを変更します。注:ChangeDetector の詳細については、「CA APM ChangeDetector ガイド」を参照してください。
- インストールする追加の監視オプションを選択します。 たとえば、Web サービスおよびその他の SOA 環境コンポーネントを監視する場合は、CA APM for SOA を選択します。インストール中にほかの監視オプションを有効にしない場合、ファイルは<Agent_Home>/examples ディレクトリにインストールされ、後で有効にすることができます。
- エージェントと共にインストールするアドオンが含まれる .zip または .tar ファイル用の「ピックアップ フォルダ」の場所を指定します。指定された場所に .zip または .tar ファイルがある場合、<Agent_Home>ディレクトリに解凍されます。
- 選択内容を確認し、エージェントのインストールを続行して、インストールを完了します。
注:
エージェントのインストールによってアプリケーション サーバが停止または起動することはありません。また、アプリケーション サーバの起動スクリプトが設定されることもありません。 インストール後にこれらのタスクを手動で実行します。 具体的な手順は、監視対象のアプリケーション サーバのタイプによって異なります。サイレント モードでの Java エージェントのインストール
サイレント モードでは、コマンド ラインからエージェント インストーラを起動し、インストールの指示が含まれる応答ファイルを指定します。 開始後は、インストールはバックグランウンドで実行され、進捗状況などは一切表示されません。 このインストール方法では、操作しなくてもエージェントをインストールできるので、リモート コンピュータにエージェントをインストールしたり、同一の設定内容で複数のエージェントをインストールしたりするのに使用するのが最も一般的です。
過去に Java エージェントをインストールしたことがある場合は、自動生成された応答ファイルを使用して追加エージェントをインストールすることもできます。 または、インストール用のファイルに含まれるサンプル応答ファイルを手動で編集するか、テキスト エディタを使用して独自の応答ファイルを作成することができます。
自動生成応答ファイル
Java エージェント インストーラを(対話モードまたはサイレント モードで)実行するたびに、ユーザが選択したインストール オプションを記録した応答ファイルがインストーラによって作成されます。 この自動的に生成される応答ファイルは、
<Agent_Home>/install
ディレクトリに保存されます。 ファイル名は、インストーラが応答ファイルを作成した日付と時間を以下の形式で表します。autogenerated.responsefile.<year>.<month>.<day>.<hour>.<minutes>.<seconds>
たとえば、インストール プロセスの完了日時が 2005 年 4 月 30 日午前 7:10:05 の場合、 以下の名前の応答ファイルが自動的に生成されます。
autogenerated.responsefile.2005.4.30.7.10.05
この自動生成応答ファイルは、それ以降のサイレント モード インストールにおいて、同じ設定で使用したり、編集して新しい設定で使用したりできます。
サンプル応答ファイル
Java エージェントを初めてインストールする場合、または以前のインストールで使用したオプション設定ではなくデフォルトの設定を使用する場合は、Java エージェント インストーラに含まれるデフォルトのサンプル応答ファイルを編集できます。 デフォルト サンプル応答ファイルは、
<Agent_Home>
\install ディレクトリ内に以下の名前で置かれています。SampleResponseFile.Agent.txt
サンプル応答ファイルでは、ほとんどのプロパティのデフォルト設定が指定されていますが、サイレント インストールで使用するには手動でファイルを編集する必要があります。
応答ファイルのプロパティ設定およびエージェントのインストール
自動生成応答ファイルまたはデフォルト サンプル応答ファイルを使用する場合、またはカスタム応答ファイルを作成する場合のいずれの場合でも、サイレント モードで Java エージェント インストーラを呼び出す前にファイル内のプロパティを適切に設定する必要があります。 応答ファイルで設定するプロパティは、インストーラを対話モードで実行するときの選択内容と同じものです。
注:
任意のプロパティの設定方法の詳細については、<Agent_Home>
/install/SampleResponse.Agent.txt ファイル内のコメントを参照してください。以下の手順に従います。
- テキスト エディタで以下の応答ファイルを開きます。
- 適切なプロパティ値を設定します。 設定するプロパティは以下のとおりです。
- USER_INSTALL_DIR=<root_installation_directory>エージェントをインストールするディレクトリを指定します。 ほとんどの場合、アプリケーション サーバ ルート ディレクトリを使用してください。
- silentInstallChosenFeatures=Agentインストールするコンポーネントを指定します。
- appServer=Default監視するアプリケーション サーバのタイプを指定します。 有効な値は、Default、JBoss、Tomcat、WebLogic、WebSphere、Sun、Oracle、または Interstage です。 値は大文字と小文字が区別されます。この設定は、エージェントと共にインストールする ProbeBuilder ディレクティブ(PBD)と、有効にする追加の監視オプションを制御します。
- (オプション) appServerHome=アプリケーション サーバのホーム ディレクトリを指定します。 USER_INSTALL_DIR プロパティをアプリケーション サーバのルート ディレクトリに設定した場合、このプロパティは必要ありません。
- (オプション) appServerJavaExecutable =アプリケーション サーバを起動するために使用する Java 実行可能ファイルへのパスを指定します。
- instrumentationLevel=TypicalFull または Typical のどちらのインスツルメンテーションを使用するかを指定します。 値は大文字と小文字が区別されます。
- instrumentationType=JVM AutoProbeManual ProbeBuildingまたはJVM AutoProbeのどちらを使用するかを指定します。 値は大文字と小文字が区別されます。使用する方法を決定するのに役立つ情報については、以下を参照してください。
- agentName=Default AgentWorkstation 内に表示するエージェント名を指定します。
- processName=Default ProcessWorkstation 内に表示するプロセス名を指定します。
- emHost=localhostデフォルトでエージェントが接続する Enterprise Manager を実行するコンピュータのホスト名を指定します。
- emPort=5001エージェントが Enterprise Manager への接続に使用するポート番号を指定します。
- (オプション) alternateAgentProfile=既存のエージェント プロファイルへの絶対パスを指定します。
- (オプション) pickupFolder=エージェントと共にインストールする任意のアドオンの .zip または .tar ファイルを含む「ピックアップ フォルダ」の絶対パスを指定します。
- (オプション) changeDetectorEnable=falseChangeDetector エージェント拡張機能を有効にするかどうかを指定します。 このプロパティを false に指定すると、ChangeDetector のファイルはインストールされますが、有効にはなりません。 これは後から有効にすることができます。
- (オプション) changeDetectorAgentID=ChangeDetector エージェント拡張機能の名前を指定します。 ChangeDetector を有効にする場合は、コメントを解除してこのプロパティを設定します。
- (オプション) shouldEnable*有効にする追加の CA APM 監視ソリューションを指定します。 オプションの CA APM 監視ソリューションのプロパティはすべてデフォルトで false に設定されます。 有効にすることができるオプションは、アプリケーション サーバのタイプによって異なります。
- 応答ファイルを保存して、テキスト エディタを閉じます。
- インストーラの実行可能ファイルのパスと応答ファイルの絶対パスを指定して、インストーラをサイレント モードで起動します。<path_to_installer> -f <absolute_path_to_response-file>インストーラの起動に使用するコマンドは、コマンドを実行するオペレーティング システムによって異なります。たとえば、Windows ではコマンド形式は次のようになります。IntroscopeAgent<version>windows.exe -f C:\temp\myResponseFile.txtLinux または UNIX では、コマンド形式は次のようになります。./IntroscopeAgent<version>unix.bin -f /tmp/MyReponseFile.txtお使いのオペレーティング システムに適したコマンド形式を選択してください。
- <Agent_Home>/install/Introscope_Agent_<version>_InstallLog.log ファイルを調べて、エージェントが正常にインストールされていることを確認します。
インストール アーカイブを使用した Java エージェントの手動インストール
Java エージェント インストーラを対話モードで実行したり、応答ファイルを設定したりしなくても、エージェント ファイルはシステム上に配置できます。 アプリケーション サーバ固有のアーカイブを使用すれば、エージェントをインストールできます。
インストール アーカイブには、エージェント インストーラを実行した場合にインストールされるファイルがすべて含まれています。 アーカイブをコンピュータにコピーしてから展開し、エージェント プロファイルで接続先の Enterprise Manager を指定し、その他のプロパティの設定も行います。 これらのファイルを使用して複数のエージェントをバッチ ジョブでデプロイするか、またはこれらのファイルをエージェント ファイルのデフォルト セットのアーカイブとして保存します。
アーカイブから Java エージェントを手動でインストールする場合は、インストール先のコンピュータに 110 MB 以上の空きディスク領域があることを確認します。
以下の手順に従います。
- アプリケーション サーバとオペレーティング システムに適したインストール アーカイブを選択します。
- お使いのオペレーティング システムに適したコマンドを使用して、アーカイブの中身を JVM がアクセス可能な場所に解凍します。 たとえば、UNIX または Linux 上では以下のように入力します。tar -xvf IntroscopeAgentFilesOnly-NoInstaller<version><app_server>.<os>.tar
- <Agent_Home>/core/config/IntroscopeAgent.profile ファイルをテキスト エディタで開き、Enterprise Manager との通信のためのプロパティを設定します。
- 任意の追加プロパティを設定し、IntroscopeAgent.profile ファイルを保存して閉じます。
- Java エージェント起動ファイルおよびエージェント プロファイルの場所を使って、アプリケーション サーバを設定します。
- アプリケーション サーバを再起動します。
z/OS 上でのコンソール モードによるエージェント インストーラの起動
エージェントを z/OS コンピュータにインストールできます。
以下の手順に従います。
- 以下のコマンドを実行して、z/OS インストーラ アーカイブの内容を展開します。tar tvf<installerFile>.tar
- z/OS インストーラ ファイルの内容を抽出します。
- <installerfilename>.jar
- runinstaller.sh -- このスクリプトを実行すると、インストーラが -i console オプションを使用して起動され、/tmp ディレクトリに十分なスペースがあるかどうかが確認されます。
- tmppath -- この実行可能ファイルによって、インストール中に一時ファイルを配置する場所が決定されます。
- コマンド ラインまたは JAVA_HOME 環境変数で、JAVA_HOME を指定します。 以下のコマンドを実行して JAVA_HOME 環境変数が存在することを確認できます。echo $JAVA_HOME
- JAVA_HOME が定義されていない場合は、以下の手順を実行します。
- runinstaller.sh スクリプトをテキスト エディタで開きます。
- JAVA_HOME 変数が設定されている行のコメント化を解除し、パスを変更して、JAVA_HOME に Java インストール ディレクトリの場所を指定します。
- 変更を保存します。
- 以下のコマンドを実行して、インストーラを起動します。runinstaller.sh <installerfilename>.jar注:システムの一時ディレクトリに十分な空き領域がない場合、インストーラは実行できません。 この問題を解決するには、以下のようにして一時ディレクトリを変更することができます。java -Dlax.nl.env.tmp=/my/Temp/Dir -jar install.jar
OS/400 または IBMi 上でのコンソール モードでのエージェント インストーラの起動
Introscope コンポーネントを OS/400 または IBMi のコンピュータにインストールできます。
以下の手順に従います。
- IBM iSeries Access for Windows または同様のユーティリティを使用して、インストーラ .ZIP アーカイブを展開します。 インストーラ アーカイブには、以下のファイルが含まれています。
- introscope<version>os400.jar
- runinstaller.os400.sh -- このスクリプトを実行すると、インストーラが -i console オプションを使用して起動されます。
- コマンド ラインまたは JAVA_HOME 環境変数で、JAVA_HOME 変数を指定します。 環境変数を使用する場合は、スクリプトの定義をコメント化します。
- JAVA_HOME 環境変数が存在することを、以下のコマンドを実行して確認します。echo $JAVA_HOMEJAVA_HOME が定義されていない場合は、以下の作業を実行します。
- runinstaller.os400.sh スクリプトをテキスト エディタで開きます。
- JAVA_HOME 変数が設定されている行のコメント化を解除し、パスを変更して、JAVA_HOME に Java インストール ディレクトリの場所を指定します。
- 変更を保存します。
- Qshell から以下のように入力してスクリプトを起動します。runinstaller.os400.sh introscope<version>os400.jar注:システムの一時ディレクトリに十分な空き領域がない場合、インストーラは実行できません。 この問題を解決するには、以下のようにして一時ディレクトリを変更することができます。java -Dlax.nl.env.tmp=/my/Temp/Dir-jar install.jar
Java エージェントのディレクトリ構造について
エージェントのインストール時には、以下のディレクトリ構造がルート インストール ディレクトリに作成されます。
- wilyこのディレクトリは<Agent_Home>ディレクトリであり、エージェントの起動に使用する Agent.jar が含まれます。<Agent_Home>ディレクトリのサブディレクトリでは、Java エージェントのさまざまな機能を有効にするライブラリと拡張ファイルが提供されています。
- core
- configここには、IntroscopeAgent.profile、ProbeBuilder ディレクティブ ファイル(.pbd)、および ProbeBuilder リスト ファイル(.pbl)が含まれます。これらのファイルにより、エージェントのオペレーション、メトリック データの収集、およびインスツルメンテーション処理が制御されます。 IntroscopeAgent.profile 内でどのプロパティが定義されているか、またどの .pbd および .pbl ファイルがデプロイされエージェント プロファイルで参照されているかは、インストール時の選択内容に応じて異なります。config ディレクトリ内の hotdeploy サブディレクトリを使用すると、IntroscopeAgent.profile の編集やアプリケーションの再起動を行わなくても、新しいディレクティブをデプロイできます。 hotdeploy ディレクトリ内のファイルに無効な構文が含まれていたり、メトリックが過剰に含まれていると、インスツルメンテーションの失敗やアプリケーション パフォーマンスの低下につながることがあります。
- ext有効化されたエージェント拡張機能やその他の機能のファイルを含んでいます。 たとえば、このディレクトリには、アプリケーション問題切り分けマップや LeakHunter のファイルが含まれます。
- connectors特定環境でのインスツルメンテーションを可能にする AutoProbe コネクタの設定に使用する CreateAutoProbeConnector.jar ユーティリティが含まれます。
- common拡張機能用の設定ファイルとプロパティ ファイルが含まれます。
- examplesCA APM for SOA などのオプションのエージェント拡張機能のフォルダとファイルが含まれます。 インストール時に拡張機能を有効にしなかった場合、後でこのディレクトリ内のファイルを使用して、拡張機能を設定できます。
- installインストール プロセスを記録したログ ファイルと、サイレント インストールで使用できるファイルが含まれます。 たとえば、生成される応答ファイルや SampleResponseFile.Agent.txt ファイルは、このディレクトリに置かれます。インストール アーカイブから手動で Java エージェントをインストールする場合、このディレクトリは作成されません。
- logsエージェントのログ ファイルが格納されます。
- tools以下のコンテンツを保持します。
- Web サーバのログ ファイルを分析する URLGrouper.jar コマンド ライン ユーティリティ。
- 拡張機能のファイルのリスト。 たとえば、configurePMI.bat、CreateIU.jar、listServers.bat、MergeUtility.jar、NetInterface.jar、setPmiModules.jacl ファイルは、このディレクトリにあります。
- TagScript ツール ファイル: TagScript.jar、TagScript.bat、および TagScript.sh コマンドライン スクリプト。
- UninstallerDataエージェントと関連リソースのアンインストールに使用する実行可能ファイルと関連リソースが入ったサブディレクトリが含まれます。インストール アーカイブから手動で Java エージェントをインストールする場合、このディレクトリは作成されません。
- versionオプションの CA APM 監視ソリューションのバージョン情報が含まれます。 この情報は、インストール時に何を有効にするように選択したかに関わりなくインストールされます。
Java エージェントのアンインストール
Java エージェントをアンインストールするには、監視対象のアプリケーションごとに、Java エージェントがインストールされている場所を把握しておく必要があります。
Java エージェント インストーラを使用して Java エージェントをインストールした場合は、アンインストール プログラムを使用して、インストールされているエージェント ファイルを削除できます。 アンインストーラを起動し、画面の指示に従います。
以下の手順に従います。
- アプリケーション サーバを停止します。注:アンインストール プログラムを実行する前に、監視対象の JVM をシャット ダウンする必要があります。
- アプリケーション サーバの起動スクリプトを開き、Java コマンド ラインから Java エージェント スイッチを削除します。 アプリケーション サーバのタイプに応じて、起動オプションには以下のような記述が含まれます。
- -Xbootclasspath
- -javaagent:<path_to_the_agent_jar>
- -Dcom.wily.introscope.agentProfile=<path_to_the_agent_profile>
- アプリケーション サーバを再起動します。
- <Agent_Home>/UnstallerData ディレクトリ内にあるUninstall_Introscope_Agentプログラムを実行します。
- 手動で<Agent_Home>ディレクトリを削除します。Java エージェントがアンインストールされました。
z/OS からの Java エージェントのアンインストール
z/OS から Java エージェントをアンインストールするための推奨方法は、
<Agent_Home>
ディレクトリを rm -rf
コマンドを使用して削除する方法です。 これは、サードパーティのバグにより、実行形式のアンインストーラが z/OS 上で正しく動作しないために必要になります。重要:
監視対象の JVM をシャットダウンした後にのみ、ファイルを削除します。z/OS 上で Introscope のインストールをアクティブにしておくには、
UninstallerData
フォルダをそのままにしておくことが重要です。 UninstallerData
フォルダを削除すると、今後 Introscope のバージョンをアップグレードできなくなってしまいます。 インスタンス全体をアンインストールするよう決定した場合を除き、UninstallerData
フォルダは削除しないでください。