You are here

Office365 SharePoint

Requires Opsview Monitor 6
check_circle
Opsview Supported
by Pius Surendralal

404: Not Found

Application - Office365 - SharePoint Opspack

SharePoint is a web-based collaborative service integrated with Office365, allowing users to collaborate in real time on Word, PowerPoint and Excel Documents as well as upload files and download files uploaded by other users.

What You Can Monitor

This Opspack allows you to monitor your Office365 Subscription's SharePoint service, providing information on the service status and the storage usage of the entire userbase.

We recommend adding the "Application - Office365" - Overview Host Template to your Host when using this template to give you a better overview of your Office365 subscription.

Service Checks

Host Template Service Check Description
Application - Office365 - SharePoint Office365 - SharePoint - Service Status The service status of SharePoint and any reported issues
Application - Office365 - SharePoint Office365 - SharePoint - Storage Usage The storage usage of SharePoint

Prerequisites

  • Ensure your Opsview Monitor version is newer than 07 September 2018. Check Opsview Release Notes for the latest version of Opsview Monitor.

Known Issues

  • As of the time of development, an issue exists with Microsoft's Graph API HTTP 429 Too Many Requests responses. These are received when too many requests are made in a short period of time. The issue lies in that the Retry-After value in the header of the response is always 86 which inhibits us from using this value to know when to retry. As a result, the checks using this API will wait for 5 seconds before retrying, up to a maximum of 5 times.

Setup Office365 for Monitoring

To monitor your Office365 environment, you will need to retrieve the following credentials, which will allow Opsview Monitor access to the metrics for your Office365 Subscription:

  • Tenant/Directory ID
  • Client/Application ID
  • Secret Key

Follow the steps below to retrieve this information.

Step 1: Find the Tenant ID

The Tenant/Directory ID can be found in the Azure Active Directory under the Properties section from the Azure dashboard.

Find Azure Tenant/Directory ID

Find Azure Tenant/Directory ID

Step 2: Find the Client/Application ID for your application

You need to create and register your application if you haven't already. Use the following documentation from Microsoft: Create an Azure Active Directory application

The Client/Application ID can be found in Azure Active Directory under the App registrations section from the Azure dashboard.

Find Azure Client/Application ID

Find Azure Client/Application ID

Step 3: Generate the Secret Key for your application

You will need to create a Secret Key for your application, once this has been created its value will be hidden so save the value during creation.

To create the Secret Key, select your application from the list, select the Settings within your application and then select the Keys option.

There you can create a new key by adding the description and expiration period and the value will be generated.

Create Secret Key

Step 4: Add Required Permissions

The appropriate permissions for the APIs used by these Office365 Host-Templates need to be added in Azure. From the same settings menu as above, go to Required Permissions under API ACCESS. Click Add, select the API and then choose the permissions for that API based on the table below.

API Application Permissions Delegated Permissions
Microsoft Graph
  • Read all usage reports
  • Read your organization’s security events

|

  • Read all usage reports
  • Read your organization’s security events

| | Office 365 Management APIs |

  • Read activity data for your organization
  • Read service health information for your organization

|

  • Read activity data for your organization
  • Read service health information for your organization

|

Add Permissions

Add Permissions

Step 1: Import the Opspack

Download the application-office365-sharepoint.opspack file from the Releases section of this repository. Navigate to Host Templates inside Opsview Monitor under the Configuration tab and select Import Opspack in the top left corner.

Add Variables

Then click Browse and select the application-office365-sharepoint.opspack file. Click Upload and then click Import when the file is uploaded. You may see a 'CONFLICT' warning message after uploading - this is because all 'Application - Office365' Opspacks utilize the same variable (OFFICE365_CREDENTIALS) for authorizing access to your resources. Just click Overwrite and the Opspack will import successfully.

Add Variables

Step 2: Add the host template

Add the relevant host template (as listed in the Service Checks table above). If the resource has no hostname or public IP, then change Host Check Command to Always assumed to be UP.

Add Host Template

Step 3: Add and configure variables required for this host

  • OFFICE365_CREDENTIALS

Add 'OFFICE365_CREDENTIALS' to the host, then override the Client ID, Secret Key and Tenant ID to match the values retrieved earlier.

Add Variables

Step 4: Apply changes and the system will now be monitored

View Output

v2.1-opsview-6

ODI-2293 v2.1-opsview-6

Improve datetime retrieval

v2.0-opsview-6

ODI-38 v2.0-opsview-6

Initial release of Opspack to work with Opsview Monitor 6.0