Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 19 additions & 43 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,14 +18,15 @@ Thank you for your interest in contributing to the SQL Server Performance Monito

This repository contains three editions of the SQL Server Performance Monitor:

**Full Edition** — server-installed collectors with a separate dashboard:
**Full Edition (deprecated)** — server-installed collectors with a separate dashboard. The Full Dashboard and the CLI installer are deprecated. No release since v3.3.0 includes them, and their last builds are in the [v3.2.0 release](https://github.com/erikdarlingdata/PerformanceMonitor/releases/tag/v3.2.0). They still build from this repository and are supported for existing users. New deployments use Lite or Darling.

| Folder | Description |
|--------|-------------|
| `install/` | 50+ T-SQL scripts that create the PerformanceMonitor database |
| `Installer/` | CLI installer for the Full Edition database and collectors |
| `Installer.Core/` | Shared installation library (used by CLI installer and Dashboard) |
| `Dashboard/` | WPF dashboard — connects to PerformanceMonitor database, can also install/upgrade via Add Server |
| `upgrades/` | Version-specific upgrade scripts for that database |
| `deprecated/Installer/` | CLI installer for the Full Edition database and collectors |
| `deprecated/Installer.Core/` | Shared installation library (used by CLI installer and Dashboard) |
| `deprecated/Dashboard/` | WPF dashboard — connects to PerformanceMonitor database, can also install/upgrade via Add Server |

**Lite Edition** — standalone desktop app, nothing installed on the target server:

Expand Down Expand Up @@ -87,9 +88,9 @@ dotnet build Darling/PerformanceMonitor.Darling.Viewer/PerformanceMonitor.Darlin

### Running the Applications

**Full Dashboard:**
1. Install the database on a SQL Server instance using the installer
2. Run `Dashboard/bin/Debug/net10.0-windows/Dashboard.exe`
**Full Dashboard (deprecated):**
1. Install the database on a SQL Server instance using the CLI installer in `deprecated/Installer/`
2. Run `deprecated/Dashboard/bin/Debug/net10.0-windows/PerformanceMonitorDashboard.exe`
3. Add your server connection and start monitoring

**Lite Edition:**
Expand All @@ -106,34 +107,9 @@ dotnet build Darling/PerformanceMonitor.Darling.Viewer/PerformanceMonitor.Darlin

## Architecture Overview

### Full Dashboard Architecture
### Full Dashboard Architecture (deprecated)

The Full Dashboard has a clean separation between data collection and display:

```
┌─────────────────────────────────────────────────────────────────┐
│ Monitored SQL Server │
│ ┌─────────────────────────────────────────────────────────┐ │
│ │ PerformanceMonitor Database │ │
│ │ ├── collect.* tables (raw collected data) │ │
│ │ ├── dbo.collect_* procedures (29 collectors) │ │
│ │ ├── report.* views (reporting layer) │ │
│ │ └── config.* tables (schedules, retention, logs) │ │
│ └─────────────────────────────────────────────────────────┘ │
│ ▲ │
│ │ SQL Agent Jobs (every 1 min) │
└───────────────────────────┼─────────────────────────────────────┘
│
│ SQL queries
▼
┌─────────────────────────────────────────────────────────────────┐
│ Dashboard Application │
│ ├── Services/DatabaseService.cs (data access layer) │
│ ├── Models/*.cs (data transfer objects) │
│ ├── ServerTab.xaml (main monitoring UI) │
│ └── Mcp/*.cs (MCP server for LLM integration) │
└─────────────────────────────────────────────────────────────────┘
```
The Full Edition is deprecated, so this guide does not describe its architecture in detail. It installs a `PerformanceMonitor` database on the monitored SQL Server. T-SQL collectors in that database run under SQL Agent, and the Full Dashboard in `deprecated/Dashboard/` reads the data. The scripts are in `install/`. See [`deprecated/Dashboard/README.md`](deprecated/Dashboard/README.md) for the details.

**Key insight:** T-SQL collectors run independently from the C# Dashboard. You can modify collectors without touching C# code, and vice versa.

Expand Down Expand Up @@ -240,19 +216,19 @@ the extension is present, so the same store works on plain PostgreSQL.

| Area | Complexity | Notes |
|------|------------|-------|
| **Full Dashboard T-SQL collectors** | Low | Clean, self-contained stored procedures |
| **Full Dashboard reporting views** | Low | SQL views in `install/47_create_reporting_views.sql` |
| **Dashboard UI improvements** | Medium | WPF/C# in `Dashboard/ServerTab.xaml*` |
| **Full Edition T-SQL collectors (deprecated)** | Low | Clean, self-contained stored procedures |
| **Full Edition reporting views (deprecated)** | Low | SQL views in `install/47_create_reporting_views.sql` |
| **Full Dashboard UI improvements (deprecated)** | Medium | WPF/C# in `deprecated/Dashboard/ServerTab.xaml*` |
| **Lite UI improvements** | Medium | WPF/C# in `Lite/Controls/ServerTab.xaml*` |
| **Bug fixes (either edition)** | Varies | Always welcome |
| **Bug fixes (any edition)** | Varies | Always welcome |
| **Documentation** | Low | README, comments, troubleshooting guides |
| **MCP tool improvements** | Medium | `Dashboard/Mcp/` or `Lite/Mcp/` |
| **MCP tool improvements** | Medium | `Lite/Mcp/`, `Darling/PerformanceMonitor.Darling.Service/Mcp/` or `deprecated/Dashboard/Mcp/` |
| **New Lite collectors** | **High** | See warning below |
| **Darling schema migrations** | **High** | Four coordinated edits — see below |

### Adding a New Full Dashboard Collector
### Adding a New Full Edition Collector (deprecated)

This is the cleanest contribution path. You need to:
The Full Edition is deprecated but still supported for existing users. This is its cleanest contribution path. You need to:

1. **Create the collection table** in `install/02_create_tables.sql`
2. **Create the collector procedure** in a new file `install/XX_collect_your_collector.sql`
Expand Down Expand Up @@ -509,9 +485,9 @@ Use the troubleshooting scripts:
- `install/99_installer_troubleshooting.sql` - Quick health check
- `install/99_user_troubleshooting.sql` - Detailed diagnostics

### Testing Dashboard Changes
### Testing Full Dashboard Changes (deprecated)

1. Build and run the Dashboard
1. Build and run the Full Dashboard from `deprecated/Dashboard/`
2. Connect to a test SQL Server with PerformanceMonitor installed
3. Verify your changes appear correctly
4. Test with different time ranges
Expand Down
13 changes: 8 additions & 5 deletions SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,13 @@ You should receive a response within 72 hours. We will work with you to understa

This policy applies to:

- SQL collection and reporting stored procedures
- Dashboard and Lite WPF applications
- Installer utilities
- SQL installation scripts
- Lite, the desktop app, and its embedded MCP server
- Darling: the service, the viewer, the MCP server, and the web dashboard
- The shared libraries that Lite and Darling use
- The deprecated Full Edition, which is still supported for existing users
- The SQL collection and reporting stored procedures
- The SQL installation scripts in `install/`
- The Full Dashboard and the CLI installer in `deprecated/`

## Security Best Practices

Expand All @@ -32,4 +35,4 @@ When using Performance Monitor:
- Use dedicated service accounts with minimal required permissions
- Enable encryption for SQL Server connections
- Keep your SQL Server instances patched and up to date
- Review the [installation documentation](README.md) for recommended security configurations
- Review the [permissions](docs/permissions.md) and [authentication](docs/authentication.md) documentation for recommended security configurations
4 changes: 3 additions & 1 deletion install/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Install Scripts

SQL scripts that create and configure the PerformanceMonitor database for the Full Edition. The CLI installer (`Installer/`) and Dashboard's Add Server dialog execute these scripts in order against the target SQL Server instance.
> **The Full Edition is deprecated.** These scripts belong to it. No release since v3.3.0 includes the Full Edition, but it is still supported for existing users. New deployments use [Lite](../Lite/README.md) or [Darling](../Darling/README.md).

SQL scripts that create and configure the PerformanceMonitor database for the Full Edition. The CLI installer (`deprecated/Installer/`) and the Add Server dialog of the Full Dashboard (`deprecated/Dashboard/`) execute these scripts in order against the target SQL Server instance.

Scripts create the database, collection tables, configuration tables, stored procedures for each collector, SQL Agent jobs, reporting views, and data retention logic. Each script is idempotent — tables use `IF NOT EXISTS` guards and procedures use `CREATE OR ALTER`, so re-running the installer on an existing installation is safe and preserves collected data.

Expand Down
6 changes: 4 additions & 2 deletions upgrades/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Upgrade Scripts

> **The Full Edition is deprecated.** This whole folder belongs to it. No release since v3.3.0 includes the Full Edition, but it is still supported for existing users. New deployments use [Lite](../Lite/README.md) or [Darling](../Darling/README.md).

This folder contains version-specific upgrade scripts for the Performance Monitor system.

## Structure
Expand Down Expand Up @@ -27,7 +29,7 @@ Each upgrade folder must contain an `upgrade.txt` file listing the SQL files to

## How Upgrades Work

The installer:
The installer (`deprecated/Installer/`, or the Add Server dialog of the Full Dashboard in `deprecated/Dashboard/`):
1. Detects current installed version from `config.installation_history`
2. Determines which upgrade folders to apply
3. Executes upgrade folders in sequence
Expand Down Expand Up @@ -94,4 +96,4 @@ GO

- **2.0.0**: Add server_start_time and delta columns to memory_grant_stats for delta framework; drop unused warning columns; new Memory Grants charts

Future upgrade folders will be added here as new versions are released.
The list above stops at 2.0.0. For later versions, read the scripts in each folder and the [CHANGELOG](../CHANGELOG.md). The newest folder is `3.0.0-to-3.1.0`.
Loading