From 8cc944f64fbdd2cc747656369c2da9556bd97a87 Mon Sep 17 00:00:00 2001 From: Gilles De Mey Date: Tue, 21 May 2024 17:10:12 +0200 Subject: [PATCH] Alerting: Docs feedback (#88125) update OK to Normal label, matching instances to instances --- .../alerting/alerting-rules/create-grafana-managed-rule.md | 4 ++-- public/app/features/alerting/unified/RuleList.test.tsx | 2 +- .../components/rule-editor/GrafanaAlertStatePicker.tsx | 2 +- .../alerting/unified/components/rules/RuleDetails.tsx | 2 +- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/sources/alerting/alerting-rules/create-grafana-managed-rule.md b/docs/sources/alerting/alerting-rules/create-grafana-managed-rule.md index 8bb94a3e1e3..cebdaa85819 100644 --- a/docs/sources/alerting/alerting-rules/create-grafana-managed-rule.md +++ b/docs/sources/alerting/alerting-rules/create-grafana-managed-rule.md @@ -243,7 +243,7 @@ You can configure the alert instance state when its evaluation returns no data: | --------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | No Data | The default option. Sets alert instance state to `No data`.
The alert rule also creates a new alert instance `DatasourceNoData` with the name and UID of the alert rule, and UID of the datasource that returned no data as labels. | | Alerting | Sets alert instance state to `Alerting`. It waits until the [pending period](ref:pending-period) has finished. | -| Ok | Sets alert instance state to `Normal`. | +| Normal | Sets alert instance state to `Normal`. | | Keep Last State | Maintains the alert instance in its last state. Useful for mitigating temporary issues, refer to [Keep last state](ref:keep-last-state). | You can also configure the alert instance state when its evaluation returns an error or timeout. @@ -252,7 +252,7 @@ You can also configure the alert instance state when its evaluation returns an e | ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Error | The default option. Sets alert instance state to `Error`.
The alert rule also creates a new alert instance `DatasourceError` with the name and UID of the alert rule, and UID of the datasource that returned no data as labels. | | Alerting | Sets alert instance state to `Alerting`. It waits until the [pending period](ref:pending-period) has finished. | -| Ok | Sets alert instance state to `Normal`. | +| Normal | Sets alert instance state to `Normal`. | | Keep Last State | Maintains the alert instance in its last state. Useful for mitigating temporary issues, refer to [Keep last state](ref:keep-last-state). | ## Create alerts from panels diff --git a/public/app/features/alerting/unified/RuleList.test.tsx b/public/app/features/alerting/unified/RuleList.test.tsx index 325c718be5f..5151b06721e 100644 --- a/public/app/features/alerting/unified/RuleList.test.tsx +++ b/public/app/features/alerting/unified/RuleList.test.tsx @@ -462,7 +462,7 @@ describe('RuleList', () => { expect(ruleDetails).toHaveTextContent('Expressiontopk ( 5 , foo ) [ 5m ]'); expect(ruleDetails).toHaveTextContent('messagegreat alert'); - expect(ruleDetails).toHaveTextContent('Matching instances'); + expect(ruleDetails).toHaveTextContent('Instances'); // finally, check instances table const instancesTable = byTestId('dynamic-table').get(ruleDetails); diff --git a/public/app/features/alerting/unified/components/rule-editor/GrafanaAlertStatePicker.tsx b/public/app/features/alerting/unified/components/rule-editor/GrafanaAlertStatePicker.tsx index 1494cc9a135..2da0a1e8a8f 100644 --- a/public/app/features/alerting/unified/components/rule-editor/GrafanaAlertStatePicker.tsx +++ b/public/app/features/alerting/unified/components/rule-editor/GrafanaAlertStatePicker.tsx @@ -13,7 +13,7 @@ type Props = Omit, 'options'> & { const options: SelectableValue[] = [ { value: GrafanaAlertStateDecision.Alerting, label: 'Alerting' }, { value: GrafanaAlertStateDecision.NoData, label: 'No Data' }, - { value: GrafanaAlertStateDecision.OK, label: 'OK' }, + { value: GrafanaAlertStateDecision.OK, label: 'Normal' }, { value: GrafanaAlertStateDecision.Error, label: 'Error' }, { value: GrafanaAlertStateDecision.KeepLast, label: 'Keep Last State' }, ]; diff --git a/public/app/features/alerting/unified/components/rules/RuleDetails.tsx b/public/app/features/alerting/unified/components/rules/RuleDetails.tsx index 0a50e1dcd3d..a0ea4f9d851 100644 --- a/public/app/features/alerting/unified/components/rules/RuleDetails.tsx +++ b/public/app/features/alerting/unified/components/rules/RuleDetails.tsx @@ -53,7 +53,7 @@ export const RuleDetails = ({ rule }: Props) => { - +