Skip to content

Commit bc194d8

Browse files
added digest to docs
1 parent bdb0191 commit bc194d8

File tree

6 files changed

+63
-1
lines changed

6 files changed

+63
-1
lines changed
Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
---
2+
title: "Incidents Digest"
3+
sidebarTitle: "Incidents digest"
4+
---
5+
6+
**Incidents Digest** lets you send a scheduled summary of incidents to your team in addition to real-time alerts. Your team receives a consolidated digest on a daily or weekly cadence covering all relevant incidents in that period.
7+
8+
This is useful for reducing noise, providing management-level visibility, or keeping stakeholders informed without overwhelming them with individual alerts.
9+
10+
<Frame>
11+
<img src="/pics/cloud/incident_digest_list.png" alt="Incidents Digest tab in Alert Rules" />
12+
</Frame>
13+
14+
## How it works
15+
16+
Digest rules are configured under **Alert Rules → Incidents Digest** tab. Each rule defines:
17+
18+
- **When** to send the digest (cadence: daily or weekly, at a specific hour)
19+
- **What** incidents to include (filters by tag, owner, status, model, or category)
20+
- **Where** to send it (one or more destinations such as a Slack channel or email)
21+
22+
At the scheduled time, Elementary collects all incidents that match the rule's filters since the last digest was sent, and delivers them as a single message.
23+
24+
<Frame>
25+
<img src="/pics/cloud/incident_digest_email.png" alt="Incidents digest email" />
26+
</Frame>
27+
28+
## Creating a digest rule
29+
30+
Navigate to **Alert Rules** in the left sidebar and select the **Incidents Digest** tab. Click **Create digest rule** to open the configuration drawer.
31+
32+
The filters, categories, and destinations are configured the same way as in [Alert Rules](/cloud/features/alerts-and-incidents/alert-rules). The one addition unique to digest rules is **cadence**.
33+
34+
### Cadence
35+
36+
Choose how often the digest should be sent:
37+
38+
- **Daily** — sent once a day at the hour you choose.
39+
- **Weekly** — sent once a week on the day and at the hour you choose.
40+
41+
The time is in UTC.
42+
43+
<Frame>
44+
<img src="/pics/cloud/incident_digest_cadence.png" alt="Digest cadence selector" />
45+
</Frame>
46+
47+
## Managing digest rules
48+
49+
Once created, digest rules appear as cards in the **Incidents Digest** tab. From each card you can:
50+
51+
- **Edit** the rule to change any configuration.
52+
- **Activate / Deactivate** the rule without deleting it.
53+
- **Delete** the rule.
54+
55+
<Frame>
56+
<img src="/pics/cloud/incident_digest_rule_menu.png" alt="Digest rule action menu" />
57+
</Frame>
58+
59+
## Relationship with alert rules
60+
61+
Digest rules are independent of [Alert Rules](/cloud/features/alerts-and-incidents/alert-rules). You can have both real-time alert rules and digest rules active at the same time — they are evaluated separately. A common pattern is to use real-time alert rules for critical on-call channels and digest rules for broader team summaries.

docs/docs.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,8 @@
100100
]
101101
},
102102
"cloud/features/alerts-and-incidents/incidents",
103-
"cloud/features/alerts-and-incidents/incident-management"
103+
"cloud/features/alerts-and-incidents/incident-management",
104+
"cloud/features/alerts-and-incidents/incident-digest"
104105
]
105106
},
106107
{
119 KB
Loading
241 KB
Loading
305 KB
Loading
69.7 KB
Loading

0 commit comments

Comments
 (0)