Skip to content
Merged
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
10 changes: 6 additions & 4 deletions api-reference/on-call.openapi.en.json
Original file line number Diff line number Diff line change
Expand Up @@ -30374,13 +30374,14 @@
},
"change_status": {
"type": "string",
"description": "Lifecycle status of the change event, reported by the change source as execution progresses.\n| Value | Meaning |\n|---|---|\n| `Planned` | Planned, not started. |\n| `Ready` | Ready for execution. |\n| `Processing` | Being executed. |\n| `Canceled` | Canceled. |\n| `Done` | Completed. |",
"description": "Lifecycle status of the change event, reported by the change source as execution progresses.\n| Value | Meaning |\n|---|---|\n| `Planned` | Planned, not started. |\n| `Ready` | Ready for execution. |\n| `Processing` | Being executed. |\n| `Canceled` | Canceled. |\n| `Done` | Completed. |\n| `Failed` | Failed. |",
"enum": [
"Planned",
"Ready",
"Processing",
"Canceled",
"Done"
"Done",
"Failed"
]
},
"link": {
Expand Down Expand Up @@ -30468,13 +30469,14 @@
},
"change_status": {
"type": "string",
"description": "Current lifecycle status of the change.\n| Value | Meaning |\n|---|---|\n| `Planned` | Planned, not started. |\n| `Ready` | Ready for execution. |\n| `Processing` | Being executed. |\n| `Canceled` | Canceled. |\n| `Done` | Completed. |",
"description": "Current lifecycle status of the change.\n| Value | Meaning |\n|---|---|\n| `Planned` | Planned, not started. |\n| `Ready` | Ready for execution. |\n| `Processing` | Being executed. |\n| `Canceled` | Canceled. |\n| `Done` | Completed. |\n| `Failed` | Failed. |",
"enum": [
"Planned",
"Ready",
"Processing",
"Canceled",
"Done"
"Done",
"Failed"
]
},
"start_time": {
Expand Down
10 changes: 6 additions & 4 deletions api-reference/on-call.openapi.zh.json
Original file line number Diff line number Diff line change
Expand Up @@ -30374,13 +30374,14 @@
},
"change_status": {
"type": "string",
"description": "变更事件的生命周期状态。由变更事件源按执行进度上报。\n| 值 | 含义 |\n|---|---|\n| `Planned` | 已计划,尚未开始。 |\n| `Ready` | 已就绪,待执行。 |\n| `Processing` | 正在执行。 |\n| `Canceled` | 已取消。 |\n| `Done` | 已完成。 |",
"description": "变更事件的生命周期状态。由变更事件源按执行进度上报。\n| 值 | 含义 |\n|---|---|\n| `Planned` | 已计划,尚未开始。 |\n| `Ready` | 已就绪,待执行。 |\n| `Processing` | 正在执行。 |\n| `Canceled` | 已取消。 |\n| `Done` | 已完成。 |\n| `Failed` | 失败。 |",
"enum": [
"Planned",
"Ready",
"Processing",
"Canceled",
"Done"
"Done",
"Failed"
]
},
"link": {
Expand Down Expand Up @@ -30468,13 +30469,14 @@
},
"change_status": {
"type": "string",
"description": "变更的当前生命周期状态。\n| 取值 | 含义 |\n|---|---|\n| `Planned` | 已计划,未开始。 |\n| `Ready` | 就绪,待执行。 |\n| `Processing` | 执行中。 |\n| `Canceled` | 已取消。 |\n| `Done` | 已完成。 |",
"description": "变更的当前生命周期状态。\n| 取值 | 含义 |\n|---|---|\n| `Planned` | 已计划,未开始。 |\n| `Ready` | 就绪,待执行。 |\n| `Processing` | 执行中。 |\n| `Canceled` | 已取消。 |\n| `Done` | 已完成。 |\n| `Failed` | 失败。 |",
"enum": [
"Planned",
"Ready",
"Processing",
"Canceled",
"Done"
"Done",
"Failed"
]
},
"start_time": {
Expand Down
10 changes: 6 additions & 4 deletions api-reference/openapi.en.json
Original file line number Diff line number Diff line change
Expand Up @@ -4494,13 +4494,14 @@
"type": "string"
},
"change_status": {
"description": "Lifecycle status of the change event, reported by the change source as execution progresses.\n| Value | Meaning |\n|---|---|\n| `Planned` | Planned, not started. |\n| `Ready` | Ready for execution. |\n| `Processing` | Being executed. |\n| `Canceled` | Canceled. |\n| `Done` | Completed. |",
"description": "Lifecycle status of the change event, reported by the change source as execution progresses.\n| Value | Meaning |\n|---|---|\n| `Planned` | Planned, not started. |\n| `Ready` | Ready for execution. |\n| `Processing` | Being executed. |\n| `Canceled` | Canceled. |\n| `Done` | Completed. |\n| `Failed` | Failed. |",
"enum": [
"Planned",
"Ready",
"Processing",
"Canceled",
"Done"
"Done",
"Failed"
],
"type": "string"
},
Expand Down Expand Up @@ -4576,13 +4577,14 @@
"type": "string"
},
"change_status": {
"description": "Current lifecycle status of the change.\n| Value | Meaning |\n|---|---|\n| `Planned` | Planned, not started. |\n| `Ready` | Ready for execution. |\n| `Processing` | Being executed. |\n| `Canceled` | Canceled. |\n| `Done` | Completed. |",
"description": "Current lifecycle status of the change.\n| Value | Meaning |\n|---|---|\n| `Planned` | Planned, not started. |\n| `Ready` | Ready for execution. |\n| `Processing` | Being executed. |\n| `Canceled` | Canceled. |\n| `Done` | Completed. |\n| `Failed` | Failed. |",
"enum": [
"Planned",
"Ready",
"Processing",
"Canceled",
"Done"
"Done",
"Failed"
],
"type": "string"
},
Expand Down
6 changes: 4 additions & 2 deletions api-reference/openapi.legacy.zh.json
Original file line number Diff line number Diff line change
Expand Up @@ -28938,7 +28938,8 @@
"Ready",
"Processing",
"Canceled",
"Done"
"Done",
"Failed"
]
},
"start_time": {
Expand Down Expand Up @@ -29007,7 +29008,8 @@
"Ready",
"Processing",
"Canceled",
"Done"
"Done",
"Failed"
],
"description": "变更状态"
},
Expand Down
10 changes: 6 additions & 4 deletions api-reference/openapi.zh.json
Original file line number Diff line number Diff line change
Expand Up @@ -4494,13 +4494,14 @@
"type": "string"
},
"change_status": {
"description": "变更事件的生命周期状态。由变更事件源按执行进度上报。\n| 值 | 含义 |\n|---|---|\n| `Planned` | 已计划,尚未开始。 |\n| `Ready` | 已就绪,待执行。 |\n| `Processing` | 正在执行。 |\n| `Canceled` | 已取消。 |\n| `Done` | 已完成。 |",
"description": "变更事件的生命周期状态。由变更事件源按执行进度上报。\n| 值 | 含义 |\n|---|---|\n| `Planned` | 已计划,尚未开始。 |\n| `Ready` | 已就绪,待执行。 |\n| `Processing` | 正在执行。 |\n| `Canceled` | 已取消。 |\n| `Done` | 已完成。 |\n| `Failed` | 失败。 |",
"enum": [
"Planned",
"Ready",
"Processing",
"Canceled",
"Done"
"Done",
"Failed"
],
"type": "string"
},
Expand Down Expand Up @@ -4576,13 +4577,14 @@
"type": "string"
},
"change_status": {
"description": "变更的当前生命周期状态。\n| 取值 | 含义 |\n|---|---|\n| `Planned` | 已计划,未开始。 |\n| `Ready` | 就绪,待执行。 |\n| `Processing` | 执行中。 |\n| `Canceled` | 已取消。 |\n| `Done` | 已完成。 |",
"description": "变更的当前生命周期状态。\n| 取值 | 含义 |\n|---|---|\n| `Planned` | 已计划,未开始。 |\n| `Ready` | 就绪,待执行。 |\n| `Processing` | 执行中。 |\n| `Canceled` | 已取消。 |\n| `Done` | 已完成。 |\n| `Failed` | 失败。 |",
"enum": [
"Planned",
"Ready",
"Processing",
"Canceled",
"Done"
"Done",
"Failed"
],
"type": "string"
},
Expand Down
2 changes: 1 addition & 1 deletion en/on-call/incident/search-view-incident.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -277,7 +277,7 @@ The change event list displays the following information:

| Column | Description |
| :--- | :--- |
| **Status** | Current status of the change event, including Planned, Ready, Processing, Canceled, Done |
| **Status** | Current status of the change event, including Planned, Ready, Processing, Canceled, Done, Failed |
| **Change Key** | Unique identifier of the change event |
| **Title** | Brief description of the change event |
| **Description** | Detailed information about the change event |
Expand Down
6 changes: 3 additions & 3 deletions en/on-call/integration/change-integration/custom-event.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -61,14 +61,14 @@ Use the **push URL** shown on the integration details page. The URL format is:
| :--- | :---: | :--- | :--- |
| title | Yes | string | Change title, such as a release title, ticket title, or deployment task name. |
| change_key | Yes | string | Change identifier. Events with the same `change_key` are treated as the same change. Subsequent events update the change status, labels, and link. |
| change_status | Yes | string | Change status. Enum values are case-sensitive: `Planned`, `Ready`, `Processing`, `Canceled`, and `Done`. |
| change_status | Yes | string | Change status. Enum values are case-sensitive: `Planned`, `Ready`, `Processing`, `Canceled`, `Done`, and `Failed`. |
| event_time | No | integer | Event occurrence time as a Unix timestamp. Seconds and milliseconds are both supported. If omitted, Flashduty uses the time when the event is received. |
| description | No | string | Change description, such as change content, impact scope, execution steps, or rollback plan. |
| link | No | string | Change details link, such as a release, ticket, or CI/CD task URL. |
| labels | No | map | Change labels. Both keys and values must be strings. We recommend following the Prometheus label naming convention for keys. Flashduty replaces special characters such as spaces, dots, and slashes in label keys with underscores. |

<Note>
When `change_status` is `Done` or `Canceled`, Flashduty records the event time as the change end time. If you report a non-terminal status again, the end time is cleared.
When `change_status` is `Done`, `Canceled`, or `Failed`, Flashduty records the event time as the change end time. If you report a non-terminal status again, the end time is cleared.
</Note>

### Response
Expand Down Expand Up @@ -151,7 +151,7 @@ Labels describe events and should be as rich as possible:

- **Change scope**: such as host, cluster, etc.
- **Change ownership**: such as team, owner, etc.
- **Change lifecycle**: use the same `change_key` to report different `change_status` values as the change moves through planned, processing, completed, or canceled states. This helps restore the change process on the incident timeline.
- **Change lifecycle**: use the same `change_key` to report different `change_status` values as the change moves through planned, processing, completed, canceled, or failed states. This helps restore the change process on the incident timeline.

## FAQ

Expand Down
2 changes: 1 addition & 1 deletion zh/on-call/incident/search-view-incident.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -278,7 +278,7 @@ AI SRE 代某位成员执行的动作(例如[自动化规则](/zh/ai-sre/autom

| 列 | 说明 |
| :--- | :--- |
| **状态** | 变更事件的当前状态,包括已提单、即将开始、进行中、已取消、已完成 |
| **状态** | 变更事件的当前状态,包括已提单、即将开始、进行中、已取消、已完成、失败 |
| **Change Key** | 变更事件的唯一标识 |
| **标题** | 变更事件的简要描述 |
| **描述** | 变更事件的详细说明 |
Expand Down
6 changes: 3 additions & 3 deletions zh/on-call/integration/change-integration/custom-event.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -62,14 +62,14 @@ POST, Content-Type: application/json
| :--- | :---: | :--- | :--- |
| title | 是 | string | 变更标题,例如发布单标题、工单标题或部署任务名称。 |
| change_key | 是 | string | 变更标识。相同 `change_key` 会被识别为同一个变更,后续事件会更新该变更的状态、标签和链接。 |
| change_status | 是 | string | 变更状态。枚举值(首字母大写):`Planned` 计划中、`Ready` 待执行、`Processing` 执行中、`Canceled` 已取消、`Done` 已完成。 |
| change_status | 是 | string | 变更状态。枚举值(首字母大写):`Planned` 计划中、`Ready` 待执行、`Processing` 执行中、`Canceled` 已取消、`Done` 已完成、`Failed` 失败。 |
| event_time | 否 | integer | 事件发生时间,Unix 时间戳。支持秒级或毫秒级时间戳;未传时使用 Flashduty 接收事件的时间。 |
| description | 否 | string | 变更描述,例如变更内容、影响范围、执行步骤或回滚方案。 |
| link | 否 | string | 变更详情链接,例如发布单、工单或 CI/CD 任务地址。 |
| labels | 否 | map | 变更标签集合,key 和 value 均为 string 类型。建议 key 遵循 Prometheus 标签命名规范;系统会将 key 中的空格、点号、斜杠等特殊字符替换为下划线。 |

<Note>
当 `change_status` 为 `Done` 或 `Canceled` 时,Flashduty 会将该事件时间记录为变更结束时间;再次上报非结束状态时,结束时间会被清空。
当 `change_status` 为 `Done`、`Canceled` 或 `Failed` 时,Flashduty 会将该事件时间记录为变更结束时间;再次上报非结束状态时,结束时间会被清空。
</Note>

### 请求响应
Expand Down Expand Up @@ -152,7 +152,7 @@ curl -X POST '{api_host}/event/push/change/standard?integration_key={integration

- **变更的应用范围**:如 host、cluster 等
- **变更的归属信息**:如 team、owner 等
- **变更的生命周期**:同一个变更在计划、执行、完成或取消时,使用相同 `change_key` 持续上报不同 `change_status`,便于在故障时间线上还原变更过程
- **变更的生命周期**:同一个变更在计划、执行、完成、取消或失败时,使用相同 `change_key` 持续上报不同 `change_status`,便于在故障时间线上还原变更过程

## 常见问题

Expand Down
Loading