diff --git a/en/ai-sre/automations.mdx b/en/ai-sre/automations.mdx index 16525a24..644ffa5b 100644 --- a/en/ai-sre/automations.mdx +++ b/en/ai-sre/automations.mdx @@ -40,7 +40,7 @@ The page header offers two creation entry points: an outline-style **Create via 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. - 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. + 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 On-call Review**, **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. @@ -54,7 +54,7 @@ The configuration form has the following fields: | Field | Required | Notes | |---|---|---| -| Name | Yes | The rule name, up to 255 characters. Placeholder example: `Weekly on-call insight`. | +| Name | Yes | The rule name, up to 255 characters. Placeholder example: `Weekly on-call insights`. | | Scope | Yes | Use the **scope selector** to choose **Personal** (`team_id=0`) or a **Team** (`team_id>0`). Scope determines both the rule's ownership and edit permissions, and constrains the self-hosted Runners selectable in **Environment** — only account-global Runners and Runners belonging to the same team as the scope are selectable. | | Environment | No | Use the **environment picker** to choose the runtime environment: **Auto** (the backend picks the best available environment, the default), **Cloud Sandbox**, or a **self-hosted (BYOC) Runner**. After picking a team scope, a team Runner that does not belong to that scope is cleared automatically. | | Task prompt | Yes | Describe the task for AI SRE to perform, written in a rich-text editor. This prompt is exactly what is sent to the agent on each run. Placeholder: `Describe the task for Flashduty AI SRE to perform.` | diff --git a/en/ai-sre/quickstart.mdx b/en/ai-sre/quickstart.mdx index 7cda4d48..d82e2ad6 100644 --- a/en/ai-sre/quickstart.mdx +++ b/en/ai-sre/quickstart.mdx @@ -34,7 +34,7 @@ For actively investigating an issue, digging deeper, or building up knowledge. G ### Automations -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) +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 On-call Review, 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) ### IM (@ Mentions + Automatic War Room Diagnosis) diff --git a/en/on-call/channel/integrate-data.mdx b/en/on-call/channel/integrate-data.mdx index 60699cfd..1b46e148 100644 --- a/en/on-call/channel/integrate-data.mdx +++ b/en/on-call/channel/integrate-data.mdx @@ -35,7 +35,7 @@ Integration created within a channel, alerts automatically enter that channel. Go to Channel Details → Configuration → Integrations → **Private integration** - Click **Add an integration** and select the alert type (the list also carries vendor cards that ride on another integration — see [Vendors that ride on another integration](#vendors-that-ride-on-another-integration)) + Click **Add an integration**, select alert type Copy the generated **Push URL** to your monitoring platform @@ -59,7 +59,7 @@ Global integration created in the Integration Center, distributes alerts to diff Go to Integration Center → Alert Events → **Add Integration** - Select the alert type (vendor cards that ride on another integration show up here too), set **Management Team** (optional) + Select alert type, set **Management Team** (optional) Copy the generated **Push URL** to your monitoring platform @@ -77,6 +77,54 @@ Shared integrations must have at least one routing rule configured, otherwise al Shared Integration +## Browsing and Finding Integrations + +The Integration Center groups the alert sources and change events it covers by category, so you can narrow the list with a category chip or search for the system you need. + +The add-integration panel has one set of chips per tab, and each tab opens on its own default category: + +| Tab | Category chips (in display order) | Default category | +| :--- | :--- | :--- | +| Alert Events | Generic, Popular, Cloud providers, Metrics & infrastructure, APM & observability, Event correlation & AIOps, Logs & error tracking, Security, Uptime & status pages, Jobs, delivery & app platforms, Network & hardware | **Popular** | +| Change Events | Generic, CI/CD & deploy, Source control, Config & feature flags, Infrastructure & platforms | **CI/CD & deploy** | + +- Integrations with no registered category are collected under **Uncategorized**; a category with no entries is not shown. +- By default the panel keeps only **All**, **Generic**, the tab's default category, and the currently selected category; the rest collapse into **More N**, which expands on click. +- The search box matches across all categories (ignoring the selected chip) by integration name or type, and shows the hits as **Search results**; clearing the search returns you to the category you had selected. + +### All integrations catalog + +Clicking the **All** chip opens a full-screen catalog: + +- The number next to the title is how many integrations the catalog covers, and the search box at the top searches all of them. +- The category rail on the left lists every category with its entry count; clicking one scrolls the right side to that category (and clears the search). +- The right side lays out cards by category (logo, name, and a two-line blurb); hovering a card reveals **Add**, which opens the new-integration page for that system. + +At the bottom the catalog keeps a "Can't find your system?" fallback area with two ways out: connect it with a generic integration, or request an integration. + +### Requesting an Integration + +If the system you need is not covered yet, click **Submit a request** in the fallback area to tell us what to support. This entry point is available on Flashduty SaaS only; private deployments do not show it. + +| Field | Required | Limit | Notes | +| :--- | :--- | :--- | :--- | +| System name | Yes | Up to 100 characters | For example `Checkmk`; a term you searched for in the catalog is prefilled here | +| Website or docs link | No | Up to 500 characters | Must start with `http://` or `https://` | +| Notes | No | Up to 2000 characters | Which alerts you want to receive, and how you handle them today | +| Work email | See notes | Up to 200 characters | Not needed when your account already has an email — we reply to that address; required otherwise | + +After you submit, the dialog confirms that the request was received and explains that we will reply by email after review; until the request is supported, you can connect the system with a generic integration. + +## Integration Features + +Optional configurations for both integration methods, configurable on the integration details page: + +| Feature | Description | Dedicated Integration | Shared Integration | +| :--- | :--- | :---: | :---: | +| Label Enhancement | Dynamically generate new labels through regex extraction, mapping tables, etc. | ✓ | ✓ | +| Alert Processing | Configure Pipeline to filter, modify, or drop alerts | ✓ | ✓ | +| Routing Rules | Distribute alerts to different channels based on conditions | ✗ | ✓ (Required) | + ### Vendors that ride on another integration Some vendors have no integration type of their own; they ingest through a compatible one. Their cards appear in the selection list above alongside the integration types, and they are searchable too — by vendor name and by common aliases such as `VSPC`, `PDU`, `WUG`, `UPS`, `OCP`, `Azure Sentinel`, and `Bro`. diff --git a/zh/ai-sre/automations.mdx b/zh/ai-sre/automations.mdx index eb3eee5c..85ac8dde 100644 --- a/zh/ai-sre/automations.mdx +++ b/zh/ai-sre/automations.mdx @@ -40,7 +40,7 @@ sidebarTitle: 自动化 选择 **从零开始**,进入空白表单,手动填写名称、任务提示词与触发方式。适合你已经清楚要让 Agent 做什么、想完全自定义提示词的场景。 - 下方列出一组 **预设模板** 卡片(由后端按界面语言下发,中文环境取 `zh-CN`、英文环境取 `en-US`),常见的有 **每周洞察**、**告警治理**、**故障自动分析**、**On-call 负载分析** 等。点击任一模板卡片,会用模板预置的名称与任务提示词预填表单,你在此基础上微调即可。 + 下方列出一组 **预设模板** 卡片(由后端按界面语言下发,中文环境取 `zh-CN`、英文环境取 `en-US`),常见的有 **值班周报**、**告警治理**、**故障自动分析**、**On-call 负载分析** 等。点击任一模板卡片,会用模板预置的名称与任务提示词预填表单,你在此基础上微调即可。 @@ -54,7 +54,7 @@ sidebarTitle: 自动化 | 字段 | 必填 | 说明 | |---|---|---| -| 名称 | 是 | 规则名称,最长 255 字符。占位示例:`每周洞察`。 | +| 名称 | 是 | 规则名称,最长 255 字符。占位示例:`每周值班洞察`。 | | 范围 | 是 | 通过 **范围选择器** 选 **个人**(`team_id=0`)或某个 **团队**(`team_id>0`)。范围既决定这条规则的归属与编辑权限,也限定 **执行 Environment** 里可选的自托管 Runner——只有账户全局的 Runner,以及与该范围同团队的 Runner 才可选。 | | 执行环境 | 否 | 通过 **环境选择器** 选运行环境:**自动**(由后端挑选最优可用环境,默认值)、**云端沙箱**,或某个 **自托管(BYOC)Runner**。选了某个团队范围后,不属于该范围的团队 Runner 会被自动清除。 | | 任务提示词 | 是 | 描述要让 AI SRE 执行的任务,用富文本编辑器撰写。这段提示词就是每次运行时发给 Agent 的内容。占位提示:`描述 Flashduty AI SRE 要执行的任务。` | diff --git a/zh/ai-sre/quickstart.mdx b/zh/ai-sre/quickstart.mdx index aafa25fb..d83832d4 100644 --- a/zh/ai-sre/quickstart.mdx +++ b/zh/ai-sre/quickstart.mdx @@ -34,7 +34,7 @@ AI SRE 没有唯一入口,从你现在所在的场景开始就好: ### 自动化(Automations) -适合不需要人守着的周期性 / 触发式任务——定时巡检、周报洞察、告警治理。进入 **AI SRE → 自动化**,可从内置模板一键创建(如故障自动分析、告警治理、每周洞察),也可以从零开始自定义任务提示词。它在后台跑一个隐藏会话,结果记录进运行历史,随时可以打开查看完整的调查过程。→ 详见[自动化](/zh/ai-sre/automations) +适合不需要人守着的周期性 / 触发式任务——定时巡检、周报洞察、告警治理。进入 **AI SRE → 自动化**,可从内置模板一键创建(如故障自动分析、告警治理、值班周报),也可以从零开始自定义任务提示词。它在后台跑一个隐藏会话,结果记录进运行历史,随时可以打开查看完整的调查过程。→ 详见[自动化](/zh/ai-sre/automations) ### IM(@ 召唤 + 作战室自动诊断) diff --git a/zh/on-call/channel/integrate-data.mdx b/zh/on-call/channel/integrate-data.mdx index c52aba55..c60b8fd6 100644 --- a/zh/on-call/channel/integrate-data.mdx +++ b/zh/on-call/channel/integrate-data.mdx @@ -36,7 +36,7 @@ Flashduty On-call 提供两种告警接入方式: 进入 协作空间详情 → 配置 → 集成数据 → **专属集成** - 点击 **新增一个集成**,选择告警类型(列表中还有借用其它集成接入的厂商卡片,见 [借用其它集成接入的厂商](#借用其它集成接入的厂商)) + 点击 **新增一个集成**,选择告警类型 复制生成的 **推送地址** 到监控平台 @@ -60,7 +60,7 @@ Flashduty On-call 提供两种告警接入方式: 进入 集成中心 → 告警事件 → **添加集成** - 选择告警类型(列表中同样有借用其它集成接入的厂商卡片),设置 **管理团队**(可选) + 选择告警类型,设置 **管理团队**(可选) 复制生成的 **推送地址** 到监控平台 @@ -78,6 +78,54 @@ Flashduty On-call 提供两种告警接入方式: 共享集成 +## 浏览与查找集成 + +集成中心把收录的告警源与变更事件按分类组织,您可以用分类胶囊缩小范围,也可以直接搜索目标系统。 + +添加集成面板的胶囊按页签分成两套,打开时默认落在各页签的默认分类: + +| 页签 | 分类胶囊(按显示顺序) | 默认分类 | +| :--- | :--- | :--- | +| 告警事件 | 通用接入、热门、云厂商、指标与基础设施监控、APM 与可观测平台、事件关联与 AIOps、日志与错误追踪、安全、拨测与状态页、任务、交付与应用平台、网络与硬件 | **热门** | +| 变更事件 | 通用接入、CI/CD 与部署、代码仓库、配置与功能开关、基础设施与平台 | **CI/CD 与部署** | + +- 未登记分类的集成统一归入 **未分类**;本身没有条目的分类不会显示。 +- 默认情况下,面板只保留 **全部**、**通用接入**、当前页签的默认分类与当前选中的分类,其余收进 **更多 N**,点击后展开。 +- 搜索框跨全部分类匹配(忽略当前选中的胶囊),按集成名称或集成类型查找,结果以 **搜索结果** 呈现;清空搜索后回到原来选中的分类。 + +### 全部集成目录 + +点击 **全部** 胶囊会打开一个全屏集成目录: + +- 标题右侧是该目录收录的集成总数,顶部搜索框跨全部集成查找。 +- 左侧分类导航列出每个分类及其条目数,点击即在右侧滚动定位到该分类(同时清空搜索)。 +- 右侧按分类平铺卡片(图标、名称、两行简介),鼠标悬停出现 **添加**,点击进入该系统的新建集成页。 + +目录底部还有一块「没有找到你要接的系统?」的兜底区,给出两条出路:用通用集成接入,或提交集成需求。 + +### 提交集成需求 + +要接入的系统如果还没收录,可以在兜底区点击 **提交需求** 告诉我们需要支持什么。该入口只在 Flashduty SaaS 环境提供,私有化部署不显示。 + +| 字段 | 必填 | 限制 | 说明 | +| :--- | :--- | :--- | :--- | +| 系统名称 | 是 | 最长 100 个字符 | 例如 `Checkmk`;从目录搜索进来的词会带入此栏 | +| 官网或文档链接 | 否 | 最长 500 个字符 | 需以 `http://` 或 `https://` 开头 | +| 补充说明 | 否 | 最长 2000 个字符 | 希望接入哪些告警、目前怎么处理这些告警 | +| 工作邮箱 | 见说明 | 最长 200 个字符 | 账号已绑定邮箱时无需填写,直接用账号邮箱联系您;未绑定时必填 | + +提交后弹窗给出「已收到「系统名称」的集成需求」的回执,并说明我们评估后会通过邮箱联系您;在需求被支持之前,可以先用通用集成接入。 + +## 集成功能 + +两种集成方式的可选配置,可在集成详情页中配置: + +| 功能 | 说明 | 专属集成 | 共享集成 | +| :--- | :--- | :---: | :---: | +| 标签增强 | 通过正则提取、映射表等方式动态生成新标签 | ✓ | ✓ | +| 告警处理 | 配置 Pipeline 对告警进行过滤、修改、丢弃等处理 | ✓ | ✓ | +| 路由规则 | 按条件将告警分发到不同的协作空间 | ✗ | ✓(必填) | + ### 借用其它集成接入的厂商 有些厂商没有自己的集成类型,而是借用兼容的集成类型接入。它们的卡片与集成类型卡片一起出现在上面的选择列表里,也一起参与搜索:除了厂商名,还可以按常见别名找到,例如 `VSPC`、`PDU`、`WUG`、`UPS`、`OCP`、`Azure Sentinel`、`Bro` 等。