Documentation / SQL Server Auditor / Getting Started

Getting Started — SQL Server Auditor

Prefer Scenario 1 (all components) for a lab. In production, many teams install the central database first, then the collector service on a jump host, then the dashboard UI for operators.

Installation

Download DBLenseSQLAuditor-Setup.exe from the Downloads page. The setup wizard lets you choose which components to install.

Setup Wizard Steps

  1. Select Components — Check the components you want to install: Central Database, Collector Service, and/or UI Dashboard. You can install all three or just one.
  2. Configure — Enter configuration for each selected component (connection details, install paths, admin account).
  3. Install — The wizard creates the database, copies files, registers the Windows service, and creates shortcuts. Progress is shown per component.
  4. Complete — Summary of installed components with an option to launch the dashboard.

Scenario 1: Install All Components (Full Setup)

Choose this when setting up the audit system for the first time on a single machine.

  1. Run DBLenseSQLAuditor-Setup.exe
  2. Check all three components: Central Database, Collector Service, UI Dashboard
  3. Click Next
  4. Configure the Central Database:
    • SQL Server — The server where the audit database will be created (e.g., localhost or SQLSERVER01)
    • Authentication — Windows Authentication, SQL Server Authentication, or Azure Entra ID
    • Database Name — Default is DBLenseAuditDB
  5. Create the Initial Admin Account:
    • Username — Default is admin
    • Display Name — e.g., Administrator
    • Password — Minimum 6 characters
  6. Configure the Collector Service:
    • Install Path — Default is C:\Program Files\DBLense\AuditCollector
    • The service will automatically use the central database configured above
  7. Configure the UI Dashboard:
    • Install Path — Default is C:\Program Files\DBLense\SQLAuditor
    • Optionally create Desktop and Start Menu shortcuts
  8. Click Install and wait for completion

Scenario 2: Central Database Only

Use this when you want to prepare the audit database on a dedicated SQL Server first, then install the service and dashboard on other machines later.

  1. Run the setup on the machine with access to the target SQL Server
  2. Check only Central Database
  3. Enter the SQL Server connection details and admin account credentials
  4. Click Install — The wizard will:
    • Create the DBLenseAuditDB database (or your chosen name)
    • Create all schema tables: AuditUsers, AuditRegisteredInstances, AuditEvents, AuditSessions, AuditAlerts, AuditServiceConfig
    • Create performance indexes
    • Create the initial admin user

After this, note down the SQL Server name and database name — you will need them when installing the service and dashboard on other machines.

Scenario 3: Collector Service Only

Use this when the central database is already configured (on this or another server) and you need to install the collector service on a monitoring server.

  1. Run the setup on the server where the collector service will run
  2. Check only Collector Service
  3. Click Next
  4. Enter the Install Path for the service files
  5. Since the central database is not being installed in this run, you will be prompted for the Central DB connection details:
    • Central DB Server — The SQL Server hosting the audit database
    • Central DB Name — The database name (default: DBLenseAuditDB)
    • Authentication — How the service authenticates to the central database
  6. Click Install — The wizard will:
    • Copy service files to the install path
    • Write appsettings.json with the central DB connection string
    • Register the DBLenseAuditCollector Windows service (auto-start)
    • Start the service

Scenario 4: UI Dashboard Only

Use this when the central database and collector service are already running, and you want to install the dashboard on a DBA's workstation.

  1. Run the setup on the target workstation
  2. Check only UI Dashboard
  3. Click Next
  4. Enter the Install Path for the dashboard files
  5. Provide the Central DB connection details:
    • Central DB Server — The SQL Server hosting the audit database
    • Central DB Name — The database name
    • Authentication — How the dashboard connects to the central database
  6. Choose whether to create Desktop and Start Menu shortcuts
  7. Click Install

After installation, launch the dashboard and log in with the admin credentials that were created during the central database setup.

Getting Started (After Installation)

  1. Launch the Dashboard — Open DBLense SQL Auditor from the desktop shortcut or Start Menu. On first launch, you can connect to an existing central database or set up a new one.
  2. Log In — Enter the admin credentials created during setup. Multiple user roles are supported: Admin, Operator, and Viewer.
  3. Register SQL Server Instances — In the dashboard, add the SQL Server instances you want to audit. The collector service will begin monitoring them automatically.
  4. Select Event Categories — For each registered instance, configure which events to track. Events marked with ★ are recommended for most environments.
  5. Configure Filters — Optionally narrow the scope by database, login, host, or application name.
  6. Monitor — The collector service runs in the background, collecting events at configurable intervals (default: 15 seconds). View live and historical audit data in the dashboard.