夜莺监控（Nightingale）上线内置指标功能

巴辉特 2024-05-11 00:06:10

Prometheus 生态里如果要查询数据，需要编写 promql，对于普通用户来说，门槛有点高。通常有两种解法，一个是通过 AI 的手段做翻译，你用大白话跟 AI 提出你的诉求，让 AI 帮你写 promql，另一种是平台里内置现成的 promql，覆盖常用场景开箱即用。夜莺监控（Nightingale）最近上线了内置指标功能，可以方便做知识沉淀，让普通用户也能开箱即用。

版本说明

需要 v7.0.0.beta3 以上版本支持。虽然是 beta 版本，实际上既有功能都是稳定的，当前还在持续往里添加新功能，而根据发版节奏，正式版本固定每年七八月份发布，所以当前的版本都是 beta，实际是可以用于生产的，可以放心升级。

指标视图长下面这个样子：

夜莺指标视图

核心就是把 promql 提前内置，配上中文名称，难理解的还会配上详细解释，同时分门别类，最终用户点击指标的中文名称就可以直接出图了。

点击某个指标，侧拉板里出图，如下：

夜莺指标视图-查询

这样一来，用户不需要懂 promql，只需要知道自己要查什么，就可以直接查到，非常方便。

默认提供的 promql 都是查询整个时序库的，没有过滤条件。对于某个业务的研发人员，可能只想看自己负责的服务的指标，此时可以提前配置一些过滤条件，选中某个过滤条件之后再点击指标，就会自动在 promql 中增加过滤条件，比如下面的例子，我配置了一个这样的过滤条件：

夜莺指标视图-过滤

这里我使用 ident 标签做过滤，值为 categraf01，你完全可以自定义其他标签的过滤条件。再次点击指标，效果如下：

夜莺指标视图-过滤查询效果

可以看到 promql 已经被自动修改了，添加上了 ident="categraf01" 的过滤条件。

其他改动

v7.0.0.beta3 版本的其他 changelog 如下：

feat: 单点登录配置，敏感信息支持使用加密变量
refactor: Prometheus 源的即时查询支持使用内置指标查询数据，易用性提升
refactor: 一些 TextArea 组件打开 autoSize 高度会自动随着内容撑开
refactor: 仪表盘只会在点击全屏后展示关闭说明提示
fix: 修复订阅规则多选告警规则时会横向溢出问题
fix: 修复 VictoriaMetrics 源的仪表盘变量查询时间范围大于1天时可能存在缓存数据的问题
fix: 修复切换账号后本地缓存的 gid 不合法导致查询错误的问题

升级注意

替换二进制以及 integrations 目录，重启即可。夜莺会自动创建表结构，如果你的夜莺所用的数据库连接账号不具备建表权限，就需要手工建表了，语句如下：

CREATE TABLE `builtin_metrics` (
    `id` bigint unsigned NOT NULL AUTO_INCREMENT COMMENT 'unique identifier',
    `collector` varchar(191) NOT NULL COMMENT 'type of collector',
    `typ` varchar(191) NOT NULL COMMENT 'type of metric',
    `name` varchar(191) NOT NULL COMMENT 'name of metric',
    `unit` varchar(191) NOT NULL COMMENT 'unit of metric',
    `lang` varchar(191) NOT NULL DEFAULT '' COMMENT 'language of metric',
    `note` varchar(4096) NOT NULL COMMENT 'description of metric in Chinese',
    `expression` varchar(4096) NOT NULL COMMENT 'expression of metric',
    `created_at` bigint NOT NULL DEFAULT 0 COMMENT 'create time',
    `created_by` varchar(191) NOT NULL DEFAULT '' COMMENT 'creator',
    `updated_at` bigint NOT NULL DEFAULT 0 COMMENT 'update time',
    `updated_by` varchar(191) NOT NULL DEFAULT '' COMMENT 'updater',
    PRIMARY KEY (`id`),
    UNIQUE KEY `idx_collector_typ_name` (`lang`,`collector`, `typ`, `name`),
    INDEX `idx_collector` (`collector`),
    INDEX `idx_typ` (`typ`),
    INDEX `idx_name` (`name`),
    INDEX `idx_lang` (`lang`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;

CREATE TABLE `metric_filter` (
  `id` bigint NOT NULL AUTO_INCREMENT COMMENT 'unique identifier',
  `name` varchar(191) NOT NULL COMMENT 'name of metric filter',
  `configs` varchar(4096) NOT NULL COMMENT 'configuration of metric filter',
  `groups_perm` text,
  `create_at` bigint NOT NULL DEFAULT '0' COMMENT 'create time',
  `create_by` varchar(191) NOT NULL DEFAULT '' COMMENT 'creator',
  `update_at` bigint NOT NULL DEFAULT '0' COMMENT 'update time',
  `update_by` varchar(191) NOT NULL DEFAULT '' COMMENT 'updater',
  PRIMARY KEY (`id`),
  KEY `idx_name` (`name`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;