Skip to content

Commit 6cc8f1d

Browse files
authored
Docs: Add docs for the resolve timer (#57)
2 parents 9049d45 + 5d2b4df commit 6cc8f1d

File tree

3 files changed

+172
-0
lines changed

3 files changed

+172
-0
lines changed
50.3 KB
Loading
61.3 KB
Loading
Lines changed: 172 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,172 @@
1+
# Resolve Timer
2+
3+
Keep your incident dashboard clean and focused with automated incident resolution. Resolve Timer automatically closes incidents after a specified time period, helping your team focus on what matters most.
4+
5+
## Overview
6+
7+
Resolve Timer is an intelligent automation feature that automatically resolves incidents after a predetermined time period. Think of it as your dashboard's cleanup crew - it ensures that incidents don't linger indefinitely and clutter your incident management view.
8+
9+
When an incident remains open for the duration you've specified, Resolve Timer steps in and automatically marks it as resolved. This helps maintain a clean, actionable dashboard where your team can focus on active, unresolved incidents that need immediate attention.
10+
11+
## Why use Resolve Timer?
12+
13+
**Cleaner dashboards**: Eliminate incident clutter and maintain focus on active issues that require immediate attention.
14+
15+
**Better team productivity**: Your team spends time on genuine incidents.
16+
17+
**Consistent incident hygiene**: Ensure incidents don't remain open indefinitely, maintaining accurate incident metrics and reporting.
18+
19+
## How Resolve Timer works
20+
21+
Once configured, Resolve Timer monitors your incidents and automatically resolves them based on your specified timeframe. The timer starts counting from the moment an incident is created, and when it reaches your configured duration, the incident is automatically marked as resolved.
22+
23+
You can configure Resolve Timer in two ways:
24+
- **Integration-level**: Automatically resolve all incidents from a specific integration
25+
- **Alert rule-level**: Resolve incidents that match specific conditions using alert rules
26+
27+
## Prerequisites
28+
29+
Before configuring Resolve Timer, make sure you have:
30+
- Permission to Edit/Create an Alert rule
31+
- Permission to Edit/Create an Integration
32+
33+
## Configuration Methods
34+
35+
### Method 1: Integration-level Resolve Timer
36+
37+
Use this method when you want every incident from a specific integration to automatically resolve after a set time period.
38+
39+
#### Step-by-step setup
40+
41+
**Step 1**: Navigate to your integration settings
42+
- Go to **Integrations** in your Spike dashboard
43+
- Find the integration you want to configure
44+
- Click **Edit** or create a new integration
45+
46+
**Step 2**: Access advanced configuration
47+
- Scroll down to the **Advanced Configuration** section
48+
- Look for the **Resolve Timer** toggle switch
49+
50+
**Step 3**: Enable and configure Resolve Timer
51+
- Toggle the **Resolve Timer** switch to **ON**
52+
- Enter your desired time value in the input field
53+
- Select the time unit from the dropdown: **Minutes**, **Hours**, or **Days**
54+
55+
**Step 4**: Save your configuration
56+
- Click **Save** to apply your changes
57+
- All future incidents from this integration will automatically resolve after your specified time period
58+
59+
#### Example configuration
60+
- **Time value**: 24
61+
- **Time unit**: Hours
62+
- **Result**: All incidents from this integration will automatically resolve after 24 hours
63+
64+
<img src="../.gitbook/assets/setup resolve timer (integration).png" style="border-radius: 6px;" alt="How to configure resolve timer in alert rules">
65+
66+
67+
### Method 2: Alert Rule-based Resolve Timer
68+
69+
Use this method when you want to resolve incidents that match specific conditions, giving you more granular control over which incidents get automatically resolved.
70+
71+
#### Step-by-step setup
72+
73+
**Step 1**: Create or edit an alert rule
74+
- Navigate to **Alert Rules** in your dashboard
75+
- Click **Create Alert Rule** or select an existing rule to edit
76+
77+
**Step 2**: Configure your conditions
78+
- Set up your alert conditions as needed
79+
- Define which incidents should trigger this rule
80+
81+
**Step 3**: Add the Resolve Timer action
82+
- In the **Actions** section, click **Add Action**
83+
- Select **Resolve After** from the action dropdown
84+
85+
**Step 4**: Configure timing
86+
- Enter your desired time value
87+
- Select the time unit: **Minutes**, **Hours**, or **Days**
88+
- Click **Save** or **Update** to apply your rule
89+
90+
#### Example alert rule configuration
91+
- **Condition**: Incidents from "Production Database" service
92+
- **Action**: Resolve After 2 hours
93+
- **Result**: Database incidents automatically resolve after 2 hours if not manually handled
94+
95+
<img src="../.gitbook/assets/Setup resovle timer (alert rules).png" style="border-radius: 6px;" alt="How to configure resolve timer in alert rules">
96+
97+
## Configuration Options
98+
99+
### Time Units Available
100+
| Unit | Minimum Value | Maximum Value | Best For |
101+
|------|---------------|---------------|----------|
102+
| Minutes | 1 | 1440 (24 hours) | Short-lived alerts, testing |
103+
| Hours | 1 | 168 (7 days) | Standard incident workflows |
104+
| Days | 1 | 7 | Long-running maintenance, planned outages |
105+
106+
### Integration vs Alert Rule: Which to choose?
107+
108+
**Use Integration-level Resolve Timer when**:
109+
- You want consistent behavior across all incidents from a source
110+
- You're dealing with noisy integrations that generate many low-priority alerts
111+
- You need simple, set-and-forget automation
112+
113+
**Use Alert Rule-based Resolve Timer when**:
114+
- You need different resolution times based on incident characteristics
115+
- You want to combine auto-resolution with other automated actions
116+
- You need conditional logic for incident resolution
117+
118+
119+
> **Resolve Timer is available on all Spike plans** - Starter, Business, and Enterprise.
120+
121+
## Best Practices
122+
123+
**Start with longer timeframes**: Begin with conservative resolution times (like 24 hours) and adjust based on your team's workflow patterns.
124+
125+
**Monitor resolution patterns**: Review auto-resolved incidents periodically to ensure you're not missing important alerts.
126+
127+
**Use different timers for different services**: Critical production services might need longer resolution times than development or staging environments.
128+
129+
**Test your configuration**: Set up Resolve Timer with a test integration first to understand how it behaves with your incident types.
130+
131+
## FAQs
132+
133+
<details>
134+
<summary>Q: Can I disable Resolve Timer for specific incidents?</summary>
135+
A: Not for individual incidents, but you can disable it at the integration level or modify alert rule conditions to exclude certain incident types.
136+
</details>
137+
138+
<details>
139+
<summary>Q: What happens if I manually resolve an incident before the timer expires?</summary>
140+
A: Manual resolution takes priority. The timer stops, and the incident remains manually resolved.
141+
</details>
142+
143+
<details>
144+
<summary>Q: Can I see which incidents were auto-resolved?</summary>
145+
A: Yes, auto-resolved incidents show a `Resolved (timer)` status. You can also check activity log to see if the incident was auto
146+
</details>
147+
148+
<details>
149+
<summary>Q: Can I set different resolution times for different severity levels?</summary>
150+
A: Yes, using alert rules you can create different Resolve Timer configurations based on incident severity, service, or other conditions.
151+
</details>
152+
153+
<details>
154+
<summary>Q: What's the shortest resolution time I can set?</summary>
155+
A: The minimum is 1 minute, though we recommend at least 15-30 minutes for most use cases to allow for proper incident handling.
156+
</details>
157+
158+
<details>
159+
<summary>Q: Will I get notified when incidents auto-resolve?</summary>
160+
A: This depends on your notification settings. You can configure whether you want to receive notifications for auto-resolved incidents.
161+
</details>
162+
163+
## Need Help?
164+
165+
If you're having trouble setting up Resolve Timer or have questions about your specific use case:
166+
- Check out our [Integration documentation](https://docs.spike.sh/integrations-guideline/create-integration-and-service-on-dashboard)
167+
- Learn about [Alert Rules](https://docs.spike.sh/alerts/alert-rules) for advanced incident handling
168+
- Contact our support team at [email protected] for personalized assistance
169+
170+
---
171+
172+
*Was this helpful? Let us know at [email protected]*

0 commit comments

Comments
 (0)