Enable Insights

This wiki page will explain how to enable the widgets in SQL Operations Studio

Configure/Enable Widgets in SQL Operations Studio

Once you have installed the Widget files on your computer follow these steps to enable the widgets in your SQL Operations Studio.

1. Open SQL Operations Studio

2. Press F1 (or CTRL+SHIFT+P for those VSCode users) to open the command palette, type "settings" and select Preferences: Open User Settings. Alternatively use the File menu to access the settings.

3. The settings screen contains the default settings on the left and your user/workspace settings on the right. Use the Settings search box to locate either "dashboard.server.widgets" or "dashboard.database.widgets" depending on the widget you wish to add.

4. If you haven't modified the default dashboards yet then, hold your mouse cursor over the current configuration and select Pencil/edit icon. This will copy the current settings to your user/workspace settings to allow you to edit them and is the preferred method.

   The configuration of your user/workspace settings will override the default settings, in the case of the widgets this means you can also remove the built-in widgets from the dashboard if you do not include them in your user/workspace settings.

5. Locate the appropriate section in your user/workspace settings and add the relevate json for the widget you are enabling. The README.md for each insight pack contains the json for enabling the relevant widget. For example the following snippet enables the AG replicate health widget for a server dashboard.

   "dashboard.server.widgets": [
       ...
       {
           "name": "AG Replica Health",
           "widget": {
               "ag-replica-health-insight": null
           }
       }
       ...
   ]