Skip to main content

Test alert queries

Introduction​

Backend data source plugins that have alerting enabled can define alerts based on the data source queries. Before you can save an alert, the conditions for an alert definition are evalauted by the alert engine to ensure that the response from the data source is shaped correctly. If it is shaped correctly, then you can use the alertRulePage fixture to verify that alert rules can be created from the output of a query returned by the data source.

info

The APIs for end-to-end testing alert rules are only compatible with Grafana >=9.4.0.

Evaluating a new alert rule​

The following example uses the alertRulePage fixture. With this fixture, the test starts in the page for adding a new alert rule. You then fill in the alert rule query and call the evaluate function. Evaluate clicks the Preview button which triggers a call to the eval endpoint to evaluate that the response of the data source query can be used to create an alert. The toBeOK matcher is used to verify that the evaluation was successful.

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();
});

Evaluating a provisioned alert rule​

You can also use a provisioned alert rule to test that your data source is compatible with alerting. For example:

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();
});