Skip to content
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
a5f9bc6
DOCS-674 - Static log monitor frequency evaluation
kimsauce Feb 4, 2025
a28f13d
Update docs/alerts/monitors/alert-grouping.md
kimsauce Feb 4, 2025
2ff31c2
Update docs/alerts/monitors/alert-grouping.md
kimsauce Feb 4, 2025
5fe6bcb
Update docs/alerts/monitors/overview.md
kimsauce Feb 4, 2025
93c418c
add CID
kimsauce Feb 4, 2025
a97312d
Merge branch 'DOCS-674-Static-monitors-evaluation-frequency-config-up…
kimsauce Feb 4, 2025
c3bb13e
Update alert-grouping.md
kimsauce Feb 10, 2025
72205e1
Update docs/alerts/monitors/create-monitor.md
kimsauce Feb 10, 2025
53b92a1
Merge branch 'main' into DOCS-674-Static-monitors-evaluation-frequenc…
kimsauce Feb 10, 2025
bc5cd58
Update docs/alerts/monitors/create-monitor.md
kimsauce Feb 11, 2025
4baf45b
Update docs/alerts/monitors/overview.md
kimsauce Feb 11, 2025
11be51a
Update docs/alerts/monitors/create-monitor.md
kimsauce Feb 11, 2025
461c4a0
Update docs/alerts/monitors/create-monitor.md
kimsauce Feb 11, 2025
abd0d01
Update docs/alerts/monitors/create-monitor.md
kimsauce Feb 11, 2025
34c8f5e
Update docs/alerts/monitors/create-monitor.md
kimsauce Feb 11, 2025
88aff1b
Merge branch 'main' into DOCS-674-Static-monitors-evaluation-frequenc…
kimsauce Feb 18, 2025
74830eb
Merge branch 'main' into DOCS-674-Static-monitors-evaluation-frequenc…
kimsauce Feb 18, 2025
7738b9f
Merge branch 'DOCS-674-Static-monitors-evaluation-frequency-config-up…
kimsauce Feb 18, 2025
305d2b4
merge w main
kimsauce Feb 18, 2025
d4269e4
Update docs/alerts/monitors/create-monitor.md
kimsauce Feb 18, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions docs/alerts/monitors/alert-grouping.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,6 @@ Alert grouping works for both logs and metrics monitors.
* **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" />
5. Configure the rest of your alert condition per standard procedure. Refer to [Monitors](/docs/alerts/monitors) for more details.

The input field has an auto-completion dropdown that allows you to select all the applicable fields from your query.

## Set a Muting Schedule for an alert group

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).
Expand Down
39 changes: 26 additions & 13 deletions docs/alerts/monitors/create-monitor.md
Original file line number Diff line number Diff line change
Expand Up @@ -166,13 +166,20 @@ You can set a logs monitor trigger to alert based on the following:

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

* 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.
| When detection window (Y) is | Evaluate trigger every |
|:-----------------------------|:-----------------------|
| 15m or less | 1m |
| 15m to 1h | 2m |
| 1h to 6h | 10m |
| Greater than 6h | 20m |
* 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>.`:
| When detection window (X) is | Evaluate trigger every (Y) |
|:-----|:-----------------------|
| 2m | 1m, 2m |
| 5m | 1m, 2m, 5m |
| 10m | 1m, 2m, 5m, 10m |
| 15m | 1m, 2m, 5m, 10m |
| 30m | 2m, 5m, 10m, 20m |
| 1h | 2m, 5m, 10m, 20m |
| 3h | 10m, 20m, 40m, 1h |
| 6h | 10m, 20m, 40m, 1h |
| 12h | 20m, 40m, 1h |
| 24h | 20m, 40m, 1h |
| 7d | 20m, 40m, 1h |
* 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.
```
_sourceCategory=Labs/Apache/Access
Expand All @@ -187,21 +194,26 @@ Triggers are evaluated by balancing the requirement of timely alert notification

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.

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"/>
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"/>

#### Static detection method

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

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

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

| Parameter | Description |
|:--|:--|
| `<threshold type>` | How you want the value compared. Select **greater than**, **greater than or equal**, **less than or equal**, or **less than**. |
| `<threshold>` | The value against which the trigger will be evaluated. You can specify any valid numeric value up to **1,000**. |
| `<time range>` | The duration of time to evaluate (values range from 5 minutes to 24 hours). |
| `<time range - trigger>` | The duration of time to evaluate. Values range from 2 Minutes to 24 Hours (or 7 Days, by request only). |
| `<time range - frequency>` | The frequency that the monitor is evaluated. |

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.

<img src={useBaseUrl('img/alerts/monitors/show-estimated-scan.png')} alt="Estimated Scan Data" style={{border: '1px solid gray'}} width="700"/>

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.

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

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

`Alert when missing data within <time range>`
`Alert when missing data within <time range>. Evaluate every <time range - frequency>.`

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

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

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

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.

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"/>
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"/>

#### Prerequisites

Expand Down
4 changes: 3 additions & 1 deletion docs/alerts/monitors/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,9 @@ To manage and/or view monitors, you'll need the **Manage** and **View Monitor

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.

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

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.

### Log monitors

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/img/alerts/monitors/logs-static-missing.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/img/alerts/monitors/logs-trigger-type.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/img/alerts/monitors/setup-logs.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.