Skip to content

Commit 1907ff0

Browse files
ryantaylor16ryantaylor16
authored
Merge pull request #9726 from harness/incident-response
IR-599: Initial Incident Response Documentation Publish
2 parents 2d80194 + 04f786b commit 1907ff0

34 files changed

+4207
-28
lines changed

‎docs/incident-response/ai-ir-agent/ai-agent.md

+111
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
1+
---
2+
title: AI Incident Response Agent
3+
description: Learn about the AI Incident Response Agent in Harness IR and how it helps document incidents through Slack and Zoom.
4+
sidebar_label: AI Agent
5+
sidebar_position: 2
6+
---
7+
8+
# AI Incident Response Agent
9+
10+
:::note Future Enhancements
11+
The AI Agent is part of Harness IR's intelligent incident management platform. While current features focus on incident documentation and communication analysis, additional AI-powered capabilities are in development.
12+
:::
13+
14+
The AI Incident Response Agent automatically captures and organizes incident response activities by monitoring Slack channels and Zoom meetings, ensuring teams maintain comprehensive records throughout the incident lifecycle.
15+
16+
## Overview
17+
18+
The AI Agent enhances incident response by:
19+
- Monitoring and analyzing Slack messages
20+
- Joining and summarizing Zoom meetings
21+
- Creating detailed timelines
22+
- Tracking action items
23+
- Maintaining incident context
24+
25+
## Communication Integrations
26+
27+
### Slack Integration
28+
The AI Agent monitors incident channels to:
29+
- Capture team discussions
30+
- Record key decisions
31+
- Track action items
32+
- Build event timelines
33+
- Save important updates
34+
35+
### Zoom Integration
36+
The AI Agent joins incident meetings to:
37+
- Monitor team discussions
38+
- Create meeting summaries
39+
- Document decisions
40+
- Track action items
41+
- Save key points
42+
43+
### Microsoft Teams Integration
44+
The AI Agent joins incident meetings to:
45+
- Monitor team discussions
46+
- Create meeting summaries
47+
- Document decisions
48+
- Track action items
49+
- Save key points
50+
51+
## Documentation Features
52+
53+
### Event Capture
54+
The AI Agent records:
55+
- Slack conversations
56+
- Zoom meeting content
57+
- Team decisions
58+
- Action items
59+
- Status updates
60+
- Follow-up tasks
61+
62+
### Timeline Generation
63+
64+
The AI Agent creates timelines from communications:
65+
66+
**Status Update** (Slack)
67+
"Database failover completed successfully at 14:23 UTC"
68+
69+
**Meeting Summary** (Zoom)
70+
"Team discussed performance issues and decided to roll back"
71+
72+
**Action Item** (Slack)
73+
"TODO: Update monitoring thresholds for database connection pool"
74+
75+
## Best Practices
76+
77+
### Channel Setup
78+
- Create dedicated incident channels
79+
- Add AI agent to incident channels
80+
- Use consistent channel naming
81+
- Keep discussions focused
82+
83+
### Meeting Setup
84+
- Add AI agent to Zoom meetings
85+
- Use descriptive meeting titles
86+
- Speak clearly
87+
- Highlight key decisions
88+
89+
### Communication
90+
- Mark key decisions clearly
91+
- Flag action items explicitly
92+
- Post clear status updates
93+
- Use structured messages
94+
- Follow channel conventions
95+
96+
### Documentation
97+
- Review recorded events
98+
- Check timeline accuracy
99+
- Add context if needed
100+
- Fix any missing items
101+
- Save important findings
102+
103+
## Next Steps
104+
105+
### Documentation
106+
- [Incident Management](/docs/incident-response/incidents/)
107+
- [Configure Runbook Integrations](/docs/category/integration-guides)
108+
109+
### Related Topics
110+
- [Slack Integration](/docs/incident-response/runbooks/integrations/slack)
111+
- [Zoom Integration](/docs/incident-response/runbooks/integrations/zoom)

‎docs/incident-response/alerts/_category_.json

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"label": "Alert Management",
3+
"position": 3,
4+
"link": {
5+
"type": "generated-index",
6+
"description": "Learn how to configure and manage alerts in Harness Incident Response. Set up webhooks, integrate with monitoring tools, and customize alert handling to streamline your incident response process."
7+
}
8+
}

‎docs/incident-response/alerts/alert-rules.md

+83
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
---
2+
title: Configure Alert Rules
3+
description: Learn how to configure alert rules in Harness Incident Response to route, filter, and enrich incoming alerts.
4+
sidebar_label: Alert Rules
5+
sidebar_position: 4
6+
---
7+
8+
# Alert Rules
9+
10+
Alert Rules define how incoming alerts are processed and when incidents should be created. This guide walks you through configuring alert rules in Harness IR.
11+
12+
## Overview
13+
14+
Alert rules help you:
15+
- Create incidents from incoming alerts
16+
- Map alert data to incident fields
17+
- Set up automated responses
18+
- Configure Harness IR on-call notifications (Coming in Q2)
19+
- Associate relevant runbooks
20+
21+
## Accessing Alert Rules
22+
23+
1. From the main menu, select **Alerts**
24+
2. Click **Configure Alert Rules**
25+
3. Select the integration you want to create rules for (e.g., Datadog, PagerDuty, etc.)
26+
27+
## Configuration Steps
28+
29+
### Step 1: Define Alert Conditions
30+
31+
Use the visual condition builder to specify when incidents should be created. You can create conditions based on any field from your alert payload, such as:
32+
- Alert severity or priority
33+
- Service or application name
34+
- Environment
35+
- Alert message content
36+
- Custom alert fields
37+
38+
The condition builder allows you to combine multiple conditions using AND/OR operators.
39+
40+
### Step 2: Map Alert Fields to Incident Fields
41+
42+
The field mapper shows you available fields from your alert payload that can be mapped to incident fields:
43+
44+
Standard incident fields include:
45+
- Title
46+
- Description
47+
- Severity
48+
- Priority
49+
- Service
50+
- Environment
51+
- Custom fields
52+
53+
### Step 3: Configure On-Call Notifications (Coming in Q2)
54+
55+
:::note
56+
The Harness IR on-call module will be available in Q2. This will enable native on-call management within Harness IR.
57+
:::
58+
59+
When the Harness IR on-call module becomes available, you will be able to configure:
60+
- Which teams should be notified
61+
- Escalation policies to use
62+
- Response time expectations
63+
- Notification channels
64+
65+
### Step 4: Associate Runbooks
66+
67+
Connect relevant runbooks to your alert rule. These runbooks can be:
68+
- Automatically triggered when an incident is created
69+
- Suggested to responders during incident resolution
70+
- Used as reference documentation for incident response
71+
72+
## Best Practices
73+
74+
- Create specific rules for different types of alerts
75+
- Use clear, descriptive names for your rules
76+
- Test rules with sample alerts before activating
77+
- Review and update rules as your services evolve
78+
- Document your rule configurations for team reference
79+
80+
## Next Steps
81+
82+
- [Configure Webhooks](./webhooks.md)
83+
- [Create Runbooks](../runbooks/create-runbook.md)

‎docs/incident-response/alerts/alerts.md

+94
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
1+
---
2+
title: Alerts Overview
3+
description: Learn how to manage and configure alerts in Harness Incident Response
4+
sidebar_label: Overview
5+
sidebar_position: 1
6+
---
7+
8+
# Alert Management in Harness IR
9+
10+
Learn how to effectively manage and configure alerts in Harness Incident Response.
11+
12+
## Overview
13+
14+
Harness IR provides flexible alert management capabilities that help you:
15+
- Receive alerts from any monitoring system
16+
- Configure alert routing and escalation
17+
- Customize alert handling based on severity and source
18+
- Automate responses using runbooks
19+
20+
## Alert Sources
21+
22+
### Native Integrations
23+
Harness IR supports direct integrations with popular monitoring tools:
24+
- Datadog
25+
- Grafana
26+
- New Relic
27+
- Prometheus
28+
- AWS CloudWatch
29+
- Azure Monitor
30+
- Google Cloud Monitoring
31+
32+
### Webhooks
33+
Our [webhook integration](./webhooks.md) supports any monitoring system or custom application that can send HTTP requests. Common use cases include:
34+
- Custom monitoring solutions
35+
- Internal applications
36+
- Legacy monitoring systems
37+
- Third-party services
38+
39+
## Alert Configuration
40+
41+
### Alert Routing
42+
Configure where alerts are sent based on:
43+
- Service
44+
- Environment
45+
- Team
46+
- Severity
47+
- Custom fields
48+
49+
### Alert Enrichment
50+
Enhance alerts with additional context:
51+
- Service metadata
52+
- Environment details
53+
- Team information
54+
- Historical data
55+
- Related incidents
56+
57+
### Alert Actions
58+
Define automated actions when alerts are received:
59+
- Create incidents
60+
- Trigger runbooks
61+
- Send notifications
62+
- Update dashboards
63+
- Create tickets
64+
65+
## Best Practices
66+
67+
### Alert Design
68+
- Use clear, actionable alert names
69+
- Include relevant context in alert descriptions
70+
- Set appropriate thresholds
71+
- Configure proper severity levels
72+
73+
### Alert Management
74+
- Document alert patterns
75+
- Review alert frequency
76+
- Update alert rules regularly
77+
- Clean up stale alerts
78+
79+
### Alert Response
80+
- Define clear ownership
81+
- Set up escalation paths
82+
- Document response procedures
83+
- Configure automated responses
84+
85+
## Next Steps
86+
87+
### Documentation
88+
- [Configure Webhooks](./webhooks.md)
89+
- [Alert Integrations](./integrations.md)
90+
- [Configure Alert Rules](./alert-rules.md)
91+
92+
### Related Topics
93+
- [Create a Runbook](../runbooks/create-runbook.md)
94+
- [Configure Fields](../runbooks/configure-incident-fields.md)

0 commit comments

Comments
 (0)