You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: x-pack/platform/plugins/shared/alerting_v2/server/lib/dispatcher/README.md
+13-13Lines changed: 13 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,7 +10,7 @@ It runs on its own Task Manager schedule, separate from per-rule execution.
10
10
11
11
- Loading candidate alert episodes for the current execution window
12
12
- Applying suppression semantics from alert actions
13
-
- Matching episodes to notification policies
13
+
- Matching episodes to action policies
14
14
- Grouping matched episodes
15
15
- Throttling repeated delivery
16
16
- Dispatching to destinations
@@ -55,7 +55,7 @@ The pipeline then moves through these phases:
55
55
2. Fetch suppression facts
56
56
3. Split into dispatchable vs suppressed episodes
57
57
4. Load rule metadata for dispatchable episodes
58
-
5. Load enabled notification policies
58
+
5. Load enabled action policies
59
59
6. Evaluate policy matchers
60
60
7. Build notification groups
61
61
8. Apply throttling
@@ -71,7 +71,7 @@ By the end of a dispatcher run, every episode that reached the later pipeline st
71
71
|`dispatch`| The episode matched a policy, survived suppression and throttling, and was selected for delivery. |`fire` per episode, plus `notified` per notification group |
72
72
|`throttled`| The episode matched a policy, but the notification group was held back by throttling. |`suppress` with a throttle-related reason |
73
73
|`suppressed`| The episode was explicitly filtered out by suppression logic such as ack, snooze, or deactivate semantics. |`suppress` with the suppression reason |
74
-
|`unmatched`| The episode remained dispatchable but matched no enabled notification policy. |`unmatched`|
74
+
|`unmatched`| The episode remained dispatchable but matched no enabled action policy. |`unmatched`|
75
75
76
76
The full action taxonomy, including user-written actions such as `ack` and `snooze`, is documented in [`../../resources/README.md`](../../resources/README.md).
77
77
@@ -113,9 +113,9 @@ Unlike the rule executor, the dispatcher is not streaming. Each step receives on
113
113
-`continue` with a partial state merge, or
114
114
-`halt` with a `DispatcherHaltReason`
115
115
116
-
## Notification policy model
116
+
## Action policy model
117
117
118
-
A notification policy is a saved object scoped to a Kibana space. Policies are not embedded into the rule. Instead, the dispatcher loads enabled policies for the space and evaluates each policy against the candidate episodes.
118
+
An action policy is a saved object scoped to a Kibana space. Policies are not embedded into the rule. Instead, the dispatcher loads enabled policies for the space and evaluates each policy against the candidate episodes.
119
119
120
120
Each policy defines:
121
121
@@ -148,7 +148,7 @@ The dispatcher carries state forward through `DispatcherPipelineState` in `types
148
148
|`suppressions`|`FetchSuppressionsStep`| Suppression facts from `.alert-actions`. |
149
149
|`dispatchable` / `suppressed`|`ApplySuppressionStep`| Split of episodes that may continue vs those that must not notify. |
150
150
|`rules`|`FetchRulesStep`| Rule metadata keyed by rule id. |
151
-
|`policies`|`FetchPoliciesStep`| Enabled notification policies keyed by id. |
151
+
|`policies`|`FetchPoliciesStep`| Enabled action policies keyed by id. |
0 commit comments