功能概述
功能模块
异常告警功能位于集群详情页的异常告警 Tab 下,包含以下三个子模块:
·通知模板:管理告警通知的渠道配置和自定义消息模板。
·告警策略:配置基于日志查询的告警规则和触发条件。
·告警列表:查看所有告警策略产生的告警记录。
一、1. 通知模板
通知模板用于定义告警触发后的通知方式和消息内容。你需要先创建通知模板,再在告警策略中关联使用。
二、1.1 新建通知模板
1. 登录 TSearch 控制台,单击集群 ID/名称进入集群详情页。
2. 选择异常告警 > 通知模板页签,单击新建通知模板。
3. 配置以下信息:
| 配置项 | 说明 |
| 模板名称 | 支持中文、英文、数字、"+"、"-"和"_"的组合,最多不超过36个字符。每个模板创建后会自动生成唯一的模板 ID。 |
| 告警渠道 | 支持选择以下一种或多种渠道:邮箱:填写邮箱地址。企微:填写企业微信机器人 Webhook 地址。飞书:填写飞书机器人 Webhook 地址。钉钉:填写钉钉机器人 Webhook 地址。 |
| 告警内容 | 配置告警消息的标题和正文,支持插入变量实现动态渲染。可用变量包括: {{app_id}}(账号 appid)、{{uin}}(账号 uin )、{{template_name}}(模板名称)、{{cluster_name}}(查询集群名称)、{{cluster_id}}(查询集群 ID)、{{index_name}}(查询索引)、{{region_name}}(地域)、{{match_numbers}}(匹配数量)、{{alert_time}}(告警时间)。 |
4. 单击确定完成创建。
三、1.2 管理通知模板
在通知模板列表页,你可以执行以下操作:
·搜索:支持按模板名称、模板 ID、最后修改人进行精确搜索。
·编辑:修改已有模板的配置信息。
·复制:基于已有模板快速创建新模板,复制后的模板名称默认为 copy_of_{原模板名称}。
·删除:删除未被告警策略引用的模板。若模板已被告警策略关联,需先解除关联后方可删除。
·查看详情:单击模板名称可查看模板的完整配置信息。
四、2. 告警策略
告警策略用于定义日志查询条件、检测规则、告警触发条件以及关联的通知模板。
五、2.1 新建告警策略
1. 在集群详情页,选择异常告警 > 告警策略页签,单击新建告警策略。
2. 配置以下信息:
基础信息
| 配置项 | 说明 |
| 策略名称 | 支持中文、英文、数字、"+"、"-"和"_"的组合,最多不超过36个字符。每个策略创建后会自动生成唯一的策略 ID。 |
| 查询索引 | 填写需要检测的索引名称,支持索引名、通配符表达式或以逗号分隔的索引列表。例如:myindex-1,myindex-2,logs-*。 |
| 用户名 | 默认为 Elastic ,支持输入其他用户名。 |
| 密码 | 输入对应用户的密码。 |
告警规则
| 配置项 | 说明 |
| 查询条件 | 基于指定的时间字段,使用查询语句检索日志数据。 |
| 查询范围 | 设置查询的时间窗口和时间字段,支持分钟和小时粒度,仅支持查询近一天的数据。 |
| 预览结果 | 配置查询条件后,单击点击预览可实时查看匹配结果及 Top 5 数据。 |
| 查询开始时间 | 设置告警检测的起始时间。 |
| 查询频率 | 设置告警检测的执行频率,支持分钟和小时粒度。 |
| 触发条件 | 设置当查询统计中的结果达到设定的阈值时,触发告警。支持如大于、等于等多种条件。 |
告警通知
开启告警通知开关后,可从下拉列表中选择已创建的通知模板。一个告警策略下可以支持关联多个通知模板。
·若尚未创建通知模板,可单击新建通知模板快速跳转创建。
·支持单击查看进入通知模板详情页,或单击移除取消关联。取消关联通知模板并不会删除模板本身。
注意:说明:
注意:使用限制:每个 ES 集群最多可创建 50 条告警策略。
六、2.2 告警策略列表
在告警策略列表页,你可以执行以下操作:
| 操作 | 说明 |
| 搜索 | 支持按策略名称、策略 ID、通知模板、通知模板 ID 、最后修改人进行精准搜索。 |
| 数据导出 | 支持将列表信息导出至本地文件 |
| 开启/关闭告警通知 | 控制是否通过配置的渠道发送告警通知。屏蔽告警通知不会影响策略的运行状态,告警记录仍会正常生成。 |
| 策略状态 | 显示当前策略的运行状态,并且支持过滤查询操作:运行中、未运行、处理中、已删除 |
| 启用/停用策略 | 启用后策略进入"运行中"状态,系统将按照配置的查询频率自动执行检测;停用后策略进入"未运行"状态,不再执行检测。 |
| 查看告警记录 | 单击操作列的告警记录可查看该策略下的所有告警记录详情。 |
| 编辑 | 修改已有策略的配置信息。 |
| 复制 | 基于已有策略快速创建新策略。 |
| 删除 | 删除告警策略,已经删除的告警策略,将立刻停止运行,但已产生告警记录的策略删除后,告警记录仍可在告警列表中查看。 |
七、2.3 告警记录
在告警策略列表页,点击操作栏的告警记录,可以查询该告警策略产生的所有告警记录,帮助你掌握当前告警策略运行的情况。
告警记录列表包含以下字段:
| 字段 | 说明 |
| 告警时间 | 告警触发的时间,默认按时间由近及远排序,支持排序切换。 |
| 查询范围 | 告警策略命中时对应的查询时间范围。 |
| 命中数量 | 该次告警匹配到的日志条数。单击数字可通过侧边栏查看告警详情。 |
| 趋势 | 以 1 分钟为粒度展示告警趋势直方图。单击可在侧边栏查看告警详情。 |
| 操作-告警详情 | 查看该次告警的详细信息,详见下述3.2部分。 |
八、3. 告警列表
告警列表汇总展示所有告警策略产生的告警记录,帮助你全局掌握集群异常告警情况。
九、3.1 查看告警列表
在集群详情页,选择异常告警 > 告警列表页签。默认展示近一小时的告警记录,支持通过快捷按钮或时间选择器自定义查看范围。
告警列表包含以下字段:
| 字段 | 说明 |
| 告警时间 | 告警触发的时间,默认按时间由近及远排序,支持排序切换。 |
| 策略名称/ID | 触发告警的策略名称及唯一标识 ID。单击策略名称可查看策略详情。 |
| 索引名称 | 告警策略配置的查询索引名称。 |
| 查询范围 | 告警策略命中时对应的查询时间范围。 |
| 命中数量 | 该次告警匹配到的日志条数。单击数字可通过侧边栏查看告警详情。 |
| 通知模板 | 该策略关联的通知模板名称。单击模板名称可查看模板详情。 |
| 趋势 | 以 1 分钟为粒度展示告警趋势直方图。单击可在侧边栏查看告警详情。 |
在告警列表页,你可以执行以下操作:
| 操作 | 说明 |
| 搜索 | 支持按策略名称、策略 ID、查询索引和通知模板名称进行精准搜索。 |
| 数据导出 | 支持将告警列表信息导出至本地(趋势图不支持导出)。 |
十、3.2 告警详情
单击告警列表或告警记录中的命中数量、趋势图或告警详情,可通过侧边栏查看该条告警的详细信息。
| 模块 | 说明 |
| 基本信息 | 展示策略名称/ID、查询范围、告警时间、查询索引信息。 |
| 趋势图 | 以直方图形式展示告警趋势,支持 1 分钟和 5 分钟粒度切换查看,支持手动刷新。 |
| 日志明细 | 展示触发告警的日志条目,支持关键字搜索和高亮显示、时间正序/倒序排列、日志内容展开与收起,以及分页查看。 |
可以在侧边栏的右上角对告警策略进行操作:
| 操作 | 说明 |
| 屏蔽告警/恢复告警 | 屏蔽当前告警策略的告警通知,或恢复已屏蔽的告警通知。 |
| 停用策略/启用策略 | 快速停用或启用当前告警策略。 |