Pre-requisites for Monitoring Microsoft SharePoint

Different pre-requisites apply to different tests that the eG agent runs on a SharePoint server/farm. The table below details these pre-requistes:

Tests

Pre-reequisites

Tests that monitor specific services on the SharePoint server, namely:

  • Distributed Cache Service Test
  • Excel Calc Services Test
  • Excel Services Application Browser Test
  • Excel Services Application WFE Test
  • OSS Search Archival Plugin Test
  • OSS Search Gatherer Databases Test
  • OSS Search Indexer Plugin Test
  • OSS Search Schema Plugin Test
  • OSS Secure Store Credentials Test
  • OSS Secure Store Tickets Test
  • Search Flow Test
  • Search Gatherer Threads Test
  • Search Gatherer Transactions Test
  • Search Submission Test
  • SharePoint Foundation Test
  • SharePoint Foundation Search Gatherer Test
  • SharePoint Foundation Search Indexer Test
  • SharePoint Foundation Search Schema Test
  • SharePoint Request Management Test
  • SharePoint Search Archival Test

For these tests to run and report metrics, the corresponding service should be running on the target SharePoint server. For instance, if the Distributed Cache Service is not available on a monitored SharePoint server, then the Distributed Cache Service Test will not run on that server.

 Site Availability Test

This test should be configured with the credentials of a user with read-only access to the site configured.

Tests that report usage analytics, namely:

  • Browser Usage Analytics Test
  • Distributed Cache Usage Analytics Test
  • Site Usage Analytics Test
  • User Analytics Test
  • Web Application Usage Analytics Test
  • These tests will run only if a SharePoint Usage and Health Service application is created and is configured to collect usage and health data. To know how to create and configure this application, follow the steps detailed in Configuring the eG Agent to Collect Usage Analytics.
  • These tests should be configured with the credentials of a user who is assigned the db_datareader role to the SharePoint Logging database.

Critical or Slow Web Parts Test

  • This test will run only if a SharePoint Usage and Health Service application is created and is configured to collect usage and health data. To know how to create and configure this application, follow the steps detailed in Configuring the eG Agent to Collect Usage Analytics.
  • The SharePoint Developer Dashboard should be enabled. The steps for the same are detailed in Enabling the SharePoint Developer Dashboard
  • This tests should be configured with the credentials of a user who is assigned the db_datareader role to the SharePoint Logging database.

All other tests, such as:

  • Backup and Restores Test
  • Health Analyzer Alerts Test
  • SharePoint Databases Test
  • SharePoint Document Libraries and Lists Test
  • SharePoint Documents Test
  • SharePoint Farm Test
  • SharePoint File Types Distribution Test
  • SharePoint SiteCollections and Sites Test
  • SharePoint Web Applications Test
  • SharePoint Web Parts Test
  • Timer Jobs Test
  • ULS Logs Test

If the Fetch Farm Measures flag of these tests is set to No or to If Central Administration Site, then these tests should be configured with the credentials of a user with the following privileges:

On the other hand, if the Fetch Farm Measures flag of these tests is set to Yes, then the user configured for the tests not only requires the four privileges discussed above, but should also be part of the following groups on the eG agent host:

  • Administrators

  • WSS_ADMIN_WPG

  • IIS_USRS

  • Performance Monitor Users

  • WSS_WPG

  • Users