Knowledge Base

Monitoring SharePoint 2016 and 2019 with Monitoring Studio X

KB1278 - Jan 25, 2021

Type: Best practice

Description: This article explains how to use the free monitoring templates available on GitHub to monitor SharePoint with Monitoring Studio X.

Additional Keywords: Studio X, GitHub, SharePoint, Template, java

Related Topic

Introduction

The Sentry Professional Services team has made available on GitHub free templates for Monitoring Studio X to monitor:

These templates are provided as an example and can be used as a working base for advanced monitoring.

In this article, you will learn how to:

  1. import these templates in Monitoring Studio X
  2. test the configuration against your monitored host
  3. import your configuration into a CMA policy.

Please note that no support is provided for these free templates. For further assistance, please contact Sentry Professional Services.

Prerequisites

Before monitoring your SharePoint environment in Monitoring Studio X, you need to install:

They can be installed on a server different than your SharePoint server.

Procedure

Step 1: Importing the Microsoft SharePoint template in Monitoring Studio X

  1. Download the template appropriate for your Microsoft SharePoint installation:

  2. Import the template in Monitoring Studio X:

    • In your Web browser, enter https://<patrol-agent>:<patrol-agent-port+262>/ where:
      • <patrol-agent> should be replaced by the name of the host on which the PATROL Agent runs
      • <patrol-agent-port+262>should be replaced by the number you obtain when you add 262 to the PATROL Agent port number (example: https://xdemo:3443)
    • Go to the Studio tab and click IMPORT TEMPLATE

      Monitoring SharePoint - Importing the template in Monitoring Studio X

    • Browse for the template you previously downloaded from GitHub (SharePoint.cfg for example). The template is then listed in the Monitoring Templates section:

      Monitoring SharePoint - Template successfully imported in Monitoring Studio X

  3. Create the host to be monitored:

    • In the Monitored Hosts section, click NEW HOST...

      Monitoring SharePoint - Creating the host to be monitored

    • Enter the Hostname or IP Address of the SharePoint server to be monitored

    • Provide the Credentials to be used to connect to the SharePoint server
    • Enable the SHAREPOINT template
    • Click CREATE

    Monitoring SharePoint - Enabling the template

Step 2: Testing the configuration against the monitored host

Once the SharePoint template has been imported and the host to be monitored created, test each Monitor against your host to ensure the template meets your environment needs:

  1. In the Monitoring Studio X Web Interface, go to the Studio tab
  2. Click the SharePoint template

    Monitoring SharePoint - Viewing the template details

  3. Go through the different Monitors. Click for example Database > Content Database

    Monitoring SharePoint - Testing Monitors

  4. In the Dry Run tab, select the host you previously created and click Dry Run

    Monitoring SharePoint - Live Testing Monitors Using the Dry Run Feature

  5. Check the Dry Run results. If problems are detected, make the needed adjustments. If you need assistance at this step, please contact Sentry Professional Services.

You can now monitor your SharePoint environment through the Console tab of the Monitoring Studio X Web Interface. To monitor your environment in TrueSight Presentation Server as well, you need to import your customized template in TrueSight.

Step 3: Importing your customized template in TrueSight

To import your customized template in TrueSight:

  1. From the Monitoring Studio X Web interface:

    • In the Studio tab, click the SharePoint template you customized
    • Note down the Internal ID (sharepoint in our example)

    Monitoring SharePoint - Getting the Internal ID

    • Go to the Export to TrueSight section:

    Monitoring SharePoint - Exporting to TrueSight

    • Click the download button
  2. Log in to TrueSight Presentation Server:

    • Create a Policy. In the Configuration Variables tab, click the action button and select Import

    Monitoring SharePoint - Importing the template in TrueSight

    • Locate the template to import and click Open

    Monitoring SharePoint - Verifying the configuration values in TrueSight

    • Verify the configuration values, change them if required and click Save
    • In the Monitoring tab, click Add Monitoring Configuration and select Monitoring Studio X

    Monitoring SharePoint - Adding Monitoring Studio X as a Monitoring Configuration

    • Configure the Host

    Monitoring SharePoint - Configuring the Host to be Monitored

    • Scroll down to the Templates section to add an associated template. Provide the Internal ID of the Template (sharepoint in our example).

    Monitoring SharePoint - Adding the Associated Template

    • Configure the required settings and click OK
    • Save the policy. The Template and all its properties are imported to the policy and ready to use.