Knowledge Base

Technical solutions and best practices to configure our products.
Type
  • Configuration Template
Related Product
  • Monitoring Studio KM for PATROL
  • Summary
    • This article explains how to monitor SharePoint 2013 or 2010 with Monitoring Studio to detect failures, errors, and performance issues.
    KNOWLEDGE BASE

    Monitoring SharePoint

    KB1175 - Updated on September 6, 2016

    Download File


    Important: The SharePoint configuration template is not compatible with Monitoring Studio KM for PATROL v9.0

    Introduction

    SharePoint is widely used by organizations to share or access information across departments and is, for most professionals, meant to always be available and must therefore be thoroughly monitored.

    To detect failures, errors, and performance issues in their SharePoint environment, PATROL administrators can rely on Monitoring Studio KM for PATROL, a configurable module for BMC PATROL. This Knowledge Module enables to monitor almost any technology for which there is no out-of-the box monitoring solution. In a few clicks and thanks to intelligent wizards, PATROL administrators can “create” the monitoring of anything. The “setup” of the monitoring is stored in the PATROL Agent’s configuration.

    To help administrators monitor their SharePoint environment, Sentry has created a SharePoint pre-built configuration. This article describes the components monitored by this pre-built configuration, how to import it into the PATROL console and how to customize it to fully meet the administrators’ needs.

    For more information about Monitoring Studio, please refer to the product page.

    SharePoint KM has reached End of Life!

    BMC Software and Sentry Software recently announced the End of Life for SharePoint KM for PATROL. For all users who wish to continue monitoring their SharePoint environment, a substitute product is available: Monitoring Studio and its SharePoint pre-built configuration.

    Using the SharePoint Pre-Built Configuration

    Monitored components

    The SharePoint pre-built configuration developed by Sentry Software monitors the following components:

    Database

    Objects are dynamically created for each Microsoft SQL Server instance declared as a Content Database of the monitored SharePoint server.
    If the Microsoft SQL server is stopped or if there is an issue with the database server, these instances will go missing and a “missing object” alert will be triggered.

    By default, the missing instances will be deleted after 5 polling cycles. This setting can be modified by right-clicking the Dynamic Object icon > [KM Commands] > [Edit] and modifying the Delete missing objects option.

    Refer to the Appendix to obtain the exhaustive list of parameters and the default thresholds for this monitored component.

    Event Log

    When Microsoft SharePoint encounters a problem, it reports it as an event in the Windows Event Log dedicated to Microsoft SharePoint Foundation. These events are constantly monitored by the Monitoring Studio and any “Audit Failure”, “Error” and “Warning” event related to SharePoint Foundation in the Windows Event Log will be reported in the console.

    Refer to the Appendix to obtain the exhaustive list of parameters and the default thresholds for this monitored component.

    Performance Metrics

    Many performance counters are monitored constantly to report the activity of Microsoft SharePoint and detect potential performance bottlenecks. Each performance counter is represented as a separate instance in the PATROL Console, grouped by the class of the corresponding Windows performance object.

    The performance metrics for objects such as .NET CLR Memory, ASP .NET, Memory, MSSQL, Physical Disk and Virtual Server Web Service are all monitored. The SharePoint pre-built configuration provides a set of predefined thresholds for some parameters. However, they can be customized based on the customer’s environment.

    Refer to the Appendix to obtain the exhaustive list of parameters and the default thresholds for this monitored component.

    Windows Processes

    Key performance metrics are constantly monitored for all of the Microsoft SharePoint processes. Each process is monitored independently and displayed as a separate object in the console. The template monitors the following processes:

    • hostcontrollerservice.exe
    • lsass.exe
    • mssearch.exe
    • noderunner.exe
    • Owstimer.exe
    • SPUCHostService.exe
    • SPUCWorkerProcess.exe
    • SPUCWorkerProcessProxy.exe
    • sqlservr.exe
    • w3wp.exe
    • wsstracing.exe

    For each of these processes, the following parameters are provided:

    • HandleCount
    • PageFaultsPerSec
    • PagefileBytes
    • PrivateBytes
    • ProcessorTime
    • ThreadCount
    • VirtualBytes
    • WorkingSet

    SharePoint Service Instances

    The SharePoint pre-built configuration monitors all the services instances of the entire SharePoint farm:

    • All the services that run under SharePoint will be discovered and an alert will be triggered if the service goes missing.
    • Their status will be checked and an alert will be triggered if the service is stopped.

    Sites

    The SharePoint pre-built configuration monitors the HTTP availability and status of all the sites in Microsoft IIS.

    HTTP Availability

    HTTP Availability of the sites can be configured manually by simply creating a Web Request analysis from the PATROL Console. Depending on the version of Monitoring Studio used, the procedure will differ. Refer to the v8.7 or v9.x documentation for more details.

    Status

    • The status of all the sites under SharePoint is monitored by default. String search to alert on the sites that are stopped can be configured in addition.

    Web Application

    The SharePoint pre-built configuration monitors all the Application Pools in Microsoft IIS, their corresponding Windows processes and:

    • Discovers all the Service Application Pools present and triggers a missing object alert when a Service Application Pool goes missing.
    • Gets the list of Windows processes related to the Web Application Services.

    Windows SharePoint Services

    The SharePoint pre-built configuration monitors the status of the services listed below:

    • IIS ADMIN Service
    • SharePoint Administration Service
    • SharePoint Search Host Controller Service
    • SharePoint Timer Service
    • SharePoint Tracing Service
    • World Wide Web Publishing Service

    Each service is represented as a separate object in the console. The “Status” parameter reports the status of the service. This parameter will trigger an alarm if the service is stopped and a warning if the service is in an intermediate state (stop pending, paused, etc.).

    Importing the SharePoint Pre-Built Configuration

    Overview

    The SharePoint Pre-Built Configuration available to download in this KB article consists of the following files:

    SharePoint2013-for-MS-8x-v1.0.zip
    Download this zip file if you are using Monitoring Studio 8.x. It contains:

    • 3 PowerShell scripts:
      • SPDatabase.ps1
      • SPServiceApplicationPool.ps1
      • SPServiceInstance.ps1
    • 2 SharePoint pre-built configuration templates:
      • SharePoint2013_MicrosoftSQLServer2008.cfg (Microsoft SQL Server 2008 compatible)
      • SharePoint2013_MicrosoftSQLServer2012.cfg (Microsoft SQL Server 2012 compatible)

    SharePoint2013-for-MS-9x-v1.0.zip
    Download this zip file if you are using Monitoring Studio 9.1 or higher. It contains:

    • 3 PowerShell scripts:
      • SPDatabase.ps1
      • SPServiceApplicationPool.ps1
      • SPServiceInstance.ps1
    • 1 SharePoint pre-built configuration template

    SharePoint2010-for-MS-9x-v1.0.zip
    Download this zip file if you are using Monitoring Studio 9.1 or higher. It contains:

    • 3 PowerShell scripts:
      • SPDatabase.ps1
      • SPServiceApplicationPool.ps1
      • SPServiceInstance.ps1
    • 1 SharePoint pre-built configuration template

    Prerequisites

    In order to setup the monitoring of Microsoft SharePoint, you will need to make sure the following items are available, installed and properly configured:

    • A fully functional BMC PATROL environment (optionally part of a larger TrueSight Operations Management environment), with a BMC PATROL Console
    • A PATROL Agent on the SharePoint Server itself
    • Monitoring Studio KM for PATROL v8.6.54 or v9.1 (or higher) installed on the agent on the SharePoint Server itself
    • Monitoring Studio KM for PATROL v8.6.54 or v9.1 (or higher) properly loaded on the PATROL agent and in the console
    • The .cfg files installed in a folder on the SharePoint Server itself
    • The PowerShell scripts stored in a folder on the SharePoint Server itself
    • The PATROL Agent default account or a specific user account configured with the rights to execute the SharePoint cmdlets Get-SPDatabase, Get-SPServiceApplicationPool, and Get-SPServiceInstance.

    Recommended Procedure

    The procedure will differ depending on the version of Monitoring Studio used.

    For Monitoring Studio 8.6.54 or 8.7

    To import the SharePoint pre-built configuration:

    1. From the PATROL Console, [right-click] the main “Monitoring Studio” icon › [KM Commands] › [Configuration] › [Import Configuration…]
    2. Enter the path of the folder where you have stored the .cfg file (this path is on the agent, on the SharePoint Server) and click [Next]:
    3. Select the configuration file in the list:
    4. Monitoring Studio checks the content of the file. This process can take a few minutes (the configuration file is rather large).
    5. Monitoring Studio is ready to import the configuration. Click [Finish] to start the import.
    6. The import process can take a few minutes:

    After the import process completes, Monitoring Studio KM starts creating the icons corresponding to the monitored objects in the PATROL Console. The icons are kept OFFLINE and the actual monitoring does not start until you enter a valid value for the %{SCRIPTPATH} application constant.

    To set the application constants value:

    1. [right-click] the “SharePoint” icon in the PATROL Console › [KM Commands] › [Modify Application Constants…]
    2. Next to the %{SCRIPTPATH} constant, enter the path of the folder where the PowerShell scripts are stored
    3. (Optional) Enter the SharePoint username and password in the %{SPUSERNAME} and %{SPPASSWORD} fields if you wish to execute the scripts and commands as a specific user.
      Important: The user specified must have the rights to execute the SharePoint cmdlets Get-SPDatabase, Get-SPServiceApplicationPool, and Get-SPServiceInstance.
    4. Click [OK]. All the icons now appear ONLINE:

    For Monitoring Studio 9.1 or higher
    To import the SharePoint pre-built configuration:

    1. From the PATROL Console, [right-click] the main “Monitoring Studio” icon › [KM Commands] › [Configuration] › [Import Configuration…]
    2. Enter the path of the folder where you have stored the configuration file (this path is on the agent, on the SharePoint Server) and click [Next]:
    3. Select the configuration file in the list. Monitoring Studio checks the content of the file. This process can take a few minutes.
    4. Configure the following group constants:
      • SCRIPTPATH: path of the folder where the PowerShell scripts are stored
      • SPHOSTNAME: name of the host where SharePoint is installed
      • (Optional) SPUSERNAME and SPPASSWORD: SharePoint username and password to be used to execute the scripts and commands as a specific user. The user specified must have the rights to execute the SharePoint cmdlets Get-SPDatabase, Get-SPServiceApplicationPool, and Get-SPServiceInstance.
      • Click [Next]
    5. Click [Next]
    6. Enter the host information:
      • Hostname/IP address/FQDN: Enter the Hostname, IP address or Fully Qualified Domain Name of the host on which SharePoint is running.
      • (Optional) Display Name: Enter the name that will be displayed in the console for this host.
      • (Optional) Description: Enter a unique description.
      • Create a separate device in TrueSight: Check this box if you want the remote monitored host to appear as a separate device in TrueSight OM.
      • Click [Next]
    7. Provide the credentials and SNMP information and click [Next].
    8. Check the import summary and click [Next].
    9. Click [Finish].

    Alternate Installation Procedure

    Alternatively, PATROL administrators can use WPCONFIG.EXE, pconfig or PCM (PATROL Configuration Manager) to deploy the configuration file. Once this is done, it is recommended to force a full discovery on the PATROL Agent to make sure Monitoring Studio KM takes into account the new configuration immediately (without waiting for the next discovery cycle, which occurs by default every hour).

    Removing Components

    The different components of Microsoft SharePoint are grouped in containers/folders in Monitoring Studio. In order to identify the components that would need to be removed from the monitoring, you simply have to expand the tree view to find the objects for which the Status parameter cannot be collected (the parameter stays OFFLINE, while the rest of the monitoring is properly collected).
    To remove components from the monitoring, right-click the component icon > [KM commands] > [Delete].

    Appendix

    This section lists all the parameters available for the monitored objects and thresholds set by default:

    Application container Monitored object Parameter Information Warning Alarm
    Database List of available Content Database Status   =1  
    Cache Size (MB) Value   N/A N/A
    Event Log Audit Failure MatchingEventCount   10 - 99 >= 100
    Warning MatchingEventCount   >=1  
    Error MatchingEventCount     >=1
    Performance .NET CLR Memory .NET CLR Memory _Global_ # Bytes in all heaps   N/A N/A
    .NET CLR Memory _Global_ % Time in GC   N/A N/A
    .NET CLR Memory _Global_ Large Object Heap Size   N/A N/A
    ASP.NET ASP.NET Application Restarts   N/A N/A
    ASP.NET Request Execution Time   N/A N/A
    ASP.NET Request Wait Time   N/A N/A
    ASP.NET Requests Queued   100 - 500 >500
    ASP.NET Requests Rejected   1 - 5 >5
    ASP.NET Worker Process Restarts   1 - 5 >5
    Memory MemoryAvailable Mbytes 1 GB - 2 GB <1 GB  
    Memory Pages/sec   >200  
    MSSQL Databases _Total Transactions/sec   N/A N/A
    General Statistics User Connections   N/A N/A
    Locks _Total Lock Wait Time (ms)   >1000  
    Locks _Total Lock Waits/sec   N/A N/A
    Locks _Total Number of Deadlocks/sec   >1  
    SQL Statistics Batch Requests/sec   >100  
    Physical Disk _Total % Disk Time   >80  
    _Total Avg Disk Queue Length   >2  
    _Total Disk Read Bytes/sec   N/A N/A
    _Total Disk Write Bytes/sec   N/A N/A
    Virtual Server
    Web Service
    Web Service _Total Bytes Received/sec   N/A N/A
    Web Service _Total Bytes Sent/sec   N/A N/A
    Web Service _Total Current ISAPI Extension Request   N/A N/A
    Web Service _Total ISAPI Extension Requests/sec   N/A N/A
    Web Service-Current Connections   N/A N/A
    Processes All Windows processes related to SharePoint ChildCount   N/A N/A
      Count     =0
      HandleCount   N/A N/A
      PageFaultsPerSec   N/A N/A
      PagefileBytes   N/A N/A
      PrivateBytes   N/A N/A
      ProcessorTime   >=90  
      ThreadCount   N/A N/A
      VirtualBytes   N/A N/A
      WorkingSet   N/A N/A
    SharePoint Service Instances List of all SharePoint Services Status     !=Online
    Sites Http Availability ExecutionTime   10 - 30 >=30
    List of all sites in the IIS Status   N/A N/A
    Web Application All Web Application Pools Status   =1  
    All Web Application Service Instances PID Status   =1