Skip to content

Commit 71cb1c2

Browse files
authored
Merge pull request #289 from flashcatcloud/feat/ai-sre
docs: AI SRE docs — nav/homepage first positioning, quickstart & automations updates
2 parents 4125f34 + fd22c14 commit 71cb1c2

7 files changed

Lines changed: 249 additions & 195 deletions

File tree

docs.json

Lines changed: 108 additions & 108 deletions
Original file line numberDiff line numberDiff line change
@@ -1423,10 +1423,10 @@
14231423
"group": "产品简介",
14241424
"icon": "cubes",
14251425
"pages": [
1426+
"zh/ai-sre",
14261427
"zh/on-call",
14271428
"zh/rum",
1428-
"zh/monitors",
1429-
"zh/ai-sre"
1429+
"zh/monitors"
14301430
]
14311431
},
14321432
{
@@ -1477,6 +1477,58 @@
14771477
}
14781478
]
14791479
},
1480+
{
1481+
"tab": "AI SRE",
1482+
"icon": "sparkles",
1483+
"groups": [
1484+
{
1485+
"group": "快速开始",
1486+
"icon": "rocket",
1487+
"pages": [
1488+
"zh/ai-sre/quickstart",
1489+
"zh/ai-sre/overview",
1490+
"zh/ai-sre/init",
1491+
"zh/ai-sre/insight"
1492+
]
1493+
},
1494+
{
1495+
"group": "对话",
1496+
"icon": "comments",
1497+
"pages": [
1498+
"zh/ai-sre/sessions",
1499+
"zh/ai-sre/im",
1500+
"zh/ai-sre/automations",
1501+
"zh/ai-sre/artifacts"
1502+
]
1503+
},
1504+
{
1505+
"group": "插件",
1506+
"icon": "puzzle-piece",
1507+
"pages": [
1508+
"zh/ai-sre/mcp",
1509+
"zh/ai-sre/skills",
1510+
"zh/ai-sre/agents",
1511+
"zh/ai-sre/apps"
1512+
]
1513+
},
1514+
{
1515+
"group": "知识",
1516+
"icon": "book",
1517+
"pages": [
1518+
"zh/ai-sre/knowledge",
1519+
"zh/ai-sre/memory"
1520+
]
1521+
},
1522+
{
1523+
"group": "环境",
1524+
"icon": "server",
1525+
"pages": [
1526+
"zh/ai-sre/environments",
1527+
"zh/ai-sre/sandbox"
1528+
]
1529+
}
1530+
]
1531+
},
14801532
{
14811533
"tab": "On-call",
14821534
"icon": "light-emergency-on",
@@ -1956,58 +2008,6 @@
19562008
}
19572009
]
19582010
},
1959-
{
1960-
"tab": "AI SRE",
1961-
"icon": "sparkles",
1962-
"groups": [
1963-
{
1964-
"group": "快速开始",
1965-
"icon": "rocket",
1966-
"pages": [
1967-
"zh/ai-sre/quickstart",
1968-
"zh/ai-sre/overview",
1969-
"zh/ai-sre/init",
1970-
"zh/ai-sre/insight"
1971-
]
1972-
},
1973-
{
1974-
"group": "对话",
1975-
"icon": "comments",
1976-
"pages": [
1977-
"zh/ai-sre/sessions",
1978-
"zh/ai-sre/im",
1979-
"zh/ai-sre/automations",
1980-
"zh/ai-sre/artifacts"
1981-
]
1982-
},
1983-
{
1984-
"group": "插件",
1985-
"icon": "puzzle-piece",
1986-
"pages": [
1987-
"zh/ai-sre/mcp",
1988-
"zh/ai-sre/skills",
1989-
"zh/ai-sre/agents",
1990-
"zh/ai-sre/apps"
1991-
]
1992-
},
1993-
{
1994-
"group": "知识",
1995-
"icon": "book",
1996-
"pages": [
1997-
"zh/ai-sre/knowledge",
1998-
"zh/ai-sre/memory"
1999-
]
2000-
},
2001-
{
2002-
"group": "环境",
2003-
"icon": "server",
2004-
"pages": [
2005-
"zh/ai-sre/environments",
2006-
"zh/ai-sre/sandbox"
2007-
]
2008-
}
2009-
]
2010-
},
20112011
{
20122012
"tab": "API 参考",
20132013
"icon": "terminal",
@@ -2774,10 +2774,10 @@
27742774
"group": "Products",
27752775
"icon": "cubes",
27762776
"pages": [
2777+
"en/ai-sre",
27772778
"en/on-call",
27782779
"en/rum",
2779-
"en/monitors",
2780-
"en/ai-sre"
2780+
"en/monitors"
27812781
]
27822782
},
27832783
{
@@ -2828,6 +2828,58 @@
28282828
}
28292829
]
28302830
},
2831+
{
2832+
"tab": "AI SRE",
2833+
"icon": "sparkles",
2834+
"groups": [
2835+
{
2836+
"group": "Quick Start",
2837+
"icon": "rocket",
2838+
"pages": [
2839+
"en/ai-sre/quickstart",
2840+
"en/ai-sre/overview",
2841+
"en/ai-sre/init",
2842+
"en/ai-sre/insight"
2843+
]
2844+
},
2845+
{
2846+
"group": "Chat",
2847+
"icon": "comments",
2848+
"pages": [
2849+
"en/ai-sre/sessions",
2850+
"en/ai-sre/im",
2851+
"en/ai-sre/automations",
2852+
"en/ai-sre/artifacts"
2853+
]
2854+
},
2855+
{
2856+
"group": "Plugins",
2857+
"icon": "puzzle-piece",
2858+
"pages": [
2859+
"en/ai-sre/mcp",
2860+
"en/ai-sre/skills",
2861+
"en/ai-sre/agents",
2862+
"en/ai-sre/apps"
2863+
]
2864+
},
2865+
{
2866+
"group": "Knowledge",
2867+
"icon": "book",
2868+
"pages": [
2869+
"en/ai-sre/knowledge",
2870+
"en/ai-sre/memory"
2871+
]
2872+
},
2873+
{
2874+
"group": "Environments",
2875+
"icon": "server",
2876+
"pages": [
2877+
"en/ai-sre/environments",
2878+
"en/ai-sre/sandbox"
2879+
]
2880+
}
2881+
]
2882+
},
28312883
{
28322884
"tab": "On-call",
28332885
"icon": "light-emergency-on",
@@ -3307,58 +3359,6 @@
33073359
}
33083360
]
33093361
},
3310-
{
3311-
"tab": "AI SRE",
3312-
"icon": "sparkles",
3313-
"groups": [
3314-
{
3315-
"group": "Quick Start",
3316-
"icon": "rocket",
3317-
"pages": [
3318-
"en/ai-sre/quickstart",
3319-
"en/ai-sre/overview",
3320-
"en/ai-sre/init",
3321-
"en/ai-sre/insight"
3322-
]
3323-
},
3324-
{
3325-
"group": "Chat",
3326-
"icon": "comments",
3327-
"pages": [
3328-
"en/ai-sre/sessions",
3329-
"en/ai-sre/im",
3330-
"en/ai-sre/automations",
3331-
"en/ai-sre/artifacts"
3332-
]
3333-
},
3334-
{
3335-
"group": "Plugins",
3336-
"icon": "puzzle-piece",
3337-
"pages": [
3338-
"en/ai-sre/mcp",
3339-
"en/ai-sre/skills",
3340-
"en/ai-sre/agents",
3341-
"en/ai-sre/apps"
3342-
]
3343-
},
3344-
{
3345-
"group": "Knowledge",
3346-
"icon": "book",
3347-
"pages": [
3348-
"en/ai-sre/knowledge",
3349-
"en/ai-sre/memory"
3350-
]
3351-
},
3352-
{
3353-
"group": "Environments",
3354-
"icon": "server",
3355-
"pages": [
3356-
"en/ai-sre/environments",
3357-
"en/ai-sre/sandbox"
3358-
]
3359-
}
3360-
]
3361-
},
33623362
{
33633363
"tab": "API Reference",
33643364
"icon": "terminal",

en/ai-sre/automations.mdx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ The page header offers two creation entry points: an outline-style **Create via
4040
Choose **Start from scratch** to open a blank form and manually fill in the name, task prompt, and triggers. This suits cases where you already know what you want the agent to do and want a fully custom prompt.
4141
</Step>
4242
<Step title="From a preset template">
43-
Below, a set of **preset template** cards is listed (delivered by the backend per UI language: `zh-CN` for Chinese, `en-US` for English). Common ones include **Alert Noise Analysis**, **Incident Response Review**, **Weekly On-call Insights**, and **Escalation and On-call Load Analysis**. Click any template card to prefill the form with the template's name and task prompt; tweak from there.
43+
Below, a set of **preset template** cards is listed (delivered by the backend per UI language: `zh-CN` for Chinese, `en-US` for English). Common ones include **Weekly Insights**, **Alert Governance**, **On-call Incident Analysis**, and **On-call Load Analysis**. Click any template card to prefill the form with the template's name and task prompt; tweak from there.
4444
</Step>
4545
</Steps>
4646

@@ -170,6 +170,8 @@ If you create or update a rule through the API, use these fields:
170170

171171
When a matching event arrives, the system creates a run with `trigger_kind: "oncall_incident"` and passes event context such as `incident_id`, `channel_id`, and `severity` into the session. The same trigger and the same `incident_id` reuse the same run, avoiding duplicate hidden sessions for one incident.
172172

173+
When the run finishes, AI SRE writes one summary comment back to the incident that triggered it: conclusion first, body kept concise, with a link to the full session at the end. The comment travels through the incident's existing notification chain (for example, incident card refreshes and thread replies in IM), so whoever is watching the incident sees the analysis without opening the console. This applies to every rule with the On-call incident trigger enabled — including rules with custom prompts — with no extra configuration.
174+
173175
## Run History
174176

175177
---

en/ai-sre/quickstart.mdx

Lines changed: 30 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Complete Your First AI SRE Investigation in 15 Minutes
3-
description: Start with a real incident and get your first AI SRE investigation — grounded in context, backed by evidence, and open to follow-up questions — then build team knowledge and connect real data sources as needed.
4-
keywords: ["AI SRE", "Quickstart", "incident investigation", "/init", "knowledge base", "MCP", "BYOC Runner"]
3+
description: Start with a real incident and get your first AI SRE investigation — grounded in context, backed by evidence, and open to follow-up questions — then get every new incident analyzed automatically, build team knowledge, and deploy a BYOC Runner to reach real data sources.
4+
keywords: ["AI SRE", "Quickstart", "incident investigation", "automatic incident analysis", "/init", "knowledge base", "MCP", "BYOC Runner"]
55
sidebarTitle: Quick Start
66
---
77

@@ -34,7 +34,7 @@ For actively investigating an issue, digging deeper, or building up knowledge. G
3434

3535
### Automations
3636

37-
For work that shouldn't need a human watching it — scheduled inspections, weekly insight reports, alert-noise cleanup. Go to **AI SRE → Automations** and create one from a built-in template (Alert Noise Analysis, Incident Response Review, Weekly On-call Insights, and more) or build one from scratch. Each run happens in a hidden session in the background, and the result lands in the run history where you can open the full trail any time. → See [Automations](/en/ai-sre/automations)
37+
For work that shouldn't need a human watching it — scheduled inspections, weekly insight reports, alert-noise cleanup. Go to **AI SRE → Automations** and create one from a built-in template (On-call Incident Analysis, Alert Governance, Weekly Insights, and more) or build one from scratch. Each run happens in a hidden session in the background, and the result lands in the run history where you can open the full trail any time. → See [Automations](/en/ai-sre/automations)
3838

3939
### IM (@ Mentions + Automatic War Room Diagnosis)
4040

@@ -82,15 +82,40 @@ If you don't have an incident on hand right now, skip ahead to "Growing It Into
8282

8383
---
8484

85-
Your first investigation is just the starting point. How well AI SRE diagnoses depends on how much it knows about your systems and how much real data it can reach — both are things you build up over time, not all at once.
85+
Your first investigation is just the starting point. From here you can make analysis automatic, and keep sharpening its diagnoses — the latter depends on how much it knows about your systems and how much real data it can reach. All of this builds up over time, not all at once.
86+
87+
### Get every new incident analyzed automatically
88+
89+
Once manual investigations feel routine, make them the default: go to **AI SRE → Automations**, create a rule from the built-in **On-call Incident Analysis** template, enable the **On-call incident** trigger card, and pick the channels and severities to watch. From then on, every matching new incident gets an automatic investigation, and AI SRE writes one summary comment back to the incident — conclusion first, full session link at the end — delivered through the incident's existing notification channels, so responders see the first analysis right in IM. Configuration details: [Automations · On-call Incident Trigger](/en/ai-sre/automations#on-call-incident-trigger).
90+
91+
This is independent of war room auto-diagnosis: this path fires for every matching new incident and writes back to the incident itself; war room diagnosis runs when you open a war room for an incident and posts into the war room group (see [IM](/en/ai-sre/im)).
8692

8793
### Build a team knowledge base
8894

8995
If the agent has to guess "what service is this," "who owns it," and "how was this handled last time" on every investigation, it won't get much sharper. Type `/init` in a session and the agent interviews you to map out your services, runbooks, on-call routing, and more — confirming each write before it saves anything, and loading it automatically in future sessions. See the full interview flow in [Setup (/init)](/en/ai-sre/init) and the knowledge base structure and best practices in [Knowledge](/en/ai-sre/knowledge).
9096

9197
### Connect real data sources
9298

93-
By default the agent only sees Flashduty's own data. To let it query your actual systems — logs, metrics, code repositories, internal databases — connect an MCP server or deploy a BYOC Runner. Publicly reachable services (observability platforms, GitHub, and similar) install and authorize in one click from the MCP directory; VPCs, internal databases, or local commands need a Runner deployed on a machine that can reach them. See [MCP](/en/ai-sre/mcp) and [Environments](/en/ai-sre/environments).
99+
By default the agent only sees Flashduty's own data. To let it query your actual systems — logs, metrics, code repositories, internal databases — connect an MCP server or deploy a BYOC Runner. Publicly reachable services (observability platforms, GitHub, and similar) install and authorize in one click from the MCP directory — see [MCP](/en/ai-sre/mcp); VPCs, internal databases, or local commands need a Runner deployed on a machine that can reach them — about three minutes, below.
100+
101+
### Deploy a BYOC Runner (~3 minutes)
102+
103+
<Steps>
104+
<Step title="Create a self-hosted Environment">
105+
Go to **AI SRE → Environments** and click **Create** on the **Self-hosted** tab. The name is optional (the first heartbeat fills it in with the machine's hostname); pick account or team scope.
106+
</Step>
107+
<Step title="Run the install command on the target machine">
108+
After creation, the **setup guide** opens with install commands that already include your Token — a Linux one-liner (needs sudo; registers a systemd service), plus Docker and macOS variants. Copy it onto a machine that can reach your target resources and run it.
109+
</Step>
110+
<Step title="Wait for the status to flip to Online">
111+
Back in the list, the status goes from **Pending** to **Online** once connected. Heartbeats are evaluated on a ~90-second cycle, so give it a moment after installing; if it stays Pending, the machine almost certainly can't reach the connect URL shown in the guide (outbound traffic blocked by a firewall).
112+
</Step>
113+
<Step title="Use it in a session">
114+
When starting a new chat, the environment picker at the bottom of the composer defaults to **Auto** — it prefers an online Runner when one is available; you can also select this self-hosted Environment explicitly. Note that the environment locks once the session starts and cannot be changed afterwards.
115+
</Step>
116+
</Steps>
117+
118+
Permission rules (limiting what the agent may do on that machine), upgrades, and uninstallation: see [Environments](/en/ai-sre/environments).
94119

95120
## What's Next
96121

0 commit comments

Comments
 (0)