Skip to content

Commit

Permalink
[Alerting] Fixing notifyWhen terminology (elastic#96490)
Browse files Browse the repository at this point in the history
* Updating terminology

* Updating wording

* Updating wording
  • Loading branch information
ymao1 authored Apr 13, 2021
1 parent e3f5249 commit 4f6bd31
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
4 changes: 2 additions & 2 deletions docs/user/alerting/defining-rules.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,8 @@ Name:: The name of the rule. While this name does not have to be unique, th
Tags:: A list of tag names that can be applied to a rule. Tags can help you organize and find rules, because tags appear in the rule listing in the management UI which is searchable by tag.
Check every:: This value determines how frequently the rule conditions below are checked. Note that the timing of background rule checks are not guaranteed, particularly for intervals of less than 10 seconds. See <<alerting-production-considerations, Alerting production considerations>> for more information.
Notify:: This value limits how often actions are repeated when an alert remains active across rule checks. See <<alerting-concepts-suppressing-duplicate-notifications>> for more information. +
- **Only on status change**: Actions are not repeated when an alert remains active across checks. Actions run only when the rule status changes.
- **Every time rule is active**: Actions are repeated when an alert remains active across checks.
- **Only on status change**: Actions are not repeated when an alert remains active across checks. Actions run only when the alert status changes.
- **Every time alert is active**: Actions are repeated when an alert remains active across checks.
- **On a custom action interval**: Actions are suppressed for the throttle interval, but repeat when an alert remains active across checks for a duration longer than the throttle interval.


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ const NOTIFY_WHEN_OPTIONS: Array<EuiSuperSelectOption<AlertNotifyWhenType>> = [
<EuiText size="s" color="subdued">
<p>
<FormattedMessage
defaultMessage="Actions run when the rule status changes."
defaultMessage="Actions run when the alert status changes."
id="xpack.triggersActionsUI.sections.alertForm.alertNotifyWhen.onActionGroupChange.description"
/>
</p>
Expand All @@ -62,22 +62,22 @@ const NOTIFY_WHEN_OPTIONS: Array<EuiSuperSelectOption<AlertNotifyWhenType>> = [
inputDisplay: i18n.translate(
'xpack.triggersActionsUI.sections.alertForm.alertNotifyWhen.onActiveAlert.display',
{
defaultMessage: 'Every time rule is active',
defaultMessage: 'Every time alert is active',
}
),
'data-test-subj': 'onActiveAlert',
dropdownDisplay: (
<Fragment>
<strong>
<FormattedMessage
defaultMessage="Every time rule is active"
defaultMessage="Every time alert is active"
id="xpack.triggersActionsUI.sections.alertForm.alertNotifyWhen.onActiveAlert.label"
/>
</strong>
<EuiText size="s" color="subdued">
<p>
<FormattedMessage
defaultMessage="Actions run with every active rule interval."
defaultMessage="Actions repeat at the rule interval when the alert is active."
id="xpack.triggersActionsUI.sections.alertForm.alertNotifyWhen.onActiveAlert.description"
/>
</p>
Expand Down

0 comments on commit 4f6bd31

Please sign in to comment.