Introduction

The On Premise Diagnostic (OPD) for SharePoint is a collection of diagnostic scenarios, analyzers, rules, and insights for diagnosing common issues in the SharePoint 2016 and 2019 On Premise environments.

Supported Products
Downloads
Download latest release

Getting Started

The following is required for successful operation

1. PowerShell 5.0 (or greater) installed on the host machine. Click here for details on how to get the latest version for your computer.
2. A connection to the internet (required for update checks and telemetry upload).
3. OPD for SharePoint requires Farm and Machine administrative permissions to perform all checks.

Installation Instructions

Detailed instructions on how to install/upgrade the latest version of OPD can be found here.

Operational Instructions

Detailed instruction on how to operate OPD can be found here.

Telemetry Information

To understand exactly what information is recorded and potentially uploaded to Microsoft, click here.

Development Instructions

Detail instruction on how to develop diagnostics leveraging the OPD framework cane be found here:

• Creating a new project hierarchy.
• Creating your first insight/rule/analyzer/scenario.

Support

If you encounter an issue with OPD for SharePoint, please select the appropriate link below:

• General questions
• Bug/Exception
  • Please include the following in your bug/exception report
    • Version of OPD for SharePoint - this can be found in the title bar of the console window. Or, you can run OPD with the -DiagnosticData option and paste the output (already in your clipboard) into the bug.
    • Screen shot of error/exception
    • Steps to reproduce the error/exception
• New scenario/feature
  • Please include the following in scenario/feature request
    • How does the issue present itself to an end user (scenario)
    • How do we determine that the specific issue exists (rules)
    • What should be displayed to the end user when we find a specific issue and how can it be resolved (insights)