CA APM for IBM WebSphere Portal のインストールと設定

内容
apmdevops102jp
内容
この章は、CA APM IBM WebSphere Portal をインストールし、設定するための手順を提供します。
インストール要件
サポートされている IBM WebSphere Portal のバージョンについては、「
Compatibility Guide
」の「APM Extensions」を参照してください。
前提条件
インストール手順を開始する前に、以下のことを確認します。
  • ネットワーク内の以下のディレクトリの場所を確認します。
    • WebSphere コンピュータ
      -- WebSphere のインストール ディレクトリは
      <WAS_Home>
      と表記されます。このディレクトリはインストール時に指定する WebSphere の場所です。
    • Enterprise Manager コンピュータ
      -- Enterprise Manager のホーム ディレクトリは
      <EM_Home>
      と表記されます。
    • Workstation コンピュータ
      -- Workstation のホーム ディレクトリは
      <Workstation_Home>
      と表記します。
  • WebSphere に Java エージェントが設定されていることを確認します。詳細については、「Java エージェントのインストール」を参照してください。
  • Java のバージョンが 1.5 以上であることを確認します。
CA APM for IBM WebSphere Portal をインストールおよび設定する方法
CA APM for IBM WebSphere Portal のインストールおよび設定は、以下の高レベルな手順に従います。
  1. 注:
    CA APM for IBM WebSphere Portal のすべての Enterprise Manager 拡張機能および計算機を、主ににコレクタに配置します。以下の情報を考慮します。
    - ダッシュ ボードが利用できるようにするには、MOM に管理モジュールをインストールします。
    - クラスタ化された環境で設定されたエージェントを MOM に接続するには、IntroscopeAgent.profile ファイルのプロパティを使用します。
  2. (オプション) ChangeDetector と CA APM for IBM WebSphere Portal を統合して、Portal コンポーネントおよび設定ファイルの変更を監視します。
  3. 使用する認証の種類に適した認証ノードを設定します。
  4. (IBM JVM 1.5、1.6 の場合) Java エージェント .jar ファイルおよび Java エージェント プロファイルの代替バージョンを使用します。これらのファイル AgentNoRedefNoRetrans.jar および IntroscopeAgent.NoRedef.profile は、<
    Agent_Home
    > ディレクトリにあります。IBM JVM 1.7 の場合には、デフォルト Java Agent.jar ファイルを使用します。AgentNoRedefNoRetrans.jar は必要ありません。
CA APM for IBM WebSphere Portal のEnterprise Manager コンポーネントのインストール
同じ Enterprise Manager を異なるエージェントに使用している場合、CA APM for IBM WebSphere Portal はすでに
<EM_Home>\examples
フォルダにインストールされています。CA APM for IBM WebSphere Portal の Enterprise Manager コンポーネントをインストールするには、Enterprise Manager インストーラを再度実行する必要はありません。
以下の手順に従います。
重要:
同じ Enterprise Manager を異なるエージェントに使用している場合は、手順 1 をスキップし、手順 2 からタスクを実行します。
  1. CA APM for IBM WebSphere Portal の Enterprise Manager コンポーネントを Enterprise Manager にインストールするには、Enterprise Manager インストーラを実行します。
    Enterprise Manager インストーラによって、以下のディレクトリにファイルが配置されます。
    <EM_Home>\examples\ PowerPackforWebspherePortal
    注:
    詳細については、「
    CA APM インストールおよびアップグレード ガイド
    」を参照してください。
  2. <EM_Home>\examples\
    PowerPackforWebspherePortal
    ディレクトリに以下のファイルがあることを確認します。
    注:
    以下の説明では Microsoft Windows のディレクトリ構文を使用しています。UNIX など、その他のインストール プラットフォームでは、「\」を「/」に置き換えてください。
    ファイル
    : <
    EM_Home
    >\examples\ PowerPackforWebspherePortal \product\enterprisemanager\plugins\com.wily.powerpack.websphereportal.em.ext.jar
    説明
    : Enterprise Manager 拡張用のプラグイン。
    ファイル
    : <
    EM_Home
    >\examples\ PowerPackforWebspherePortal\product\enterprisemanager\plugins\com.wily.powerpack.websphereportal.em.service.jar
    説明
    : Enterprise Manager サービスのプラグイン。
    ファイル
    : <
    EM_Home
    >\examples\ PowerPackforWebspherePortal\ws-plugins\com.wily.powerpack.websphereportal.ws.ext.jar
    説明
    : Workstation 拡張用のプラグイン。
    ファイル
    : <
    EM_Home
    >\examples\ PowerPackforWebspherePortal\config\modules\PowerpackForWebspherePortal_ManagementModule_typical.jar
    説明
    : ダッシュボードにパフォーマンス メトリックを表示するための標準設定用の管理モジュール JAR。
    ファイル
    : <
    EM_Home
    >\examples\PowerPackforWebspherePortal\config\modules\PowerpackForWebspherePortal_ManagementModule_full.jar
    説明
    : ダッシュボードにパフォーマンス メトリックを表示するための完全設定用の管理モジュール JAR。
  3. \examples
    ディレクトリでのファイル構成に基づいて、すべてのファイルを正しい場所にコピーします。
    たとえば、Enterprise Manager 拡張機能のプラグインは、以下のようにコピーします。
    com.wily.powerpack.websphereportal.em.ext.jar
    コピー元
    <EM_Home>\examples\PowerPackforWebspherePortal \product\enterprisemanager\plugins\
    コピー先:
    <EM_Home>\product\enterprisemanager\plugins\
CA APM for IBM WebSphere Portal のエージェント コンポーネントのインストール
以下の手順に従います。
  1. IntroscopeAgentFiles-Legacy-NoInstaller<
    Release_Number
    >websphere.windows.zip ファイルをダウンロードします。
  2. インストール ディレクトリとして <
    WAS_Home
    >\PortalServer に .zip ファイルを抽出します。
    その結果、
    wily
    という名前の新しいフォルダが作成されます。
  3. <WAS_Home>\PortalServer\wily
    ディレクトリに以下のファイルがあることを確認します。
    注:
    以下では Microsoft Windows のディレクトリ構文を使用しています。UNIX など、その他のインストール プラットフォームでは、「\」を「/」に置き換えてください。
    ファイル
    : <
    WAS_Home
    >\PortalServer\wily\core\config\powerpackforwebsphereportal-legacy.pbl
    説明
    : すべての PBD が記載されている ProbeBuilder リスト。
    ファイル
    : <
    WAS_Home
    >\PortalServer\wily\core\config\powerpackforwebsphereportal-legacy.pbd
    説明
    : WebSphere Portal のトレーサのすべてのクラスとメソッドの定義が含まれている PBD。
    ファイル
    : <
    WAS_Home
    >\PortalServer\wily\core\config\powerpackforwebsphereportal_typical.pbd
    説明
    : ポータル サーバのクリティカルなコンポーネントのパフォーマンスを監視するために有効になっているクリティカルなトレーサのみが含まれている PBD。
  4. <
    WAS_Home
    >\PortalServer\wily\core\config\IntroscopeAgent.profile を編集します。
    1. introscope.autoprobe.directivesFile プロパティを探します。
    2. このプロパティに以下の PBL ファイルを追加します。
      introscope.autoprobe.directivesFile=websphere-typical-NoRedef-legacy.pbl,hotdeploy,powerpackforwebsphereportal-legacy.pbl
  5. PowerPackforWebspherePortal_ext.jar ファイルを <WAS_Home>\PortalServer\wily\examples\<PowerPackForWebspherePortal>\ext ディレクトリから <WAS_Home>\PortalServer\wily\core\ext ディレクトリにコピーします。
CA APM for IBM WebSphere Portal のエージェント コンポーネントが設定されました。
標準、完全、エラー PBD の PBL ファイルの設定
CA APM for IBM WebSphere Portal は、標準または完全のいずれかの設定をすることができます。標準設定の場合は、powerpackforwebsphereportal_typical.pbd を有効にします。この PBD では、ポータル サーバのクリティカルなコンポーネントのパフォーマンスを監視するための、クリティカルなトレーサのみを有効にします。完全設定の場合は、powerpackforwebsphereportal_full.pbd を有効にします。この PBD には、ポータル サーバのすべてのコンポーネントのパフォーマンスを監視するための、すべてのトレーサが含まれます。
デフォルトで、CA APM for IBM WebSphere Portal の PBL ファイルは、標準設定(powerpackforwebsphereportal_typical.pbd)が有効になり、完全設定(powerpackforwebsphereportal_full.pbd)が無効になっています。
powerpackforwebsphereportal_typical.pbd を使用する場合は、Investigator ツリーに以下のノードが表示されます。
  • [Access Control]、[Authentication]、[Engine]、[Legacy Portlet Container]、[Portal]、[Portlets]、[Standard Portlet Container]、[Virtual Portal]、[WSRP]ノードが、[WebSphere Portal]ノードで利用可能です。
  • すべてのノードで、Average Response Time と Responses Per Interval メトリックだけがレポートされます。標準設定の場合は、Concurrent Invocations、Errors Per Interval、および Stall Count は利用できません。
注:
ストールがレポートされる場合は、それぞれのノードの下に表示されます。[Errors Per Interval]を表示するには、powerpackforwebsphereportal-legacy.pbl ファイル内の powerpackforwebsphereportal_errors-legacy.pbd を有効にします。
powerpackforwebsphereportal_full.pbd を使用する場合は、Investigator ツリーの[WebSphere Portal]ノード下に以下のノードが表示されます。
  • Access Control
  • 認証
  • キャッシュ
  • エンジン
  • Legacy Portlet Container
  • Portal、Portlet Services
  • Portlets
  • Standard Portlet Container
  • Virtual Portal
  • WSRP
すべてのノードで、以下の 5 つのメトリックがすべてレポートされます。
  • Average Response Time (平均応答時間)
  • Responses Per Interval
  • Concurrent Invocations
  • Errors Per Interval
  • Stall Count
重要:
[Portal]、[Virtual Portal]、および[WSRP]ノードでは、完全設定の場合は[Average Response Time]と[Responses Per Interval]のみが表示されます。
注:
[Errors Per Interval]を表示するには、powerpackforwebsphereportal-legacy.pbl ファイル内の powerpackforwebsphereportal_errors-legacy.pbd を有効にします。
標準設定では、クリティカルなコンポーネントまたはメトリック用の 5 つのメトリックをすべて表示できます。また、追跡されているクリティカルなコンポーネント以外のコンポーネントを表示することもできます。
標準設定で 5 つのメトリックをすべて表示する方法
  1. Blame ポイント メトリックに対する powerpackforwebsphereportal_typical.pbd のエントリを、以下のように false から true に変更します。
    SetTracerParameter:CustomBlamePointTracer forcestandardblamemetrics true SetTracerParameter:PortletNameAwareBlamePointTracer forcestandardblamemetrics true SetTracerParameter:WSRPPortletRenderActionTracer forcestandardblamemetrics true
  2. Portal Server を再起動します。
    変更が反映されます。
標準設定でより多くの WebSphere Portal コンポーネントを追跡する方法
  1. powerpackforwebsphereportal_typical.pbd の関連するトレーサのコメント化を解除して、トレーサを有効にします。
  2. Portal Server を再起動します。
    変更が反映されます。
PBL で完全設定を有効にする方法
  1. powerpackforwebsphereportal_typical.pbd エントリをコメント化するかまたは無効にし、powerpackforwebsphereportal-legacy.pbl の powerpackforwebsphereportal_full.pbd エントリのコメント化を解除するかまたは有効にします。
  2. Portal Server を再起動します。
    変更が反映されます。
    重要:
    完全設定を有効にする場合は、PowerpackForWebspherePortal_ManagementModule_full.jar を
    <EM_Home>
    \config\modules ディレクトリにコピーして、完全設定用のダッシュボードを表示します。
    標準設定を有効にする場合は、PowerpackForWebspherePortal_ManagementModule_typical.jar を
    <EM_Home>
    \config\modules ディレクトリにコピーします。
    完全設定を有効にすると、原因であるコンポーネントの切り分け、診断、検出を詳細に行って、エラーを修正することができます。
重要:
powerpackforwebsphereportal_typical.pbd と powerpackforwebsphereportal_full.pbd は同時に有効にしないでください。同時に有効にすると、Investigator ツリーの親レベル ノードで集約メトリックを表示する際に競合が発生し、Introscope Enterprise Manager から例外が投入されることがあります。
また、powerpackforwebsphereportal-legacy.pbl ファイル内の powerpackforwebsphereportal_errors-legacy.pbd を有効にして、Investigator で Errors Per Interval メトリックをレポートすることができます。
Investigator ツリーのライフサイクル メソッドからレポートされるエラーを表示する方法
  1. powerpackforwebsphereportal-legacy.pbl ファイルの powerpackforwebsphereportal_errors-legacy.pbd エントリのコメント化を解除するかまたは有効にします。
  2. Portal Server を再起動します。
    変更が有効になります。
    powerpackforwebsphereportal_errors-legacy.pbd は、15 秒のタイム スライスで Java 例外をキャッチして Introscope エージェントで記録されたエラーの数をレポートします。エラーは、PBD で追跡されているクラスのメソッドに対して記録されます。
    powerpackforwebsphereportal_errors-legacy.pbd ファイルを有効にした場合は、標準設定と完全設定の両方でエラーがレポートされます。powerpackforwebsphereportal_errors-legacy.pbd ファイルを有効にした場合は、エラーは標準設定に対してはレポートされません。ただし、完全設定の場合は、[Errors Per Interval]のノードは Investigator ツリー内に存在しますが、値はレポートされません。
    完全設定の powerpackforwebsphereportal_errors-legacy.pbd ファイルを有効にすると、Errors Per Interval メトリックを利用可能なほかのメトリックと共に取得できます。これらのメトリックから、より適切な方法で問題を切り分けるための詳細な情報が得られます。そのため、CA Technologies は、完全設定では powerpackforwebsphereportal_errors-legacy.pbd ファイルを使用することをお勧めします。
以上で、標準、完全、エラーの PBD が設定されました。
認証ノードの設定
使用する認証のタイプで使用する認証ノードを設定できます。
以下の手順に従います。
  1. <
    EM_Home
    > フォルダにある powerpackforwebsphereportal-legacy.pbd ファイルを開きます。
  2. 以下のオプションのうちの 1 つを選択します。使用する WebSphere Portal のバージョンとログインのタイプに基づいて選択してください。
    • Enable this section for WAS Portal 7 and previous versions when Custom Login Command is used for authentication. (カスタム ログイン コマンドが認証に使用される場合、WAS Portal 7 および旧バージョンではこのセクションを有効にします。)
      IdentifyClassAs: com.ibm.wps.engine.commands.LoginUserAuth WASPAuthenticationTracing TraceOneMethodIfFlagged: WASPAuthenticationTracing doAuthenticate CustomBlamePointTracer "WebSphere Portal|Authentication|Login"
    • Enable this section for WAS Portal versions that are previous to version 7 when Servlet Filters are used for authentication. (サーブレット フィルタが認証に使用される場合、バージョン 7 よりも前の WAS Portal ではこのセクションを有効にします。)
      IdentifyClassAs: com.ibm.wps.auth.impl.DefaultLoginFilter WASPAuthenticationTracing TraceOneMethodIfFlagged: WASPAuthenticationTracing doLoginWithExceptions CustomBlamePointTracer "WebSphere Portal|Authentication|Login"
    • Enable this section for WAS Portal 7 and later versions when Servlet Filters are used for authentication. (サーブレット フィルタが認証に使用される場合、バージョン 7 以降の WAS Portal ではこのセクションを有効にします。)
      IdentifyClassAs: com.ibm.wps.auth.impl.LoginDefaultFilter WASPAuthenticationTracing TraceOneMethodIfFlagged: WASPAuthenticationTracing internalLogin CustomBlamePointTracer "WebSphere Portal|Authentication|Login"
  3. ファイルを保存して閉じます。
オプションでの ChangeDetector の CA APM for IBM WebSphere Portal との統合
Introscope ChangeDetector を使用すると、WebSphere Portal のページ、ポートレット、およびポータル設定ファイルに対する変更を監視できます。
以下の手順に従います。
  1. <WAS_Home>\PortalServer\wily\common
    ディレクトリに
    ChangeDetector-config-WebSpherePortal61.xml
    があることを確認します。
  2. <WAS_Home>\PortalServer\wily\core\config
    ディレクトリにある
    IntroscopeAgent.profile
    ファイルで、以下のプロパティを
    true
    に設定します。デフォルトでは
    false
    に設定されています。
    introscope.Changedetector.enable=true
  3. IntroscopeAgent.profile
    ファイルで、以下のプロパティを
    ChangeDetector-config-WebSpherePortal61.xml
    を指定するように設定します。
    introscope.changeDetector.profile=<path to WAS_Home>\PortalServer\wily\common\ChangeDetector-config-WebSpherePortal61.xml.
    introscope.changeDetector.profileDir=<path to WAS_Home>\PortalServer\wily
    例:
    introscope.changeDetector.profile=C:\\WAS_Home\\PortalServer\\wily\\common\\ChangeDetector-config-WebSpherePortal61.xml introscope.changeDetector.profileDir=C:\\WAS_Home\\PortalServer\\wily
    UNIX 環境の場合
    introscope.changeDetector.profile=<path to WAS_Home>/ChangeDetector-config-WebSphereportal.xml introscope.changeDetector.profileDir=<path to WAS_Home>/PortalServer/wily
  4. IntroscopeAgent.profile
    を保存します。
  5. 環境変数
    WEBSPHERE_PORTAL_DIR
    を追加して、ChangeDetector に WebSphere Portal のルート ディレクトリの場所がわかるようにします。環境変数は
    IntroscopeAgent.profile
    ファイルまたはアプリケーション サーバの起動スクリプトに追加できます。以下の手順のいずれかを実行します。
    • <WAS_Home>\PortalServer\wily\core\config
      ディレクトリにある
      IntroscopeAgent.profile
      ファイルに、以下の環境変数
      WEBSPHERE_PORTAL_DIR
      を追加して、WebSphere Portal のルート ディレクトリの場所を指定するようにします。
      WEBSPHERE_PORTAL_DIR=<path to WebSphere Portal root directory>
      例:
      WEBSPHERE_PORTAL_DIR=C:\\<WAS_Home>\\PortalServer
    • アプリケーションの起動ファイルに変数
      WEBSPHERE_PORTAL_DIR
      を追加して、WebSphere Portal のルート ディレクトリを指定するようにし、起動スクリプトを保存して、Portal Server を再起動します。
      -DWEBSPHERE_PORTAL_DIR=<path to WebSphere Portal root directory>
      例:
      -DWEBSPHERE_PORTAL_DIR=C:\<WAS_Home>\PortalServer
      注:
      アプリケーションの起動スクリプトは
      startServer.bat
      という名前で、
      <WAS_Home>\<domain>\bin\
      ディレクトリにあります。たとえば、アプリケーションの起動スクリプトは
      <WAS_Home>\<wp_profile>\bin\
      ディレクトリにあります。
  6. 環境変数
    WEBSPHERE_PROFILE_DIR
    を追加して、ChangeDetector に WebSphere アプリケーション サーバのプロファイル ディレクトリの場所がわかるようにします。環境変数は
    IntroscopeAgent.profile
    ファイルまたはアプリケーション サーバの起動スクリプトに追加できます。以下の手順のいずれかを実行します。
    • IntroscopeAgent.profile
      ファイルに、環境変数
      WEBSPHERE_PROFILE_DIR
      を追加して、WebSphere Portal のルート ディレクトリの場所を指定するように設定します。
      WEBSPHERE_PROFILE_DIR=<path to the WebSphere Application Server profile directory>
      例:
      WEBSPHERE_PROFILE_DIR=C:\\<WAS_Home>\\wp_profile
    • 変数
      WEBSPHERE_PROFILE_DIR
      をアプリケーションの起動ファイルに追加して保存し、Portal Server を再起動します。
      -DWEBSPHERE_PROFILE_DIR=<path to the WebSphere Application Server profile directory>
      例:
      -DWEBSPHERE_PROFILE_DIR=C:\<WAS_Home>\wp_profile
      注:
      アプリケーションの起動スクリプトは
      startServer.bat
      という名前で、
      <WAS_Home>\<domain>\bin\
      ディレクトリにあります。たとえば、アプリケーションの起動スクリプトは
      <WAS_Home>\<wp_profile>\bin\
      ディレクトリにあります。
    ChangeDetector の詳細については、「
    CA APM ChangeDetector ユーザ ガイド
    」を参照してください。
    ChangeDetector が CA APM for IBM WebSphere Portal と統合されました。
クラスタ化された環境用の CA APM for IBM WebSphere Portal のインストールおよび設定
クラスタ環境またはクラスタ化によって、Enterprise Manager は MOM (Manager of Managers)として機能し、ほかの Enterprise Manager を管理することができます。管理される Enterprise Manager は、コレクタと呼ばれます。クラスタ化された環境で、CA APM for IBM WebSphere Portal を各コレクタにインストールし、設定します。
以下の手順に従います。
  1. CA APM for IBM WebSphere Portal の Enterprise Manager コンポーネントをインストールします。
    注:
    CA APM for IBM WebSphere Portal のすべての Enterprise Manager 拡張機能および計算機を、主ににコレクタに配置します。以下の情報を考慮します。
    - ダッシュ ボードが利用できるようにするには、MOM に管理モジュールをインストールします。
    - クラスタ化された環境で設定されたエージェントを MOM に接続するには、IntroscopeAgent.profile ファイルのプロパティを使用します。
  2. CA APM for IBM WebSphere Portal のエージェント コンポーネントをインストールします。
  3. PBL ファイルを使用して、標準モードまたは完全モードのいずれかでエージェントを設定します。
  4. (オプション) ChangeDetector と CA APM for IBM WebSphere Portal を統合して、Portal コンポーネントおよび設定ファイルの変更を監視します。
MOM 上での JavaScript 計算機の実行
MOM 上で JavaScript 計算機を実行して、MOM エージェント用のメトリックを作成することができます。コレクタに接続されているエージェントのメトリックを作成することはできませんが、コレクタ内のエージェントから入力メトリックを表示することはできます。
コレクタに対する自動更新をオフにしないと、計算機が変更されるとき、MOM によってすべてのコレクタが更新されます。詳細については、「
CA APM Workstation ユーザ ガイド
」を参照してください。
runOnMOM 関数
MOM 上で実行される JavaScript 計算機を停止するには、false を返す runOnMOM 機能を実装します。例:
// return false if the script should not run on the MOM // default is true. function runOnMOM() { return false; }
重要:
runOnMOM 関数が true を返す場合、または runOnMOM 関数が実装されていない場合は、JavaScript 計算機は MOM 上で実行されます。
CA APM for IBM WebSphere Portal の無効化
CA APM for IBM WebSphere Portal を無効にするには、CA APM for IBM WebSphere Portal のインストール中にコピーしたファイルを削除します。また、IntroscopeAgent.profile ファイルとアプリケーションの起動スクリプトから、プロパティと環境変数の関連するエントリを削除します。
以下の手順に従います。
  1. エージェントの対応するディレクトリから以下のファイルを削除します。
    • <
      WAS_Home
      >\PortalServer\wily\core\ext から PowerPackforWebspherePortal_ext.jar を削除
  2. Enterprise Manager の対応するディレクトリから以下のファイルを削除します。
    • <
      EM_Home
      >\config\modules から PowerpackForWebSpherePortal_ManagementModule_typical.jar を削除
    • <
      EM_Home
      >\config\modules から PowerpackForWebSpherePortal_ManagementModule_full.jar を削除
    • <
      EM_Home
      >\product\enterprisemanager\plugins から com.wily.powerpack.websphereportal.em.ext.jar および com.wily.powerpack.websphereportal.em.service.jar を削除
    • <
      EM_Home
      >\ws-plugins ディレクトリと <
      Workstation_Home
      >\config\internal\console\ws-plugins ディレクトリから com.wily.powerpack.websphereportal.ws.ext.jar を削除
    • <
      WAS_Home
      >\PortalServer\wily\common から ChangeDetector-config-WebSpherePortal61.xml を削除
  3. <
    WAS_Home
    >\PortalServer\wily\core\config ディレクトリにある IntroscopeAgent.profile ファイルを開き、以下のプロパティおよび環境変数に関係するエントリを削除します。
    • introscope.autoprobe.directivesFile
    • introscope.changeDetector.profile (該当する場合)
    • introscope.changeDetector.profileDir (該当する場合)
    • WEBSPHERE_PORTAL_DIR (該当する場合)
    • WEBSPHERE_PROFILE_DIR (該当する場合)
  4. 該当する場合は、アプリケーション サーバの起動スクリプト(startServer.bat)から以下の環境変数を削除します。
    • WEBSPHERE_PORTAL_DIR
    • WEBSPHERE_PROFILE_DIR
    CA APM for IBM WebSphere Portal が無効になりました。