How to Enable Logging for SSMS Add-ins Without Built-in Logging

How to Enable Logging for SSMS Add-ins Without Built-in Logging

Logging is essential for diagnosing complex issues and capturing technical details that may not be immediately visible through the user interface. When troubleshooting failures or unexpected behavior in SSMS add-ins that do not provide built-in logging, external logs can assist in conducting a deeper investigation.

This guide applies to SQL Server Management Studio (SSMS) environments where logging needs to be enabled manually for specific dbForge add-ins. The process is compatible with all supported SSMS versions, including those installed via the official SSMS installer or the most recent SSMS 21 download available for users who want to install SSMS on Windows.

Add-ins Covered by This Guide

The following dbForge add-ins do not include built-in logging functionality and are supported by this guide:
  1. dbForge Unit Test for SQL Server
  2. dbForge Index Manager for SQL Server
  3. dbForge Search for SQL Server
  4. dbForge Monitor for SQL Server
InfoNote: Add-ins such as Source Control, Data Pump, and SQL Complete include dedicated logging mechanisms and are not covered here.

Steps to Capture Logs

1. Reproduce the Issue in SSMS
  1. Launch SQL Server Management Studio (SSMS)
  2. Perform the actions that trigger the issue within the affected add-in
2. Locate the Log Files
  1. Navigate to the following path on your system:  %SystemDrive%\Users\%UserName%\AppData\Roaming\Devart\current_product\
  2. Example path for Unit Test logs: %SystemDrive%\Users\%UserName%\AppData\Roaming\Devart\dbForge Unit Test for SQL Server\
3. Send the Log Files
  1. In the folder, locate the following files:
            - loader.log
            - SSMS.log
  1. Identify and send the files with the latest modification date for further analysis by the support team.
This method allows Devart support to review background events and diagnose issues even in tools without direct logging controls. Be sure that your SSMS environment, particularly if installed via the SSMS installer or using the SSMS 21 download, is up to date to avoid compatibility issues when logging and analyzing errors.

    • Related Articles

    • How to Enable Logging for SQL Complete

      Logging is a standard mechanism used in many software tools to capture detailed information about application behavior, errors, and performance issues. It is particularly useful when diagnosing problems that are difficult to reproduce or analyze in ...

    • What is the difference between Standalone applications and Add-Ins?

      dbForge offers a suite of powerful MiniTools designed to streamline database development and administration. These tools come in two primary forms: standalone applications and add-ins, each catering to distinct user needs and workflows. 1. dbForge ...

    • How to Create a Dump File from Task Manager for SSMS and Integrated Add-ins

      In cases where SSMS (SQL Server Management Studio) or any integrated add-ins freeze or stop responding, a dump file can be generated for debugging purposes. This applies to both SSMS and the following dbForge add-ins for SQL Server: dbForge SQL ...

    • How to Enable Logging for Source Control and Data Pump for SQL Server

      Logging is essential for capturing detailed information about failures and issues in the program. If reproducing or diagnosing a problem is difficult, logging helps in providing a deeper investigation. This guide applies to the following products: ...

    • How to Generate a "dump_crash" for SSMS, Including Add-in Tools

      If SQL Server Management Studio (SSMS) crashes, it’s possible to configure your system to automatically generate a memory dump file. This file is essential for identifying issues related to both SSMS and integrated tools such as SQL Complete. This ...