apm_9.5--apm for ibm websphere portal guide

Upload: ggenmailru

Post on 11-Oct-2015

46 views

Category:

Documents


0 download

TRANSCRIPT

  • for IBM WebSphere Portal Guide Release 9.5

    CA Application Performance Management

  • This Documentation, which includes embedded help systems and electronically distributed materials, (hereinafter referred to as the Documentation) is for your informational purposes only and is subject to change or withdrawal by CA at any time.

    This Documentation may not be copied, transferred, reproduced, disclosed, modified or duplicated, in whole or in part, without the prior written consent of CA. This Documentation is confidential and proprietary information of CA and may not be disclosed by you or used for any purpose other than as may be permitted in (i) a separate agreement between you and CA governing your use of the CA software to which the Documentation relates; or (ii) a separate confidentiality agreement between you and CA.

    Notwithstanding the foregoing, if you are a licensed user of the software product(s) addressed in the Documentation, you may print or otherwise make available a reasonable number of copies of the Documentation for internal use by you and your employees in connection with that software, provided that all CA copyright notices and legends are affixed to each reproduced copy.

    The right to print or otherwise make available copies of the Documentation is limited to the period during which the applicable license for such software remains in full force and effect. Should the license terminate for any reason, it is your responsibility to certify in writing to CA that all copies and partial copies of the Documentation have been returned to CA or destroyed.

    TO THE EXTENT PERMITTED BY APPLICABLE LAW, CA PROVIDES THIS DOCUMENTATION AS IS WITHOUT WARRANTY OF ANY KIND, INCLUDING WITHOUT LIMITATION, ANY IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NONINFRINGEMENT. IN NO EVENT WILL CA BE LIABLE TO YOU OR ANY THIRD PARTY FOR ANY LOSS OR DAMAGE, DIRECT OR INDIRECT, FROM THE USE OF THIS DOCUMENTATION, INCLUDING WITHOUT LIMITATION, LOST PROFITS, LOST INVESTMENT, BUSINESS INTERRUPTION, GOODWILL, OR LOST DATA, EVEN IF CA IS EXPRESSLY ADVISED IN ADVANCE OF THE POSSIBILITY OF SUCH LOSS OR DAMAGE.

    The use of any software product referenced in the Documentation is governed by the applicable license agreement and such license agreement is not modified in any way by the terms of this notice.

    The manufacturer of this Documentation is CA.

    Provided with Restricted Rights. Use, duplication or disclosure by the United States Government is subject to the restrictions set forth in FAR Sections 12.212, 52.227-14, and 52.227-19(c)(1) - (2) and DFARS Section 252.227-7014(b)(3), as applicable, or their successors.

    Copyright 2013 CA. All rights reserved. All trademarks, trade names, service marks, and logos referenced herein belong to their respective companies.

  • CA Technologies Product References

    This document references the following CA Technologies products and features:

    CA Application Performance Management (CA APM)

    CA Application Performance Management ChangeDetector (CA APM ChangeDetector)

    CA Application Performance Management ErrorDetector (CA APM ErrorDetector)

    CA Application Performance Management for CA Database Performance (CA APM for CA Database Performance)

    CA Application Performance Management for CA SiteMinder (CA APM for CA SiteMinder)

    CA Application Performance Management for CA SiteMinder Application Server Agents (CA APM for CA SiteMinder ASA)

    CA Application Performance Management for IBM CICS Transaction Gateway (CA APM for IBM CICS Transaction Gateway)

    CA Application Performance Management for IBM WebSphere Application Server (CA APM for IBM WebSphere Application Server)

    CA Application Performance Management for IBM WebSphere Distributed Environments (CA APM for IBM WebSphere Distributed Environments)

    CA Application Performance Management for IBM WebSphere MQ (CA APM for IBM WebSphere MQ)

    CA Application Performance Management for IBM WebSphere Portal (CA APM for IBM WebSphere Portal)

    CA Application Performance Management for IBM WebSphere Process Server (CA APM for IBM WebSphere Process Server)

    CA Application Performance Management for IBM z/OS (CA APM for IBM z/OS)

    CA Application Performance Management for Microsoft SharePoint (CA APM for Microsoft SharePoint)

    CA Application Performance Management for Oracle Databases (CA APM for Oracle Databases)

    CA Application Performance Management for Oracle Service Bus (CA APM for Oracle Service Bus)

    CA Application Performance Management for Oracle WebLogic Portal (CA APM for Oracle WebLogic Portal)

    CA Application Performance Management for Oracle WebLogic Server (CA APM for Oracle WebLogic Server)

    CA Application Performance Management for SOA (CA APM for SOA)

  • CA Application Performance Management for TIBCO BusinessWorks (CA APM for TIBCO BusinessWorks)

    CA Application Performance Management for TIBCO Enterprise Message Service (CA APM for TIBCO Enterprise Message Service)

    CA Application Performance Management for Web Servers (CA APM for Web Servers)

    CA Application Performance Management for webMethods Broker (CA APM for webMethods Broker)

    CA Application Performance Management for webMethods Integration Server (CA APM for webMethods Integration Server)

    CA Application Performance Management Integration for CA CMDB (CA APM Integration for CA CMDB)

    CA Application Performance Management Integration for CA NSM (CA APM Integration for CA NSM)

    CA Application Performance Management LeakHunter (CA APM LeakHunter)

    CA Application Performance Management Transaction Generator (CA APM TG)

    CA Cross-Enterprise Application Performance Management

    CA Customer Experience Manager (CA CEM)

    CA Embedded Entitlements Manager (CA EEM)

    CA eHealth Performance Manager (CA eHealth)

    CA Insight Database Performance Monitor for DB2 for z/OS

    CA Introscope

    CA SiteMinder

    CA Spectrum Infrastructure Manager (CA Spectrum)

    CA SYSVIEW Performance Management (CA SYSVIEW)

  • Contact CA Technologies

    Contact CA Support

    For your convenience, CA Technologies provides one site where you can access the information that you need for your Home Office, Small Business, and Enterprise CA Technologies products. At http://ca.com/support, you can access the following resources:

    Online and telephone contact information for technical assistance and customer services

    Information about user communities and forums

    Product and documentation downloads

    CA Support policies and guidelines

    Other helpful resources appropriate for your product

    Providing Feedback About Product Documentation

    If you have comments or questions about CA Technologies product documentation, you can send a message to [email protected].

    To provide feedback about CA Technologies product documentation, complete our short customer survey which is available on the CA Support website at http://ca.com/docs.

  • Contents 7

    Contents

    Chapter 1: Overview 9

    How the CA APM for IBM WebSphere Portal Works ................................................................................................... 9

    CA APM for IBM WebSphere Portal Components .............................................................................................. 10

    How CA APM for IBM WebSphere Portal Components Work With Each Other ................................................. 10

    Monitoring WebSphere Portal Functions................................................................................................................... 11

    Chapter 2: Installing and Configuring the CA APM for IBM WebSphere Portal 13

    Installation Requirements .......................................................................................................................................... 13

    Prerequisites ....................................................................................................................................................... 13

    How to Install and Configure CA APM for IBM WebSphere Portal ............................................................................ 14

    Install Enterprise Manager Components of the CA APM for IBM WebSphere Portal ........................................ 14

    Install Agent Components of the CA APM for IBM WebSphere Portal ............................................................... 16

    Configure the PBL File for Typical, Full, and Error PBDs ...................................................................................... 18

    Configure the Authentication Node .................................................................................................................... 21

    Optional: Integrating ChangeDetector with CA APM for IBM WebSphere Portal .............................................. 22

    Install and Configure CA APM for IBM WebSphere Portal for Clustered Environment ............................................. 24

    Running JavaScript Calculators on the MOM ...................................................................................................... 25

    Disable CA APM for IBM WebSphere Portal .............................................................................................................. 25

    Chapter 3: Using the CA APM for IBM WebSphere Portal 27

    WebSphere Portal Metrics ......................................................................................................................................... 27

    Viewing Dashboards ................................................................................................................................................... 27

    Dashboards for CA APM for IBM WebSphere Portal .......................................................................................... 29

    Viewing Metrics .......................................................................................................................................................... 30

    Viewing Worst Performing Components ................................................................................................................... 30

    Sample Operation Scenario ........................................................................................................................................ 35

    Customer Says: "We Have a Problem" ................................................................................................................ 35

    Appendix A: Metrics 37

    Access Control ............................................................................................................................................................ 37

    Authentication ........................................................................................................................................................... 37

    Caching ....................................................................................................................................................................... 37

    Engine ......................................................................................................................................................................... 37

    Legacy Portlet Container ............................................................................................................................................ 37

  • 8 for IBM WebSphere Portal Guide

    Portal .......................................................................................................................................................................... 38

    Portlet Services........................................................................................................................................................... 38

    Portlets ....................................................................................................................................................................... 38

    Standard Portlet Container ........................................................................................................................................ 38

    Virtual Portal .............................................................................................................................................................. 38

    WSRP .......................................................................................................................................................................... 39

    Appendix B: Frequently Asked Questions 41

    Frequently Asked Questions ...................................................................................................................................... 41

    Appendix C: IPv6 Support 43

    Index 45

  • Chapter 1: Overview 9

    Chapter 1: Overview

    The CA APM for IBM WebSphere Portal collects and analyzes metrics from the WebSphere Portal in real time. The CA APM for IBM WebSphere Portal is built on the CA Introscope enterprise monitoring platform and shares all its key benefits.

    This section contains the following topics:

    How the CA APM for IBM WebSphere Portal Works (see page 9) Monitoring WebSphere Portal Functions (see page 11)

    How the CA APM for IBM WebSphere Portal Works

    The following diagram shows how the CA APM for IBM WebSphere Portal components are deployed in a WebSphere Portal Server environment:

  • How the CA APM for IBM WebSphere Portal Works

    10 for IBM WebSphere Portal Guide

    CA APM for IBM WebSphere Portal Components

    The CA APM for IBM WebSphere Portal includes the following components:

    IntroscopeForms the foundation for the CA APM for IBM WebSphere Portal. It includes the Enterprise Manager, Introscope agent, Workstation, and WebView.

    For more information about Introscope and its components, see CA APM Installation and Configuration Guide.

    Agent Extension, PBL, and PBD filesCollect WebSphere Portal metric data and pass on the data to Introscope Enterprise Manager.

    Management Module, Enterprise Manager plug-ins, and Workstation plug-inAnalyze and aggregate the metric data and pass on the data to Workstation for display.

    Introscope Workstation and DashboardsDisplay overall health, performance, and availability of WebSphere Portal based on WebSphere Portal-specific metrics.

    How CA APM for IBM WebSphere Portal Components Work With Each Other

    The CA APM for IBM WebSphere Portal components work with each other as follows:

    The agent extension that resides in the WebSphere Portal and Application server collects metrics and passes them to the Enterprise Manager.

    The Enterprise Manager analyzes the metrics and aggregates them with the help of Enterprise Manager plug-ins.

    The Introscope Workstation displays these metrics and the worst performing components based on the metrics. The Workstation also displays the overall health, performance, and availability of the Portal Server.

  • Monitoring WebSphere Portal Functions

    Chapter 1: Overview 11

    Monitoring WebSphere Portal Functions

    The following diagram shows the WebSphere Portal workflow.

    The following table describes the workflow sequences, functions, and metric categories.

    Workflow Sequence

    WebSphere Portal Function Metric Categories

    1 Transaction Request sent None

    2 Authentication Login

    3 Access Control Load User, Load UserGroup, Load Entitlements, Load Roles

    4 Engine Build Models, Load Pages, Render Pages, Gateway Servlet

    5 Legacy Portlet Container Perform Actions

    6 Portlets Perform Action, Render

    7 Portlet Services Credential Vault, Content Access

    8 Standard Portlet Container (not illustrated in the diagram)

    Perform Actions

  • Monitoring WebSphere Portal Functions

    12 for IBM WebSphere Portal Guide

    9 Caching (not illustrated in the diagram)

    Hit Count, Invalidate Count, Miss Count

    10 Click to Action (C2A) (not illustrated in the diagram)

    C2A Actions, C2A Portlets, Perform Action, Render

    11 Web Services for Remote Portlets (WSRP) (not illustrated in the diagram)

    Consumer, Producer, GetMarkup, Perform Action

    The CA APM for IBM WebSphere Portal also monitors and reports metrics for the Portal, Virtual Portal, Page, and Portlets components of the WebSphere Portal. The Portlet function's corresponding lifecycle method is the Render and Perform action.

    For a complete list of the CA APM for IBM WebSphere Portal metrics, see Metrics (see page 37).

  • Chapter 2: Installing and Configuring the CA APM for IBM WebSphere Portal 13

    Chapter 2: Installing and Configuring the CA APM for IBM WebSphere Portal

    This chapter provides instructions for installing and configuring CA APM for IBM WebSphere Portal.

    This section contains the following topics:

    Installation Requirements (see page 13) How to Install and Configure CA APM for IBM WebSphere Portal (see page 14) Install and Configure CA APM for IBM WebSphere Portal for Clustered Environment (see page 24) Disable CA APM for IBM WebSphere Portal (see page 25)

    Installation Requirements

    For supported versions of IBM WebSphere Portal, see the APM Extensions section of the Compatibility Guide.

    Prerequisites

    Before you begin the installation procedure:

    Identify the following directory locations in your network:

    WebSphere computerthe installation directory for WebSphere is referred to as . This directory is the WebSphere location that you specified during installation.

    Enterprise Manager computerthe home directory for the Enterprise Manager is referred to as .

    Workstation computerthe home directory for the Workstation is referred to as .

    Verify that the Java version is a minimum of 1.5.

  • How to Install and Configure CA APM for IBM WebSphere Portal

    14 for IBM WebSphere Portal Guide

    How to Install and Configure CA APM for IBM WebSphere Portal

    Installing and configuring CA APM for IBM WebSphere Portal involves the following high-level steps:

    1. Install the Enterprise Manager components of the CA APM for IBM WebSphere Portal (see page 14).

    2. Install the Agent components of the CA APM for IBM WebSphere Portal (see page 16).

    3. Configure the agent in typical or full mode using the PBL file, and errors PBDs (see page 18).

    4. (Optional) Integrate ChangeDetector with CA APM for IBM WebSphere Portal (see page 22) to monitor changes to Portal components and configuration files.

    5. Configure the Authentication node (see page 21) for the type of authentication you want to use.

    6. (For WebSphere Application Server 6.1 using an IBM JVM 1.5 only) Use the alternate versions of the Java Agent .jar file and Java Agent profile. These files, AgentNoRedef.jar and IntroscopeAgent.NoRedef.profile, are located in the /wily directory.

    Install Enterprise Manager Components of the CA APM for IBM WebSphere Portal

    If you are using the same Enterprise Manager for different agents, the CA APM for IBM WebSphere Portal are already installed in the \examples folder. You do not have to run the Enterprise Manager installer again to install Enterprise Manager components of the CA APM for IBM WebSphere Portal.

    Follow these steps:

    Important! If you are using the same Enterprise Manager for different agents, skip Step 1 and perform the tasks from Step 2 onward.

    1. Run the Enterprise Manager installer to install the Enterprise Manager components of the CA APM for IBM WebSphere Portal onto the Enterprise Manager.

    The Enterprise Manager installer places the files into this directory:

    \examples\ PowerPackforWebspherePortal

    Note: For details, see the CA APM Installation and Upgrade Guide.

  • How to Install and Configure CA APM for IBM WebSphere Portal

    Chapter 2: Installing and Configuring the CA APM for IBM WebSphere Portal 15

    2. Verify that the \examples\ PowerPackforWebspherePortal directory has the following files:

    Note: The following list uses the Microsoft Windows directory syntax. For other installation platforms, such as UNIX, replace "\" with "/".

    File:

    \examples\ PowerPackforWebspherePortal

    \product\enterprisemanager\plugins\com.wily.powerpack.websphereportal.em.

    ext.jar

    Description:

    Plug-in for Enterprise Manager extension.

    File:

    \examples\

    PowerPackforWebspherePortal\product\enterprisemanager\plugins\com.wily.po

    werpack.websphereportal.em.service.jar

    Description:

    Plug-in for Enterprise Manager service.

    File:

    \examples\

    PowerPackforWebspherePortal\ws-plugins\com.wily.powerpack.websphereportal

    .ws.ext.jar

    Description:

    Plug-in for Workstation extension.

    File:

    \examples\

    PowerPackforWebspherePortal\config\modules\PowerpackForWebspherePortal_Ma

    nagementModule_typical.jar

    Description:

    Management Module JAR for typical configuration for displaying performance metrics in dashboards.

    File:

    \examples\

    PowerPackforWebspherePortal\config\modules\portal\PowerpackForWebspherePo

    rtal_ManagementModule_full.jar

    Description:

    Management Module JAR for full configuration for displaying performance metrics in dashboards.

  • How to Install and Configure CA APM for IBM WebSphere Portal

    16 for IBM WebSphere Portal Guide

    3. Copy all the files to the correct location, based on how the files are organized in the \examples directory.

    For example, copy the plug-in for Enterprise Manager extension:

    com.wily.powerpack.websphereportal.em.ext.jar

    from:

    \examples\PowerPackforWebspherePortal

    \product\enterprisemanager\plugins\

    to:

    \product\enterprisemanager\plugins\

    Install Agent Components of the CA APM for IBM WebSphere Portal

    Follow these steps:

    1. Download IntroscopeAgentFiles-Legacy-NoInstaller9.5.0.0websphere.windows.zip file

    2. Extract the .zip file to \PortalServer as the installation directory.

    The result will be a folder new folder named wily.

    3. Verify that the \PortalServer\wily directory has the following files:

    Note: The following table uses the Microsoft Windows directory syntax. For other installation platforms, such as UNIX, replace "\" with "/".

    File:

    \PortalServer\wily\core\config\powerpackforwebsph

    ereportal-legacy.pbl

    Description:

    ProbeBuilder List containing all the PBDs listed in it.

    File:

    \PortalServer\wily\core\config\powerpackforwebsph

    ereportal-legacy.pbd

    Description:

    PBD containing definitions for all the classes and methods for the tracers for WebSphere Portal.

    File:

    \PortalServer\wily\core\config\powerpackforwebsph

    ereportal_typical.pbd

    Description:

    PBD containing only critical tracers enabled to monitor the performance of critical components of the portal server.

  • How to Install and Configure CA APM for IBM WebSphere Portal

    Chapter 2: Installing and Configuring the CA APM for IBM WebSphere Portal 17

    File:

    \PortalServer\wily\core\config\powerpackforwebsph

    ereportal_full.pbd

    Description:

    PBD containing all the tracers enabled to monitor the performance of all the components of the portal server.

    File:

    \PortalServer\wily\core\config\powerpackforwebsph

    ereportal_errors-legacy.pbd

    Description:

    PBD containing the tracers for reporting Errors Per Interval metric.

    File:

    \PortalServer\wily\common\ChangeDetector-config-W

    ebSpherePortal61.xml

    Description:

    ChangeDetector configuration file for WebSphere Portal Server.

    4. Edit \PortalServer\wily\core\config\IntroscopeAgent.profile:

    a. Locate the property introscope.autoprobe.directivesFile.

    b. Add the following PBL file to this property:

    introscope.autoprobe.directivesFile=websphere-typical-NoRed

    ef-legacy.pbl,hotdeploy,powerpackforwebsphereportal-legacy.

    pbl

    5. Copy the PowerPackforWebspherePortal_ext.jar file from the \PortalServer\wily\examples\\ext directory to the \PortalServer\wily\core\ext directory.

    You have now configured the agent components for CA APM for IBM WebSphere Portal.

  • How to Install and Configure CA APM for IBM WebSphere Portal

    18 for IBM WebSphere Portal Guide

    Configure the PBL File for Typical, Full, and Error PBDs

    You can configure the CA APM for IBM WebSphere Portal for either typical or full configuration. For a typical configuration, you enable powerpackforwebsphereportal_typical.pbd. This PBD enables only critical tracers to monitor the performance of critical components of the portal server. For a full configuration, you enable powerpackforwebsphereportal_full.pbd. This PBD has all the tracers enabled to monitor the performance of all the components of the portal server.

    By default, the PBL file for the CA APM for IBM WebSphere Portal has typical configuration (powerpackforwebsphereportal_typical.pbd) enabled and full configuration (powerpackforwebsphereportal_full.pbd) disabled.

    When you use powerpackforwebsphereportal_typical.pbd, you see the following nodes in the Investigator tree:

    Access Control, Authentication, Engine, Legacy Portlet Container, Portal, Portlets, Standard Portlet Container, Virtual Portal, and WSRP nodes are available under the WebSphere Portal node.

    All the nodes report only Average Response Time and Responses Per Interval metrics. Concurrent Invocations, Errors Per Interval, and Stall Count are not available for typical configuration.

    Note: If any stalls are reported, they appear under the respective nodes. To display Errors Per Interval, enable powerpackforwebsphereportal_errors-legacy.pbd in the powerpackforwebsphereportal-legacy.pbl file.

    When you use powerpackforwebsphereportal_full.pbd, you see the following nodes in the Investigator tree under the WebSphere Portal node:

    Access Control

    Authentication

    Caching

    Engine

    Legacy Portlet Container

    Portal, Portlet Services

    Portlets

    Standard Portlet Container

    Virtual Portal

    WSRP

  • How to Install and Configure CA APM for IBM WebSphere Portal

    Chapter 2: Installing and Configuring the CA APM for IBM WebSphere Portal 19

    All nodes report all the following five metrics:

    Average Response Time

    Responses Per Interval

    Concurrent Invocations

    Errors Per Interval

    Stall Count

    Important! Portal, Virtual Portal, and WSRP nodes, display only Average Response Time and Responses Per Interval for full configuration.

    Note: To display Errors Per Interval, enable powerpackforwebsphereportal_errors-legacy.pbd in the powerpackforwebsphereportal-legacy.pbl file.

    The typical configuration lets you view all five metrics for critical components or metrics. You can also view components other than the critical components that are being traced.

    To view all five metrics in a typical configuration

    1. Modify the entries in the powerpackforwebsphereportal_typical.pbd file for blame point metrics from false to true as follows.

    SetTracerParameter:CustomBlamePointTracer forcestandardblamemetrics true

    SetTracerParameter:PortletNameAwareBlamePointTracer forcestandardblamemetrics

    true

    SetTracerParameter:WSRPPortletRenderActionTracer forcestandardblamemetrics

    true

    2. Restart the Portal Server.

    The changes take effect.

    To trace more WebSphere Portal components in a typical configuration

    1. Enable the relevant tracer in powerpackforwebsphereportal_typical.pbd by uncommenting the tracer.

    2. Restart the Portal Server.

    The changes take effect.

  • How to Install and Configure CA APM for IBM WebSphere Portal

    20 for IBM WebSphere Portal Guide

    To enable the full configuration in PBL

    1. Comment out or disable powerpackforwebsphereportal_typical.pbd entry and uncomment or enable powerpackforwebsphereportal_full.pbd entry in powerpackforwebsphereportal-legacy.pbl.

    2. Restart the Portal Server.

    The changes take effect.

    Important! When you enable the full configuration, copy PowerpackForWebspherePortal_ManagementModule_full.jar to the \config\modules directory to view the dashboards for full configuration. When you enable the typical configuration, copy PowerpackForWebspherePortal_ManagementModule_typical.jar to the \config\modules directory.

    By enabling the full configuration, you can further triage, diagnose and detect the component responsible, and rectify the error.

    Important! Do not enable powerpackforwebsphereportal_typical.pbd and powerpackforwebsphereportal_full.pbd at the same time. A conflict can exist in displaying the aggregated metrics at the parent level node in the Investigator tree and Introscope Enterprise Manager can throw exceptions.

    You can also enable powerpackforwebsphereportal_errors-legacy.pbd in the powerpackforwebsphereportal-legacy.pbl file to report Errors Per Interval metric in the Investigator.

    To view errors that the lifecycle methods in the Investigator tree report

    1. Uncomment or enable the powerpackforwebsphereportal_errors-legacy.pbd entry in the powerpackforwebsphereportal-legacy.pbl file.

    2. Restart the Portal Server.

    The change takes effect.

    The file powerpackforwebsphereportal_errors-legacy.pbd reports how many errors the Introscope Agent records by catching a Java exception in a 15-second time slice. The errors are recorded for the methods of the classes that are being traced in the PBD.

  • How to Install and Configure CA APM for IBM WebSphere Portal

    Chapter 2: Installing and Configuring the CA APM for IBM WebSphere Portal 21

    If you enable the powerpackforwebsphereportal_errors-legacy.pbd file, the errors are reported for both, typical and full configuration. If you enable the powerpackforwebsphereportal_errors-legacy.pbd file, errors are not reported for typical configuration. However, for full configuration, the node for Errors Per Interval is present in the investigator tree but does not report any values.

    When you enable the powerpackforwebsphereportal_errors-legacy.pbd file in the full configuration, you get metrics for Errors Per Interval with the other metrics available. These metrics give you the details to triage the problem in a better way. Therefore, CA Technologies recommends that you use the powerpackforwebsphereportal_errors-legacy.pbd file in the full configuration.

    You have now configured the PBL for typical, full, and errors PBDs.

    Configure the Authentication Node

    You can configure the Authentication node for use with the type of authentication you want to use.

    Follow these steps:

    1. Open the powerpackforwebsphereportal-legacy.pbd file in the \wily folder.

    2. Select one of the following options. Base your choice on the WebSphere Portal version and the login type your organization uses:

    Enable this section for WAS Portal 7 and previous versions when Custom Login Command is used for authentication.

    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.

    IdentifyClassAs: com.ibm.wps.auth.impl.DefaultLoginFilter

    WASPAuthenticationTracing

    TraceOneMethodIfFlagged: WASPAuthenticationTracing

    doLoginWithExceptions CustomBlamePointTracer "WebSphere

    Portal|Authentication|Login"

  • How to Install and Configure CA APM for IBM WebSphere Portal

    22 for IBM WebSphere Portal Guide

    Enable this section for WAS Portal 7 and later versions when Servlet Filters are used for authentication.

    IdentifyClassAs: com.ibm.wps.auth.impl.LoginDefaultFilter

    WASPAuthenticationTracing

    TraceOneMethodIfFlagged: WASPAuthenticationTracing

    internalLogin CustomBlamePointTracer "WebSphere

    Portal|Authentication|Login"

    3. Save and close the file.

    Optional: Integrating ChangeDetector with CA APM for IBM WebSphere Portal

    You can monitor changes to WebSphere Portal pages, portlets, and the portal configuration files by using Introscope ChangeDetector.

    Follow these steps:

    1. Verify that ChangeDetector-config-WebSpherePortal61.xml is present in the \PortalServer\wily\common directory.

    2. In the IntroscopeAgent.profile file located in the \PortalServer\wily\core\config directory, set the following property to true. It is set to false by default.

    introscope.Changedetector.enable=true

    3. In the IntroscopeAgent.profile file, set the following properties to point to the location of the ChangeDetector-config-WebSpherePortal61.xml file:

    introscope.changeDetector.profile=\PortalServer\wily\common\ChangeDetector-config-WebSpherePortal61.xml.

    introscope.changeDetector.profileDir=\PortalServer\wily

    For example,

    introscope.changeDetector.profile=C:\\WAS_Home\\PortalServer\\wily\\common\\C

    hangeDetector-config-WebSpherePortal61.xml

    introscope.changeDetector.profileDir=C:\\WAS_Home\\PortalServer\\wily

    For UNIX environment,

    introscope.changeDetector.profile=/ChangeDetector-config-WebSphereportal.xml

    introscope.changeDetector.profileDir=/PortalServer/wily

    4. Save IntroscopeAgent.profile.

  • How to Install and Configure CA APM for IBM WebSphere Portal

    Chapter 2: Installing and Configuring the CA APM for IBM WebSphere Portal 23

    5. Add the environment variable WEBSPHERE_PORTAL_DIR so the ChangeDetector knows the location of the WebSphere Portal root directory. You can add the environment variable to the IntroscopeAgent.profile file or the application server startup script. Perform one of the following steps:

    In the IntroscopeAgent.profile file located in the \PortalServer\wily\core\config directory, add the following environment variable WEBSPHERE_PORTAL_DIR to point to the location of the WebSphere Portal root directory:

    WEBSPHERE_PORTAL_DIR=

    For example,

    WEBSPHERE_PORTAL_DIR=C:\\\\PortalServer

    Add the variable, WEBSPHERE_PORTAL_DIR to your application startup file, point it to the WebSphere Portal root directory, save the startup script, and restart the Portal Server:

    -DWEBSPHERE_PORTAL_DIR=

    For example,

    -DWEBSPHERE_PORTAL_DIR=C:\\PortalServer

    Note: The application startup script is named as startServer.bat and is located in the \\bin\ directory. For example, the application startup script could be located in the \\bin\ directory.

    6. Add the environment variable, WEBSPHERE_PROFILE_DIR so the ChangeDetector knows the location of the WebSphere Application Server profile directory. You can add the environment variable to the IntroscopeAgent.profile file or the application server startup script. Perform one of the following steps:

    In the IntroscopeAgent.profile file, add the following environment variable WEBSPHERE_PROFILE_DIR to point to the location of the WebSphere Portal root directory.

    WEBSPHERE_PROFILE_DIR=

    For example,

    WEBSPHERE_PROFILE_DIR=C:\\\\wp_profile

  • Install and Configure CA APM for IBM WebSphere Portal for Clustered Environment

    24 for IBM WebSphere Portal Guide

    Add the variable, WEBSPHERE_PROFILE_DIR to your application startup file, save and restart the Portal Server:

    -DWEBSPHERE_PROFILE_DIR=

    For example,

    -DWEBSPHERE_PROFILE_DIR=C:\\wp_profile

    Note: The application startup script is named as startServer.bat and is located in the \\bin\ directory. For example, the application startup script could be located in the \\bin\ directory.

    For further information about ChangeDetector, see CA APM ChangeDetector User Guide.

    You have now integrated ChangeDetector with CA APM for IBM WebSphere Portal.

    Install and Configure CA APM for IBM WebSphere Portal for Clustered Environment

    Clustered environment or clustering allows an Enterprise Manager to manage other Enterprise Managers, serving as a Manager of Managers (MOM). The managed Enterprise Managers are named Collectors. In a clustered environment, install and configure the CA APM for IBM WebSphere Portal on each Collector.

    Follow these steps:

    1. Install Enterprise Manager components of the CA APM for IBM WebSphere Portal.

    2. Install the agent components of the CA APM for IBM WebSphere Portal.

    Note: Place all Enterprise Manager extensions and calculators for the CA APM for IBM WebSphere Portal on the Collectors primarily. Use the properties in the IntroscopeAgent.profile file to connect the agents configured in the clustered environment to the MOM.

    3. Configure the agent in either typical or full mode using the PBL file.

    4. (Optional) Integrate ChangeDetector with CA APM for IBM WebSphere Portal to monitor changes to Portal components and configuration files.

  • Disable CA APM for IBM WebSphere Portal

    Chapter 2: Installing and Configuring the CA APM for IBM WebSphere Portal 25

    Running JavaScript Calculators on the MOM

    You can run a JavaScript calculator on the MOM to produce metrics for the MOM agent. Although the MOM cannot produce metrics for agents that are connected to a Collector, it can see input metrics from agents in the Collectors.

    Unless you turn off the automatic update for Collectors, the MOM updates all Collectors when a calculator is changed. For more information, see the CA APM Workstation User Guide.

    The runOnMOM function

    To stop JavaScript calculators running on the MOM, implement a runOnMOM function that returns false. For example:

    // return false if the script should not run on the MOM

    // default is true.

    function runOnMOM()

    {

    return false;

    }

    Important! If the runOnMOM function returns true or the function is not implemented, the JavaScript calculator runs on the MOM.

    Disable CA APM for IBM WebSphere Portal

    To disable CA APM for IBM WebSphere Portal, you delete the files that you copied while installing CA APM for IBM WebSphere Portal. You also delete the relevant entries for properties and environment variables from the IntroscopeAgent.profile file and application startup script.

    Follow these steps:

    1. Delete the following file from the relevant directories on the agent:

    PowerPackforWebspherePortal_ext.jar from \PortalServer\wily\core\ext.

  • Disable CA APM for IBM WebSphere Portal

    26 for IBM WebSphere Portal Guide

    2. Delete the following files from the relevant directories on Enterprise Manager:

    PowerpackForWebSpherePortal_ManagementModule_typical.jar from \config\modules.

    PowerpackForWebSpherePortal_ManagementModule_full.jar from \config\modules\portal.

    com.wily.powerpack.websphereportal.em.ext.jar and com.wily.powerpack.websphereportal.em.service.jar from \product\enterprisemanager\plugins.

    com.wily.powerpack.websphereportal.ws.ext.jar from \ws-plugins and \config\internal\console\ws-plugins directories.

    ChangeDetector-config-WebSpherePortal61.xml from \PortalServer\wily\common.

    3. Open the IntroscopeAgent.profile file located in the \PortalServer\wily\core\config directory and delete the relevant entries for the following properties and environment variables:

    introscope.autoprobe.directivesFile

    introscope.changeDetector.profile (if applicable)

    introscope.changeDetector.profileDir (if applicable)

    WEBSPHERE_PORTAL_DIR (if applicable)

    WEBSPHERE_PROFILE_DIR (if applicable)

    4. Delete the following environment variables from the application server startup script, startServer.bat, if applicable:

    WEBSPHERE_PORTAL_DIR

    WEBSPHERE_PROFILE_DIR

    You have now disabled the CA APM for IBM WebSphere Portal.

  • Chapter 3: Using the CA APM for IBM WebSphere Portal 27

    Chapter 3: Using the CA APM for IBM WebSphere Portal

    The CA APM for IBM WebSphere Portal lets you monitor the WebSphere Portal components and view its health and availability metrics in Introscope. You can view real time metric data in the Investigator and Console to monitor the health, availability, and performance of WebSphere Portal.

    This section contains the following topics:

    WebSphere Portal Metrics (see page 27) Viewing Dashboards (see page 27) Viewing Metrics (see page 30) Viewing Worst Performing Components (see page 30) Sample Operation Scenario (see page 35)

    WebSphere Portal Metrics

    Introscope displays the following metrics for each operation in WebSphere Portal:

    Average Response Time (ms): average time for executing or invoking a specific operation or action.

    Concurrent Invocations: how many requests are going through at a given time (throughput).

    Errors Per Interval: errors from the Introscope Agent by catching a Java exception in a 15-second time slice.

    Responses Per Interval: the number of invocations that completed during a 15-second time slice.

    Stall Count: how many operations, invocations, or calls are taking longer than 30 seconds in a 15-second time slice.

    Viewing Dashboards

    CA APM for IBM WebSphere Portal dashboards provide:

    Overall application health and status views of the application.

    At-a-glance notification of problems in the production application environment.

    Pre defined navigation between high-level and drill-down performance information.

  • Viewing Dashboards

    28 for IBM WebSphere Portal Guide

    The Management Module PowerpackForWebspherePortal_ManagementModule_full.jar and PowerpackForWebspherePortal_ManagementModule_typical.jar files provide pre defined dashboards for CA APM for IBM WebSphere Portal.

    Important! Do not have PowerpackForWebspherePortal_ManagementModule_full.jar and PowerpackForWebspherePortal_ManagementModule_typical.jar in the \config\modules directory at the same time.

    Dashboards are associated with alerts that show the overall health of the application. Each alert color has a metric value:

    Gray indicates that no data is available.

    Green indicates OK.

    Yellow indicates Caution.

    Red indicates Danger.

    To view dashboards in the Console:

    By default, the PowerpackForWebspherePortal_ManagementModule_typical.jar is in the \config\modules directory and PowerpackForWebspherePortal_ManagementModule_full.jar is in the \config\modules\portal directory.

    1. When you enable the full configuration, copy PowerpackForWebspherePortal_ManagementModule_full.jar to the \config\modules directory. When you enable the typical configuration, copy PowerpackForWebspherePortal_ManagementModule_typical.jar to the \config\modules directory.

    2. Verify that your applications are instrumented and providing data.

    3. Verify that the Enterprise Manager is running.

    4. Launch the Workstation by clicking Start > Programs > CA APM > Introscope > Introscope Workstation.

    5. Log in to the Workstation.

    6. Navigate to the Introscope Workstation Console by clicking Workstation > New Console.

  • Viewing Dashboards

    Chapter 3: Using the CA APM for IBM WebSphere Portal 29

    Dashboards for CA APM for IBM WebSphere Portal

    CA APM for IBM WebSphere Portal (typical/full)Overview

    When monitoring WebSphere Portal, first view the Overview dashboard. The dashboard shows the overall portal performance and WebSphere Portal component performance. Each component is associated with an alert to show its overall health.

    CA APM for IBM WebSphere Portal (typical/full)Authentication & Authorization

    The dashboard shows the overall health of Authentication, Authorization, and Access Control.

    CA APM for IBM WebSphere Portal (typical/full)Engine

    The dashboard shows the overall health of the Engine for Building Models, Loading Pages, and Rendering metric category.

    CA APM for IBM WebSphere Portal (typical/full)Portlet Container

    The dashboard shows the overall health of the Portlet Container.

    CA APM for IBM WebSphere Portal (full)Portlet Services

    The dashboard shows the overall health of Portlet Services for Content Access Service and Credential Vault Service for metric categories.

    CA APM for IBM WebSphere Portal (typical/full)Remote Portlet Consumer

    The dashboard shows the overall health of the Remote Portlet Consumer for Perform Action and Get Markup metric categories.

    CA APM for IBM WebSphere Portal (typical/full)Remote Portlet Producer

    The dashboard shows the overall health of the Remote Portlet Producer for Perform Action and Get Markup metric categories.

    CA APM for IBM WebSphere Portal (typical/full)Top 10 Pages

    The dashboard shows

    Graph for top 10 slowest Portal Pages that are sorted by highest response time.

    Graph for top 10 most visited Portal Pages that are sorted by highest current Responses Per Interval.

    CA APM for IBM WebSphere Portal (typical/full)WSRP

    The dashboard shows the overall health of Web services for Remote Portlets (WSRP) for the producer and consumer.

  • Viewing Metrics

    30 for IBM WebSphere Portal Guide

    To view more information using dashboards:

    Double-click an alert to open the dashboard associated.

    Right-click a graph or an alert, click Links, and navigate to the corresponding alert in the Management Module.

    Double-click a metric from the chart displaying top 10 slowest metric data to view its details in the Investigator.

    Thus you can use dashboards to triage the problem-causing components, services, or functions for WebSphere Portal.

    Viewing Metrics

    To view metrics in the Investigator:

    1. Ensure that your applications are instrumented and providing data.

    2. Ensure that the Enterprise Manager is running.

    3. Launch the Workstation by clicking Start > Programs > CA APM > Introscope > Introscope Workstation.

    4. Log in to the Workstation.

    Introscope Workstation appears.

    5. Navigate to Introscope Investigator by clicking Workstation > New Investigator.

    6. Metrics that are specific to WebSphere Portal appear under this node:

    *SuperDomain* > > WebSphere > WebSphere Agent > WebSphere Portal

    7. Expand the WebSphere Portal node.

    WebSphere Portal metric data appears under these sub nodes.

    Note: The nodes that are listed, are for full configuration. You can see a subset of the nodes in typical configuration.

    8. Expand the sub nodes to view the individual portal components, services, functions and metrics.

    The metrics displayed in the Investigator depend on the Portal resources your application uses.

    Viewing Worst Performing Components

    You can view the worst performing component of the portal server in the Investigator.

  • Viewing Worst Performing Components

    Chapter 3: Using the CA APM for IBM WebSphere Portal 31

    Follow these steps:

    1. In the Investigator, click the WebSphere Portal node or a subnode.

    In the Viewer pane, the Portal tab is active by default. Depending on the node you selected, a list of components is displayed in a table. The following table gives details of the components that are displayed at each node.

    Node:

    WebSphere Portal

    Components displayed in table:

    Pages and Portlets.

    Node:

    WebSphere Portal > Portal

    Components displayed in table:

    All pages in the portal.

    Node:

    WebSphere Portal > Portal > Pages

    Components displayed in table:

    All pages in the portal.

    Node:

    WebSphere Portal > Portal > Pages > > Portlets

    Components displayed in table:

    All portlets for the selected page name in the portal.

    Node:

    WebSphere Portal > Portlets

    Components displayed in table:

    All portlets in the Portal Server.

    Node:

    WebSphere Portal > Virtual Portal >

    Components displayed in table:

    All pages in the virtual portal.

    Node:

    WebSphere Portal >Virtual Portal > > Pages

    Components displayed in table:

    All pages in the virtual portal.

  • Viewing Worst Performing Components

    32 for IBM WebSphere Portal Guide

    Node:

    WebSphere Portal >Virtual Portal > > Pages >

    > Portlets

    Components displayed in table:

    All portlets for the selected page name in the virtual portal.

    2. If you selected WebSphere Portal node, you can select All, Pages, or Portlets from the Component Type drop-down list. You can also select a number from the Top N drop-down list.

    Note: Here N is 10, 100, or 500. You can also enter a number other than 10,100, or 500 for Top N.

    Important! If you select a number greater than 25 for Top N, workstation performance can be impacted.

    Select a component type and number N to view top N worst performing components of the same type. For example, select Pages and number N to view top N worst performing pages.

    Important! The Component Type drop-down list and Top N drop-down list are available only if you select the WebSphere Portal node. If you select any node other than WebSphere Portal node, the drop-down lists are not available.

    3. Perform one of the following tasks:

    Select a page and click Detail.

    The Viewer pane displays the following tables:

    The table at the top of the Viewer pane displays the portlets for the selected page.

    This table displays only the top ten worst performing portlets. The table also displays the aggregated Average Response Time and aggregated Responses Per Interval for the portlets.

    The table at the bottom of the Viewer pane displays the portal or virtual portals that the selected page belongs to.

    This table displays only the top ten worst performing portals. The table also displays the Average Response Time and Responses Per Interval that are Average Response Time and the Responses Per Interval of the selected component relative to the portal.

    If you select a portlet and click Detail, only a single table is displayed for the parent components of the selected portlets. This table displays only the top ten worst performing pages. The table also displays the aggregated Average Response Time and aggregated Responses Per Interval for the pages.

  • Viewing Worst Performing Components

    Chapter 3: Using the CA APM for IBM WebSphere Portal 33

    The following list summarizes the details that you can view for each component:

    Component:

    Page

    Details:

    Table at the top displays a list of Portlets under the selected Page.

    Table at the bottom displays a list of Portals that contain the selected Page.

    Component:

    Portlet

    Details:

    Table at the top displays a list of Pages that contain the selected Portlet.

    Table at the bottom is not displayed.

    Click Generate Graph.

    The graphical view has the following details:

    Root Name (WebSphere Portal)

    Portal, Page, and Portlet name in the node

    The date and timestamp when the graph is generated.

    The number of components being displayed in the graph.

    A maximum of top 20 worst performing components from the tabular view are used to construct the graph.

    At each level of the graph, the number of viewable nodes is restricted to 20.

    Note: See the FAQ section to understand how the individual components in the graph view are selected.

    Nodes in the graph have values for Average Response Time and Responses Per Interval. These values are from the tabular view from which the graph was generated.

    Edges in the graph have values for Average Response Time and Responses Per Interval. These values indicate the child component performance, relative to its parent component. For example, the Average Response Time and Responses Per Interval for an edge between portlet1 and page1, indicates the Average Response Time and Responses Per Interval of the portlet1 in page1.

    Each node type is identified with a unique icon for the component.

  • Viewing Worst Performing Components

    34 for IBM WebSphere Portal Guide

    The components from the tabular view for generating the graph view are highlighted with blue colored background.

    The following figure shows a graphical view that is based on a tabular view for worst performing components. In this image, the icons for Root node, Portals, Pages, and Portlets are circled:

    You can perform the following actions for the graph:

    Pan

    Marquee Zoom

    Interactive Zoom

    Fit to Canvas

    To save the graph in GIF, JPEG, PNG, or PDF format:

    a. Select the checkbox at the bottom right corner of the graphical view to see an overview of the entire graph. You can use this overview to pan or zoom the contents of the graph. If you deselect the checkbox, the overview is not displayed.

    b. Click Back to go back to the tabular view that lists the worst performing components.

    Important! The tabular view displayed is a refreshed view. Save the graph before you click Back again.

  • Sample Operation Scenario

    Chapter 3: Using the CA APM for IBM WebSphere Portal 35

    Sample Operation Scenario

    This section describes a typical production setting situation in which the CA APM for IBM WebSphere Portal helps resolve the problem.

    Customer Says: "We Have a Problem"

    The operator on duty receives a problem escalation indicating that there could be a performance or availability problem with one of the monitored systems. The operator does not know which of a dozen systems are the root cause or how to fix it. The operator wants to know who to call to fix the problem.

    Data Center Operator: Responding to Red Light

    The data center operator notices a red light on the CA APM for IBM WebSphere Portal (typical) - Overview dashboard, indicating a problem with the Portal. Specifically, the operator sees that the Gateway Servlet alert is red.

    The operator responds to the problem escalation by performing the following tasks:

    1. The operator double-clicks the alert in the dashboard and switches to the CA APM for IBM WebSphere Portal (typical) - Top 10 Pages dashboard.

    The dashboard displays information about top 10 slowest Portal pages, which are sorted by the highest response times. The dashboard also displays the top 10 most visited pages, which are sorted by highest current Responses Per Interval. The operator notices that the Average Response Time for one page is higher than any other page.

    2. The operator double-clicks the page with the highest Average Response Time and views it details in the Investigator.

    3. The operator alerts the application support specialist about the dashboard.

    Application Support Specialist: Viewing Worst Performing Components for WebSphere Portal

    Often the application support specialist receives reports of performance problems. The operator wants to narrow down the problem further to escalate the issue to the proper team.

    The Application support specialist performs the following tasks:

    1. The operator views the worst performing components in the Investigator from the WebSphere Portal node to use the table to narrow down the problem.

    The operator observers that for a portlet the Average Response Time is high.

  • Sample Operation Scenario

    36 for IBM WebSphere Portal Guide

    2. The operator clicks Generate Graph to generate a graphical view to see if this portlet is affecting the other components of the portal.

    The operator notices that this portlet is causing one portal and three virtual portals to slow down, even though none of them would stand out otherwise.

    1. The operator then escalates this problem to the relevant Portal development team with information about the portals and pages that were involved in the problem.

    Portal Developers: Resolving the Problem Using Metrics for In-Depth Diagnosis

    After the Portal developers receive the problem report, they use Introscope Investigator to drill down to the metrics for the problem page. Their intimate knowledge of the code, with the Introscope metrics, let them pinpoint the root cause. They fix the code and resolve the problem.

    The team used Investigator dashboards, tabular and graphical view for worst performing components, and metrics to detect, triage, diagnose, and resolve the problem.

  • Chapter 3: Using the CA APM for IBM WebSphere Portal 37

    Appendix A: Metrics

    This appendix lists the metrics for CA APM for IBM WebSphere Portal.

    All CA APM for IBM WebSphere Portal metrics appear in the Introscope Investigator under the WebSphere Portal node. Metrics appear in the following format, where the vertical bars "|" separate alternative, mutually exclusive elements:

    WebSphere Portal|modulename|metricname.

    Note: The metrics seen in your Introscope Workstation depend on your environment.

    Access Control WebSphere Portal|Access Control|Load Entitlements

    WebSphere Portal|Access Control|Load Roles

    WebSphere Portal|Access Control|Load User

    WebSphere Portal|Access Control|Load UserGroup

    Authentication WebSphere Portal|Authentication|Login

    Caching WebSphere Portal|Caching|

    Engine WebSphere Portal|Engine|Build Models|Compose Models

    WebSphere Portal|Engine|Build Models|Get Children

    WebSphere Portal|Engine|Build Models|Get Parent

    WebSphere Portal|Engine|Build Models|Get Root

    WebSphere Portal|Engine|GateWay Servlet

    WebSphere Portal|Engine|Load Pages

    WebSphere Portal|Engine|Render Pages

    Legacy Portlet Container WebSphere Portal|Legacy Portlet Container|Perform Actions

  • Portal

    38 for IBM WebSphere Portal Guide

    Portal WebSphere Portal|Portal|Pages|{page_name}

    WebSphere Portal|Portal|Pages|{page_name}|C2A Actions

    WebSphere Portal|Portal|Pages|{page_name}|C2A Actions|{C2A Target Portlet Name}

    WebSphere Portal|Portal|Pages|{page_name}|Portlets|{Portlet Name}

    WebSphere Portal|Portal|Pages|{page_name}|Portlets|{PortletName}|C2A Portlets|{C2A

    Target Portlet Name}

    WebSphere Portal|Portal|Pages|{page_name}|Portlets|{PortletName}|{method}

    Portlet Services WebSphere Portal|Portlet Services|Content Access|Get Input Stream

    WebSphere Portal|Portlet Services|Content Access|Get Input Stream|URL=URL

    WebSphere Portal|Portlet Services|Content Access|Get Markup

    WebSphere Portal|Portlet Services|Content Access|Get URL

    WebSphere Portal|Portlet Services|Content Access|Init

    WebSphere Portal|Portlet Services|Credential Vault|Create Slot

    WebSphere Portal|Portlet Services|Credential Vault|Get all Segments

    WebSphere Portal|Portlet Services|Credential Vault|Get Credential

    WebSphere Portal|Portlet Services|Credential Vault|Get Slots

    WebSphere Portal|Portlet Services|Credential Vault|Get User Subject

    Portlets WebSphere Portal|Portlets|PortletName|{method}

    Standard Portlet Container WebSphere Portal|Standard Portlet Container|Perform Actions

    Virtual Portal WebSphere Portal|Virtual Portal|{virtualportal_name}|Pages|{page_name}

    WebSphere Portal|Virtual Portal|{virtualportal_name}|Pages|{page_name}|C2A Actions

    WebSphere Portal|Virtual Portal|{virtualportal_name}|Pages|{page_name}|C2A

    Actions|{C2A Target Portlet Name}

    WebSphere Portal|Virtual

    Portal|{virtualportal_name}|Pages|{page_name}|Portlets|{Portlet Name}|

    WebSphere Portal|Virtual

    Portal|{virtualportal_name}|Pages|{page_name}|Portlets|{Portlet Name}|C2A

    Portlets|{C2A Target Portlet Name}

    WebSphere Portal|Virtual

    Portal|{virtualportal_name}|Pages|{page_name}|Portlets|{Portlet Name}|{method}

  • WSRP

    Chapter 3: Using the CA APM for IBM WebSphere Portal 39

    WSRP WebSphere Portal|WSRP|Consumer|Remote Portlets|PortletName|Get Markup

    WebSphere Portal|WSRP|Consumer|Remote Portlets|PortletName|Perform Action

    WebSphere Portal|WSRP|Producer|Remote Portlets|PortletName|Get Markup

    WebSphere Portal|WSRP|Producer|Remote Portlets|PortletName|Perform Action

  • Chapter 3: Using the CA APM for IBM WebSphere Portal 41

    Appendix B: Frequently Asked Questions

    Frequently Asked Questions

    How can I avoid seeing many portlets being shown as Frontends in the Investigator?

    apm-common.pbd:

    TraceOneMethodWithParametersIfFlagged: ServletFilterTracing

    doFilter(Ljavax/servlet/ServletRequest;Ljavax/servlet/ServletResponse;Ljavax/

    servlet/FilterChain;)V HttpServletTracer "ServletFilters|{classname}"

    j2ee.pbd:

    TraceOneMethodWithParametersIfFlagged: JSPServletTracing _jspService

    HttpServletTracer "JSPServlet|{classname}"

    TraceOneMethodWithParametersIfFlagged: HttpServletTypeSpecificServiceTracing

    service(Ljavax/servlet/http/HttpServletRequest;Ljavax/servlet/http/HttpServle

    tResponse;)V HttpServletTracer Servlets

    TraceOneMethodWithParametersIfFlagged: HTTPServletTracing

    service(Ljavax/servlet/ServletRequest;Ljavax/servlet/ServletResponse;)V

    HttpServletTracer Servlets

    ws60x.pbd:

    TraceOneMethodWithParametersIfFlagged: StaticServletEmulation handleRequest

    HttpServletTracer Servlets

    Frontends nodes do not display with these modifications. These modifications also prevent the Overview tab at the Agent level from getting overloaded.

    How can I customize the metrics that the product creates?

    The product includes the following preconfigured pbds:

    powerpackforwebsphereportal_typical.pbd

    powerpackforwebsphereportal_full.pbd

    If you want to enable other modules, uncomment the corresponding lines from the powerpackforwebsphereportal_typical.pbd. Do not comment out any of the Tracer flags that are enabled by default from powerpackforwebsphereportal_typical.pbdthis modification can affect the other metrics from being created.

  • Frequently Asked Questions

    42 for IBM WebSphere Portal Guide

    Why am I not seeing any graph even though I have numerous portlets in the table?

    When the portlets are WSRP producers, relationships or impacted-components do not exist within this server. Because this component does not have corresponding impacted components within the server, the graph does not have the producers. Unless the same portlet is used as a normal portlet within the server.

    I have a portlet which is part of many pages. Why am I not seeing all of them in the graph?

    The number of components at each level in the graph is restricted to 20. The pages where the portlet is worst performing is present in the graph. The remaining pages are present in the graph depending upon the upper limit of 20.

    Why am I not seeing an edge from a parent to a child (page - portlet), even though the graph has both the components?

    The graph identifies the impact of the worst performing components. Even though a page and a portlet part of the page are present in the graph, that portlet may perform well with respect to that page. For example, a portlet has Average Response Times as 15 and 20 for page 1 and page 2. Although page 1 is in the graph as worst performing, the graph shows a relationship from the portlet to page 2 because the portlet has the worst performance with respect to page 2. Page 1 may be worst performing because of another portlet.

    Why am I not seeing all the components from the table in the graph?

    The graph shows the impact of the components within the server. Graphs do not display components when relationships or the impacted components are missing.

    Why am I seeing multiple Portal typeviews? Within that, only one is performing as expected.

    If you see more than one portal tab, you may have logged out of the workstation without also exiting the workstation. The solution is to exit the workstation, delete the ws-plugins folder under /config/internal/console and start the workstation. Always exit the workstation when you log out from the workstation.

    Why does data for some of the components in the Dashboard not appear?

    Use the management module jar that corresponds to the pbd that the agent uses:

    PowerpackForWebspherePortal_ManagementModule_typical.jar

    PowerpackForWebspherePortal_ManagementModule_full.jar

    You can move the jar file that you do not use to the portal directory for future use.

  • Chapter 3: Using the CA APM for IBM WebSphere Portal 43

    Appendix C: IPv6 Support

    Components of the CA APM for IBM WebSphere Portal that are installed on WebSphere Portal Server are IPv6 compliant.

    Important! IPv6 support for the CA APM for IBM WebSphere Portal is dependent upon IPv6 support in the environment (JVM, WebSphere Portal, operating system, hardware stack) in which the CA APM for IBM WebSphere Portal is running.

    To enable display of the IPv6 address in the Investigator for WebSphere Portal:

    On Windows:

    1. Open the Portal Server startup script.

    2. Add the following property to the JavaOptions section in the script:

    -Djava.net.preferIPv6Addresses=true

    On UNIX:

    1. Open the Portal Server startup script.

    2. Add the following property to the JavaOptions section in the script:

    -Djava.net.preferIPv6Addresses=true

    Note: When you set -Djava.net.preferIPv6Addresses=true, the Investigator displays the full IPv6 address under *SuperDomain* | | | Host : IP Address. However, if the IPv6 address is not mentioned in the hosts file of the running agent, the Investigator displays 0:0:0:0:0:0:0:1.

  • Index 45

    Index

    A

    Access Control 37 Application Support Specialist

    Viewing Worst Performing Components for WebSphere Portal 35

    Authentication 37

    C

    CA APM for IBM WebSphere Portal Components 10

    CA Technologies Product References 3 Caching 37 Configure the Authentication Node 21 Configure the PBL File for Typical, Full, and Error

    PBDs 18 Contact CA Technologies 5 Customer Says

    D

    Dashboards for CA APM for IBM WebSphere Portal 29

    Data Center Operator Responding to Red Light 35

    Disable CA APM for IBM WebSphere Portal 25

    E

    Engine 37

    F

    Frequently Asked Questions 41

    H

    How CA APM for IBM WebSphere Portal Components Work With Each Other 10

    How the CA APM for IBM WebSphere Portal Works 9

    How to Install and Configure CA APM for IBM WebSphere Portal 14

    I

    Install Agent Components of the CA APM for IBM WebSphere Portal 16

    Install and Configure CA APM for IBM WebSphere Portal for Clustered Environment 24

    Install Enterprise Manager Components of the CA APM for IBM WebSphere Portal 14

    Installation Requirements 13 Installing and Configuring the CA APM for IBM

    WebSphere Portal 13 IPv6 Support 43

    L

    Legacy Portlet Container 37

    M

    Metrics 37 Monitoring WebSphere Portal Functions 11

    O

    Optional Integrating ChangeDetector with CA APM for IBM

    WebSphere Portal 22 Overview 9

    P

    Portal 38 Portal Developers

    Resolving the Problem Using Metrics for In-Depth Diagnosis 36

    Portlet Services 38 Portlets 38 Prerequisites 13

    R

    Running JavaScript Calculators on the MOM 25

    S

    Sample Operation Scenario 35 Standard Portlet Container 38

    U

    Using the CA APM for IBM WebSphere Portal 27

    V

    Viewing Dashboards 27

  • 46 for IBM WebSphere Portal Guide

    Viewing Metrics 30 Viewing Worst Performing Components 30 Virtual Portal 38

    W

    WebSphere Portal Metrics 27 WSRP 39

    CA Technologies Product ReferencesContact CA TechnologiesContentsChapter 1: OverviewHow the CA APM for IBM WebSphere Portal WorksCA APM for IBM WebSphere Portal ComponentsHow CA APM for IBM WebSphere Portal Components Work With Each Other

    Monitoring WebSphere Portal Functions

    Chapter 2: Installing and Configuring the CA APM for IBM WebSphere PortalInstallation RequirementsPrerequisites

    How to Install and Configure CA APM for IBM WebSphere PortalInstall Enterprise Manager Components of the CA APM for IBM WebSphere PortalInstall Agent Components of the CA APM for IBM WebSphere PortalConfigure the PBL File for Typical, Full, and Error PBDsConfigure the Authentication NodeOptional: Integrating ChangeDetector with CA APM for IBM WebSphere Portal

    Install and Configure CA APM for IBM WebSphere Portal for Clustered EnvironmentRunning JavaScript Calculators on the MOM

    Disable CA APM for IBM WebSphere Portal

    Chapter 3: Using the CA APM for IBM WebSphere PortalWebSphere Portal MetricsViewing DashboardsDashboards for CA APM for IBM WebSphere Portal

    Viewing MetricsViewing Worst Performing ComponentsSample Operation ScenarioCustomer Says: "We Have a Problem"Data Center Operator: Responding to Red LightApplication Support Specialist: Viewing Worst Performing Components for WebSphere PortalPortal Developers: Resolving the Problem Using Metrics for In-Depth Diagnosis

    Appendix A: MetricsAccess ControlAuthenticationCachingEngineLegacy Portlet ContainerPortalPortlet ServicesPortletsStandard Portlet ContainerVirtual PortalWSRP

    Appendix B: Frequently Asked QuestionsFrequently Asked Questions

    Appendix C: IPv6 SupportIndex