Skip to content

Commit 8858b4e

Browse files
kimsaucegchairuangsangjpipkin1
authored
DOCS-674 - Static log monitor frequency evaluation (#5036)
* DOCS-674 - Static log monitor frequency evaluation * Update docs/alerts/monitors/alert-grouping.md * Update docs/alerts/monitors/alert-grouping.md * Update docs/alerts/monitors/overview.md * add CID * Update alert-grouping.md revert * Update docs/alerts/monitors/create-monitor.md * Update docs/alerts/monitors/create-monitor.md Co-authored-by: Gin Chairuangsang <[email protected]> * Update docs/alerts/monitors/overview.md Co-authored-by: John Pipkin (Sumo Logic) <[email protected]> * Update docs/alerts/monitors/create-monitor.md Co-authored-by: Gin Chairuangsang <[email protected]> * Update docs/alerts/monitors/create-monitor.md Co-authored-by: Gin Chairuangsang <[email protected]> * Update docs/alerts/monitors/create-monitor.md * Update docs/alerts/monitors/create-monitor.md * merge w main * Update docs/alerts/monitors/create-monitor.md --------- Co-authored-by: Gin Chairuangsang <[email protected]> Co-authored-by: John Pipkin (Sumo Logic) <[email protected]>
1 parent c9d745f commit 8858b4e

File tree

9 files changed

+28
-14
lines changed

9 files changed

+28
-14
lines changed

cid-redirects.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1565,6 +1565,7 @@
15651565
"/cid/1001": "/docs/send-data/installed-collectors/sources/remote-file-source",
15661566
"/cid/10011": "/docs/manage/data-archiving",
15671567
"/cid/1002": "/docs/send-data/installed-collectors/sources/syslog-source",
1568+
"/cid/10019": "/docs/alerts/monitors/create-monitor",
15681569
"/cid/10020": "/docs/alerts/monitors",
15691570
"/cid/10021": "/docs/alerts/monitors/alert-response-faq",
15701571
"/cid/10022": "/docs/alerts/monitors/muting-schedules",

docs/alerts/monitors/create-monitor.md

Lines changed: 24 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -166,13 +166,18 @@ 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+
| 5m | 1m, 2m |
173+
| 10m | 1m, 2m, 5m |
174+
| 15m | 1m, 2m, 5m, 10m |
175+
| 30m | 2m, 5m, 10m, 20m |
176+
| 1h | 2m, 5m, 10m, 20m |
177+
| 3h | 10m, 20m, 40m, 1h |
178+
| 6h | 10m, 20m, 40m, 1h |
179+
| 12h | 20m, 40m, 1h |
180+
| 24h | 20m, 40m, 1h |
176181
* 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.
177182
```
178183
_sourceCategory=Labs/Apache/Access
@@ -187,21 +192,26 @@ Triggers are evaluated by balancing the requirement of timely alert notification
187192

188193
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.
189194

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"/>
195+
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"/>
191196

192197
#### Static detection method
193198

194199
**Example: Logs - Static - Critical and Warning**
195200

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

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

200205
| Parameter | Description |
201206
|:--|:--|
202207
| `<threshold type>` | How you want the value compared. Select **greater than**, **greater than or equal**, **less than or equal**, or **less than**. |
203208
| `<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). |
209+
| `<time range - trigger>` | The duration of time to evaluate. Values range from 2 Minutes to 24 Hours (or 7 Days, by request only). |
210+
| `<trigger - frequency>` | The frequency that the trigger is evaluated. |
211+
212+
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.
213+
214+
<img src={useBaseUrl('img/alerts/monitors/show-estimated-scan.png')} alt="Estimated Scan Data icon" style={{border: '1px solid gray'}} width="700"/>
205215

206216
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.
207217

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

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

214-
`Alert when missing data within <time range>`
224+
`Alert when missing data within <time range - trigger>. Evaluate every <trigger - frequency>.`
215225

216226
| Parameter | Description |
217227
|:--|:--|
218-
| `<time range>` | The duration of time to evaluate (values range from 5 minutes to 24 hours). |
228+
| `<time range - trigger>` | The duration of time to evaluate (values range from 5 minutes to 24 hours). |
229+
| `<trigger - frequency>` | The frequency that the trigger is evaluated. |
219230

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

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

271282
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.
272283

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"/>
284+
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"/>
274285

275286
#### Prerequisites
276287

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 24 hours, 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)