跳至主要内容

测试告警查询

介绍

启用了告警功能的后端数据源插件可以根据数据源查询定义告警。在保存告警之前,告警定义的条件会由告警引擎进行评估,以确保数据源返回的响应格式正确。如果格式正确,则可以使用 alertRulePage 固定装置来验证是否可以根据数据源返回的查询输出创建告警规则。

信息

端到端测试告警规则的 API 仅与 Grafana >=9.4.0 兼容。

评估新的告警规则

以下示例使用 alertRulePage 固定装置。使用此固定装置,测试将在添加新告警规则的页面中启动。然后,您填写告警规则查询并调用 evaluate 函数。Evaluate 会点击“预览”按钮,该按钮会触发对 eval 端点的调用,以评估数据源查询的响应是否可用于创建告警。toBeOK 匹配器用于验证评估是否成功。

test('should evaluate to true if query is valid', async ({ page, alertRuleEditPage, selectors }) => {
const queryA = alertRuleEditPage.getAlertRuleQueryRow('A');
await queryA.datasource.set('gdev-prometheus');
await queryA.locator.getByLabel('Code').click();
await page.waitForFunction(() => window.monaco);
await queryA.getByGrafanaSelector(selectors.components.CodeEditor.container).click();
await page.keyboard.insertText('topk(5, max(scrape_duration_seconds) by (job))');
await expect(alertRuleEditPage.evaluate()).toBeOK();
});

评估已配置的告警规则

您还可以使用已配置的告警规则来测试您的数据源是否与告警兼容。例如

test('should evaluate to true when loading a provisioned query that is valid', async ({
gotoAlertRuleEditPage,
readProvisionedAlertRule,
}) => {
const alertRule = await readProvisionedAlertRule({ fileName: 'alerts.yml' });
const alertRuleEditPage = await gotoAlertRuleEditPage(alertRule);
await expect(alertRuleEditPage.evaluate()).toBeOK();
});