SQL Agent Insights:Documentation:Insight Configuration: Difference between revisions

From SQL Agent Insights Wiki
No edit summary
 
(26 intermediate revisions by the same user not shown)
Line 1: Line 1:
[[SQL Agent Insight:Documentation|Back to Documentation Main]]
[[SQL Agent Insights:Documentation|Back to Documentation Main]]
<hr>
<hr>
= Configuration of an Insight =
= Configuration of an Insight =
Line 8: Line 8:


=== Polling Interval ===
=== Polling Interval ===
* The frequency at which data will be refreshed from the SQL instance.
The frequency at which data will be refreshed from the SQL instance.
 
Set the polling interval to a value indicating the frequency in which the metrics should be updated. The dropdown has the following options:
 
* Every 15 seconds
* Every 30 seconds
* Every 60 seconds
* Every 5 minutes
* Every 10 minutes
* Every 15 minutes
* Every 30 minutes
* Every 1 hour
* Manual
 
For a more in-depth understanding of how this option functions, please visit [[SQL Agent Insights:Documentation:Insight Polling Freq Recent Timeframe|Polling Frequency & Recent Timeframe]].


=== Recent Timeframe ===
=== Recent Timeframe ===
* The number of days prior to today when gathering ''recent'' metrics.
The number of days prior to today when gathering ''recent'' metrics.
 
The purpose of the recent timeframe selection allows the manipulation of some metrics that are best measured over a time period. This dropdown has the following options:
 
* Every 3 days
* Every 5 days
* Every 7 days
* Every 14 days
* Every 30 days
 
For a more in-depth understanding of how this option functions, please visit [[SQL Agent Insights:Documentation:Insight Polling Freq Recent Timeframe|Polling Frequency & Recent Timeframe]].


=== Log Running Jobs ===
=== Log Running Jobs ===
* List running jobs to the Insight log once every polling interval. This must be enabled for long running job notifications.
* List running jobs to the Insight log once every polling interval. When enabled, the logging of running jobs indicator in the Insight toolbar will appear green in color.
 
{| {{Template:TableAttentionColor}}
|-
|
{|
|-
|style="vertical-align: top;"|
[[file: warning-gray-26.png|bottom]]
|style="vertical-align: top; padding: 0px 0px 0px 11px;"|
This must be enabled to receive long running job notification emails.
|}
|}


=== Verify SQL Instance Connectivity ===
=== Verify SQL Instance Connectivity ===
* Each Insight does a background check to see if the monitored instance is still available. This setting allows the Insight to check every 10, 30, or 60 seconds. Optionally toggling this off does not check for connectivity.
* Each Insight does a background check to see if the monitored instance is still available, typically called a heartbeat. This setting allows the Insight to check every 10, 30, or 60 seconds. Optionally toggling this off does not check for connectivity.
* It is suggested to leave this on if you are actively doing actions with your SQL agent which can alert you ahead of time of any errors.
* It is suggested to leave this on if you are actively doing actions with your SQL agent which can alert you ahead of time of any errors.


Line 25: Line 61:
=== Long Running Job Interval ===
=== Long Running Job Interval ===
* The number of seconds that need to elapse before a job is classified as long running for notification purposes.
* The number of seconds that need to elapse before a job is classified as long running for notification purposes.
* It is recommended to have an overall Insight polling interval less than this value so that long running jobs will be captured appropriately to the Insight log.
 
{| {{Template:TableTipColor}}
|-
|
{|
|-
|style="vertical-align: top;"|
[[file: lightbulb-gray-26.png|bottom]]
|style="vertical-align: top; padding: 0px 0px 0px 11px;"|
It is recommended to have an overall Insight polling interval less than this value so that long running jobs will be captured appropriately to the Insight log and to potentially receive email notifications.
|}
|}


=== Extended Pause Notification Interval ===
=== Extended Pause Notification Interval ===
Line 43: Line 90:


{| {{Template:TableAttentionColor}}
{| {{Template:TableAttentionColor}}
|-
| [[file: warning-gray-26.png|bottom]] '''Attention'''
|-  
|-  
|
|
Global email notifications must be enabled in ''Preferences'' for individual Insight notifications to work correctly.
{|
|-
|style="vertical-align: top;"|
[[file: warning-gray-26.png|bottom]]
|style="vertical-align: top; padding: 0px 0px 0px 11px;"|
Global email notifications must be enabled in ''Preferences'' for individual Insight notifications to work correctly. This is the one single option to enable if you wish to receive notifications for the monitored SQL instance.
|}
|}
|}


Line 56: Line 107:
=== Enable Long Running Job Email ===
=== Enable Long Running Job Email ===


* A distinct email will be sent indicating jobs that run longer than the configured long running job interval on the ''General'' tab.
* A distinct email will be sent indicating jobs that run longer than the configured ''Long running job interval'' on the ''General'' tab.




{| {{Template:TableAttentionColor}}
{| {{Template:TableAttentionColor}}
|-
| [[file: warning-gray-26.png|bottom]] '''Attention'''
|-  
|-  
|
|
{|
|-
|style="vertical-align: top;"|
[[file: warning-gray-26.png|bottom]]
|style="vertical-align: top; padding: 0px 0px 0px 11px;"|
The option ''Enable email notifications'' must be toggled on for this instance.<br>
The option ''Enable email notifications'' must be toggled on for this instance.<br>
Log running jobs on the ''General'' tab must also be enabled for this instance.
Log running jobs on the ''General'' tab must also be enabled for this instance.
|}
|}
|}


Line 75: Line 130:


{| {{Template:TableAttentionColor}}
{| {{Template:TableAttentionColor}}
|-
| [[file: warning-gray-26.png|bottom]] '''Attention'''
|-  
|-  
|
|
{|
|-
|style="vertical-align: top;"|
[[file: warning-gray-26.png|bottom]]
|style="vertical-align: top; padding: 0px 0px 0px 11px;"|
The option ''Enable email notifications'' must be toggled on for this instance.
The option ''Enable email notifications'' must be toggled on for this instance.
|}
|}
|}


Line 85: Line 144:


{|
{|
|- style="vertical-align:top;"
|
|
* Use the toggles on this tab to enable/disable metric collection for an entire Insight category. Metrics that are not collected are not reported on and do not factor into the metric counts for the monitored instance.
* Use the toggles on this tab to enable/disable metric collection for an entire Insight category. Metrics that are not collected are not reported on and do not factor into the metric counts for the monitored instance.
* If you wish to continue to see a group of metrics collected but not alerted on, consider enabling them below and putting that category into maintenance mode.
 
 
{| {{Template:TableTipColor}}
|-
|
{|
|-
|style="vertical-align: top;"|
[[file: lightbulb-gray-26.png|bottom]]
|style="vertical-align: top; padding: 0px 0px 0px 11px;"|
If you wish to continue to see a group of metrics collected but not alerted on, consider enabling them on this tab but instead putting that category into maintenance mode directly on the Insight.
|}
|}
 
|
|
[[file: insight-config-category-polling.png|thumb|right|The Insight configuration window showing the options on the Category Polling tab.]]
[[file: insight-config-category-polling.png|thumb|right|The Insight configuration window showing the options on the Category Polling tab.]]
|}
|}


<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:39, 16 October 2023

Back to Documentation Main

Configuration of an Insight

General

The Insight configuration window showing the options on the General tab.

Polling Interval

The frequency at which data will be refreshed from the SQL instance.

Set the polling interval to a value indicating the frequency in which the metrics should be updated. The dropdown has the following options:

  • Every 15 seconds
  • Every 30 seconds
  • Every 60 seconds
  • Every 5 minutes
  • Every 10 minutes
  • Every 15 minutes
  • Every 30 minutes
  • Every 1 hour
  • Manual

For a more in-depth understanding of how this option functions, please visit Polling Frequency & Recent Timeframe.

Recent Timeframe

The number of days prior to today when gathering recent metrics.

The purpose of the recent timeframe selection allows the manipulation of some metrics that are best measured over a time period. This dropdown has the following options:

  • Every 3 days
  • Every 5 days
  • Every 7 days
  • Every 14 days
  • Every 30 days

For a more in-depth understanding of how this option functions, please visit Polling Frequency & Recent Timeframe.

Log Running Jobs

  • List running jobs to the Insight log once every polling interval. When enabled, the logging of running jobs indicator in the Insight toolbar will appear green in color.

Error creating thumbnail: Unable to save thumbnail to destination

This must be enabled to receive long running job notification emails.

Verify SQL Instance Connectivity

  • Each Insight does a background check to see if the monitored instance is still available, typically called a heartbeat. This setting allows the Insight to check every 10, 30, or 60 seconds. Optionally toggling this off does not check for connectivity.
  • It is suggested to leave this on if you are actively doing actions with your SQL agent which can alert you ahead of time of any errors.

Log Heartbeat Messages

  • Toggles the ability to log heartbeat messages to the Insight log. Disabling this option can reduce the amount written to the Insight log.

Long Running Job Interval

  • The number of seconds that need to elapse before a job is classified as long running for notification purposes.

Error creating thumbnail: Unable to save thumbnail to destination

It is recommended to have an overall Insight polling interval less than this value so that long running jobs will be captured appropriately to the Insight log and to potentially receive email notifications.

Extended Pause Notification Interval

The frequency at which paused notifications are logged and or emailed.

Notifications

The Insight configuration window showing the options on the Notifications tab.

Enable Email Notifications

  • Toggle this on to receive notifications for this Insight. The megaphone icon on the Insight toolbar will appear green when this in on.
  • This must be toggled on for long running job notifications.


Error creating thumbnail: Unable to save thumbnail to destination

Global email notifications must be enabled in Preferences for individual Insight notifications to work correctly. This is the one single option to enable if you wish to receive notifications for the monitored SQL instance.

Enable Long Running Job Email

  • A distinct email will be sent indicating jobs that run longer than the configured Long running job interval on the General tab.


Error creating thumbnail: Unable to save thumbnail to destination

The option Enable email notifications must be toggled on for this instance.
Log running jobs on the General tab must also be enabled for this instance.

Enable Extended Pause Notifications Email

  • A distinct email will be sent every Extended Pause Notification Interval notifying that the monitored instance has been paused. This interval is configured on the General tab.
  • This can be useful in situations whereby a loss of communication with the instance occurs.


Error creating thumbnail: Unable to save thumbnail to destination

The option Enable email notifications must be toggled on for this instance.

Category Polling

  • Use the toggles on this tab to enable/disable metric collection for an entire Insight category. Metrics that are not collected are not reported on and do not factor into the metric counts for the monitored instance.


Error creating thumbnail: Unable to save thumbnail to destination

If you wish to continue to see a group of metrics collected but not alerted on, consider enabling them on this tab but instead putting that category into maintenance mode directly on the Insight.

The Insight configuration window showing the options on the Category Polling tab.

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:Insight_Configuration&oldid=1662"