Alerting: update Set evaluation behavior text (#88301)

* Alerting: update `Set evaluation behavior` text

* Update `Evaluation group` description for the `Evaluation group` modal view
This commit is contained in:
Pepe Cano
2024-06-03 15:41:34 +02:00
committed by GitHub
parent 54a3ed1c7c
commit 2a8a6d755f
4 changed files with 32 additions and 9 deletions

View File

@@ -28,7 +28,7 @@ export const CloudEvaluationBehavior = () => {
<RuleEditorSection stepNo={3} title="Set evaluation behavior">
<Field
label="Pending period"
description="Period in which an alert rule can be in breach of the condition until the alert rule fires."
description='Period the threshold condition must be met to trigger the alert. Selecting "None" triggers the alert immediately once the condition is met.'
>
<div className={styles.flexRow}>
<Field invalid={!!errors.forTime?.message} error={errors.forTime?.message} className={styles.inlineField}>

View File

@@ -208,9 +208,9 @@ export function FolderAndGroup({
<Stack alignItems="center">
<div style={{ width: 420 }}>
<Field
label="Evaluation group"
label="Evaluation group and interval"
data-testid="group-picker"
description="Rules within the same group are evaluated concurrently over the same time interval."
description="Define how often the alert rule is evaluated."
className={styles.formInput}
error={errors.group?.message}
invalid={!!errors.group?.message}
@@ -397,7 +397,11 @@ function EvaluationGroupCreationModal({
<FormProvider {...formAPI}>
<form onSubmit={handleSubmit(() => onSubmit())}>
<Field
label={<Label htmlFor={'group'}>Evaluation group name</Label>}
label={
<Label htmlFor={'group'} description="A group evaluates all its rules over the same evaluation interval.">
Evaluation group
</Label>
}
error={formState.errors.group?.message}
invalid={Boolean(formState.errors.group)}
>

View File

@@ -181,7 +181,7 @@ function ForInput({ evaluateEvery }: { evaluateEvery: string }) {
label={
<Label
htmlFor="evaluateFor"
description="Period in which an alert rule can be in breach of the condition until the alert rule fires."
description='Period the threshold condition must be met to trigger the alert. Selecting "None" triggers the alert immediately once the condition is met.'
>
Pending period
</Label>
@@ -232,10 +232,22 @@ function getDescription() {
Define how the alert rule is evaluated.
</Text>
<NeedHelpInfo
contentText="Evaluation groups are containers for evaluating alert and recording rules. An evaluation group defines an evaluation interval - how often a rule is checked. Alert rules within the same evaluation group are evaluated sequentially"
contentText={
<>
<p>Evaluation groups are containers for evaluating alert and recording rules.</p>
<p>
An evaluation group defines an evaluation interval - how often a rule is evaluated. Alert rules within the
same evaluation group are evaluated over the same evaluation interval.
</p>
<p>
Pending period specifies how long the threshold condition must be met before the alert starts firing. This
option helps prevent alerts from being triggered by temporary issues.
</p>
</>
}
externalLink={docsLink}
linkText={`Read about evaluation`}
title="Evaluation"
linkText={`Read about evaluation and alert states`}
title="Alert rule evaluation"
/>
</Stack>
);

View File

@@ -293,7 +293,14 @@ export function EditCloudGroupModal(props: ModalProps): React.ReactElement {
</Stack>
)}
<Field
label={<Label htmlFor="groupName">Evaluation group name</Label>}
label={
<Label
htmlFor="groupName"
description="A group evaluates all its rules over the same evaluation interval."
>
Evaluation group
</Label>
}
invalid={!!errors.groupName}
error={errors.groupName?.message}
>