Skip to content

Commit 049b324

Browse files
authored
Monitor and alert cleanup (#4627)
* Monitor and alert cleanup * link fix
1 parent 95f6809 commit 049b324

24 files changed

+146
-129
lines changed

blog-service/2022/12-31.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -663,7 +663,7 @@ Update - We’ve eased the process of offboarding Sumo Logic users. Now, when yo
663663
---
664664
## February 18, 2022 (Monitors)
665665

666-
Update - The [Monitors page](/docs/alerts/monitors) has a new shortcut to quickly view triggered alerts from a Monitor. Hover your cursor over the Status column of a Monitor and click the icon to open [Alert List](/docs/alerts/monitors/alert-response/#alerts-list).
666+
Update - The [Monitors page](/docs/alerts/monitors) has a new shortcut to quickly view triggered alerts from a Monitor. Hover your cursor over the Status column of a Monitor and click the icon to open [Alert List](/docs/alerts/monitors/alert-response/#alert-list).
667667

668668
---
669669
## February 12, 2022 (Apps)

docs/alerts/monitors/alert-response.md

Lines changed: 59 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -8,17 +8,17 @@ import useBaseUrl from '@docusaurus/useBaseUrl';
88

99
<img src={useBaseUrl('img/icons/operations/alert-and-notify.png')} alt="alert-and-notify.png" width="40"/>
1010

11-
Alert Response provides contextual insights about triggered alerts to minimize the time needed to investigate and resolve application failures.
11+
Alert response provides contextual insights about triggered alerts to minimize the time needed to investigate and resolve application failures. An alert provides curated information to on-calls to help them troubleshoot issues more quickly.
1212

1313
On-call engineers are tasked with firefighting production issues and recovering quickly. They have to investigate issues and try to identify the root cause and fix it, which requires deep knowledge about the production systems, troubleshooting tools, and tons of experience as on-calls. 
1414

15-
By assembling relevant context from prior alerts and by analyzing patterns in logs and metrics underlying alerts, Alert Response enables on-call engineers to cut down the time spent piecing together insights during an incident from various sources and accelerate recovery.
15+
By assembling relevant context from prior alerts and by analyzing patterns in logs and metrics underlying alerts, Sumo Logic alert response enables on-call engineers to cut down the time spent piecing together insights during an incident from various sources and accelerate recovery.
1616

1717
import Iframe from 'react-iframe';
1818

1919
:::sumo Micro Lesson
2020

21-
Learn how to use Alert Response.
21+
Learn how to use alert response.
2222

2323
<Iframe url="https://www.youtube.com/embed/3FHomBuFyV8?rel=0"
2424
width="854px"
@@ -33,46 +33,45 @@ Learn how to use Alert Response.
3333

3434
:::
3535

36-
## Setting up Alert Response
36+
## Setting up alert response
3737

38-
Email alerts automatically get a button labeled **View Alert** that opens the alert on the Alert page, shown in the below image.<br/> ![view alert from email.png](/img/alerts/monitors/view-alert-from-email.png)
38+
Email alerts automatically get a button labeled **View Alert** that opens the alert on the alert page, shown in the below image.<br/> ![view alert from email.png](/img/alerts/monitors/view-alert-from-email.png)
3939

40-
If you use [Webhook connections](/docs/alerts/webhook-connections) offered by Sumo Logic for receiving notifications, you'll need to provide the [`alertResponseUrl` variable](/docs/alerts/monitors/alert-variables) in your notification payload of a monitor to receive a link that opens Alert Response. When your monitor is triggered, it will generate a URL and provide it in the alert notification payload, which you can use to open the Alert Response.
40+
If you use [Webhook connections](/docs/alerts/webhook-connections) offered by Sumo Logic for receiving notifications, you'll need to provide the [`alertResponseUrl` variable](/docs/alerts/monitors/alert-variables) in your notification payload of a monitor to receive a link that opens alert response. When your monitor is triggered, it will generate a URL and provide it in the alert notification payload, which you can use to open the alert response.
4141

4242
The following is an example Slack payload with the variable:
43+
4344
```json
4445
{
45-
"attachments":[
46-
{
47-
"pretext":"Sumo Logic Alert",
48-
"fields":[
49-
{
50-
"title":"Alert Page",
51-
"value":"{{alertResponseUrl}}"
52-
}
53-
],
54-
"mrkdwn_in":[
55-
"text",
56-
"pretext"
57-
],
58-
"color":"#29A1E6"
59-
}
60-
]
46+
"attachments":[
47+
{
48+
"pretext":"Sumo Logic Alert",
49+
"fields":[
50+
{
51+
"title":"Alert Page",
52+
"value":"{{alertResponseUrl}}"
53+
}
54+
],
55+
"mrkdwn_in":[
56+
"text",
57+
"pretext"
58+
],
59+
"color":"#29A1E6"
60+
}
61+
]
6162
}
6263
```
6364

64-
## Alerts list
65-
66-
The Alerts list shows all of your Alerts from monitors triggered within the past 7 days. By default, the list is sorted by status (showing **Active** on top, followed by **Resolved**), and then chronologically by creation time.
65+
## Alert List
6766

68-
[**Classic UI**](/docs/get-started/sumo-logic-ui-classic). To access the Alerts list, click the bell icon in the top menu. <br/> <img src={useBaseUrl('img/alerts/alert-list-page-bell-border.png')} alt="alert-list-page-bell-border" width="300"/>
67+
The Alert List shows all alerts triggered by your monitors within the past 30 days. By default, the list is sorted by status (showing **Active** on top, followed by **Resolved**), and then chronologically by creation time.
6968

70-
[**New UI**](/docs/get-started/sumo-logic-ui/). To access the Alerts list, in the main Sumo Logic menu select **Alerts > Alert List**. You can also click the **Go To...** menu at the top of the screen and select **Alert List**.
69+
To get to your Alert List from the [**New UI**](/docs/get-started/sumo-logic-ui/), select **Alerts > Alert List**. From the [**Classic UI**](/docs/get-started/sumo-logic-ui-classic), click the bell icon in the top menu. <br/> <img src={useBaseUrl('img/alerts/alert-list-page-bell-border.png')} alt="alert-list-page-bell-border" width="200"/>
7170

72-
To filter or sort by category (e.g., **Name**, **Severity**, **Status**), you can use the search bar or click on a column header.<br/>![search alert list.png](/img/alerts/monitors/search-alert-list.png)
71+
To search, use the search bar and filters. To sort by category (for example, **Name**, **Severity**, **Status**), click on a column header.<br/>![search alert list.png](/img/alerts/monitors/search-alert-list.png)
7372

74-
:::info Limitations
75-
The Alerts list displays up to 1,000 alerts.
73+
:::info
74+
The Alerts List displays up to 1,000 alerts.
7675
:::
7776

7877
### Resolving alerts
@@ -81,14 +80,13 @@ To resolve an alert, click a row to select it, then click **Resolve**.
8180

8281
### Translating thresholds
8382

84-
Threshold translating allows you to open the Alert Response page in the **Metrics Explorer** that helps you to easily view the threshold associated with an alert. This also helps you to understand how your monitor's thresholds are translating into metrics and compare the threshold values set in a monitor with the data displayed in the Metrics Explorer chart.
83+
Threshold translating allows you to open the alert response page in the **Metrics Explorer** that helps you to easily view the threshold associated with an alert. This also helps you to understand how your monitor's thresholds are translating into metrics and compare the threshold values set in a monitor with the data displayed in the Metrics Explorer chart.
8584

8685
For example, when you open an alert response page in Metrics Explorer, you can see critical thresholds defined with some number. You can then see that this threshold is also applied and enabled in the Metrics Explorer view, with exactly the same number defined.<br/> <img src={useBaseUrl('img/alerts/arp-metrics-explorer.png')} alt="arp-metrics-explorer" width="800"/>
8786

88-
To view the Alert Response chart in Metrics Explorer, follow the steps below:
87+
To view the alert response chart in Metrics Explorer, follow the steps below:
8988

90-
1. Navigate to the [Alerts list](#alerts-list) and select the alert for which you want to view the corresponding metrics and threshold values.
91-
1. Open the **Alert Response** page.
89+
1. Navigate to your [Alert List](#alert-list) and select the alert for which you want to view the corresponding metrics and threshold values.
9290
1. Click the **View in Metrics Explorer** button for that alert. You can click on either of the two buttons, and they both function the same way.
9391
1. The Metrics Explorer view will open with the graph of the metric associated with the alert.
9492
1. In the **Threshold** section of the Metrics Explorer, you can see the same threshold values for the monitor associated with the alert.<br/> <img src={useBaseUrl('img/alerts/threshold-metrics-explorer-view.png')} alt="threshold-metrics-explorer" width="800"/>
@@ -104,15 +102,12 @@ Note that the same threshold translating functionality supports to [Create Monit
104102

105103
## Alert page
106104

107-
The Alert page is where you can view granular details about an individual alert. To get to an Alert page, click on any row from your Alerts list.
108-
109-
An Alert provides curated information to on-calls in order for them to troubleshoot issues more quickly. It provides two different types of information to help get to the root cause of the issue quickly.
110-
* **Alert Details**. Overview of the alert that was triggered to help you understand the issue and its potential impact. 
111-
* **Alert Context**. System curated context helps you understand potential underlying symptoms within the system that might be causing the issue.
105+
An alert page is where you can view granular details about an individual alert. To get to an alert page, go to your **Alert List** and click on any alert. You'll see two types of information to help get to the root cause of the issue quickly: alert details and alert context.
112106

113107
### Alert details
114108

115-
The details section provides:
109+
The alert details section is an overview of the alert that was triggered to help you understand the issue and its potential impact. This section provides:
110+
116111
* a chart to visualize the alerting KPI before and during the alert.
117112
* a table with the raw data that triggered the alert.
118113
* related alerts firing in the system around the same time.
@@ -123,10 +118,10 @@ The following images label each section of the page with a letter, see the list
123118

124119
The top of the page provides several details and buttons.
125120

126-
* **A**. The title of the monitor.
127-
* **B**. Copy the link to the opened Alert page.
128-
* **C**. The type of monitor trigger condition that triggered the alert, either Critical, Warning, or MissingData.
129-
* **D**. The status of the Alert, either **Active** or **Resolved**.
121+
* **A**. Monitor name.
122+
* **B**. Copies the link to the opened Alert page.
123+
* **C**. Shows the type of monitor trigger condition that triggered the alert (Critical, Warning, or Missing Data).
124+
* **D**. Status of the Alert (**Active** or **Resolved**).
130125
* **E**. Refreshes the Alert page.
131126
* **F**. Opens the [playbook associated with this monitor](/docs/alerts/monitors/create-monitor/#step-4-playbook-optional).
132127
* Text playbooks allow admins to codify tribal knowledge for an on-call so they know what exactly to do when they receive an alert:<br/> ![playbook example.png](/img/alerts/monitors/playbook-example.png)
@@ -155,10 +150,14 @@ Below this, as you scroll down on the page, you'll see context cards covered in
155150

156151
### Alert context cards
157152

158-
**Alert Context** provides additional insights that the system has discovered automatically by analyzing your data. The system uses artificial intelligence and machine learning to track your logs and metrics data and find interesting patterns in the data that might help explain the underlying issue and surfaces them in the form of context cards.
153+
Alert context is system-curated information helps you understand potential underlying symptoms that might be causing the issue. It provides additional insights automatically discovered by the system through data analysis. Using artificial intelligence and machine learning, the system tracks your logs and metrics, identifies patterns that may explain the issue, and presents them as context cards.
159154

160155
Depending on the type of data an alert is based on (metrics or logs) and the detection method (static or outlier), you'll see different context cards. You will see a progress spinner labeled **Analyzing alert content** at the bottom of the window when cards are still being loaded. It may take a minute for some cards to load.<br/> ![analyzing alert content.png](/img/alerts/monitors/analyzing-alert-content.png)
161156

157+
### Alert tags
158+
159+
See [Using tags in alerts](/docs/alerts/monitors/settings/#using-tags-in-alerts).
160+
162161
### Log fluctuations
163162

164163
This card detects different signatures in your log messages using [LogReduce](/docs/search/logreduce) such as errors, exceptions, timeouts, and successes. It compares log signatures trends with a normal baseline period and surfaces noteworthy changes in signatures.
@@ -227,17 +226,23 @@ For example, the card below shows that `ServiceUnavailable` error is happening 3
227226
* **E**. Expand/collapse details panel.
228227
* **F**. Opens a Log Search filtered to the Log messages that match the dimensional details of the telemetry value
229228

230-
## Subscribe to alert monitors
229+
## Subscribe to monitors
230+
231+
### From your Alerts List
232+
233+
There are three places from your [Alerts List](#alert-list) to subscribe to a monitor:
234+
235+
* Right-click on a row item > click **Subscribe**.
236+
* Hover your mouse over a row, click the three-dot kebab menu > select **Subscribe**.
237+
* Single-click on a row item > on the opened alert page, click the three-dot kebab menu > **Subscribe to Monitor**.
238+
239+
### From your Monitors list
231240

232-
### From your Alerts list
233-
* Right-click on a row item > click **Subscribe**
234-
* Hover your mouse over a row, click the three-dot kebab menu > select **Subscribe**
235-
* Single-click on a row item > on the opened Alert page, click the three-dot kebab menu > **Subscribe to Monitor**
241+
There are three places from your [Monitors](/docs/alerts/monitors/settings) list to subscribe to a monitor:
236242

237-
### From your monitors list
238-
* Right-click on a row item > click **Subscribe**
239-
* Hover your mouse over a row > click the three-dot kebab menu > click **Subscribe**
240-
* Single-click on a row item > in the side panel (Monitor Details), click **More Actions** > **Subscribe**
243+
* Right-click on a row item > click **Subscribe**.
244+
* Hover your mouse over a row > click the three-dot kebab menu > click **Subscribe**.
245+
* Single-click on a row item > in the side panel (Monitor Details), click **More Actions** > **Subscribe**.
241246

242247
#### From a folder
243248

docs/alerts/monitors/create-monitor.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
id: create-monitor
3-
title: Create a Monitor
3+
title: Create a New Monitor
44
description: Learn how to create a Sumo Logic monitor.
55
---
66

@@ -12,7 +12,7 @@ This guide will walk you through the steps of creating a monitor in Sumo Logic,
1212

1313
There are several ways to create a new monitor, depending on where you are in Sumo Logic.
1414

15-
### From the Monitors page
15+
### From Monitors
1616

1717
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**.
1818
1. Click **Add** > **New Monitor**, and the **New Monitor** dialog box will appear.

0 commit comments

Comments
 (0)