Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 20 additions & 2 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,24 @@
"canonical": "https://docs.flashcat.cloud"
}
},
"redirects": [
{
"source": "/zh/on-call/integration/alert-integration/alert-sources/standard alert",
"destination": "/zh/on-call/integration/alert-integration/alert-sources/standard-alert"
},
{
"source": "/zh/on-call/integration/alert-integration/alert-sources/standard%20alert",
"destination": "/zh/on-call/integration/alert-integration/alert-sources/standard-alert"
},
{
"source": "/en/on-call/integration/alert-integration/alert-sources/standard alert",
"destination": "/en/on-call/integration/alert-integration/alert-sources/standard-alert"
},
{
"source": "/en/on-call/integration/alert-integration/alert-sources/standard%20alert",
"destination": "/en/on-call/integration/alert-integration/alert-sources/standard-alert"
}
],
"navigation": {
"languages": [
{
Expand Down Expand Up @@ -208,7 +226,7 @@
"group": "告警集成",
"expanded": false,
"pages": [
"zh/on-call/integration/alert-integration/alert-sources/standard alert",
"zh/on-call/integration/alert-integration/alert-sources/standard-alert",
"zh/on-call/integration/alert-integration/alert-sources/http-pull",
"zh/on-call/integration/alert-integration/alert-sources/prometheus",
"zh/on-call/integration/alert-integration/alert-sources/grafana",
Expand Down Expand Up @@ -1309,7 +1327,7 @@
"group": "Alert Integration",
"expanded": false,
"pages": [
"en/on-call/integration/alert-integration/alert-sources/standard alert",
"en/on-call/integration/alert-integration/alert-sources/standard-alert",
"en/on-call/integration/alert-integration/alert-sources/http-pull",
"en/on-call/integration/alert-integration/alert-sources/prometheus",
"en/on-call/integration/alert-integration/alert-sources/grafana",
Expand Down
2 changes: 1 addition & 1 deletion en/on-call/advanced/reference-variables.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ By referencing variables from alert labels and attributes, you can modify and cu

<CardGroup cols={2}>
<Card title="Event API Reporting" icon="code">
When reporting custom alert events via the alert [Event API](/en/on-call/integration/alert-integration/alert-sources/standard alert), you can use the `title_rule` field to customize the alert title.
When reporting custom alert events via the alert [Event API](/en/on-call/integration/alert-integration/alert-sources/standard-alert), you can use the `title_rule` field to customize the alert title.
</Card>
<Card title="Alert Pipeline" icon="filter" href="/en/on-call/integration/alert-integration/alert-pipelines">
Reference variables in alert pipelines to modify alert severity, title, description, and other information.
Expand Down
2 changes: 1 addition & 1 deletion en/on-call/incident/what-is-incident.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ Flashduty On-call supports dedicated and shared integration modes:

### Trigger via API

Flashduty On-call provides a custom event standard, allowing you to report alerts via standard protocol, suitable for any non-integrated monitoring system. For details, read [Custom Alert Events](/en/on-call/integration/alert-integration/alert-sources/standard alert).
Flashduty On-call provides a custom event standard, allowing you to report alerts via standard protocol, suitable for any non-integrated monitoring system. For details, read [Custom Alert Events](/en/on-call/integration/alert-integration/alert-sources/standard-alert).

<Warning>
To ensure system stability, Flashduty On-call enforces rate limits per integration (**100 requests/second**, **1000 requests/minute**). Exceeding these limits returns a `429` status code — please wait and retry. See [Integrate Data - Rate Limits](/en/on-call/channel/integrate-data#rate-limits) for details.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: "Flashduty periodically polls an external HTTP endpoint and ingests
keywords: ["Alert Integration", "HTTP Pull", "Polling", "Cursor Pagination", "Data Ingestion"]
---

By configuring an HTTP endpoint, Flashduty issues a request on the schedule you define and parses the response into events conforming to the [Standard Alert Event](/en/on-call/integration/alert-integration/alert-sources/standard%20alert) protocol, which are then written into the alert channel. Your system does not need to support push delivery — it only needs to expose a readable alert query endpoint.
By configuring an HTTP endpoint, Flashduty issues a request on the schedule you define and parses the response into events conforming to the [Standard Alert Event](/en/on-call/integration/alert-integration/alert-sources/standard-alert) protocol, which are then written into the alert channel. Your system does not need to support push delivery — it only needs to expose a readable alert query endpoint.

:::tips
HTTP Pull is the right choice when your source **cannot send webhooks**, **is query-only by nature**, or when you **do not want to modify the upstream system**. If your system already supports webhook delivery, prefer the corresponding push-based integration (Prometheus, Zabbix, etc.) — it has lower latency and a smaller resource footprint.
Expand Down Expand Up @@ -74,7 +74,7 @@ External systems use different field names and values for alert severity. **Seve

### Response Format

The response must conform to Flashduty's [Standard Alert Event](/en/on-call/integration/alert-integration/alert-sources/standard%20alert) protocol (`response_mode = standard`). Key fields include `event_status`, `title_rule`, `alert_key`, `description`, `labels`, etc. Refer to the Standard Alert Event documentation for the semantics and length limits of each field.
The response must conform to Flashduty's [Standard Alert Event](/en/on-call/integration/alert-integration/alert-sources/standard-alert) protocol (`response_mode = standard`). Key fields include `event_status`, `title_rule`, `alert_key`, `description`, `labels`, etc. Refer to the Standard Alert Event documentation for the semantics and length limits of each field.

When pagination is enabled, the response must additionally expose a field for the next-page cursor, located at the path you set in **Cursor Path**. A typical shape:

Expand Down
2 changes: 1 addition & 1 deletion en/openapi/introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Open API lets you call Flashduty via HTTP endpoints to query and manage entity d
**Not sure if you need Open API?** Flashduty offers multiple data interaction methods:

- **Open API** (this guide) — You actively call Flashduty to query or operate on data. See the [API Catalog](/en/openapi/api-catalog) for all available endpoints.
- **Standard Alert Events** — Push alerts from your custom monitoring system to Flashduty to trigger incident handling. See [Custom Alert Events](/en/on-call/integration/alert-integration/alert-sources/standard alert).
- **Standard Alert Events** — Push alerts from your custom monitoring system to Flashduty to trigger incident handling. See [Custom Alert Events](/en/on-call/integration/alert-integration/alert-sources/standard-alert).
- **Custom Change Events** — Push change events to correlate with incidents for root cause analysis. See [Custom Change Events](/en/on-call/integration/change-integration/custom-event).
- **Webhook Push** — Flashduty proactively pushes incident/alert event notifications to your system. See [Incident Webhook](/en/on-call/integration/webhooks/incident-webhook) and [Alert Webhook](/en/on-call/integration/webhooks/alert-webhook).
- **Custom Actions** — Trigger external operations from the incident detail page. See [Custom Actions](/en/on-call/integration/webhooks/custom-actions).
Expand Down
2 changes: 1 addition & 1 deletion zh/on-call/advanced/reference-variables.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ keywords: ["引用变量", "模板变量", "标签引用", "动态内容", "变

<CardGroup cols={2}>
<Card title="Event API 上报" icon="code">
通过告警 [Event API](/zh/on-call/integration/alert-integration/alert-sources/standard alert) 上报自定义告警事件时,可以使用 `title_rule` 字段自定义告警的标题。
通过告警 [Event API](/zh/on-call/integration/alert-integration/alert-sources/standard-alert) 上报自定义告警事件时,可以使用 `title_rule` 字段自定义告警的标题。
</Card>
<Card title="告警 Pipeline" icon="filter" href="/zh/on-call/integration/alert-integration/alert-pipelines">
在告警 Pipeline 中引用变量,实现对告警的严重程度、标题和描述等信息的修改。
Expand Down
2 changes: 1 addition & 1 deletion zh/on-call/incident/what-is-incident.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ Flashduty On-call 支持专属集成和共享集成模式:

### 通过 API 触发故障

Flashduty On-call 提供了一个自定义事件标准,允许您通过标准协议上报告警,适用于任何未适配的监控系统。详细文档请阅读[自定义告警事件](/zh/on-call/integration/alert-integration/alert-sources/standard alert)。
Flashduty On-call 提供了一个自定义事件标准,允许您通过标准协议上报告警,适用于任何未适配的监控系统。详细文档请阅读[自定义告警事件](/zh/on-call/integration/alert-integration/alert-sources/standard-alert)。

<Warning>
为了保证整个系统的稳定,Flashduty On-call 对每个集成的 API 上报实施频率限制(**100 次/秒**、**1000 次/分钟**),超出限制将返回 `429` 状态码,请等待后重试。详见[接入告警 - 频率限制](/zh/on-call/channel/integrate-data#频率限制)。
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: "Flashduty 主动按周期访问外部 HTTP 接口,将返回的
keywords: ["告警集成", "HTTP Pull", "拉取", "轮询", "Polling", "数据接入"]
---

通过配置一个 HTTP 端点,Flashduty 会按照您设定的周期主动发起请求,将响应解析为符合 [标准告警事件](/zh/on-call/integration/alert-integration/alert-sources/standard%20alert) 协议的事件并写入告警通道。整个过程不需要您的系统具备推送能力,只要能对外暴露一个可读的告警查询接口即可。
通过配置一个 HTTP 端点,Flashduty 会按照您设定的周期主动发起请求,将响应解析为符合 [标准告警事件](/zh/on-call/integration/alert-integration/alert-sources/standard-alert) 协议的事件并写入告警通道。整个过程不需要您的系统具备推送能力,只要能对外暴露一个可读的告警查询接口即可。

<Tip>
HTTP 拉取适合 **无法主动 webhook**、**接口本身就是查询型** 或 **不希望对告警源做改造** 的场景。如果您的系统已经支持 webhook 推送,优先使用对应的推送式集成(Prometheus、Zabbix 等),延迟更低、资源开销更小。
Expand Down Expand Up @@ -72,7 +72,7 @@ HTTP 拉取适合 **无法主动 webhook**、**接口本身就是查询型** 或

### 响应格式

接口响应必须符合 Flashduty 的 [标准告警事件](/zh/on-call/integration/alert-integration/alert-sources/standard%20alert) 协议(`response_mode = standard`),核心字段包括 `event_status`、`title_rule`、`alert_key`、`description`、`labels` 等。请直接参考标准告警事件文档了解每个字段的语义与长度限制。
接口响应必须符合 Flashduty 的 [标准告警事件](/zh/on-call/integration/alert-integration/alert-sources/standard-alert) 协议(`response_mode = standard`),核心字段包括 `event_status`、`title_rule`、`alert_key`、`description`、`labels` 等。请直接参考标准告警事件文档了解每个字段的语义与长度限制。

启用分页时,您的响应需要在标准事件载荷之外,额外暴露一个用于提取下一页游标的字段,路径由 **游标路径** 指定。常见的形态如下:

Expand Down
2 changes: 1 addition & 1 deletion zh/openapi/introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Open API 用于通过 HTTP 接口主动调用 Flashduty,查询和管理故障
**不确定是否需要 Open API?** Flashduty 提供多种数据交互方式:

- **Open API**(本文档)— 您主动调用 Flashduty,查询或操作数据。查看 [API 总览](/zh/openapi/api-catalog) 了解全部接口。
- **标准告警事件** — 将自研监控系统的告警推送到 Flashduty,触发故障处理流程。详见[自定义告警事件](/zh/on-call/integration/alert-integration/alert-sources/standard alert)。
- **标准告警事件** — 将自研监控系统的告警推送到 Flashduty,触发故障处理流程。详见[自定义告警事件](/zh/on-call/integration/alert-integration/alert-sources/standard-alert)。
- **自定义变更事件** — 推送变更事件关联故障,辅助根因分析。详见[自定义变更事件](/zh/on-call/integration/change-integration/custom-event)。
- **Webhook 推送** — Flashduty 主动向您的系统推送故障/告警事件通知。详见[故障 Webhook](/zh/on-call/integration/webhooks/incident-webhook) 和[告警 Webhook](/zh/on-call/integration/webhooks/alert-webhook)。
- **自定义操作** — 在故障详情页触发外部操作。详见[自定义操作](/zh/on-call/integration/webhooks/custom-actions)。
Expand Down