Skip to content

Commit 18601ff

Browse files
ysyneuysyneu
committed
Remove deprecated fields from webhook and template documentation
1 parent 54a0a77 commit 18601ff

6 files changed

Lines changed: 0 additions & 27 deletions

File tree

‎flashduty/en/1. On-call/4. Configure On-call/4.7 Templates.md‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -132,10 +132,8 @@ Title | string | Yes | Alert title
132132
Description | string | Yes | Alert description, can be empty
133133
AlertSeverity | string | Yes | Severity level, enum values: Critical, Warning, Info
134134
AlertStatus | string | Yes | Alert status, enum values: Critical, Warning, Info, Ok
135-
Progress | string | Yes | Processing progress, enum values: Triggered, Processing, Closed
136135
StartTime | int64 | Yes | Trigger time, Unix timestamp in seconds
137136
EndTime | int64 | No | Recovery time, Unix timestamp in seconds, default 0
138-
CloseTime | int64 | No | Close time, EndTime is alert recovery time, CloseTime is processing progress close time. Alert automatically closes upon recovery, manual closure doesn't affect alert recovery. Unix timestamp in seconds, default 0
139137
`Labels` | map[string]string | No | Label key-value pairs, both Key and Value are strings
140138

141139
## Common Questions

‎flashduty/en/1. On-call/8. Integrations/8.5 Webhooks/8.5.1 Alert webhook.md‎

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -64,13 +64,11 @@ email | string | Yes | Email address
6464
| alert_key | string | Yes | Alert correlation basis |
6565
| alert_severity | string | Yes | Severity level, enum: Critical, Warning, Info |
6666
| alert_status | string | Yes | Alert status, enum: Critical, Warning, Info, Ok |
67-
| progress | string | Yes | Processing progress, enum: Triggered, Closed |
6867
| created_at | int64 | Yes | Creation time |
6968
| updated_at | int64 | Yes | Update time |
7069
| start_time | int64 | Yes | First trigger time (time of first event received by platform), Unix timestamp in seconds |
7170
| last_time | int64 | Yes | Latest event time (time of most recent event received by platform), Unix timestamp in seconds |
7271
| end_time | int64 | No | Alert recovery time (time when platform last received end-type event), Unix timestamp in seconds, defaults to 0 |
73-
| close_time | int64 | No | Closure time, different from end_time, this indicates progress closure, not actual alert recovery. Unix timestamp in seconds, defaults to 0 |
7472
| labels | map[string]string | No | Label key-value pairs, both Key and Value are strings |
7573
| event_cnt | int64 | No | Number of associated events |
7674
| incident | [Incident](#Incident) | No | Associated incident |
@@ -103,7 +101,6 @@ curl -X POST 'https://example.com/alert/webhook?a=a' \
103101
"alert_status":"Warning",
104102
"channel_id":1163577812973,
105103
"channel_name":"Order System",
106-
"close_time":0,
107104
"created_at":1683766015,
108105
"data_source_id":1571358104973,
109106
"data_source_name":"Aliyun SLS",
@@ -131,7 +128,6 @@ curl -X POST 'https://example.com/alert/webhook?a=a' \
131128
"severity":"6"
132129
},
133130
"last_time":1683809153,
134-
"progress":"Triggered",
135131
"start_time":1683766013,
136132
"title":"Test alert trigger to Flashduty",
137133
"title_rule":"$resource::$check",

‎flashduty/en/1. On-call/8. Integrations/8.5 Webhooks/8.5.3 Custom action.md‎

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -95,13 +95,11 @@ acknowledged_at | int64| No | Acknowledgment time
9595
| alert_key | string | Yes | Alert correlation basis |
9696
| alert_severity | string | Yes | Severity level, enum: Critical, Warning, Info |
9797
| alert_status | string | Yes | Alert status, enum: Critical, Warning, Info, Ok |
98-
| progress | string | Yes | Processing progress, enum: Triggered, Closed |
9998
| created_at | int64 | Yes | Creation time |
10099
| updated_at | int64 | Yes | Update time |
101100
| start_time | int64 | Yes | First trigger time (time of first event received by platform), Unix timestamp in seconds |
102101
| last_time | int64 | Yes | Latest event time (time of latest event received by platform), Unix timestamp in seconds |
103102
| end_time | int64 | No | Alert recovery time (time of last end-type event received by platform), Unix timestamp in seconds, default 0 |
104-
| close_time | int64 | No | Close time, different from end_time, this is processing progress closure, doesn't mean alert actually recovered. Unix timestamp in seconds, default 0 |
105103
| labels | map[string]string | No | Label KV pairs, both Key and Value are strings |
106104

107105
</div>
@@ -132,7 +130,6 @@ curl -X POST 'https://example.com/incident/action?a=a' \
132130
"alert_key": "asdflasdfl2xzasd112621",
133131
"alert_severity": "Critical",
134132
"alert_status": "Critical",
135-
"close_time": 0,
136133
"created_at": 1699869567,
137134
"data_source_id": 2398086111504,
138135
"description": "cpu.idle < 20%",
@@ -148,10 +145,6 @@ curl -X POST 'https://example.com/incident/action?a=a' \
148145
"v": "v"
149146
},
150147
"last_time": 1699869562,
151-
"progress": "Triggered",
152-
"responder_email": "",
153-
"responder_id": 0,
154-
"responder_name": "",
155148
"start_time": 1699869562,
156149
"title": "nj / es.nj.01 - 自定义字段测试",
157150
"title_rule": "$cluster::$resource::$check",

‎flashduty/zh/1. On-call/3. 配置管理/4.7 配置通知模板.md‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -132,10 +132,8 @@ Title | string | 是 | 告警标题
132132
Description | string | 是 | 告警描述，可能为空
133133
AlertSeverity | string | 是 | 严重程度，枚举值：Critical，Warning，Info
134134
AlertStatus | string | 是 | 告警状态，枚举值：Critical，Warning，Info，Ok
135-
Progress | string | 是 | 处理进度，枚举值：Triggered，Processing，Closed
136135
StartTime | int64 | 是 | 触发时间，Unix 秒时间戳
137136
EndTime | int64 | 否 | 恢复时间，Unix 秒时间戳，默认为 0
138-
CloseTime | int64 | 否 | 关闭时间，EndTime 为告警恢复时间，CloseTime 为处理进度的关闭时间，告警恢复时会自动关闭，告警手动关闭时不影响告警恢复。Unix 秒时间戳，默认为 0
139137
`Labels` | map[string]string | 否 | 标签 KV，Key 和 Value 均为字符串
140138

141139
## 常见问题

‎flashduty/zh/1. On-call/5. 集成引导/8.5 Webhooks/8.5.1 告警 webhook.md‎

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,6 @@
1313
| a_new | 集成推送新事件，触发一条新告警 |
1414
| a_update | 集成推送新事件，合并到一条告警，并更新告警信息（严重程度、状态、labels、描述等） |
1515
| a_merge | 合并告警至故障 |
16-
| a_close | 手动关闭告警 |
1716

1817
</div>
1918

@@ -64,13 +63,11 @@ email | string | 是 | 邮件地址
6463
| alert_key | string | 是 | 告警关联依据|
6564
| alert_severity | string | 是 | 严重程度，枚举值：Critical，Warning，Info|
6665
| alert_status | string | 是 | 告警状态，枚举值：Critical，Warning，Info，Ok|
67-
| progress | string | 是 | 处理进度，枚举值：Triggered，Closed|
6866
| created_at | int64 | 是 | 创建时间|
6967
| updated_at | int64 | 是 | 更新时间|
7068
| start_time | int64 | 是 | 首次触发时间（平台接收到的首个事件的时间），Unix 秒时间戳|
7169
| last_time | int64 | 是 | 最新事件时间（平台接收到的最新事件时间），Unix 秒时间戳|
7270
| end_time | int64 | 否 | 告警恢复时间（平台上一次接收到结束类型事件的时间），Unix 秒时间戳，默认为 0|
73-
| close_time | int64 | 否 | 关闭时间，不同于 end_time，这个是处理进度的关闭，不代表告警真的恢复。Unix 秒时间戳，默认为 0 |
7471
| labels | map[string]string | 否 | 标签 KV，Key 和 Value 均为字符串|
7572
| event_cnt | int64 | 否 | 关联事件个数|
7673
| incident | [Incident](#Incident) | 否 | 所属故障|
@@ -103,7 +100,6 @@ curl -X POST 'https://example.com/alert/webhook?a=a' \
103100
"alert_status":"Warning",
104101
"channel_id":1163577812973,
105102
"channel_name":"订单系统",
106-
"close_time":0,
107103
"created_at":1683766015,
108104
"data_source_id":1571358104973,
109105
"data_source_name":"阿里云 SLS",
@@ -131,7 +127,6 @@ curl -X POST 'https://example.com/alert/webhook?a=a' \
131127
"severity":"6"
132128
},
133129
"last_time":1683809153,
134-
"progress":"Triggered",
135130
"start_time":1683766013,
136131
"title":"测试发送到Flashduty告警触发",
137132
"title_rule":"$resource::$check",

‎flashduty/zh/1. On-call/5. 集成引导/8.5 Webhooks/8.5.3 自定义操作.md‎

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -96,13 +96,11 @@ acknowledged_at | int64| 否 | 认领时间
9696
| alert_key | string | 是 | 告警关联依据|
9797
| alert_severity | string | 是 | 严重程度，枚举值：Critical，Warning，Info|
9898
| alert_status | string | 是 | 告警状态，枚举值：Critical，Warning，Info，Ok|
99-
| progress | string | 是 | 处理进度，枚举值：Triggered，Closed|
10099
| created_at | int64 | 是 | 创建时间|
101100
| updated_at | int64 | 是 | 更新时间|
102101
| start_time | int64 | 是 | 首次触发时间（平台接收到的首个事件的时间），Unix 秒时间戳|
103102
| last_time | int64 | 是 | 最新事件时间（平台接收到的最新事件时间），Unix 秒时间戳|
104103
| end_time | int64 | 否 | 告警恢复时间（平台上一次接收到结束类型事件的时间），Unix 秒时间戳，默认为 0|
105-
| close_time | int64 | 否 | 关闭时间，不同于 end_time，这个是处理进度的关闭，不代表告警真的恢复。Unix 秒时间戳，默认为 0 |
106104
| labels | map[string]string | 否 | 标签 KV，Key 和 Value 均为字符串|
107105

108106
</div>
@@ -133,7 +131,6 @@ curl -X POST 'https://example.com/incident/action?a=a' \
133131
"alert_key": "asdflasdfl2xzasd112621",
134132
"alert_severity": "Critical",
135133
"alert_status": "Critical",
136-
"close_time": 0,
137134
"created_at": 1699869567,
138135
"data_source_id": 2398086111504,
139136
"description": "cpu.idle < 20%",
@@ -149,10 +146,6 @@ curl -X POST 'https://example.com/incident/action?a=a' \
149146
"v": "v"
150147
},
151148
"last_time": 1699869562,
152-
"progress": "Triggered",
153-
"responder_email": "",
154-
"responder_id": 0,
155-
"responder_name": "",
156149
"start_time": 1699869562,
157150
"title": "nj / es.nj.01 - 自定义字段测试",
158151
"title_rule": "$cluster::$resource::$check",

0 commit comments

Comments
 (0)