Skip to content

Commit 5a0dfd3

Browse files
authored
Merge pull request #579 from flashcatcloud/fix/kentik-integration-e2e
docs(kentik): channel form, Synthetics per-agent alerts, test notifications
2 parents 51005fa + d124b17 commit 5a0dfd3

2 files changed

Lines changed: 12 additions & 10 deletions

File tree

  • en/on-call/integration/alert-integration/alert-sources
  • zh/on-call/integration/alert-integration/alert-sources

‎en/on-call/integration/alert-integration/alert-sources/kentik.mdx‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,8 @@ Creating a notification channel requires the Administrator role in Kentik; Membe
3737
<Steps>
3838
<Step title="Create a Custom Webhook notification channel">
3939

40-
1. Log in to the Kentik Portal and go to **Settings** → **Notifications**
41-
2. Click **Add Notification Channel** and set **Type** to **Custom Webhook**. Do not choose the **JSON** type: Flashduty parses the output of the template below
40+
1. Log in to the Kentik Portal and go to **Settings** → **Notification Channels**
41+
2. Click **Add Notification Channel** and set **Type** to **Webhook** (listed as Custom Webhook). Do not choose the **JSON** type: Flashduty parses the output of the template below
4242
3. Fill in the fields as follows:
4343

4444
| Field | Value |
@@ -47,7 +47,7 @@ Creating a notification channel requires the Administrator role in Kentik; Membe
4747
| **Status** | On |
4848
| **URL** | The full Flashduty integration push URL, including `integration_key` |
4949
| **Custom Headers** | Leave empty |
50-
| **Custom Template** | Paste the template below without renaming any field |
50+
| **Custom Template** | Click **Go to Notification Template Setup** and paste the template below into **TEMPLATE** on the **Template & Preview** tab, without renaming any field |
5151
| **Uglify JSON** | Keep the default |
5252

5353
```go-template
@@ -75,7 +75,7 @@ Creating a notification channel requires the Administrator role in Kentik; Membe
7575
}
7676
```
7777

78-
4. Click **Add Notification Channel** to save
78+
4. Click **Save**
7979

8080
</Step>
8181

@@ -102,6 +102,7 @@ Do not use this channel for mitigation methods or Insights notifications: these
102102
Flashduty uses the Kentik alert ID (`AlarmID`, shown as **Alert ID** in Kentik) as the Alert Key. Every state-change notification of one Kentik alert, from Active to Cleared, carries the same alert ID, so they merge into one alert, and the clear notification closes it.
103103

104104
- **Alerts per key**: an alert policy raises a separate alert for each key (one set of values of the policy dimensions) that matches the conditions. Each alert has its own ID, so each is a separate Flashduty alert that recovers on its own
105+
- **Synthetics alerts per agent**: a Synthetics test raises a separate alert, with its own ID, for each test agent. A new failure after an alert clears gets a new alert ID and becomes a new Flashduty alert
105106
- Changes to the description, severity, metric values, or times do not change the Alert Key. Events without `AlarmID` are rejected
106107
- When one notification carries several events, each event maps to its own alert. A notification with no events is accepted but creates no alert
107108

@@ -150,6 +151,6 @@ The alert title is the Kentik event description (`Description`), such as `Alarm
150151
- **`AlarmID is required`**: the channel is used for mitigation or Insights notifications, or the template was changed. Use the channel only for alert policies and Synthetics tests
151152
- **The alert does not recover**: confirm that the alert is Cleared in Kentik. For policies with **Acknowledgement Required** on, the alert must be acknowledged in Kentik before it can clear (see [Kentik threshold policy settings](https://kb.kentik.com/v1/docs/threshold-policy-settings))
152153
- **One policy creates several alerts**: the policy alerts on each set of dimension values separately; this is expected
153-
- **Test notifications**: the content of the Kentik **Test** / **Test Notification Channels** buttons is defined by Kentik. If it carries an alert ID, Flashduty handles it as a regular alert; close that alert manually in Flashduty
154+
- **Test notifications**: **Send Test Notification** on the **Template & Preview** tab sends mock data whose event description starts with `[TEST]`; Flashduty accepts it and creates no alert. If you first load a real alert with **Enter Alert ID**, the test carries that alert's real state, and Flashduty handles it as a real notification
154155

155156
For field details, see [Kentik notification channels](https://kb.kentik.com/docs/notification-channel) and the [Kentik Custom Webhook templating reference](https://github.com/kentik/custom-notification-templates/blob/main/docs/TEMPLATING_REFERENCE.md).

‎zh/on-call/integration/alert-integration/alert-sources/kentik.mdx‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,8 @@ keywords: ["告警集成", "Kentik", "Custom Webhook", "通知渠道", "Syntheti
3737
<Steps>
3838
<Step title="创建 Custom Webhook 通知渠道">
3939

40-
1. 登录 Kentik Portal,进入 **Settings** → **Notifications**
41-
2. 点击 **Add Notification Channel**,类型(Type)选择 **Custom Webhook**。请不要选择 **JSON** 类型,Flashduty 解析的是下面模板的输出
40+
1. 登录 Kentik Portal,进入 **Settings** → **Notification Channels**
41+
2. 点击 **Add Notification Channel**,类型(Type)选择 **Webhook**(列表中显示为 Custom Webhook)。请不要选择 **JSON** 类型,Flashduty 解析的是下面模板的输出
4242
3. 按下表填写:
4343

4444
| 配置项 | 填写内容 |
@@ -47,7 +47,7 @@ keywords: ["告警集成", "Kentik", "Custom Webhook", "通知渠道", "Syntheti
4747
| **Status** | 开启 |
4848
| **URL** | Flashduty 集成的完整推送地址,需包含 `integration_key` |
4949
| **Custom Headers** | 无需填写 |
50-
| **Custom Template** | 粘贴下方模板,不要修改字段名 |
50+
| **Custom Template** | 点击 **Go to Notification Template Setup**,在 **Template & Preview** 标签页的 **TEMPLATE** 中粘贴下方模板,不要修改字段名 |
5151
| **Uglify JSON** | 保持默认即可 |
5252

5353
```go-template
@@ -75,7 +75,7 @@ keywords: ["告警集成", "Kentik", "Custom Webhook", "通知渠道", "Syntheti
7575
}
7676
```
7777

78-
4. 点击 **Add Notification Channel** 保存
78+
4. 点击 **Save** 保存
7979

8080
</Step>
8181

@@ -102,6 +102,7 @@ keywords: ["告警集成", "Kentik", "Custom Webhook", "通知渠道", "Syntheti
102102
Flashduty 使用 Kentik 的告警 ID(`AlarmID`,Kentik 界面中的 **Alert ID**)作为 Alert Key。同一条 Kentik 告警从 Active 到 Cleared 的每次状态变化通知都携带同一个告警 ID,因此会合并到同一条告警,并由清除通知关闭。
103103

104104
- **按维度告警**:告警策略会为每个满足条件的键(Key,即策略维度的一组取值)分别生成告警,每条告警有自己的 ID,因此在 Flashduty 中是不同的告警,分别恢复
105+
- **合成监测按代理告警**:合成监测测试为每个测试代理(Agent)分别生成告警,各有自己的 ID;告警清除后再次失败会生成新的告警 ID,对应新的 Flashduty 告警
105106
- 描述、严重程度、指标值和时间的变化不会改变 Alert Key。缺少 `AlarmID` 的事件会被拒绝
106107
- 一次推送包含多个事件时,每个事件各自对应一条告警;没有事件的推送会返回成功,但不会创建告警
107108

@@ -150,6 +151,6 @@ Flashduty 使用 Kentik 的告警 ID(`AlarmID`,Kentik 界面中的 **Alert I
150151
- **提示 `AlarmID is required`**:该渠道被用于缓解或洞察通知,或模板被修改。只把该渠道用于告警策略和合成监测测试
151152
- **告警没有恢复**:确认告警在 Kentik 中已变为 Cleared。开启了 **Acknowledgement Required** 的策略,告警需先在 Kentik 中确认才能清除(参见 [Kentik 策略阈值设置](https://kb.kentik.com/v1/docs/threshold-policy-settings))
152153
- **一条策略产生了多条告警**:策略按维度的每组取值分别告警,这是预期行为
153-
- **测试通知**:Kentik 的 **Test** / **Test Notification Channels** 按钮发送的内容以 Kentik 为准;若其中带有告警 ID,Flashduty 会按普通告警处理,请在 Flashduty 中手动关闭该告警
154+
- **测试通知**:**Template & Preview** 标签页的 **Send Test Notification** 使用模拟数据(Mock Data)发送时,事件描述以 `[TEST]` 开头,Flashduty 返回成功但不创建告警。若先通过 **Enter Alert ID** 加载一条真实告警再发送,推送内容就是该告警的真实状态,Flashduty 会按真实通知处理
154155

155156
更多字段含义请参阅 [Kentik 通知渠道](https://kb.kentik.com/docs/notification-channel) 和 [Kentik Custom Webhook 模板参考](https://github.com/kentik/custom-notification-templates/blob/main/docs/TEMPLATING_REFERENCE.md)。

0 commit comments

Comments
 (0)