Skip to content

Commit a5f9bc6

Browse files
committed
DOCS-674 - Static log monitor frequency evaluation
1 parent 2ab79e6 commit a5f9bc6

File tree

9 files changed

+31
-18
lines changed

9 files changed

+31
-18
lines changed

docs/alerts/monitors/alert-grouping.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Alert grouping works for both logs and metrics monitors.
2020

2121
### Metrics
2222

23-
1. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Manage Data > Monitoring > Monitors**. <br/>[**New UI**](/docs/get-started/sumo-logic-ui). In the main Sumo Logic menu, select **Alerts > Monitors**. You can also click the **Go To...** menu at the top of the screen and select **Monitors**.
23+
1. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Manage Data > Monitoring > Monitors**. <br/>[**New UI**](/docs/get-started/sumo-logic-ui). In the main Sumo Logic menu, select **Alerts > Monitors**. You can also click the **Go To...** menu at the top of the screen and select **Monitors**.
2424
2. Click **Add a New monitor**.
2525
3. Select **Metrics** as the type of monitor.
2626
4. Enter your metrics query, then select your desired alert grouping option.
@@ -32,16 +32,14 @@ Alert grouping works for both logs and metrics monitors.
3232

3333
### Logs
3434

35-
1. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Manage Data > Monitoring > Monitors**. <br/>[**New UI**](/docs/get-started/sumo-logic-ui). In the main Sumo Logic menu, select **Alerts > Monitors**. You can also click the **Go To...** menu at the top of the screen and select **Monitors**.
35+
1. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Manage Data > Monitoring > Monitors**. <br/>[**New UI**](/docs/get-started/sumo-logic-ui). In the main Sumo Logic menu, select **Alerts > Monitors**. You can also click the **Go To...** menu at the top of the screen and select **Monitors**.
3636
2. Click **Add a New monitor**.
3737
3. Select **Logs** as the type of monitor.
3838
4. Enter your logs query, then select your desired alert grouping option:
3939
* **One alert per monitor**. Choose this option if you want to only receive a single alert for the entire monitor.
4040
* **One alert per [group]**. Allows you to receive one notification per each unique value of the grouping field(s). You can pick more than one field for the grouping condition. In the example below, you would receive one alert for each `service` that has error count greater than 50. The input field has an auto-completion dropdown that allows you to select all the applicable fields from your query.<br/><img src={useBaseUrl('img/alerts/monitors/setup-logs.png')} alt="setup-logs.png" style={{border: '1px solid gray'}} width="800" />
4141
5. Configure the rest of your alert condition per standard procedure. Refer to [Monitors](/docs/alerts/monitors) for more details.
4242

43-
The input field has an auto-completion dropdown that allows you to select all the applicable fields from your query.
44-
4543
## Set a Muting Schedule for an alert group
4644

4745
Optionally, you can apply a Muting Schedule to your alert group. [Learn more](/docs/alerts/monitors/muting-schedules/#set-a-muting-schedule-for-an-alert-group).

docs/alerts/monitors/create-monitor.md

Lines changed: 26 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -166,13 +166,20 @@ You can set a logs monitor trigger to alert based on the following:
166166

167167
Triggers are evaluated by balancing the requirement of timely alert notifications while ensuring that monitor data is indeed available to evaluate trigger conditions.
168168

169-
* For [static logs monitors](#static-detection-method), triggers are similar to "Alert when the result is greater than _ within Y Minutes". The triggers are evaluated periodically as below.
170-
| When detection window (Y) is | Evaluate trigger every |
171-
|:-----------------------------|:-----------------------|
172-
| 15m or less | 1m |
173-
| 15m to 1h | 2m |
174-
| 1h to 6h | 10m |
175-
| Greater than 6h | 20m |
169+
* For [static logs monitors](#static-detection-method), you can control trigger monitor evaluation frequency using the options below. If `Alert when result is <greater/less> than <_> within <X>. Evaluate trigger every <Y>.`:
170+
| When detection window (X) is | Evaluate trigger every (Y) |
171+
|:-----|:-----------------------|
172+
| 2m | 1m, 2m |
173+
| 5m | 1m, 2m, 5m |
174+
| 10m | 1m, 2m, 5m, 10m |
175+
| 15m | 1m, 2m, 5m, 10m |
176+
| 30m | 2m, 5m, 10m, 20m |
177+
| 1h | 2m, 5m, 10m, 20m |
178+
| 3h | 10m, 20m, 40m, 1h |
179+
| 6h | 10m, 20m, 40m, 1h |
180+
| 12h | 20m, 40m, 1h |
181+
| 24h | 20m, 40m, 1h |
182+
| 7d | 20m, 40m, 1h |
176183
* For [anomaly logs monitors](#anomaly-detection-method), triggers are evaluated every `timeslice` as specified in the monitor query. For example, the below query is evaluated every 2 minutes.
177184
```
178185
_sourceCategory=Labs/Apache/Access
@@ -187,21 +194,26 @@ Triggers are evaluated by balancing the requirement of timely alert notification
187194

188195
When configuring monitor trigger conditions, you can set a resolution window to resolve alerts quickly once the underlying issue is fixed. The resolution window specifies how long a monitor will wait before resolving an alert after the issue is corrected.
189196

190-
For example, if your monitor evaluates the last 1 hour, you can set a resolution window of 15 minutes. Once the resolution window is continuously satisfied for 15 minutes, the alert will resolve automatically.<br/><img src={useBaseUrl('img/alerts/monitors/config-resolution-window-2.png')} alt="config-resolution-window" style={{border: '1px solid gray'}} width="700"/>
197+
For example, if your monitor evaluates the last 1 Hour, you can set a resolution window of 15 Minutes. Once the resolution window is continuously satisfied for 15 Minutes, the alert will resolve automatically.<br/><img src={useBaseUrl('img/alerts/monitors/config-resolution-window-logs.png')} alt="config-resolution-window" style={{border: '1px solid gray'}} width="700"/>
191198

192199
#### Static detection method
193200

194201
**Example: Logs - Static - Critical and Warning**
195202

196203
<img src={useBaseUrl('img/alerts/monitors/logs-trigger-type.png')} alt="logs trigger type.png" style={{border: '1px solid gray'}} width="600"/>
197204

198-
`Alert when result is <threshold type> <threshold> within <time range>`
205+
`Alert when result is <threshold type> <threshold> within <time range - trigger>. Evaluate every <time range - frequency>.`
199206

200207
| Parameter | Description |
201208
|:--|:--|
202209
| `<threshold type>` | How you want the value compared. Select **greater than**, **greater than or equal**, **less than or equal**, or **less than**. |
203210
| `<threshold>` | The value against which the trigger will be evaluated. You can specify any valid numeric value up to **1,000**. |
204-
| `<time range>` | The duration of time to evaluate (values range from 5 minutes to 24 hours). |
211+
| `<time range - trigger>` | The duration of time to evaluate. Values range from 2 Minutes to 24 Hours (or 7 Days, by request only). |
212+
| `<time range - frequency>` | The frequency that the monitor is evaluated. |
213+
214+
After setting the frequency evaluation, you can preview your [estimated scan data](/docs/manage/partitions/flex/estimate-scan-data) by clicking the **Show Estimated Scan** icon, as seen below.
215+
216+
<img src={useBaseUrl('img/alerts/monitors/show-estimated-scan.png')} alt="Estimated Scan Data" style={{border: '1px solid gray'}} width="700"/>
205217

206218
The recovery condition is set by default to the opposite of the alert condition. If you need to change these settings, switch on the **Edit recovery settings** toggle and then adjust values for the recovery settings accordingly.
207219

@@ -211,11 +223,12 @@ For example, if an alert is set to `greater than 10`, the recovery would be se
211223

212224
<img src={useBaseUrl('img/alerts/monitors/logs-static-missing.png')} alt="logs-static-missing" style={{border: '1px solid gray'}} width="600" />
213225

214-
`Alert when missing data within <time range>`
226+
`Alert when missing data within <time range>. Evaluate every <time range - frequency>.`
215227

216228
| Parameter | Description |
217229
|:--|:--|
218-
| `<time range>` | The duration of time to evaluate (values range from 5 minutes to 24 hours). |
230+
| `<time range - trigger>` | The duration of time to evaluate (values range from 5 minutes to 24 hours). |
231+
| `<time range - frequency>` | The frequency that the monitor is evaluated. |
219232

220233
For recovery, Sumo Logic will automatically resolve the incident when the resolution condition is satisfied.
221234

@@ -270,7 +283,7 @@ For Metrics monitors, you can choose to recover based on a single data point bel
270283

271284
When configuring monitor trigger conditions, you can set a resolution window to resolve alerts quickly once the underlying issue is fixed. The resolution window specifies how long a monitor will wait before resolving an alert after the issue is corrected.
272285

273-
For example, if your monitor evaluates the last 1 hour, you can set a resolution window of 15 minutes. Once the resolution window is continuously satisfied for 15 minutes, the alert will resolve automatically.<br/><img src={useBaseUrl('img/alerts/monitors/config-resolution-window-2.png')} alt="config-resolution-window" style={{border: '1px solid gray'}} width="700"/>
286+
For example, if your monitor evaluates the last 1 hour, you can set a resolution window of 15 minutes. Once the resolution window is continuously satisfied for 15 minutes, the alert will resolve automatically.<br/><img src={useBaseUrl('img/alerts/monitors/config-resolution-window-metrics.png')} alt="config-resolution-window" style={{border: '1px solid gray'}} width="700"/>
274287

275288
#### Prerequisites
276289

docs/alerts/monitors/overview.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,9 @@ To manage and/or view monitors, you'll need the **Manage** and **View Monitor
2323

2424
The frequency at which a monitor executes depends on various factors, such as the underlying query, the operators used, and the detection window. This frequency can range from a few seconds to several minutes.
2525

26-
For example, if the detection window of your alert is one day, it will be evaluated every few minutes. Conversely, if the detection window of the monitor is 15 minutes, it will be evaluated every few seconds.
26+
For example, if the detection window of your alert is 1 Day, it will be evaluated every few minutes. Conversely, if the detection window of the monitor is 15 Minutes, it will be evaluated every few seconds.
27+
28+
See [Trigger Type (Logs)](/docs/alerts/monitors/create-monitor/#trigger-type-logs) and [Trigger Type (Metrics)](/docs/alerts/monitors/create-monitor/#trigger-type-metrics) for more information.
2729

2830
### Log monitors
2931

51.3 KB
Loading
21.6 KB
Loading
4.59 KB
Loading
-33 KB
Loading
179 KB
Loading

0 commit comments

Comments
 (0)