Installation - microsoft/SqlNexus GitHub Wiki

Requirements

For SQL Nexus version 7.24.02.18 and later, the following must be installed:

• RML Utilities
• .NET Framework 4.8
• An instance of SQL Server 2016 or later to import data into. It does not need to be on the same machine where you run SQL Nexus

For SQL Nexus version 7.23.06.06 or earlier, the following must be installed:

• CLR Types
• Report Viewer
• RML Utilities
• .NET Framework 4.8
• An instance of SQL Server 2016 or later to import data into. It does not need to be on the same machine where you run SQL Nexus

Data Collection Tool (Recommended)

SQL Nexus analyzes diagnostic data collected from your SQL Server. You will also need one of the following data collection tools:

• SQL LogScout (recommended) — modern, lightweight collection tool for SQL Server on Windows and Linux
• PSSDIAG/DiagManager — legacy SQLDiag-based collection tool

Automated Installation of Prerequisites

You can use the following PowerShell script to install all prerequisites automatically:

1. Copy the file (or its contents to a new file with a .ps1 extension) onto the target system

2. Run using the following command:

   powershell -File SetupSQLNexusPrereq.ps1

Installation Steps

1. Download the latest binary files from Releases
2. Unzip the file to a local directory
3. Run sqlnexus.exe to start SQL Nexus

⚠️ Important: Do not point SQL Nexus at a production SQL Server instance. Use a dedicated non-production instance for importing and analyzing data.