夜莺监控 指标视图 详解
Prometheus 生态里如果要查询数据,需要编写 promql,对于普通用户来说,门槛有点高。通常有两种解法,一个是通过 AI 的手段做翻译,你用大白话跟 AI 提出你的诉求,让 AI 帮你写 promql,另一种是平台里内置现成的 promql,覆盖常用场景开箱即用。夜莺选择的是第二个方案,内置了一些 promql,当然了,监控指标何其之多,要想全部覆盖显然不可能,所以夜莺内置的 promql 只能算是一个样例,大家可以自行增删。
操作入口
内置的 promql 有两个查看入口。一个是在即时查询的时候,直接点击搜索内置指标,另一个是直接进到指标视图页面。下面是即时查询的页面样例:
点击内置查询,下面会出一个下拉浮层,里边会展示一个指标列表,你可以通过上面的几个搜索条件来筛选,比如我这个图上是选择的 Linux 类别,选择的 Categraf 采集器。鼠标在指标上面 hover,右侧会展示这个指标的一些信息,包括类型、采集器、表达式、单位、描述等。
为什么会有一个采集器的选项。因为夜莺可以接入多个时序库,不同的时序库中采集的数据各异,有些可能是 Categraf 采集的,有些是 Exporter 采集,有些甚至是自研的一些 agent 采集的。所以专门设计了这么一个字段,主要用于搜索过滤。
点击某个指标,就会自动填充到 promql 输入框里并触发查询,效果如下:
另一个操作入口是在指标视图页面。
指标视图
指标视图长下面这个样子:
核心就是把 promql 提前内置,配上中文名称,难理解的还会配上详细解释,同时分门别类,最终用户点击指标的中文名称就可以直接出图了。
点击某个指标,侧拉板里出图,如下:
这样一来,用户不需要懂 promql,只需要知道自己要查什么,就可以直接查到,非常方便。
默认提供的 promql 都是查询整个时序库的,没有过滤条件。对于某个业务的研发人员,可能只想看自己负责的服务的指标,此时可以提前配置一些过滤条件,选中某个过滤条件之后再点击指标,就会自动在 promql 中增加过滤条件,比如下面的例子,我配置了一个这样的过滤条件:
这里我使用 ident 标签做过滤,值为 categraf01,你完全可以自定义其他标签的过滤条件。再次点击指标,效果如下:
可以看到 promql 已经被自动修改了,添加上了 ident="categraf01"
的过滤条件。
内置的指标如何添加
夜莺内置的指标如果觉得不够用想要自行添加,需要具备指标视图下面的几个写权限。如果你想添加的是自己公司特定的一些指标,就在指标视图添加即可,如果你想补充的是通用的组件指标,比如是 MySQL、Redis 的一些指标,那建议去模板中心添加。比如我要添加一些 Redis 的指标:
因为在这里添加的时候,可以省去选择组件字段。
假设你添加了一些指标,觉得这些指标整理的很好,想和社区分享,那就选中相关的指标,然后右上角有个导出指标的操作,即可导出为一段 json 内容。然后把这段内容提到夜莺的 github 中即可。夜莺的代码目录中有个 integrations 目录:
里边分门别类放置了各类组件的仪表盘、告警规则、内置指标,其中内置指标是在各个组件目录下的 metrics 目录下,你可以参考 Linux 的 metrics 目录里的内容。一般每个采集器分别有个 json 文件。json 文件里的内容整体是个数组,数组的每个元素就是定义了一个内置指标。
欢迎大家提交 PR,这个事大家多多参与,很快就可以有一个丰富的内置指标库了。