for Microsoft SharePoint Guide
Release 9.6
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 is proprietary information of CA and may not be copied, transferred, reproduced, disclosed, modified or duplicated, in whole or in part, without the prior written consent of CA.
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 © 2014 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 for z/OS (CA APM for IBM WebSphere Application Server for z/OS)
■ CA Application Performance Management for IBM WebSphere for Distributed
Environments (CA APM for IBM WebSphere for 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 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®
■ CA NetQoS® Performance Center ■ CA Performance Center
Contact CA Technologies
Contact CA SupportFor 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
Contents 7
Contents
Chapter 1: Overview
11
About the Extension ... 11
How the Extension Works ... 12
Extension Components ... 12
How Extension Components Work With Each Other ... 13
The SharePoint Monitor Agent ... 13
SharePoint Monitor Agent Components ... 13
How Agent Components Work with Each Other... 14
Chapter 2: Installing and Configuring the Extension
15
Perform Prerequisite Tasks ... 15Configure User Privileges ... 15
System and Version Support ... 16
How to Install and Configure the SPMonitor Agent ... 16
Install SharePoint Monitor Agent Components ... 16
Configuring SharePoint Monitor Properties ... 17
Register SharePoint Monitor Agent as a Windows Service... 20
Start the SharePoint Monitor Agent ... 20
Installation Requirements for the Extension ... 21
Prepare for Installation ... 21
System and Version Support ... 21
How to Install and Configure the Extension ... 21
Install Enterprise Manager Components of the Extension ... 22
Install Agent Components of the Extension ... 24
Configure the PBL File for Typical and Full PBDs ... 25
Uninstall the SPMonitor Agent... 28
How to Uninstall the Extension ... 28
Remove an Entry From the Profile File ... 28
Delete the Relevant Files and Folders ... 29
Chapter 3: Using the Extension
31
Using the Extension to Monitor SharePoint Portal ... 31SharePoint Portal Metrics ... 31
Worst Performing Components ... 32
View Dashboards ... 32
8 for Microsoft SharePoint Guide
View Metric Groupings and Alerts ... 35
View SharePoint Portal Services Metrics and Events Information ... 37
View Overall Performance of SharePoint Portal and its Components Using sharepoint-typical PBD ... 40
View Worst Performing Pages Using sharepoint-full PBD ... 42
View Active Sites and Page Hits ... 47
View Layout Pages Metrics ... 48
View Web Services Metrics ... 49
View Transaction Tracing ... 50
Transaction Trace Viewer ... 51
Appendix A: Metrics
53
Understanding How to Read Metric Tables ... 53SharePoint Publishing Cache ... 54
Office Server Search Archival Plug-in/OSS Search Archival Plug-in ... 55
Office Server Search Gatherer Projects/OSS Search Gatherer Projects ... 56
Office Server Search Gatherer/OSS Search Gatherer... 61
Office Server Search Indexer Catalogs/OSS Search Indexer Plugin ... 68
Office Server Search Schema Plugin/OSS Search Schema Plugin ... 74
OSS Secure Store Credentials ... 74
OSS Secure Store Tickets ... 75
Excel Calculation Services... 75
Excel Services Web Front End/Excel Services Application Web Front End ... 76
Excel Web Access/Excel Services Application Browser ... 77
Microsoft Single Sign On ... 78
InfoPath Forms Services/InfoPath Forms Services 14 ... 79
Web Service... 81
Appendix B: Monitored Events
91
SharePoint Events Monitored by the Extension ... 91Appendix C: Monitored Web Services
93
Web Services Monitored by SharePoint 2007 ... 93Web Services Monitored by SharePoint 2010 ... 94
Appendix D: Frequently Asked Questions
97
IIS Performance Tab Not Working in SharePoint Dashboards ... 97Database Operations Tab Not Working in SharePoint Dashboards ... 98
Backend Tab is Not Working in the SharePoint Dashboards ... 98
Contents 9
Database Server Not Appearing in the Investigator Tree as Part of Farm Servers ... 99
Stall Count Metric Only Appears Under Pages or Web Parts ... 99
Site Metrics Do Not Appear ... 100
Page Metrics Do Not Appear ... 100
Performance of Page and Web Part Lifecycle Methods ... 100
High Responses per Interval Though No User Activity is Identified ... 101
Nothing Appears in Transaction Trace With the Do Not Ignore Case Option ... 101
Page Identification in Transaction Trace for Site Collection, Site, or Subsite ... 102
Group All ASPX Pages Metric Reporting ... 102
Group All URL Metrics in the Frontend Node ... 103
Index
105
Chapter 1: Overview 11
Chapter 1: Overview
This section contains the following topics: About the Extension (see page 11) How the Extension Works (see page 12) The SharePoint Monitor Agent (see page 13)
About the Extension
CA APM for Microsoft SharePoint is a complete performance monitoring and
management solution. This extension offers continous monitoring of your SharePoint Portal components during development, QA, staging, and production. The extension also extends visibility beyond SharePoint Portal, allowing you to identify performance problems both within SharePoint Portal and in connection to critical back-end systems. The extension collects and analyzes metrics from the SharePoint Portal in real time. Metrics show problems that are related to availability, performance, or health. You can customize the extension to alert an administrator or system user about the problem that has occurred. You can configure alerts to meet the needs of an individual
SharePoint Portal deployment. The extension is built on the CA Introscope® enterprise monitoring platform and shares all its key benefits.
You can view the overall health, performance, and availability of SharePoint Portal using the dashboards. The Investigator tree provides a list of top worst performing
components in a tabular view. You can use this tabular view to generate a graphical view. This graphical view displays the relationships between the worst performing components with other SharePoint Portal components. The graphical view helps you understand how the worst performing components can affect the other components in SharePoint Portal.
How the Extension Works
12 for Microsoft SharePoint Guide
How the Extension Works
The following diagram shows how CA APM for Microsoft SharePoint is deployed in your environment:
Extension Components
CA APM for Microsoft SharePoint includes the following components: Agent Extension, PBL, and PBD files
Collects SharePoint Portal metric data and transfers the data to Enterprise Manager.
Enterprise Manager plug-ins, and Workstation plug-in
Analyzes and aggregates the metrics and transfers the data to Workstation for display.
Management Module
Displays metric groupings, Alerts, and Dashboards for SharePoint Portal. SharePoint Monitor Agent
The SharePoint Monitor Agent
Chapter 1: Overview 13
How Extension Components Work With Each Other
The extension components work with each other as follows:
1. The CA Introscope® agent that resides in the SharePoint Portal and application server collects metrics and passes them to the Enterprise Manager.
2. The SharePoint Monitor agent that resides in one of the SharePoint servers in a farm collects the Windows events and PerfMon counters. Then the agent passes the events and counters to the Enterprise Manager.
3. The Enterprise Manager analyzes the metrics and aggregates them using Enterprise Manager plug-ins.
The Workstation displays these metrics and the worst performing components that are based on the metrics. The Workstation also displays the overall health, performance, and availability of SharePoint Portal Server.
The SharePoint Monitor Agent
When you deploy the SharePoint Monitor agent in SharePoint Portal Server environment, the components of the SharePoint Monitor agent interact with each other. The agent and components report Performance Monitor counters and Windows application events.
SharePoint Monitor Agent Components
The SharePoint Monitor agent includes the following components:
■ SPPerfCounters.list.xml—This XML contains a list of PerfMon categories, counters,
and their instance information that the extension monitors. This component also contains monitoring levels that are associated with the counters.
■ SPEvents.list—This file contains a list of SharePoint Windows application event
sources that the extension monitors.
The SharePoint Monitor Agent
14 for Microsoft SharePoint Guide
How Agent Components Work with Each Other
The SharePoint Monitor agent works as follows:
1. The agent monitors the PerfMon counters and Windows events of the Sharepoint Portal application server.
2. The agent sends the relevant metrics to the Enterprise Manager depending on the monitoring level that is set for services.
3. The agent monitors application event for the sources specified in the SPEvents.list file and sends the event information to the Enterprise Manager.
Chapter 2: Installing and Configuring the Extension 15
Chapter 2: Installing and Configuring the
Extension
This section contains the following topics: Perform Prerequisite Tasks (see page 15) Configure User Privileges (see page 15) System and Version Support (see page 16)
How to Install and Configure the SPMonitor Agent (see page 16) Installation Requirements for the Extension (see page 21) How to Install and Configure the Extension (see page 21) Uninstall the SPMonitor Agent (see page 28)
How to Uninstall the Extension (see page 28)
Perform Prerequisite Tasks
Before you begin the installation procedure, perform the following tasks:
1. Enable Windows Management Instrumentation (WMI) on all servers in the farm. 2. Identify the following directory location in your network:
The installation directory for the SharePoint Monitor agent that the
<SharePoint_Agent_Home> refers to. This location is the SharePoint directory on
the server that is a part of the SharePoint Portal farm installation.
Configure User Privileges
You perform administrative tasks to enable user privileges. Follow these steps:
1. Create a domain service account for running the CA Introscope® SPMonitor Windows service.
2. Add this service account to the following groups for all farm servers: – SharePoint farm administrator group
– Local administrators group (Administrators)
This step enables the automatic discovery of the farm servers. This step also enables the CA Introscope® SPMonitor agent to read the Performance Monitor (PerfMon) counters and Windows event logs.
System and Version Support
16 for Microsoft SharePoint Guide
3. Verify that the user has the following privileges:
– A member of the Windows Admin group on the SharePoint server. – A member of the SharePoint Admin group.
– Sysadmin permission on the database.
Note: If sysadmin is not allowed, add the SPMonitor user to the SQL Server Logins and grant the following roles to the SharePoint_Config database:
– Db_datareader – Public
– WSS_Content_Application_Pools
System and Version Support
See the CA APM Compatibility Guide for the supported SharePoint versions and systems.
How to Install and Configure the SPMonitor Agent
To view SharePoint Portal services metrics and events information, install and configure the SPMonitor agent that is part of CA APM for Microsoft SharePoint.
Perform the following high-level steps:
1. Install the SharePoint Monitor agent components (see page 16). 2. Configure the SharePoint Monitor properties (see page 17).
3. Register the SharePoint Monitor agent as a Windows service (see page 20).
Install SharePoint Monitor Agent Components
To install the SharePoint Monitor agent, run the Standalone agent installer.
Note: You can also use the .NET agent installer to install the SharePoint Monitor agent. For more information, see the CA APM .NET Agent Implementation Guide.
Follow these steps:
1. Run the Standalone agent installer.
Note: For details, see the CA APM Installation and Upgrade Guide. 2. Specify <SharePoint_Monitor_Agent> as the installation directory.
How to Install and Configure the SPMonitor Agent
Chapter 2: Installing and Configuring the Extension 17 3. Specify the Enterprise Manager host and port.
All the agent files are copied to the <SharePoint_Monitor_Agent> directory. 4. Verify that the <SharePoint_Monitor_Agent> directory has the following files:
File Description
.\SPMonitorAgent\RegisterSP
MonitorWindowService.bat
Batch file to register the SPMonitor agent as a Windows service.
.\SPMonitorAgent\DeregisterSP
MonitorWindowService.bat
Batch file to unregister the SPMonitor agent as a Windows service.
.\SPMonitorAgent\SPEvents.list File that contains a list of Windows application event sources that
the extension monitors.
.\SPMonitorAgent\logging.config.xml XML file that lets you configure logging settings.
.\SPMonitorAgent\Introscope
Agent.profile
File that lets you configure settings for CA Introscope® AutoProbe and agent.
.\SPMonitorAgent\SPPerf
Counters.list.xml
XML file that contains a list of PerfMon categories, counters, and their instance information that the extension monitors. The file also contains monitoring levels that are associated with the counters.
.\SPMonitorAgent\properties\
SPMonitor.properties
Properties file for monitoring SharePoint.
.\SPMonitorAgent\bin\wily.Agent.dll Dependency library for SharePoint.
You have now configured the SharePoint Monitor agent.
Configuring SharePoint Monitor Properties
The extension uses the following SharePoint Monitor properties and their default values specified in the SPMonitor.properties file present in the SPMonitorAgent\properties directory:
■ sharepoint.farm.monitor.service.excel.level=recommended
■ sharepoint.farm.monitor.service.form.level=recommended
How to Install and Configure the SPMonitor Agent
18 for Microsoft SharePoint Guide
■ sharepoint.farm.monitor.service.cache.level=recommended ■ sharepoint.farm.monitor.service.searchindexcrawler.level=recommended ■ sharepoint.farm.monitor.service.webapplication.level=recommended ■ sharepoint.perfmon.metric.pollIntervalInSeconds=300 ■ sharepoint.perfmon.instances.pollIntervalInSeconds=600 ■ sharepoint.farm.monitor.event.error.enabled=true ■ sharepoint.farm.monitor.event.warning.enabled=true ■ sharepoint.farm.monitor.event.information.enabled=false
Monitoring Levels for Metrics
You can set the following monitoring levels for metrics of a given service for a specific farm using the SPMonitor.properties file:
■ When you set the monitoring level to none, CA Introscope® does not monitor the
service and metrics do not display for the service.
■ When you set the monitoring level to minimum, CA Introscope® displays the minimum set of metrics for the service.
■ When you set the monitoring level to recommended, CA Introscope® displays the recommended and minimum set of metrics for the service.
■ When you set the monitoring level to full, CA Introscope® displays the full set of
metrics for the service. This set includes all monitored metrics.
Note: If you do not set a value for the monitoring level, recommended level is set by default.
You can set the monitoring level for metrics for the following services of SharePoint Portal using the SPMonitor.properties file:
Note: The services use the default monitoring level.
■ sharepoint.farm.monitor.service.excel.level=recommended ■ sharepoint.farm.monitor.service.form.level=recommended ■ sharepoint.farm.monitor.service.singlesignon.level=recommended ■ sharepoint.farm.monitor.service.cache.level=recommended ■ sharepoint.farm.monitor.service.searchindexcrawler.level=recommended ■ sharepoint.farm.monitor.service.webapplication.level=recommended
How to Install and Configure the SPMonitor Agent
Chapter 2: Installing and Configuring the Extension 19
Set Polling Intervals for PerfMon Counters
You can also set the polling intervals for PerfMon counters. Follow these steps:
1. Set the interval at which PerfMon metrics are collected using the sharepoint.perfmon.metric.pollIntervalInSeconds property. For example, set
sharepoint.perfmon.metric.pollIntervalInSeconds=300
Note: Default is 5 minutes. Minimum interval is 15 seconds and maximum interval is 60 minutes. If you set a value less than 15 seconds or greater than 60 minutes, CA APM for Microsoft SharePoint automatically resets the value to a default value of 5 minutes.
2. Set the interval at which PerfMon category instances are refreshed using the sharepoint.perfmon.instances.pollIntervalInSeconds property
For example, set
sharepoint.perfmon.instances.pollIntervalInSeconds=600
Note: Default is 10 minutes. Minimum interval is 5 minutes and maximum interval is 24 hours. A value less than 5 minutes or greater than 24 hours causes the extension to reset automatically to a default value of 10 minutes.
Monitor Generated Windows Events
You can monitor the Windows events that the SharePoint Portal generates using the SPMonitor.properties file.
Follow these steps:
1. Set sharepoint.farm.monitor.event.error.enabled to true or false to enable or disable error event monitoring, respectively.
2. Set sharepoint.farm.monitor.event.warning.enabled to true or false to enable or disable warning event monitoring, respectively.
3. Set sharepoint.farm.monitor.event.information.enabled to true or false to enable or disable information event monitoring, respectively.
Note: By default, error and warning events are enabled and information events are disabled.
For example:
■ sharepoint.farm.monitor.event.error.enabled=true
■ sharepoint.farm.monitor.event.warning.enabled=true
How to Install and Configure the SPMonitor Agent
20 for Microsoft SharePoint Guide
Register SharePoint Monitor Agent as a Windows Service
You must register the SharePoint Monitor Agent as a Windows service before you can start it.
Follow these steps:
1. Edit the RegisterSPMonitorWindowService.bat file in the SPMonitorAgent directory and include the absolute path of the InstallUtil.exe file.
The InstallUtil.exe file is part of the .NET Framework. 2. Run the RegisterSPMonitorWindowService.bat file.
The Set Service Login dialog appears.
3. Enter the SharePoint domain account username and password in the Set Service Login dialog.
Note: The account username must be entered in the <domain>\<username>
format. 4. Click OK.
Note: To troubleshoot any setup problems you encounter, refer to \SPMonitorAgent\InstallUtil.InstallLog.
You have now successfully registered the SharePoint Monitor Agent as a Windows service.
Important! After you register the Windows service, start it manually. You have now installed the SharePoint Monitor Agent.
Start the SharePoint Monitor Agent
You start the SharePoint Monitor agent to view SharePoint Services metrics in the Investigator tree.
Follow these steps:
1. Go to the command prompt and run services.msc. A list of all Windows services appears.
2. Right-click CA Introscope® SPMonitor and click Start.
The SharePoint Monitor agent starts. If the SharePoint Monitor agent is unable to start, an error message is generated in the application events.
3. Go to the command prompt, run eventvwr, and review the Windows event viewer for details.
Installation Requirements for the Extension
Chapter 2: Installing and Configuring the Extension 21
Installation Requirements for the Extension
This section lists the prerequisites and system and version support for the extension.
Prepare for Installation
You perform tasks to prepare for the installation procedure. Follow these steps:
1. Identify the following directory locations in your network:
– SharePoint Server—.NET Agent CA APM folder on the SharePoint Server Web Frontend where the CA Introscope® .NET agent is installed is referred to as
<Agent_Home>.
– Enterprise Manager—The home directory for the Enterprise Manager is referred to as <EM_Home>.
2. (Optional) Install and configure the following components to monitor Web servers and databases:
– CA Introscope® PowerPack for Web Servers v8.0
– CA Insight Database Performance Manager for Distributed Databases r11.2.4 – CA Insight Bridge for CA Introscope®
System and Version Support
See the CA APM Compatibility Guide for the supported SharePoint versions and systems.
How to Install and Configure the Extension
Installing and configuring CA APM for Microsoft SharePoint involves the following high-level steps:
1. Install Enterprise Manager components of the extension (see page 22). 2. Install agent components of the extension (see page 24).
How to Install and Configure the Extension
22 for Microsoft SharePoint Guide
Install Enterprise Manager Components of the Extension
If you are using the same Enterprise Manager for different agents, the Enterprise Manager components of all the extensions are already installed. These components are installed in the <EM_Home>\examples folder when you run the installer for the first time. You do not have to run the Enterprise Manager installer again to install Enterprise Manager components of the extension.
Note: If you are installing the Enterprise Manager for the first time, a list of extensions that you can install and configure appears. Select SP Monitor For SharePoint Portal. For more information, see the CA APM Installation and Upgrade Guide.
Follow these steps:
Important! Skip Step 1 and start from Step 2 when you are using the same Enterprise Manager for different agents.
1. Run the Enterprise Manager installer.
The Enterprise Manager components of the extension are installed onto the Enterprise Manager.
The installer places the files into the
<EM_Home>\examples\PowerPackforSharepointPortal directory.
Note: For details, see the CA APM Installation and Upgrade Guide.
2. Verify that the <EM_Home>\examples\PowerPackforSharepointPortal directory has the following files:
Note: The following directory paths use the Microsoft Windows directory syntax. For other installation platforms, such as UNIX, replace "\" with "/".
■ <EM_Home>\examples\PowerPackforSharepointPortal\config\modules\ShareP
oint_ManagementModule.jar
Management Module JAR for typical configuration for displaying performance metrics in dashboards.
■ <EM_Home>\examples\PowerPackforSharepointPortal\product\enterprisema
nager\plugins\com.wily.powerpack.sharepoint.common.ext.tracefilter.jar Plug-in for Enterprise Manager extension for setting filters for Transaction Trace.
■ <EM_Home>\examples\PowerPackforSharepointPortal\product\enterprisema
nager\plugins\com.wily.powerpack.sharepoint.ddtv.typeviews.jar Plug-in for Enterprise Manager extension.
■ <EM_Home>\examples\PowerPackforSharepointPortal\product\enterprisema
nager\plugins\com.wily.powerpack.sharepoint.em.ext.listandwebpart.jar Plug-in for Enterprise Manager for aggregated Metrics of sharepoint-full.pbd.
How to Install and Configure the Extension
Chapter 2: Installing and Configuring the Extension 23
■ <EM_Home>\examples\PowerPackforSharepointPortal\product\enterprisema
nager\plugins\com.wily.powerpack.sharepoint.em.ext.perfmon.jar
Plug-in for Enterprise Manager for the aggregated Metrics of SPMonitor agent.
■ <EM_Home>\examples\PowerPackforSharepointPortal\product\enterprisema
nager\plugins\com.wily.powerpack.sharepoint.em.ext.tracefilter.jar Plug-in for Enterprise Manager extension for setting filters for Transaction Trace.
■ <EM_Home>\examples\PowerPackforSharepointPortal\product\enterprisema
nager\plugins\com.wily.powerpack.sharepoint.em.service.jar Plug-in for Enterprise Manager service to display a graphical view.
■ <EM_Home>\examples\
PowerPackforSharepointPortal\scripts\Sharepoint-ActiveSites.js
JavaScript calculator for providing the number of sites that are currently being accessed in SharePoint Portal Web Application.
■ <EM_Home>\examples\
PowerPackforSharepointPortal\ws-plugins\com.wily.powerpack.sharepoint.co mmon.ext.tracefilter.jar
Plug-in for Workstation for setting filters for Transaction Trace.
■ <EM_Home>\examples\
PowerPackforSharepointPortal\ws-plugins\com.wily.powerpack.sharepoint.ws. ext.jar
Plug-in for Workstation.
■ <EM_Home>\examples\
PowerPackforSharepointPortal\ws-plugins\com.wily.powerpack.sharepoint.ws. ext.tracefilter.jar
Plug-in for Workstation for setting filters for Transaction Trace. 3. Copy all the files to the correct location. Base this location on how they are
organized in the \examples directory. For example, copy the following file:
com.wily.powerpack.sharepoint.common.ext.tracefilter.jar From the following directory:
<EM_Home>\examples\PowerPackforSharepointPortal\product\enterprisemanage
r\plugins\
To the following directory:
<EM_Home>\product\enterprisemanager\plugins\
Note: In a clustered CA APM implementation, move these files on both the MOM Enterprise Manager and on the collector Enterprise Managers.
How to Install and Configure the Extension
24 for Microsoft SharePoint Guide
Install Agent Components of the Extension
To install the .NET agent extension for CA APM for Microsoft SharePoint, you run the .NET agent installer.
Follow these steps:
1. Run the .NET agent installer.
Note: For details, see the CA APM .NET Agent Implementation Guide. 2. Perform one of the following tasks:
a. To only install the extension, select IIS as the Application Server, and specify
<Agent_Home> as the installation directory.
All the agent files are copied to the <Agent_Home>\wily directory.
b. To install and enable the extension, select IIS as the Application Server, select CA APM for Microsoft SharePoint to install, and specify <Agent_Home> as the installation directory.
All the agent files are copied to the <Agent_Home>\wily directory. 3. Verify that the <Agent_Home>\wily directory has the following files:
The following directory paths use the Microsoft Windows directory syntax. For other installation platforms, such as UNIX, replace "\" with "/".
■ <Agent_Home>\wily\SharePoint.ext.dll
Dependency library for SharePoint.
■ <Agent_Home>\wily\sharepoint.pbl
ProbeBuilder List that has all the PBDs listed in it.
■ <Agent_Home>\wily\sharepoint-typical.pbd
PBD that monitors the performance of critical components of CA APM for Microsoft SharePoint.
■ <Agent_Home>\wily\sharepoint-full.pbd
PBD that monitors the same traces as sharepoint-typical.pbd and the critical lifecycle methods of pages, web parts, and lists.
4. If you have installed and enabled the extension, verify that the PBL file is added to the introscope.autoprobe.directivesFile property in the IntroscopeAgent.profile file that is located in the <Agent_Home>\wily directory as follows:
How to Install and Configure the Extension
Chapter 2: Installing and Configuring the Extension 25 5. If you have not enabled the extension during the Standalone agent installation and
you want to enable it, perform the following tasks:
a. Add the following PBL file to the introscope.autoprobe.directivesFile property in the IntroscopeAgent.profile file that is located in the <Agent_Home>\wily directory as follows:
introscope.autoprobe.directivesFile=sharepoint.pbl
b. Copy the SharePoint.ext.dll file from the <Agent_Home>\wily directory to the
<Agent_Home>\wily\ext directory.
You have now configured the agent components for extension.
Configure the PBL File for Typical and Full PBDs
You can configure the extension for either typical or full configuration.
■ The typical configuration lets you view metrics for overall performance of SharePoint Portal and its components. For a typical configuration, you enable sharepoint-typical.pbd. For this PBD, only critical tracers are enabled to monitor the performance of critical components of the portal server.
■ The full configuration lets you view the worst performing components of SharePoint Portal in a tabular view. For a full configuration, you enable sharepoint-full.pbd. This PBD has all the tracers enabled to monitor the
performance of all the components of the portal server. Based on the tabular view, you can also generate a graphical view. This graphical view helps you understand how the worst performing components can affect the other components in the SharePoint Portal Server.
By default, the PBL file for the extension has typical configuration
(sharepoint-typical.pbd) enabled and full configuration (sharepoint-full.pbd) disabled. Follow these steps:
1. Comment out or disable sharepoint-typical.pbd entry and uncomment or enable sharepoint-full.pbd entry in sharepoint.pbl.
2. Restart the IIS Server. The changes take effect.
Metrics for sharepoint-typical PBD
When you use sharepoint-typical.pbd, you see the following structure in the Investigator tree:
■ SharePoint-Typical: 5 Metrics (Average Response Time, Concurrent Invocations,
Errors Per Interval, Responses Per Interval, and Stall Count)
■ SharePoint|Application_layout Pages: 5 Metrics (Average Response Time,
How to Install and Configure the Extension
26 for Microsoft SharePoint Guide
■ SharePoint|Site Collections: Active Sites (number of Sites)
Note: Enable the TurnOn: SiteARTTracing and TurnOn: SiteRPITracing tracers in the sharepoint-typical.pbd or sharepoint-full.pbd to view Active Sites.
■ SharePoint|Site Collections: Page Hits (number of pages)
■ SharePoint|Site Collections|{Site Collection name}: 5 Metrics (Average Response Time, Concurrent Invocations, Errors Per Interval, Responses Per Interval, and Stall Count)
■ SharePoint|Site Collections|{Site Collection name}|Sites|{site name}: 2 Metrics (Average Response Time and Responses Per Interval)
Note: By default, the metrics for Site are not available. To view them in the Investigator, enable the metrics for Site.
CA Introscope® displays Stall Count metrics only when stalls occur. The stall can occur either at page-level or web-part level.
If the stall occurs at the page level, CA Introscope® displays it at one of the following paths:
■ SharePoint|Site Collections|{Site Collection name}|Sites|{Site name}|Pages|{Page
Name}:Stall Count
■ SharePoint|Site Collections|{Site Collection name}|Sites|{Site name}|Pages|{Page Name}|{Page lifecycle method}:Stall Count
If the stall occurs at the web-part level, CA Introscope® displays it at one of the following paths:
■ SharePoint|Site Collections|{Site Collection name}|Sites|{Site name}|Pages|{Page Name}|Web Parts and Lists:Stall Count
■ SharePoint|Site Collections|{Site Collection name}|Sites|{Site name}|Pages|{Page Name}|Web Parts and Lists|{Web Part lifecycle method}:Stall Count
More information:
Metrics for sharepoint-full PBD (see page 26)
Metrics for sharepoint-full PBD
When you use sharepoint-full.pbd, you see the following structure in the Investigator tree:
■ SharePoint-Full: 5 Metrics (Average Response Time, Concurrent Invocations, Errors
Per Interval, Responses Per Interval, and Stall Count)
■ SharePoint|Application_layout Pages: 5 Metrics (Average Response Time,
How to Install and Configure the Extension
Chapter 2: Installing and Configuring the Extension 27
■ SharePoint|Site Collections: Active Sites (number of Sites)
Note: Enable the TurnOn: SiteARTTracing and TurnOn: SiteRPITracing tracers in the sharepoint-typical.pbd or sharepoint-full.pbd to view Active Sites.
■ SharePoint|Site Collections: Page Hits (number of Pages)
■ SharePoint|Site Collections|{Site Collection name}: 5 Metrics (Average Response Time, Concurrent Invocations, Errors Per Interval, Responses Per Interval, and Stall Count)
■ SharePoint|Site Collections|{Site Collection name}|Sites|{Site name}: 2 Metrics (Average Response Time and Responses Per Interval)
Note: By default, the metrics for Site Collection are not available. To view them in the Investigator, enable the metrics for Site Collection.
■ SharePoint|Site Collections|{Site Collection name}|Sites|{Site name}|Pages|{Page name}: 1 Metric (Average Response Time)
■ SharePoint|Site Collections|{Site Collection name}|Sites|{Site name}|Pages|{Page name}|Web Parts and Lists: 1 Metric (Average Response Time)
CA Introscope® displays Stall Count metrics only when stalls occur. The stall can occur either at page-level or web-part level.
If the stall occurs at the page level, CA Introscope® displays it at one of the following paths:
■ SharePoint|Site Collections|{Site Collection name}|Sites|{Site name}|Pages|{Page
Name}:Stall Count
■ SharePoint|Site Collections|{Site Collection name}|Sites|{Site name}|Pages|{Page Name}|{Page Lifecycle method}:Stall Count
If the stall occurs at the web-part level, CA Introscope® displays it at one of the following paths:
■ SharePoint|Site Collections|{Site Collection name}|Sites|{Site name}|Pages|{Page Name}|Web Parts and Lists:Stall Count
■ SharePoint|Site Collections|{Site Collection name}|Sites|{Site name}|Pages|{Page Name}|Web Parts and Lists|{Web Part Lifecycle method}:Stall Count
To view Active Sites and metrics for Sites using PBDs
1. Uncomment the TurnOn: SiteARTTracing and TurnOn: SiteRPITracing tracers in the sharepoint-typical.pbd or sharepoint-full.pbd to enable the tracers and view Active Sites and metrics for Sites.
2. Restart the IIS Server. The changes take effect.
Uninstall the SPMonitor Agent
28 for Microsoft SharePoint Guide
Uninstall the SPMonitor Agent
You can uninstall the SPMonitor agent. Follow these steps:
1. Go to Windows services and stop the CA Introscope® SPMonitor service.
2. Run the DeregisterSPMonitorWindowService.bat file located in the SPMonitorAgent directory.
This action unregisters the SharePoint Monitor agent as a Windows service. 3. Delete the SPMonitorAgent folder and its contents from the relevant server where
the installation copied the folder.
You have now uninstalled the SPMonitor agent.
How to Uninstall the Extension
Uninstalling CA APM for Microsoft SharePoint involves the following high-level steps: 1. Remove an entry from the Profile file (see page 28).
2. Delete the relevant files and folders that you copied while installing the extension (see page 29).
Remove an Entry From the Profile File
You remove the PBL file that you added to the property. Follow these steps:
1. Open the IntroscopeAgent.profile file located in the <Agent_Home> directory and remove sharepoint.pbl from the introscope.autoprobe.directivesFile property. 2. Restart the IIS Server.
How to Uninstall the Extension
Chapter 2: Installing and Configuring the Extension 29
Delete the Relevant Files and Folders
You remove the agent and Enterprise Manager components for the extension by deleting the relevant files and folders.
Follow these steps: 1. Restart the computer.
2. Delete sharepoint.pbl, sharepoint-typical.pbd, and sharepoint-full.pbd from the
<Agent_Home> directory.
3. Delete SharePoint.ext.dll from the <Agent_Home>\ext directory. 4. Stop the Enterprise Manager.
5. Delete the following files from the relevant directories:
■ SharePoint_ManagementModule.jar from the <EM_Home>\config\modules directory. ■ com.wily.powerpack.sharepoint.common.ext.tracefilter.jar, com.wily.powerpack.sharepoint.ddtv.typeviews.jar, com.wily.powerpack.sharepoint.em.ext.listandwebpart.jar, com.wily.powerpack.sharepoint.em.ext.perfmon.jar, com.wily.powerpack.sharepoint.em.ext.tracefilter.jar, and com.wily.powerpack.sharepoint.em.service.jar from the
<EM_Home>\product\enterprisemanager\plugins directory.
■ Sharepoint-ActiveSites.js from the <EM_Home>\scripts directory.
■ com.wily.powerpack.sharepoint.common.ext.tracefilter.jar, com.wily.powerpack.sharepoint.ws.ext.jar, and
com.wily.powerpack.sharepoint.ws.ext.tracefilter.jar from the
<EM_Home>\ws-plugins directory.
Chapter 3: Using the Extension 31
Chapter 3: Using the Extension
This section contains the following topics:
Using the Extension to Monitor SharePoint Portal (see page 31) View Dashboards (see page 32)
View Metric Groupings and Alerts (see page 35)
View SharePoint Portal Services Metrics and Events Information (see page 37) View Overall Performance of SharePoint Portal and its Components Using sharepoint-typical PBD (see page 40)
View Worst Performing Pages Using sharepoint-full PBD (see page 42) View Active Sites and Page Hits (see page 47)
View Layout Pages Metrics (see page 48) View Web Services Metrics (see page 49) View Transaction Tracing (see page 50)
Using the Extension to Monitor SharePoint Portal
You can view real-time metric data in the Investigator and console. This data helps you to monitor the health, availability, and performance of SharePoint Portal.
SharePoint Portal Metrics
CA Introscope® displays the following metrics for each operation in SharePoint Portal:
■ Average Response Time (ms): Average time that is taken for executing or invoking a specific operation or action.
■ Concurrent Invocations: Number of requests that are processed at a given time
(throughput).
■ Errors Per Interval: Number of errors the CA Introscope® agent records in a 15-second time period.
■ Responses Per Interval: Number of invocations that completed during a 15-second
time period.
■ Stall Count: Number of operations, invocations, or calls that are processing longer
View Dashboards
32 for Microsoft SharePoint Guide
Worst Performing Components
The extension displays the worst performing components in a tabular view under the Details tab. This tabular view corresponds to the nodes that display metrics for the components of the SharePoint Portal in the Investigator tree. Based on the tabular view, you can also generate a graphical view.
Tabular View for Worst Performing Components
The tabular view displays the following information:
■ Top worst performing pages of the SharePoint Portal.
■ The pages are sorted on their Average Response Time by default.
Graphical View for Worst Performing Components
After you identify the worst performing page using the Average Response Time, you can view the overall impact of the worst performing page.
The SharePoint Portal shows a visual or graphical view. This tabular view provides high-level information about relationships between the worst performing pages and other SharePoint Portal components. This view helps you understand how the worst performing pages can affect the other components in the SharePoint Portal Server.
View Dashboards
CA APM for Microsoft SharePoint dashboards combine and present application metrics in views that you can use to monitor your application environment. Dashboards aggregate data across all the deployed agents. Dashboards deliver in-depth performance information so you can diagnose and resolve problems. The Management Module SharePoint_ManagementModule.jar file in the
<EM_Home>\config\modules directory provides predefined dashboards for CA APM for
Microsoft SharePoint.
The dashboards provide the following information:
■ Overall application health and status views of the application.
■ At-a-glance notification of problems in the production application environment. ■ Data that enables you to identify the problems.
View Dashboards
Chapter 3: Using the Extension 33 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.
Follow these steps:
1. Verify that your applications are instrumented and providing data. 2. Verify that the Enterprise Manager is running.
3. Launch the Workstation by clicking Start > Programs > CA APM > Introscope
<version> > Introscope Workstation.
4. Log in to the Workstation. The Workstation appears.
5. Navigate to the Workstation console by clicking Workstation > New Console. 6. Select one of the following dashboards from the drop-down list.
■ SharePoint Overview
■ SharePoint Services
■ SharePoint Web Frontends
7. (Optional) View more information using dashboards. More information:
View SharePoint Services (see page 34)
Dashboards
You can monitor the health and availability of SharePoint Portal and its services by using the dashboards.
View Dashboards
34 for Microsoft SharePoint Guide
SharePoint Overview
When monitoring SharePoint Portal, first view the Overview dashboard. The dashboard shows:
■ The overall health of SharePoint Portal.
■ The overall health of resources that are being utilized. ■ The overall health of web frontends.
■ The overall health of SharePoint services.
■ The overall health of the user resources. The alerts that are associated with user
resources depict the health of IIS Web servers.
■ The overall health of the application events.
■ The overall health of the database and its operations.
SharePoint Web Frontends
The dashboard shows:
■ The overall health of Applications, Site Collections, and Sites.
■ Active sites.
■ Page Hits.
■ The graphs for Resource use.
View SharePoint Services
The dashboard shows the overall health of the following services:
■ Cache ■ Excel ■ Form ■ Search ■ SSO ■ Web Application
View Metric Groupings and Alerts
Chapter 3: Using the Extension 35 Follow these steps:
■ Double-click an alert.
The dashboard that is associated with the alert appears.
■ Double-click a tab on the dashboard.
The dashboard that is associated with the tab appears. For example:
Double-click the Web Frontends tab on the SharePoint Overview dashboard. The SharePoint Web Frontends dashboard appears.
■ Right-click a graph or an alert, and select Links. Navigate to the corresponding alert
in the Management Module or another dashboard that is associated with it.
■ Double-click a metric from the chart displaying top ten slowest metric data. The metric details appear in the Investigator.
Important! To view Backends and IIS Performancedashboard data, install the extension for Web Servers and CA Insight Bridge for CA Introscope® with CA APM for Microsoft SharePoint.
View Metric Groupings and Alerts
You can view the metric groupings and Alerts for SharePoint Portal using the Management Module Editor and Investigator.
Follow these steps:
1. In the Investigator, click Workstation > New Management Module Editor. The Management Module Editor opens.
2. Expand the following nodes: a. Super Domain
b. Management Modules
View Metric Groupings and Alerts
36 for Microsoft SharePoint Guide
3. Expand the Metric Grouping node.
All metric groupings for SharePoint Portal appear. 4. Click a metric grouping.
The metric grouping appears in the Viewer pane.
5. Click Elements > New Metric Grouping to create a metric grouping that is based on the SharePoint Portal management module.
Note: For information about creating and defining metric groupings, see the CA
APM Configuration and Administration Guide.
To view SharePoint Portal Alerts using Management Module Editor
1. In the Investigator, click Workstation > New Management Module Editor. The Management Module Editor opens.
2. Expand the following nodes: a. Super Domain
b. Management Modules
c. SharePoint_Management Module 3. Expand the Alerts node.
All alerts for SharePoint Portal appear. 4. Click an alert.
The alert appears in the Viewer pane. 5. Click Elements > New Alert to create an alert.
Note: For information about creating and defining Alerts, see the CA APM Configuration
and Administration Guide.
To view SharePoint Portal Alerts using the Investigator 1. In the Investigator, expand the following nodes:
a. Super Domain b. Custom Metric Host c. Custom Metric Process d. Custom Metric Agent e. Alerts
View SharePoint Portal Services Metrics and Events Information
Chapter 3: Using the Extension 37 2. Expand the SharePoint_Management Module node.
All alerts for SharePoint Portal appear. 3. Click an alert.
The status for the alert appears in the Viewer pane.
View SharePoint Portal Services Metrics and Events
Information
You can view availability and health of SharePoint Portal services and events information in the Investigator tree.
The extension determines SharePoint-related events by using Windows Management Instrumentation (WMI). The extension monitors all application events on all SharePoint servers through WMI. The Windows events matching the event sources listed in the SPEvents.list file are reported to the Enterprise Manager.
The extension also gathers metric data about health of the SharePoint Portal services through the Performance Monitor (PerfMon) counters. The metrics appear in the Investigator tree.
Follow these steps:
Note: When you click Workstation > New Investigator and click a node in the Investigator tree, the Viewer pane refreshes and displays correct values. 1. Open the Investigator.
2. Click the SharePoint Monitor > SharePoint Services and Event Monitor Agent (*SuperDomain*) > SharePoint Monitor > SharePoint Services and Event Monitor Agent (*SuperDomain*) > SharePoint Monitor > <Farm_name> node.
Note: The Farm name displayed in the Investigator tree is the SharePoint Database name.
In the Viewer pane, the Farm Services Overview tab is active by default. The tab displays service availability information of Excel, Search, Single Sign-On, and Web Application services for all farm servers.
3. Click the Farm Events Overview tab in the Viewer pane.
The tab displays alerts for the error count, information count, and warning count for all the farm servers.
The threshold default values for the alerts follow:
■ For the error count, the caution threshold is 5 and the danger threshold is 10.
■ For the warning count, the caution threshold is 25 and the danger threshold is 50.
View SharePoint Portal Services Metrics and Events Information
38 for Microsoft SharePoint Guide
4. Expand the <Farm_name> node and click a <Server_name> that belongs to the farm.
In the Viewer pane, the Services Overview is active by default. The tab displays service availability information of Excel, Search, Single Sign-On, and Web Application services for the selected server.
5. Click the Events Overview tab in the Viewer pane.
The tab displays alerts for the error count, information count, and warning count for the selected server.
The threshold default values for the alerts follow:
■ For the error count, the caution threshold is 5 and the danger threshold is 10.
■ For the warning count, the caution threshold is 25 and the danger threshold is 50.
6. Expand the <Server_name> node and select Applications Events or Services.
■ When you select Application Events, the Events Overview tab is active by default in the Viewer pane. The tab displays the error count, information count, and warning count for the selected server.
■ When you select Services, the Services Overview tab is active by default in the Viewer pane. The tab displays service availability information of Excel, Search, Single Sign-On, and Web Application services for the selected server.
7. Expand the Services nodes. The following subnodes appear:
■ Cache ■ Excel ■ Form ■ Search ■ Single Sign-On ■ Web Application
Note: Cache and Form nodes might not be available if the Cache or Form service is idle on the servers that are being monitored. The nodes appear automatically when their respective PerfMon counters are available.
8. Expand the subnodes.
The metrics for each subnode appear.
Note: If the services are not available, the Investigator tree shows the status for the service as disabled. The tree does not display performance metrics for the services.
View SharePoint Portal Services Metrics and Events Information
Chapter 3: Using the Extension 39 The following table summarizes the details that you can view in the Viewer pane, when you select a subnode:
For this service You see
Cache No data.
Cache > <Performance category> Aggregated data for metrics that are set to minimum in
SPPerfCounters.list.xml for the selected <Performance category> are displayed in a graphical format.
Cache > <Performance category> > <Performance category instance>
All instances metrics that are set to minimum in SPPerfCounters.list.xml for the selected <Performance category> are displayed in a graphical format.
Cache > <Performance category> > <metric>
Data for the selected metric in a graphical format.
Excel Status value for Excel service in a graphical format.
Excel > <Performance category> Aggregate of metrics that are set to minimum in SPPerfCounters.list.xml for the selected <Performance category> are displayed in a graphical format.
Excel > <Performance category> > <metric>
All instances metrics that are set to minimum in SPPerfCounters.list.xml for the selected <Performance category> are displayed in a graphical format.
Form No data.
Form > <Performance category> Aggregated data for metrics that are set to minimum in
SPPerfCounters.list.xml for the selected <Performance category> are displayed in a graphical format.
Form > <Performance category> > <Performance category instance>
All instances metrics that are set to minimum in SPPerfCounters.list.xml for the selected <Performance category> are displayed in a graphical format.
Form > <Performance category> > <metric>
Data for the selected metric in a graphical format.
Search Status value for Search service in a graphical format.
Search > <Performance category> Aggregated data for metrics that are set to minimum in
SPPerfCounters.list.xml for the selected <Performance category> are displayed in a graphical format.
View Overall Performance of SharePoint Portal and its Components Using sharepoint-typical PBD
40 for Microsoft SharePoint Guide
For this service You see
Search > <Performance category> > <Performance category instance>
All instances metrics that are set to minimum in SPPerfCounters.list.xml for the selected <Performance category> are displayed in a graphical format.
Search > <Performance category> > <metric>
Data for the selected metric in a graphical format.
Single Sign-On Status value for Single Sign-On service in a graphical format. Single Sign-On > <Performance
category>
All instances metrics that are set to minimum in SPPerfCounters.list.xml for the selected <Performance category> are displayed in a graphical format.
Single Sign-On > <Performance category> > <metric>
Data for the selected metric in a graphical format.
Web Application Status value for Web Application service in a graphical format. Web Application > <Performance
category>
Aggregated data for metrics that are set to minimum in
SPPerfCounters.list.xml for the selected <Performance category> are displayed in a graphical format.
Web Application > <Performance category> > <Performance category instance>
All instances metrics that are set to minimum in SPPerfCounters.list.xml for the selected <Performance category> are displayed in a graphical format.
Web Application > <Performance category> > <metric>
Data for the selected metric in a graphical format.
You have now viewed the SharePoint Portal services metrics and events information. Refer to PerfMon metrics (see page 53) for details of the Performance Monitor (PerfMon) metrics that are displayed for each SharePoint Portal service.
View Overall Performance of SharePoint Portal and its
Components Using sharepoint-typical PBD
You can view the overall performance of SharePoint Portal and its component in the Investigator tree by using sharepoint-typical PBD. CA Introscope® displays the metrics for SharePoint Portal and its components in the Viewer pane of the Investigator tree.
View Overall Performance of SharePoint Portal and its Components Using sharepoint-typical PBD
Chapter 3: Using the Extension 41 Follow these steps:
1. Open sharepoint.pbl present in the <Agent_Home> directory and verify that the entry for sharepoint-typical.pbd is uncommented. If it is not uncommented, uncomment the entry for sharepoint-typical.pbd to enable it and save the sharepoint.pbl file.
2. If you have uncommented the entry for sharepoint-typical.pbd, restart the SharePoint Portal Server for the changes to take effect.
3. Verify that Enterprise Manager is running.
4. Launch the Workstation by clicking Start > Programs > CA APM > Introscope
<version> > Introscope Workstation.
5. Log in to the Workstation. The Workstation appears.
6. Navigate to the Workstation Investigator by clicking Workstation > New Investigator.
7. In the Investigator, click the *SuperDomain* > <Host_name> > .NET Process >
<Agent_name> > SharePoint-Typical node. Or you can click any of the following
subnodes for which you want to view the metrics:
■ Site Collections
■ <Site_Collection_name>
■ Sites
■ <Site_name>
The Overview tab is active by default and displays metrics for to assess the overall performance of SharePoint Portal and its components.
The Overview tab displays the following information for each node in the Investigator tree:
■ SharePoint-Full
Data for all the metrics that are associated with the web application to assess its overall performance. All the site collections that the SharePoint Portal is using are listed in a table. The table also displays the Average Response Time, Concurrent Invocations, Errors Per Interval, Responses Per Interval, and Stall Count for each Site Collection.
■ SharePoint-Full > Site Collections
Data for Page Hits and Active Sites metrics for SharePoint Portal. All the site collections of the SharePoint Portal are listed in a table. The table also displays the Average Response Time, Concurrent Invocations, Errors Per Interval, Responses Per Interval, and Stall Count for each Site Collection.
View Worst Performing Pages Using sharepoint-full PBD
42 for Microsoft SharePoint Guide
■ SharePoint-Full > Site Collections > <Site_Collection_name>
Data for all the metrics that are associated with the selected Site Collection to assess its overall performance. All the Sites under the selected Site Collection are listed in a table. The table also displays the Average Response Time, Concurrent Invocations, Errors Per Interval, Responses Per Interval, and Stall Count for each Site.
■ SharePoint-Full > Site Collections ><Site_Collection_name> > Sites
All the Sites under the selected Site Collection in a table. The table also displays the Average Response Time and Responses Per Interval for each Site.
■ SharePoint-Full > Site Collections ><Site_Collection_name> > Sites > <Site_name>
Data for Average Response Time and Responses Per Interval metrics for the selected site to assess its performance.
Note: The Average Response Time and Responses Per Interval metrics are shown only if the TurnOn: SiteARTTracing and TurnOn: SiteRPITracing tracers are uncommented in the sharepoint-typical.pbd.
View Worst Performing Pages Using sharepoint-full PBD
You can view the worst performing pages of the SharePoint Portal Server in theInvestigator tree by using sharepoint-full PBD. The worst performing pages are displayed in a table in the Viewer pane. The components are sorted on the Average Response Time. You can generate a graphical view that is based on the table and view how the pages can affect other components in the SharePoint Portal.
Follow these steps:
1. Open sharepoint.pbl present in the <Agent_Home> directory, uncomment the entry for sharepoint-full.pbd to enable it, and save the sharepoint.pbl file.
2. Restart the IIS Server. The changes take effect.
3. Verify that Enterprise Manager is running.
4. Launch the Workstation by clicking Start > Programs > CA APM > Introscope
<version> > Introscope Workstation.
5. Log in to the Workstation. The Workstation appears.
View Worst Performing Pages Using sharepoint-full PBD
Chapter 3: Using the Extension 43 6. Navigate to the Workstation Investigator by clicking Workstation > New
Investigator.
7. In the Investigator, click the *SuperDomain* > <Host_name> > .NET Process >
<Agent_name> > SharePoint-Full node. Or you can click any of the following
subnodes for which you want to view the worst performing components:
■ Site Collections ■ <Site_Collection_name> ■ Sites ■ <Site_name> ■ Pages ■ <Page_name>
In the Viewer pane, the Details tab is active by default. Depending on the node you selected, a list of pages is displayed in a table. Nodes and the associated pages details are as follows:
■ SharePoint-Full
List of pages across the SharePoint Portal with the following information: – The page names
– The Site and Site Collection to which the page belongs – The Average Response Time for each page
■ SharePoint-Full > Site Collections
List of pages for all Site Collections with the following information: – The page names
– The Site and Site Collection to which the page belongs – The Average Response Time for each page
■ SharePoint-Full > Site Collections > <Site_Collection_name>
List of pages for the selected Site Collection with the following information: – The page names
– The Site to which the page belongs – The Average Response Time for each page
View Worst Performing Pages Using sharepoint-full PBD
44 for Microsoft SharePoint Guide
■ SharePoint-Full > Site Collections ><Site_Collection_name> > Sites List of pages for all Sites under the selected Site Collection and shows the following information:
– The page names
– The Site to which the page belongs – The Average Response Time for each page
■ SharePoint-Full > Site Collections ><Site_Collection_name> > Sites > <Site_name>
List of pages for the selected Site that is under the selected Site Collection and shows the following information:
– The page names
– The Average Response Time for each page
Note: The Average Response Time and Responses Per Interval metrics are shown only if the TurnOn: SiteARTTracing and TurnOn: SiteRPITracing tracers are uncommented in the sharepoint-full.pbd
■ SharePoint-Full > Site Collections ><Site_Collection_name> > Sites > <Site_name> > Pages
List of pages for the selected Site that is under the selected Site Collection and shows the following information:
– The page names
– The Average Response Time for each page
■ SharePoint-Full > Site Collections ><Site_Collection_name> > Sites > <Site_name> > Pages > <Page_name>
List of Sites and Site Collections that contain the selected page and the Average Response Time for the page.
8. 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! A number greater than 25 for Top N can affect performance on the Workstation.
For example, select 10 from the Top N drop-down list to view top ten worst performing pages.
9. Select a page from the table and click Detail.
The table displays the sites and site collections that contain the selected page, and the Average Response Time.