Applies to:

SQL Agent Insight version 0.22

Configuration of an Insight

Within the configuration dialog for each individual Insight, one can accomplish the following:

  1. Enabling long running job email notifications,
  2. List running jobs to the Insight log,
  3. Toggle maintenance mode for all metrics at once or by individual metric groups,
  4. Set all thresholds in all groups to the current polled value of each individual metric in a single click,
  5. Reset all thresholds in all groups to zero for each metric in a single click,
  6. For each metric grouping one can
    • Put all metrics into maintenance,
    • Set all thresholds to the currently polled value (in a single click), and,
    • Reset all thresholds to zero (in a single click).
  7. Save all thresholds to file for immediate use upon starting the Insight for this instance in the future,
  8. Load all thresholds immediately from file,
  9. Save the configured thresholds as default for any opened Insights in the future, and,
  10. Load the default thresholds file for quick manipulation.
■ NOTE

In version 0.23, options 3, 4, 5, 6 and 7 will be moved directly to the Insight form, allowing inline threshold manipulation to happen directly beside the polled values. Additionally options 8, 9 and 10 will be deprecated.
An Insight configuration dialog.
Click to enlarge.

Configuration Toolbar Options

Within the Configuration toolbar, the following options are available.

LOAD CONFIGURATION FOR THIS INSIGHT
All previously saved configuration values are loaded from file, overwriting any and all current values/options. Apply these values by clicking on the ‘Apply’ button.

SAVE CONFIGURATION FOR THIS INSIGHT
All current values will be saved to a text file in the current working directory of SQL Agent Insight with a naming convention including the current instance name.

LOAD DEFAULT CONFIGURATION
All previously saved default configuration values are loaded from file, DEFAULT_Thresholds.txt, overwriting any and all current values/options. Apply these values by clicking on the ‘Apply’ button. The default configuration will be used for any Insight that does not currently have a configuration file; this will be indicated within the Insight log.

SAVE AS DEFAULT CONFIGURATION
All current values will be saved to a text file, DEFAULT_Thresholds.txt. The default configuration will be used for any Insight that does not currently have a configuration file; this will be indicated within the Insight log.

TOGGLE MAINTENANCE FOR ALL METRICS
All metrics will either be put into maintenance, or taken out of maintenance. Each metric tab that is in maintenance mode is shown with a wrench and screwdriver icon. Additionally, the toggle to put each category into maintenance will be adjusted accordingly.

SET ALL CRITICAL AND WARNING THRESHOLDS TO CURRENTLY POLLED VALUES
All critical and warning thresholds for each metric will be set to the currently polled value for that metric. The current polled value is shown between the critical and warning thresholds on each metric category tab.

SET ALL CRITICAL AND WARNING THRESHOLDS TO ZERO
Conversely, all metrics can be ‘reset’ and set to zero if so desired. Please note that if e-mail notifications are enabled for the Insight, this could result in an abnormal number of alerts. It is suggested to put the category into maintenance before setting all thresholds to zero.

REFRESH CURRENT POLLED VALUES
By refreshing the polled values, the configuration dialog will update the middle column between the critical and warning threshold values with the latest polled values from the Insight. This can be valuable if the configuration dialog is open while the Insight is actively polling the SQL instance.

General Tab

Upon opening the Insight Configuration dialog, the general tab is front and foremost allowing the configuration of long running job e-mail notifications.
A distinct e-mail (outside of the regular breached threshold e-mails) will be sent indicating the jobs that run longer than the configured value indicated.

To successfully enable the long running job e-mail notification one must:

  • Enable global e-mail notifications within SQL Agent Insight’s Preferences,
  • Toggle the option to List Running Jobs to an ‘on’ state, and
  • Set the number of seconds that must elapse before a job is considered in a long running state.

To toggle the List Running Jobs option to an ‘on’ state, click the text beside the red ‘x’ so that the ‘x’ changes to a green checkmark.
Alternatively, one can click the List Running Jobs button in the Insight toolbar, indicated by the icon depicted as a running person. This icon will change to green (from the default blue) when it is enabled.

At a minimum, this will enable the feature and running jobs will be listed to the Insight Log.

■ PRO TIP

It is recommended to have an overall Insight polling interval less than the number of seconds that need to elapse for a job to be considered ‘long running’. In doing so, SQL Agent Insight will capture all running jobs during that polling interval to the Insight Log tab of the Insight for later review.
An Insight Configuration dialog showing the long running jobs e-mail notification properly configured.
Click to enlarge.

Each Category Tab

Besides the General tab in the Insight configuration, there will be a tab for each individual category of metrics represented on an Insight.

Each category tab will contain four columns, from left to right are:

  • The metric name,
  • The critical threshold value for the metric,
  • The most recent polled value for the metric, and,
  • The warning threshold value for the metric.

Below the critical and warning threshold columns are four buttons, two for the critical thresholds and two for the warning thresholds, and perform the same actions as the buttons in the toolbar indicated by the same icon, but instead work directly with the metrics in the current tab only. They are as follows.

SET ALL CRITICAL THRESHOLDS TO CURRENTLY POLLED VALUES
All of the critical thresholds for the metrics on the current category tab will be set to the values as indicated in the middle column.

SET ALL CRITICAL THRESHOLDS TO ZERO
All of the critical thresholds for the metrics on the current category tab will be set to zero.

SET ALL WARNING THRESHOLDS TO CURRENTLY POLLED VALUES
All of the warning thresholds for the metrics on the current category tab will be set to the values as indicated in the middle column.

SET ALL WARNING THRESHOLDS TO ZERO
All of the warning thresholds for the metrics on the current category tab will be set to zero.

The bottommost control on each category tab is a toggle to put that category of metrics in and out of maintenance.
Toggling maintenance on or off will only affect the metrics on the current tab, and when toggled on, an icon indicated by a wrench and screwdriver will appear in the tab header, beside it’s name.
When maintenance for the category is toggled on, direct metric manipulation is disabled. However, the four previous threshold configuration buttons will still work as expected.

Not all categories of metrics need to be in maintenance at one time. Toggling a specific category into maintenance is useful for metrics that are constantly changing.

Metrics in maintenance will not generate alarms, nor be represented in any threshold breach e-mail notifications.

Metrics in maintenance appear gray in color on an Insight.

■ PRO TIP

To toggle maintenance for an individual category quicker without opening the Insight configuration, double-click the metric group box on the Insight directly.
■ WARNING

The ‘Apply’ button does not inherently save any settings for future use. Be sure to click the button, ‘Save configuration for this Insight’ to have these values loaded when monitoring this SQL instance in the future.
In version 0.23, configuration changes will automatically be saved when modified.
The Jobs category tab in the Insight configuration and all of it’s metrics.
Click to enlarge.