Skip to content

Commit aedf416

Browse files
ysyneuclaude
andcommitted
docs: expand drop rules, links template syntax, audit log tiers, and invite limits
- f001: Add dedicated drop rules section with full CRUD steps, matching logic, priority ordering, and comparison with silence rules - f002: Document channel links template variable syntax (${variable}), list all available variables, and explain iframe vs new-tab modes - f003: Add per-tier max searchable time range table for audit logs (Free 30d, Standard 180d, Professional 366d) - f004: Add daily invite resend limit (5/day) to member management - f005: Clarify audit log retention varies by subscription tier Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 8b77375 commit aedf416

6 files changed

Lines changed: 152 additions & 16 deletions

File tree

en/on-call/channel/create-edit.mdx

Lines changed: 65 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -87,14 +87,36 @@ After creating a channel, go to the **Configuration** tab on the details page to
8787
Create alert integrations in **Configuration****Integrate Data****Dedicated Integrations** to bring monitoring system alerts into this channel.
8888

8989
- Each integration type generates an independent Webhook address
90-
- Configure rules in **Configuration****Integrate Data****Drop Rules** to filter test data or invalid alerts
90+
91+
See [Integrate Data](/en/on-call/channel/integrate-data) for details.
92+
93+
### Configure Drop Rules
94+
95+
Configure rules in **Configuration****Integrate Data****Drop Rules** to filter out events that have entered the channel but don't need processing (such as test data or invalid alerts). Dropped events will not generate new alerts or merge into existing alerts.
96+
97+
<Steps>
98+
<Step title="Create a Drop Rule">
99+
Go to **Configuration****Integrate Data****Drop Rules**, click **Add Drop Rule**.
100+
</Step>
101+
<Step title="Fill in Rule Information">
102+
Enter a **Rule Name** (required) and **Description** (optional) for identification and management.
103+
</Step>
104+
<Step title="Set Filter Conditions">
105+
Configure filter conditions — supports matching by **Integration Source** and **Severity**.
106+
</Step>
107+
<Step title="Save the Rule">
108+
After saving, the rule is enabled by default. You can enable or disable any rule at any time from the drop rules list.
109+
</Step>
110+
</Steps>
111+
112+
<Note>
113+
Multiple drop rules are executed sequentially in list order. If any rule matches, the event is dropped. You can drag to adjust the execution priority of rules.
114+
</Note>
91115

92116
<Warning>
93-
Dropped events will not appear anywhere. If you're not receiving alerts, check the drop rules first.
117+
Dropped events will not appear anywhere. If you're not receiving alerts, check the drop rules first. Drop rules differ from [silence rules](/en/on-call/channel/noise-reduction) — silence rules only suppress notifications while the incident still exists; drop rules discard events entirely, producing no alert or incident records.
94118
</Warning>
95119

96-
See [Integrate Data](/en/on-call/channel/integrate-data) for details.
97-
98120
### Configure Escalation Rules
99121

100122
Define incident notification paths in **Configuration****Notification & Assignment****Escalation Rules**: who to notify, how to notify, and how to escalate on timeout.
@@ -126,7 +148,45 @@ Typical use cases include:
126148
- Linking to an internal knowledge base or Runbook
127149
- Opening a related monitoring dashboard
128150

129-
Links support two open modes: **Open in New Tab** and **Open in Embedded iframe**.
151+
#### Template Variable Syntax
152+
153+
Use `${variable_name}` in the link URL to reference incident or alert property values. The system automatically replaces variables with actual values when rendering links.
154+
155+
**Supported variables:**
156+
157+
| Variable | Description |
158+
| :--- | :--- |
159+
| `${title}` | Incident/alert title |
160+
| `${incident_id}` | Incident ID |
161+
| `${alert_id}` | Alert ID |
162+
| `${num}` | Incident number |
163+
| `${description}` | Incident/alert description |
164+
| `${incident_severity}` | Incident severity |
165+
| `${alert_severity}` | Alert severity |
166+
| `${channel_id}` | Channel ID |
167+
| `${progress}` | Incident processing progress |
168+
| `${start_time}` | Trigger time |
169+
| `${end_time}` | Close time |
170+
| `${labels.KEY}` | Alert label value — replace `KEY` with the label name, e.g., `${labels.service}` |
171+
| `${fields.KEY}` | Custom field value — replace `KEY` with the field identifier, e.g., `${fields.actions}` |
172+
173+
**Example:**
174+
```
175+
https://ticket.example.com/create?title=${title}&severity=${incident_severity}&service=${labels.service}
176+
```
177+
178+
#### Open Modes
179+
180+
Links support two open modes:
181+
182+
| Mode | Description |
183+
| :--- | :--- |
184+
| **Open in New Tab** | Clicking the link opens the target URL in a new browser tab |
185+
| **Open in Embedded iframe** | Clicking the link opens an iframe popup on the current page, embedding the target page directly |
186+
187+
<Note>
188+
Each channel can be associated with up to 3 links. Create links through the **Integration Center**, then select the associated channels in the link configuration.
189+
</Note>
130190

131191
## Managing Channels
132192

en/platform/audit-log.mdx

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Audit logs provide multiple filtering criteria to help you quickly locate target
3232

3333
| Filter | Description |
3434
| --- | --- |
35-
| **Time Range** | Select the query time interval; defaults to showing the last 7 days of logs |
35+
| **Time Range** | Select the query time interval; defaults to showing the last 7 days of logs. The maximum searchable range depends on your subscription plan (see table below) |
3636
| **User** | Filter by operator, supports searching by member name or email |
3737
| **Event** | Filter by event type, supports multi-select and keyword search |
3838
| **Event ID** | Enter an event ID to precisely match a specific operation record |
@@ -41,14 +41,22 @@ Audit logs provide multiple filtering criteria to help you quickly locate target
4141
You can combine multiple filters. For example, you can specify both a time range and an operator to quickly find all operations by a specific member during a particular period.
4242
</Tip>
4343

44+
**Maximum searchable range by plan:**
45+
46+
| Subscription Plan | Maximum Searchable Range |
47+
| --- | --- |
48+
| Free | 30 days |
49+
| Standard | 180 days |
50+
| Professional | 366 days |
51+
4452
## Pagination
4553

4654
---
4755

4856
Audit logs display 10 records per page. Use the pagination buttons at the bottom of the page to browse more records. The current page number and total pages are shown at the bottom.
4957

5058
<Note>
51-
The audit log retention period depends on your subscription plan. Contact support to upgrade if you need a longer retention period.
59+
Both the audit log retention period and searchable range depend on your subscription plan — higher tiers retain logs longer. Contact support to upgrade if you need a longer retention period.
5260
</Note>
5361

5462
## FAQ

en/platform/team-members.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ In the member list, a warning icon appears next to unverified email addresses or
9696

9797
<Note>
9898
- The system will send SMS or email notifications to invitees
99-
- Daily invitation limit is 200 people, with a maximum of 20 people per invitation
99+
- Daily invitation limit is 200 people, with a maximum of 20 people per invitation, and up to 5 invitation resends per day
100100
- Unactivated accounts cannot receive alert-related notifications
101101
</Note>
102102

zh/on-call/channel/create-edit.mdx

Lines changed: 65 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -88,14 +88,36 @@ keywords: ["协作空间", "创建管理", "业务隔离", "团队协作", "告
8888
**配置****集成数据****专属集成** 中创建告警集成,将监控系统的告警接入本空间。
8989

9090
- 每种类型集成会生成独立的 Webhook 地址
91-
-**配置****集成数据****排除规则** 中配置规则,过滤测试数据或无效告警
91+
92+
详见 [接入告警](/zh/on-call/channel/integrate-data)
93+
94+
### 配置排除规则
95+
96+
**配置****集成数据****排除规则** 中配置规则,过滤已进入当前协作空间但不需要处理的事件(如测试数据或无效告警)。被排除的事件不会生成新告警,也不会合入已有告警。
97+
98+
<Steps>
99+
<Step title="创建排除规则">
100+
进入 **配置****集成数据****排除规则**,点击 **添加排除规则**
101+
</Step>
102+
<Step title="填写规则信息">
103+
输入 **规则名称**(必填)和 **描述**(可选),便于后续识别和管理。
104+
</Step>
105+
<Step title="设置过滤条件">
106+
配置过滤条件,支持按 **集成来源****严重程度** 进行匹配。
107+
</Step>
108+
<Step title="保存规则">
109+
保存后规则默认启用,你可以随时在排除规则列表中启用或禁用某条规则。
110+
</Step>
111+
</Steps>
112+
113+
<Note>
114+
多条排除规则按照列表顺序依次执行,只要任意一条规则命中,事件即被排除。你可以通过拖动调整规则的执行优先级。
115+
</Note>
92116

93117
<Warning>
94-
排除后的事件不会在任何地方显示。如遇收不到告警的情况,请先检查排除规则。
118+
排除后的事件不会在任何地方显示。如遇收不到告警的情况,请先检查排除规则。排除规则与[静默策略](/zh/on-call/channel/noise-reduction)不同——静默策略只是抑制通知,故障仍然存在;排除规则会直接丢弃事件,不产生任何告警或故障记录。
95119
</Warning>
96120

97-
详见 [接入告警](/zh/on-call/channel/integrate-data)
98-
99121
### 配置分派策略
100122

101123
**配置****通知分派****分派策略** 中定义故障的通知路径:通知谁、怎么通知、超时如何升级。
@@ -127,7 +149,45 @@ keywords: ["协作空间", "创建管理", "业务隔离", "团队协作", "告
127149
- 链接到内部知识库或 Runbook
128150
- 打开相关的监控仪表盘
129151

130-
链接支持两种打开方式:**新标签页打开****页面内嵌 iframe 打开**
152+
#### 模板变量语法
153+
154+
在链接 URL 中使用 `${变量名}` 引用故障或告警的属性值。系统在渲染链接时会自动替换为实际值。
155+
156+
**支持的变量:**
157+
158+
| 变量 | 说明 |
159+
| :--- | :--- |
160+
| `${title}` | 故障/告警标题 |
161+
| `${incident_id}` | 故障 ID |
162+
| `${alert_id}` | 告警 ID |
163+
| `${num}` | 故障编号 |
164+
| `${description}` | 故障/告警描述 |
165+
| `${incident_severity}` | 故障严重程度 |
166+
| `${alert_severity}` | 告警严重程度 |
167+
| `${channel_id}` | 协作空间 ID |
168+
| `${progress}` | 故障处理进度 |
169+
| `${start_time}` | 触发时间 |
170+
| `${end_time}` | 关闭时间 |
171+
| `${labels.KEY}` | 告警标签值,`KEY` 替换为标签名,如 `${labels.service}` |
172+
| `${fields.KEY}` | 自定义字段值,`KEY` 替换为字段标识,如 `${fields.actions}` |
173+
174+
**示例:**
175+
```
176+
https://ticket.example.com/create?title=${title}&severity=${incident_severity}&service=${labels.service}
177+
```
178+
179+
#### 打开方式
180+
181+
链接支持两种打开方式:
182+
183+
| 方式 | 说明 |
184+
| :--- | :--- |
185+
| **新标签页打开** | 点击链接在浏览器新标签页中打开目标 URL |
186+
| **页面内嵌 iframe 打开** | 点击链接在当前页面弹出 iframe 弹窗,直接嵌入展示目标页面 |
187+
188+
<Note>
189+
每个协作空间最多关联 3 个链接。链接通过 **集成中心** 创建后,在链接配置中选择关联的协作空间即可生效。
190+
</Note>
131191

132192
## 管理空间
133193

zh/platform/audit-log.mdx

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ keywords: ["审计日志", "操作审计", "安全合规", "操作记录"]
3232

3333
| 筛选条件 | 说明 |
3434
| --- | --- |
35-
| **时间范围** | 选择查询的时间区间,默认展示最近 7 天的日志 |
35+
| **时间范围** | 选择查询的时间区间,默认展示最近 7 天的日志。可检索的最大时间范围取决于订阅版本(见下表) |
3636
| **用户** | 按操作人筛选,支持搜索成员名称或邮箱 |
3737
| **事件** | 按事件类型筛选,支持多选和关键词搜索 |
3838
| **事件 ID** | 输入事件 ID 精确匹配特定操作记录 |
@@ -41,14 +41,22 @@ keywords: ["审计日志", "操作审计", "安全合规", "操作记录"]
4141
多个筛选条件可以组合使用。例如,你可以同时指定时间范围和操作人,快速查找某位成员在特定时段内的所有操作。
4242
</Tip>
4343

44+
**各版本可检索时间范围:**
45+
46+
| 订阅版本 | 最大可检索范围 |
47+
| --- | --- |
48+
| 免费版 | 30 天 |
49+
| 标准版 | 180 天 |
50+
| 专业版 | 366 天 |
51+
4452
## 日志翻页
4553

4654
---
4755

4856
审计日志每页展示 10 条记录,通过页面底部的翻页按钮浏览更多记录。页面底部会显示当前页码和总页数。
4957

5058
<Note>
51-
审计日志的保留时长取决于你的订阅版本。如需更长的日志保留期限,请联系客服升级。
59+
审计日志的保留时长和可检索范围均取决于你的订阅版本,版本越高保留越久。如需更长的日志保留期限,请联系客服升级。
5260
</Note>
5361

5462
## 常见问题

zh/platform/team-members.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ keywords: ["团队管理", "成员管理", "邀请成员", "组织架构", "角
9797

9898
<Note>
9999
- 系统会向被邀请人发送短信或邮件通知
100-
- 每天邀请上限为 200 人,单次邀请至多 20 人
100+
- 每天邀请上限为 200 人,单次邀请至多 20 人,重新发送邀请每天至多 5 次
101101
- 未激活账号无法接收告警相关通知
102102
</Note>
103103

0 commit comments

Comments
 (0)