Preferences

At anytime while running SQL Agent Insight, clicking on the “Preferences” toolbar button or by pressing CTRL+ALT+C key sequence will open the preferences dialog.

The toolbar of the Preferences dialog contains two buttons:

  • Load
    • When clicked, will load the configuration settings from file. If the loaded configuration settings are satisfactory, make sure to click “Apply” before closing the dialog to use the configured settings.
  • Save
    • When clicked, will save the current configured settings to file. Make sure to click “Apply” before closing the dialog to use the configured settings.

General Preferences. Click to enlarge.

The “General” tab has the following options:

  • Show system tray notifications
    • When enabled, SQL Agent Insight will send notifications to Window’s notification panel.
  • Show metric tool tips within Insight on mouse hover
    • When enabled, tool tips on Insight metrics will be shown.
  • Show dashboard on startup
    • Opens the dashboard immediately on startup of SQL Agent Insight.
  • Override application name in SQL connection string
    • For any connection made to the SQL instance via a connection string, the application name is replaced by this string.
    • By default, it is SQL Agent Insight along with the version number.
    • If left blank/empty, .NET will replace substitute the string “.Net SqlClient Data Provider” in it’s place.
    • Pro Tip: if other SQL monitoring software is tracking application connections to the instance, this could be changed to disguise the operation of SQL Agent Insight.
  • Hide SQL Agent Insight from taskbar when minimized
    • When enabled, and SQL Agent Insight is minimized, the taskbar entry for the program is hidden.
  • Prevent system from entering sleep mode or invoking the screensaver
    • When enabled, this setting will prevent the client system running SQL Agent Insight from going into sleep mode and prevent the screensaver from activating.
    • Pro Tip: this is handy for users, e.g. a helpdesk, that has to continually monitor the dashboard.
  • Start Insights in minimal view mode
    • When enabled, Insights will start in minimal view immediately. That is, no metrics will be visible, only the 4 groupings of the metric states.
  • Start Insights in maintenance mode
    • When enabled, all metrics will immediately be in maintenance mode.
    • Pro Tip: this is useful on the occasion whereby metric thresholds have not yet been configured, preventing alarms and possibly email notifications from firing.


Notifications Preferences. Click to enlarge.

The “Notifications” tab has the following options:

  • Enable global email notifications
    • When enabled, this allows the configuration of all other email settings on the form all fully allows email notifications from SQL Agent Insight.
    • If this option is disabled, no email notifications will be sent from SQL Agent Insight, even if individual Insights have notifications turned on.
  • Outgoing SMTP Server
    • Name or IP
      • Enter the outgoing SMTP fully qualified domain name (FQDN) or it’s IP address.
    • Enable SSL/TLS
      • When enabled, connections to the outgoing SMTP server will use SSL/TLS encryption.
    • Port
      • Specify the outgoing SMTP server port, by default this will be port 25.
      • However, for Google for example, use 465 or 587.
    • Authentication
      • Username/Mailbox
        • Enter the username or mailbox identifier to connect to the SMTP service with.
      • Password
        • Specify the password for the username or mailbox identifier above.
        • NOTE: this value will be stored encrypted in the settings file of SQL Agent Insight.
  • Mail Message Settings
    • From
      • Specify the ‘from’ email address as it will appear in the email client. Note that most outgoing SMTP servers will require the email address domain name to be the same as the outgoing SMTP server name above.
    • To
      • Specify all email addresses in which to notify via email notifications. Separate multiple email addresses with a comma.
    • CC
      • (Optional) – Specify all email addresses in which to carbon-copy via email notifications. Separate multiple email addresses with a comma.
    • Message body in HTML format
      • When enabled, the message body format will be in HTML format. When disabled, the message body format will be plain text.
    • Send Test Email
      • Clicking this button will send a test email using all of the settings specified above. The outcome of the test will be displayed in the Preferences status bar.
  • Apply
    • When clicked, all settings are validated and applied for future use of all sessions. This does not save the settings. Please make sure to save your settings with the save button in the toolbar.
    • If any settings are invalid, settings will not be applied and the offending setting will be highlighted to correct.
  • Close
    • When clicked, the preferences dialog will be closed.
    • If there have been changes since the dialog was opened, and not applied/saved, a warning will be shown to ensure you want to close without saving/applying.