SQL Agent Insights:Documentation:Preferences: Difference between revisions

From SQL Agent Insights Wiki
No edit summary
 
(24 intermediate revisions by the same user not shown)
Line 1: Line 1:
'''Applies to:''' [[File:ok-green-24.png]] SQL Agent Insight (all supported versions unless otherwise noted)
[[SQL Agent Insights:Documentation|Back to Documentation Main]]
<hr>
At anytime while running ''SQL Agent Insights'', clicking on the <span style="color: dodgerblue;">'''Preferences'''</span> toolbar button or by pressing <span style="color: dodgerblue;">'''CTRL+ALT+C'''</span> key sequence will open the Preferences dialog.


At anytime while running ''SQL Agent Insight'', clicking on the <span style="color: dodgerblue;">'''Preferences'''</span> toolbar button or by pressing <span style="color: dodgerblue;">'''CTRL+ALT+C'''</span> key sequence will open the Preferences dialog.
= General =


= General =
[[File:preferences-general.png|frameless|right]]


{|
|- style="vertical-align:top;"
|
=== Show system tray notifications ===
=== Show system tray notifications ===
* When enabled, ''SQL Agent Insight'' will send notifications to Window’s notification panel.
* When enabled, ''SQL Agent Insights'' will send notifications to Window’s notification panel.


=== Show Dashboard on startup ===
=== Show Dashboard on startup ===
* Opens the dashboard immediately on startup of ''SQL Agent Insight''.
* Opens the dashboard immediately on startup of ''SQL Agent Insights''.


=== Open Dashboard as window ===
=== Open Dashboard as window ===
* The Dashboard can either be windowed or tabbed within ''SQL Agent Insight''. If this option is enabled, the Dashboard will open as a window available on the taskbar, otherwise it will be tabbed alongside any Insights.
* The Dashboard can either be windowed or tabbed within ''SQL Agent Insights''. If this option is enabled, the Dashboard will open as a window available on the taskbar, otherwise it will be tabbed alongside any Insights.


=== Override application name in SQL connection string ===
=== Override application name in SQL connection string ===
Line 22: Line 21:
* If left blank/empty, .NET will replace substitute the string ".Net SqlClient Data Provider" in it's place.
* If left blank/empty, .NET will replace substitute the string ".Net SqlClient Data Provider" in it's place.
* The Reset button will overwrite the current configured string and reset it back to the product name and version number.
* The Reset button will overwrite the current configured string and reset it back to the product name and version number.
{| {{Template: TableTipColor}}
|-
|
{|
|-
|style="vertical-align: top;"|
[[file: lightbulb-gray-26.png|bottom]]
|style="vertical-align: top; padding: 0px 0px 0px 11px;"|
If other monitoring software is tracking application connections to the instance, changing the connection string application name keyword could be used to disguise/obfuscate the operation of ''SQL Agent Insights''. This does not prevent other software/users from identifying the source, but merely falsifies the application name within the SQL Server® process tables.
|}
|}


=== Prevent system from entering sleep mode or invoking the screensaver ===
=== 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.
* When enabled, this setting will prevent the client system running ''SQL Agent Insights'' from going into sleep mode and prevent the screensaver from activating.
 
 
{| {{Template: TableTipColor}}
|-
|
{|
|-
|style="vertical-align: top;"|
[[file: lightbulb-gray-26.png|bottom]]
|style="vertical-align: top; padding: 0px 0px 0px 11px;"|
Preventing the system from entering sleep mode is ideal for users, such as a helpdesk, that has to continually monitor the dashboard.
|}
|}


=== Start Insights in maintenance mode ===
=== Start Insights in maintenance mode ===
* When enabled, all metrics will immediately be in maintenance mode.
* When enabled, all metrics will immediately be in maintenance mode.
{| {{Template: TableTipColor}}
|-
|
{|
|-
|style="vertical-align: top;"|
[[file: lightbulb-gray-26.png|bottom]]
|style="vertical-align: top; padding: 0px 0px 0px 11px;"|
Starting Insights in maintenance mode is useful on the occasion whereby metric thresholds have not yet been configured, preventing alarms and possibly email notifications from firing.
|}
|}


=== Open Job Monitor as window ===
=== Open Job Monitor as window ===
* An Insight's Job Monitor can either by windowed or tabbed within ''SQL Agent Insight''. If this option is enabled, any Job Monitor will open as a window available on the taskbar, otherwise it will be tabbed alongside any Insights.
* An Insight's Job Monitor can either by windowed or tabbed within ''SQL Agent Insights''. If this option is enabled, any Job Monitor will open as a window available on the taskbar, otherwise it will be tabbed alongside any Insights.


=== Encrypt connection to SQL Server by default (recommended) ===
=== Encrypt connection to SQL Server by default (recommended) ===
Line 41: Line 79:
   
   
=== License File ===
=== License File ===
* Shows the active license file located within the ''SQL Agent Insight'' program directory/folder.
* Shows the active license file located within the ''SQL Agent Insights'' program directory/folder.


|| [[File:preferences-general.png|frameless]]
= Notifications =
|-
|}


= Notifications =
[[File:preferences-notifications.png|frameless|right]]


{|
|- style="vertical-align:top;"
|
=== Enable global email notifications ===
=== 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''.
* When enabled, this allows the configuration of all other email settings on the form all fully allows email notifications from ''SQL Agent Insights''.
* If this option is disabled, no email notifications will be sent from ''SQL Agent Insight'', even if individual Insights have notifications turned on.
* If this option is disabled, no email notifications will be sent from ''SQL Agent Insights'', even if individual Insights have notifications turned on.


=== Outgoing SMTP Server ===
=== Outgoing SMTP Server ===
Line 65: Line 98:
* '''Port'''
* '''Port'''
** Specify the outgoing SMTP server port, by default this will be port 25.
** Specify the outgoing SMTP server port, by default this will be port 25.
** However, for Google for example, use 465 or 587.
** However, Google for example will use 465 or 587.


=== Authentication ===
=== Authentication ===
Line 73: Line 106:
* '''Password'''
* '''Password'''
** Specify the password for the username or mailbox identifier above.
** Specify the password for the username or mailbox identifier above.
{| {{Template: TableInfoColor}}
|-
|
{|
|-
|style="vertical-align: top;"|
[[file: info-gray-26.png|bottom]]
|style="vertical-align: top; padding: 0px 0px 0px 11px;"|
The password is stored in the settings file of ''SQL Agent Insights'' and is <span style="color: dodgerblue;">'''encrypted'''</span>.
|}
|}


=== Mail Message Settings ===
=== Mail Message Settings ===
Line 93: Line 139:


* '''OK (button)'''
* '''OK (button)'''
** Upon changing any setting, the status bar of the Preferences dialog will change and notify the user Changes Detected. Click OK to save and apply. Pressing the OK button will do just that, then promptly close the Preferences dialog.
** Upon changing any setting, the status bar of the Preferences dialog will change and notify the user <span style="color: dodgerblue;">'''Changes Detected. Click OK to save and apply'''</span>. Pressing the OK button will do just that, then promptly close the Preferences dialog.
[[File:preferences-changes-detected.png]]


* '''Cancel (button)'''
* '''Cancel (button)'''
**
** Pressing the Cancel button will do just that, close the Preferences dialog and any pending changes are not applied.


|| [[File:preferences-notifications.png|frameless]]
|-
|}


<hr>
<hr>
[[SQL Agent Insight:Documentation|Back to Documentation Main]]
[[SQL Agent Insights:Documentation|Back to Documentation Main]]
{{MicrosoftFooter}}
{{MicrosoftFooter}}
[[Category:Documentation]]

Latest revision as of 03:36, 16 October 2023

Back to Documentation Main

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

General

Show system tray notifications

  • When enabled, SQL Agent Insights will send notifications to Window’s notification panel.

Show Dashboard on startup

  • Opens the dashboard immediately on startup of SQL Agent Insights.

Open Dashboard as window

  • The Dashboard can either be windowed or tabbed within SQL Agent Insights. If this option is enabled, the Dashboard will open as a window available on the taskbar, otherwise it will be tabbed alongside any Insights.

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 product name along with the version number.
  • If left blank/empty, .NET will replace substitute the string ".Net SqlClient Data Provider" in it's place.
  • The Reset button will overwrite the current configured string and reset it back to the product name and version number.


Error creating thumbnail: Unable to save thumbnail to destination

If other monitoring software is tracking application connections to the instance, changing the connection string application name keyword could be used to disguise/obfuscate the operation of SQL Agent Insights. This does not prevent other software/users from identifying the source, but merely falsifies the application name within the SQL Server® process tables.

Prevent system from entering sleep mode or invoking the screensaver

  • When enabled, this setting will prevent the client system running SQL Agent Insights from going into sleep mode and prevent the screensaver from activating.


Error creating thumbnail: Unable to save thumbnail to destination

Preventing the system from entering sleep mode is ideal for users, such as a helpdesk, that has to continually monitor the dashboard.

Start Insights in maintenance mode

  • When enabled, all metrics will immediately be in maintenance mode.


Error creating thumbnail: Unable to save thumbnail to destination

Starting Insights in maintenance mode is useful on the occasion whereby metric thresholds have not yet been configured, preventing alarms and possibly email notifications from firing.

Open Job Monitor as window

  • An Insight's Job Monitor can either by windowed or tabbed within SQL Agent Insights. If this option is enabled, any Job Monitor will open as a window available on the taskbar, otherwise it will be tabbed alongside any Insights.

Encrypt connection to SQL Server by default (recommended)

  • When enabled, the Encrypt connection checkbox will automatically be in a checked state on the Connection dialog.
  • This then adds the Encrypt keyword to the connection string for that instance only and sets the value to true.

Trust SQL Server certificate by default

  • When enabled, the Trust server certificate checkbox will automatically be in a checked state on the Connection dialog.
  • This then adds the TrustServerCertificate keyword to the connection string for that instance and sets the value to true.

License File

  • Shows the active license file located within the SQL Agent Insights program directory/folder.

Notifications

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 Insights.
  • If this option is disabled, no email notifications will be sent from SQL Agent Insights, even if individual Insights have notifications turned on.

Outgoing SMTP Server

  • Enable SSL/TLS
    • When enabled, connections to the outgoing SMTP server will use SSL/TLS encryption.
  • Name or IP
    • Enter the outgoing SMTP fully qualified domain name (FQDN) or it’s IP address.
  • Port
    • Specify the outgoing SMTP server port, by default this will be port 25.
    • However, Google for example will 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.


Error creating thumbnail: Unable to save thumbnail to destination

The password is stored in the settings file of SQL Agent Insights and is encrypted.

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 for security reasons.
  • 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.
  • OK (button)
    • Upon changing any setting, the status bar of the Preferences dialog will change and notify the user Changes Detected. Click OK to save and apply. Pressing the OK button will do just that, then promptly close the Preferences dialog.

Error creating thumbnail: Unable to save thumbnail to destination

  • Cancel (button)
    • Pressing the Cancel button will do just that, close the Preferences dialog and any pending changes are not applied.


Back to Documentation Main

Microsoft®, Windows® and SQL Server® are registered trademarks of Microsoft Corporation in the United States and/or other countries.
Some icons courtesy of Icons8

Retrieved from "https://brentec.ca/wiki/index.php?title=SQL_Agent_Insights:Documentation:Preferences&oldid=1659"