SQL Agent Insights:Documentation:Main User Interface: Difference between revisions

From SQL Agent Insights Wiki
No edit summary
 
(36 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>
This article showcases the main user interface for ''SQL Agent Insights'', explaining all of the options available to the version(s) noted above.


This article showcases the main user interface for ''SQL Agent Insight'', explaining all of the options available to the version(s) noted above.
= About Dialog =


= The About Dialog =
The <span style="color: dodgerblue;">'''About'''</span> dialog is shown upon first starting ''SQL Agent Insights'', and has the following tabs described below. Additionally, one can access the About dialog by selecting <span style="color: dodgerblue;">'''Help'''</span> from the [[SQL_Agent_Insight:Documentation:Main_User_Interface#Menu_bar|''menu bar'']] and then clicking on <span style="color: dodgerblue;">'''About SQL Agent Insights'''</span>.
 
The <span style="color: dodgerblue;">'''About'''</span> dialog is shown upon first starting ''SQL Agent Insight'', and has the following tabs described below. Additionally, one can access the About dialog by selecting <span style="color: dodgerblue;">'''Help'''</span> from the menu bar and then clicking on <span style="color: dodgerblue;">'''About SQL Agent Insight'''</span>.


== General ==
== General ==
Line 11: Line 11:
|- style="vertical-align:top;"
|- style="vertical-align:top;"
| [[File:about-general.png|frameless|300px|thumbnail|none]] ||
| [[File:about-general.png|frameless|300px|thumbnail|none]] ||
* Outlines basic copyright information, provides the user with some contact information, and gives kudos to the websites and software that has helped in the making of ''SQL Agent Insight''.
* Outlines basic copyright information, provides the user with some contact information, and gives kudos to the websites and software that has helped in the making of ''SQL Agent Insights''.
|}
|}


Line 18: Line 18:
|- style="vertical-align:top;"
|- style="vertical-align:top;"
| [[File:about-license.png|frameless|300px|thumbnail|none]] ||
| [[File:about-license.png|frameless|300px|thumbnail|none]] ||
* Details the current active ''SQL Agent Insight'' license. Of particular note, the Expiry Date shows the date on which ''SQL Agent Insight'' will cease functioning.
* Details the current active ''SQL Agent Insights'' license. Of particular note, the Expiry Date shows the date on which ''SQL Agent Insights'' will cease functioning.
* The <span style="color: dodgerblue;">'''Days Until Expiry'''</span> indicates the number of days until the noted expiry date above.
* The <span style="color: dodgerblue;">'''Days Until Expiry'''</span> indicates the number of days until the noted expiry date above.
* When you are approaching the expiry date, simply download an updated version of ''SQL Agent Insight'' from [https://brentec.ca here].
* When you are approaching the expiry date, simply download an updated version of ''SQL Agent Insights'' from the download page located [https://brentec.ca here].
|}
|}


Line 27: Line 27:
|- style="vertical-align:top;"
|- style="vertical-align:top;"
| [[File:about-file-versions.png|frameless|300px|thumbnail|none]] ||
| [[File:about-file-versions.png|frameless|300px|thumbnail|none]] ||
* Displays all of the ''Brentec'' libraries that are being used with ''SQL Agent Insight''. This is helpful for support purposes.
* Displays all of the ''Brentec'' libraries that are being used with ''SQL Agent Insights''. This is helpful for support purposes.
|}
|}


Line 34: Line 34:
|- style="vertical-align:top;"
|- style="vertical-align:top;"
| [[File:about-eula.png|frameless|300px|thumbnail|none]] ||
| [[File:about-eula.png|frameless|300px|thumbnail|none]] ||
* Important information that outlines your usage of the product and what you are agreeing to by using ''SQL Agent Insight''.
* Important information that outlines your usage of the product and what you are agreeing to by using ''SQL Agent Insights''.
|}
|}


= The Main User Interface (UI) =
= Main User Interface (UI) =


As soon as the EULA is accepted, and the <span style="color: dodgerblue;">'''OK'''</span> button is clicked on the About dialog, ''SQL Agent Insight'' gets to work. You will notice in the status bar, in the bottom left, the <span style="color: dodgerblue;">'''Enumerating all (visible) supported versions...'''</span> message. ''SQL Agent Insight'' is enumerating all instances of SQL Server® that it can find on the local network segment.
As soon as the EULA is accepted, and the <span style="color: dodgerblue;">'''OK'''</span> button is clicked on the About dialog, ''SQL Agent Insights'' gets to work. You will notice in the status bar, in the bottom left, the <span style="color: dodgerblue;">'''Enumerating all (visible) supported versions...'''</span> message. ''SQL Agent Insights'' is enumerating all instances of SQL Server® that it can find on the local network segment.


[[File:status-bar-enumerate.png|506px|frameless|border|none]]
[[File:status-bar-enumerate.png|506px|frameless|border|none]]




{| style="background-color:#E7F5FE;border-style: solid; border-width: 1px; border-color:blue" cellpadding="3"
{| {{Template:TableAttentionColor}}
|- style="color:blue;"
|-  
| '''NOTE'''
|
{|
|-
|-
| Some SQL Server instances on your network may not appear in ''SQL Agent Insight'' after enumeration. This could be for a number of reasons, including but not limited to:
|style="vertical-align: top;"|
[[file: warning-gray-26.png|bottom]]
|style="vertical-align: top; padding: 0px 0px 0px 11px;"|
Some SQL Server instances on your network may not appear in ''SQL Agent Insights'' after enumeration. This could be for a number of reasons, including but not limited to:
* Windows® firewall settings on the machine running the SQL Server® instance itself, or
* Windows® firewall settings on the machine running the SQL Server® instance itself, or
* Windows® firewall settings on the client machine running ''SQL Agent Insight'', or
* Windows® firewall settings on the client machine running ''SQL Agent Insights'', or
* The SQL Agent Browser service on the machine running the SQL Server® instance may not be running, or
* The SQL Agent Browser service on the machine running the SQL Server® instance may not be running, or
* A physical network firewall blocking the traffic from the SQL Server® instance to the client.
* A physical network firewall blocking the traffic from the SQL Server® instance to the client.
|}
|}
|}


Line 61: Line 66:
|- style="vertical-align: top;"
|- style="vertical-align: top;"
|
|
* Applies to: [[File:ok-green-24.png]] SQL Agent Insight (version 0.27+)
* Upon completion of the enumeration, if any SQL Server® instances are found, they will be shown in the <span style="color:dodgerblue;">'''Available Instances'''</span> pane. Beside each named instance will be a row header color indicating if the discovered instance of SQL is local to the client running ''SQL Agent Insights'' (blue) or if the enumerated instance is remote to ''SQL Agent Insights'' (gray).  
* Upon completion of the enumeration, if any SQL Server® instances are found, they will be shown in the <span style="color:dodgerblue;">'''Available Instances'''</span> pane. Beside each named instance will be a row header color indicating if the discovered instance of SQL is local to the client running ''SQL Agent Insight'' (blue) or if the enumerated instance is remote to ''SQL Agent Insight'' (gray).  
* Double-clicking a server instance name from within this pane will automatically open the <span style="color:dodgerblue;">'''Connection'''</span> dialog.
* Double-clicking a server instance name from within this pane will automatically open the <span style="color:dodgerblue;">'''Connection'''</span> dialog.
* Alternatively, the <span style="color:dodgerblue;">'''Connection'''</span> dialog can be opened by selecting an instance and clicking on the <span style="color:dodgerblue;">'''Connect to selected instance'''</span> button in the upper-right of this pane.
* Alternatively, the <span style="color:dodgerblue;">'''Connection'''</span> dialog can be opened by selecting an instance and clicking on the <span style="color:dodgerblue;">'''Connect to selected instance'''</span> button in the upper-right of this pane.
Line 69: Line 73:
|}
|}


{| style="background-color:#E9FBE5;border-style: solid; border-width: 1px; border-color: limegreen" cellpadding="3"
{| {{Template:TableTipColor}}
|- style="color:limegreen;"
|-  
| '''PRO TIP'''
|
{|
|-
|-
|
|style="vertical-align: top;"|
It is highly suggested that you do '''NOT''' run ''SQL Agent Insight'' directly on your SQL Server® machine to monitor the instance(s). Pick a client machine to run ''SQL Agent Insight'' per the [https://brentec.ca/sql-agent-insight/requirements/ System Requirements]. No matter how much testing ''SQL Agent Insight'' undergoes, running any monitoring software directly on your SQL Server® instance could cause unwanted performance / capacity issues.
[[file:lightbulb-gray-26.png|bottom]]
|style="vertical-align: top; padding: 0px 0px 0px 11px;"|
It is highly suggested that you do '''NOT''' run ''SQL Agent Insights'' directly on your SQL Server® machine to monitor the instance(s). Pick a client machine to run ''SQL Agent Insights'' per the [https://brentec.ca/sql-agent-insight/requirements/ System Requirements]. No matter how much testing ''SQL Agent Insights'' undergoes, running any monitoring software directly on your SQL Server® instance uses resources (CPU/RAM) that would be better allocated to the SQL engine directly.
|}
|}
|}


Line 96: Line 104:
== Expand/Collapse Buttons ==
== Expand/Collapse Buttons ==


{|
|- style="vertical-align:top;"
|
To give your Insights more screen real estate, toggle the expand/collapse button in the menu bar to either show/hide the toolbar.
To give your Insights more screen real estate, toggle the expand/collapse button in the menu bar to either show/hide the toolbar.


Additionally, for the dockable windows mentioned above, one can either pin/unpin them. Unpinning them will retract the window to a sidebar with an appropriate caption. Clicking on this caption will reveal the unpinned window while the mouse hovers over it, until it is pinned.
Additionally, for the dockable windows mentioned above, one can either pin/unpin them. Unpinning them will retract the window to a sidebar with an appropriate caption. Clicking on this caption will reveal the unpinned window while the mouse hovers over it, until it is pinned.
|
[[File:expand-collapse.png|thumb|500px|center|Location of the expand/collapse and pin buttons.]]
[[File:main-window-all-panes-collapsed.png|thumb|500px|center|An example of the entire ''SQL Agent Insights'' working area with all panes/toolbars collapsed.]]
|}


[[File:expand-collapse.png|frameless|800px|none]]
== Tool bar ==
[[File:main-window-all-panes-collapsed.png|frameless|800px|none]]
[[File:main-toolbar.png|thumb|800px|center|''SQL Agent Insights''' main toolbar.]]
The main toolbar consists of the most common actions within ''SQL Agent Insights''. From left to right they are:


== The Toolbar ==
* '''New Insight'''
[[File:main-toolbar.png|frameless|800px|none]]
** Allows the connection to and monitoring of a ''SQL Server® Agent''.
The main toolbar consists of the most common actions within ''SQL Agent Insight''. From left to right they are:


* '''NEW INSIGHT'''
* '''Enumerate'''
** Allows the connection to and monitoring of a ''SQL Server Agent''.
**Forces a rescan of the network and refreshes the <span style="color: dodgerblue";>'''Available Instances'''</span> pane.


* '''ENUMERATE'''
* '''Dasboard'''
**Forces a rescan of the network and refreshes the <span style="color: dodgerblue";>'''Available SQL Servers'''</span> pane.
 
* '''DASHBOARD'''
** Displays the <span style="color: dodgerblue";>'''Dashboard and Alarms'''</span> window.
** Displays the <span style="color: dodgerblue";>'''Dashboard and Alarms'''</span> window.


* '''ALARMS'''
* '''Alarms'''
** Will also display the <span style="color: dodgerblue";>'''Dashboard and Alarms'''</span> window, however, this icon will appear red in color for any new alarms raised since the last polling interval.
** Will also display the <span style="color: dodgerblue";>'''Dashboard and Alarms'''</span> window, however, this icon will appear red in color for any new alarms raised since the last polling interval.


* '''PREFERENCES'''
* '''Preferences'''
** Opens a dialog to configure <span style="color: dodgerblue;">'''Preferences'''</span> for ''SQL Agent Insight''.
** Opens a dialog to configure <span style="color: dodgerblue;">'''Preferences'''</span> for ''SQL Agent Insights''.


* '''EXIT'''
* '''Exit'''
** Closes ''SQL Agent Insight'', but first will confirm if any SQL instances are actively being monitored.
** Closes ''SQL Agent Insights'', but first will confirm if any SQL instances are actively being monitored.


== The Menu Bar ==
== Menu bar ==
[[File:main-menubar.png|frameless|800px|none]]
[[File:main-menubar.png|thumb|right|''SQL Agent Insights''' menubar, near the top of the application.]]
==='''File'''===
==='''File'''===
*New Insight...
*''New Insight...''
**Allows the connection to, and monitoring of, a SQL Server® Agent.
**Allows the connection to, and monitoring of, a SQL Server® Agent.
** Shortcut key CTRL+N
** Shortcut key <span style="color: dodgerblue;">'''CTRL+N'''</span>
*Exit
*''Exit''
**Closes SQL Agent Insight, but first will confirm if any SQL instances are actively being monitored.
**Closes SQL Agent Insights, but first will confirm if any SQL instances are actively being monitored.
** Shortcut key CTRL+E
** Shortcut key <span style="color: dodgerblue;">'''CTRL+E'''</span>


==='''Options'''===
==='''Options'''===
*Enumerate SQL Servers
*''Enumerate SQL Servers''
**Rescans the network for SQL instances and updates the Available SQL Servers pane.
**Rescans the network for SQL instances and updates the Available SQL Servers pane.
*Preferences...
*''Preferences...''
**Opens a window to configure preferences for SQL Agent Insight.
**Opens a window to configure preferences for SQL Agent Insights.
** Shortcut key CTRL+ALT+C
** Shortcut key <span style="color: dodgerblue;">'''CTRL+ALT+C'''</span>


==='''WINDOW'''===
==='''Window'''===
*DASHBOARD
*''Dashboard''
**Displays the Dashboard and Alarms window.
**Displays the Dashboard and Alarms window.
*CLOSE ALL WINDOWS EXCEPT INSIGHTS
**Shortcut key <span style="color: dodgerblue;">'''CTRL+D'''</span>
*''Close All Windows except Insights''
**A good way to clean up all open secondary windows, except Insights of course.
**A good way to clean up all open secondary windows, except Insights of course.
*AVAILABLE INSTANCES
** Shortcut key <span style="color: dodgerblue;">'''CTRL+SHIFT+O'''</span>
*''Available Instances''
**Restores a closed Available Instances window to it’s last known location.
**Restores a closed Available Instances window to it’s last known location.
*CONNECTED INSTANCES
*''Connected Instances''
**Restores a closed Connected Instances window to it’s last known location.
**Restores a closed Connected Instances window to it’s last known location.
*PREVIOUSLY CONNECTED INSTANCES
*''Previously Connected Instances''
**Restores a closed Previously Connected Instances window to it’s last known location.
**Restores a closed Previously Connected Instances window to it’s last known location.
*SAVE WINDOW LAYOUT
*''Save Window Layout''
**Saves the dockable window layout to the ''ApplicationState.xml'' file within the ''SQL Agent Insight'' working folder.
**Saves the dockable window layout to the ''ApplicationState.xml'' file within the ''SQL Agent Insights'' working folder.
*LOAD AND APPLY WINDOW LAYOUT
*''Load and Apply Window Layout''
**Loads a previously saved dockable window layout and applies it to the current working session.
**Loads a previously saved dockable window layout and applies it to the current working session.
*RESET WINDOW LAYOUT
*''Reset Window Layout''
**Resets all dockable windows to the left-hand side of the main window.
**Resets all dockable windows to the left-hand side of the main window.


==='''HELP'''===
==='''Help'''===
*CHECK FOR UPDATES…
*''Check for Updates...''
**Makes a request to the Brentec website and checks to see if there is a newer version of SQL Agent Insight to download.
**Makes a request to the Brentec website and checks to see if there is a newer version of ''SQL Agent Insights'' to download.
*ABOUT SQL AGENT INSIGHT
*''About SQL Agent Insights''
**Displays the About dialog described earlier.
**Displays the About dialog described earlier.
*BRENTEC WEBSITE
*''Brentec Website (via Browser)''
**Opens your default browser to this Brentec website.
**Opens your default browser to this [https://brentec.ca Brentec] website.
*SUPPORT DEVELOPMENT – CONSIDER A DONATION
*''Support Development – Consider a Donation (via Browser)''
**Opens your default browser to the donation page on the Brentec website.
**Opens your default browser to the [https://brentec.ca/donate/ donation] page on the Brentec website.
 


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

Latest revision as of 03:32, 16 October 2023

Back to Documentation Main

This article showcases the main user interface for SQL Agent Insights, explaining all of the options available to the version(s) noted above.

About Dialog

The About dialog is shown upon first starting SQL Agent Insights, and has the following tabs described below. Additionally, one can access the About dialog by selecting Help from the menu bar and then clicking on About SQL Agent Insights.

General

thumbnail
thumbnail
  • Outlines basic copyright information, provides the user with some contact information, and gives kudos to the websites and software that has helped in the making of SQL Agent Insights.

License Information

thumbnail
thumbnail
  • Details the current active SQL Agent Insights license. Of particular note, the Expiry Date shows the date on which SQL Agent Insights will cease functioning.
  • The Days Until Expiry indicates the number of days until the noted expiry date above.
  • When you are approaching the expiry date, simply download an updated version of SQL Agent Insights from the download page located here.

File Versions

thumbnail
thumbnail
  • Displays all of the Brentec libraries that are being used with SQL Agent Insights. This is helpful for support purposes.

End User License Agreement (EULA)

thumbnail
thumbnail
  • Important information that outlines your usage of the product and what you are agreeing to by using SQL Agent Insights.

Main User Interface (UI)

As soon as the EULA is accepted, and the OK button is clicked on the About dialog, SQL Agent Insights gets to work. You will notice in the status bar, in the bottom left, the Enumerating all (visible) supported versions... message. SQL Agent Insights is enumerating all instances of SQL Server® that it can find on the local network segment.

Error creating thumbnail: Unable to save thumbnail to destination


Error creating thumbnail: Unable to save thumbnail to destination

Some SQL Server instances on your network may not appear in SQL Agent Insights after enumeration. This could be for a number of reasons, including but not limited to:

  • Windows® firewall settings on the machine running the SQL Server® instance itself, or
  • Windows® firewall settings on the client machine running SQL Agent Insights, or
  • The SQL Agent Browser service on the machine running the SQL Server® instance may not be running, or
  • A physical network firewall blocking the traffic from the SQL Server® instance to the client.

User Dockable Windows

Available Instances

  • Upon completion of the enumeration, if any SQL Server® instances are found, they will be shown in the Available Instances pane. Beside each named instance will be a row header color indicating if the discovered instance of SQL is local to the client running SQL Agent Insights (blue) or if the enumerated instance is remote to SQL Agent Insights (gray).
  • Double-clicking a server instance name from within this pane will automatically open the Connection dialog.
  • Alternatively, the Connection dialog can be opened by selecting an instance and clicking on the Connect to selected instance button in the upper-right of this pane.
Error creating thumbnail: Unable to save thumbnail to destination
thumbnail

Error creating thumbnail: Unable to save thumbnail to destination

It is highly suggested that you do NOT run SQL Agent Insights directly on your SQL Server® machine to monitor the instance(s). Pick a client machine to run SQL Agent Insights per the System Requirements. No matter how much testing SQL Agent Insights undergoes, running any monitoring software directly on your SQL Server® instance uses resources (CPU/RAM) that would be better allocated to the SQL engine directly.

Connected Instances

  • The Connected Instances pane actively shows all currently monitored SQL Server® instances. Beside each named instance will be a color indicating its current status, either one of green (Healthy), yellow (Warning), red (Critical) or gray (Maintenance).
Error creating thumbnail: Unable to save thumbnail to destination
thumbnail

Previously Monitored Instances

  • When a connection to any SQL Server® instance is successful, the instance name is saved into the Previously Monitored Instances pane for quick future reference.
  • Double-clicking a server instance name from within this pane will automatically open the Connection dialog.
Error creating thumbnail: Unable to save thumbnail to destination
thumbnail

Expand/Collapse Buttons

To give your Insights more screen real estate, toggle the expand/collapse button in the menu bar to either show/hide the toolbar.

Additionally, for the dockable windows mentioned above, one can either pin/unpin them. Unpinning them will retract the window to a sidebar with an appropriate caption. Clicking on this caption will reveal the unpinned window while the mouse hovers over it, until it is pinned.

Location of the expand/collapse and pin buttons.
An example of the entire SQL Agent Insights working area with all panes/toolbars collapsed.

Tool bar

SQL Agent Insights' main toolbar.

The main toolbar consists of the most common actions within SQL Agent Insights. From left to right they are:

  • New Insight
    • Allows the connection to and monitoring of a SQL Server® Agent.
  • Enumerate
    • Forces a rescan of the network and refreshes the Available Instances pane.
  • Dasboard
    • Displays the Dashboard and Alarms window.
  • Alarms
    • Will also display the Dashboard and Alarms window, however, this icon will appear red in color for any new alarms raised since the last polling interval.
  • Preferences
    • Opens a dialog to configure Preferences for SQL Agent Insights.
  • Exit
    • Closes SQL Agent Insights, but first will confirm if any SQL instances are actively being monitored.

Menu bar

Error creating thumbnail: Unable to save thumbnail to destination
SQL Agent Insights' menubar, near the top of the application.

File

  • New Insight...
    • Allows the connection to, and monitoring of, a SQL Server® Agent.
    • Shortcut key CTRL+N
  • Exit
    • Closes SQL Agent Insights, but first will confirm if any SQL instances are actively being monitored.
    • Shortcut key CTRL+E

Options

  • Enumerate SQL Servers
    • Rescans the network for SQL instances and updates the Available SQL Servers pane.
  • Preferences...
    • Opens a window to configure preferences for SQL Agent Insights.
    • Shortcut key CTRL+ALT+C

Window

  • Dashboard
    • Displays the Dashboard and Alarms window.
    • Shortcut key CTRL+D
  • Close All Windows except Insights
    • A good way to clean up all open secondary windows, except Insights of course.
    • Shortcut key CTRL+SHIFT+O
  • Available Instances
    • Restores a closed Available Instances window to it’s last known location.
  • Connected Instances
    • Restores a closed Connected Instances window to it’s last known location.
  • Previously Connected Instances
    • Restores a closed Previously Connected Instances window to it’s last known location.
  • Save Window Layout
    • Saves the dockable window layout to the ApplicationState.xml file within the SQL Agent Insights working folder.
  • Load and Apply Window Layout
    • Loads a previously saved dockable window layout and applies it to the current working session.
  • Reset Window Layout
    • Resets all dockable windows to the left-hand side of the main window.

Help

  • Check for Updates...
    • Makes a request to the Brentec website and checks to see if there is a newer version of SQL Agent Insights to download.
  • About SQL Agent Insights
    • Displays the About dialog described earlier.
  • Brentec Website (via Browser)
    • Opens your default browser to this Brentec website.
  • Support Development – Consider a Donation (via Browser)
    • Opens your default browser to the donation page on the Brentec website.


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:Main_User_Interface&oldid=1657"