Skip to content

Commit 2e9c872

Browse files
[Observability][8.19] Docs new context.grouping variable added to Obs rules (elastic#4921)
* First draft * Updates metric threshold docs * Removes var from metric threshold * uno reverse * Update docs/en/observability/apm-error-count-threshold-rule.asciidoc Co-authored-by: Bena Kansara <[email protected]> * Update docs/en/observability/apm-failed-transaction-rate-threshold-rule.asciidoc Co-authored-by: Bena Kansara <[email protected]> * Update docs/en/observability/apm-latency-threshold-rule.asciidoc Co-authored-by: Bena Kansara <[email protected]> * Update docs/en/observability/slo-burn-rate-alert.asciidoc Co-authored-by: Bena Kansara <[email protected]> --------- Co-authored-by: Bena Kansara <[email protected]>
1 parent 4ba9bde commit 2e9c872

File tree

4 files changed

+29
-19
lines changed

4 files changed

+29
-19
lines changed

docs/en/observability/apm-error-count-threshold-rule.asciidoc

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -95,31 +95,34 @@ You an also specify {kibana-ref}/rule-action-variables.html[variables common to
9595
Link to the alert troubleshooting view for further context and details. This will be an empty string if the server.publicBaseUrl is not configured.
9696

9797
`context.environment`::
98-
The transaction type the alert is created for
98+
The transaction type the alert is created for.
99+
100+
`context.grouping`::
101+
The object containing groups that are reporting data.
99102

100103
`context.errorGroupingKey`::
101-
The error grouping key the alert is created for
104+
The error grouping key the alert is created for.
102105

103106
`context.errorGroupingName`::
104-
The error grouping name the alert is created for
107+
The error grouping name the alert is created for.
105108

106109
`context.interval`::
107-
The length and unit of the time period where the alert conditions were met
110+
The length and unit of the time period where the alert conditions were met.
108111

109112
`context.reason`::
110-
A concise description of the reason for the alert
113+
A concise description of the reason for the alert.
111114

112115
`context.serviceName`::
113-
The service the alert is created for
116+
The service the alert is created for.
114117

115118
`context.threshold`::
116-
Any trigger value above this value will cause the alert to fir
119+
Any trigger value above this value will cause the alert to fire.
117120

118121
`context.transactionName`::
119-
The transaction name the alert is created for
122+
The transaction name the alert is created for.
120123

121124
`context.triggerValue`::
122-
The value that breached the threshold and triggered the alert
125+
The value that breached the threshold and triggered the alert.
123126

124127
`context.viewInAppUrl`::
125-
Link to the alert source
128+
Link to the alert source.

docs/en/observability/apm-failed-transaction-rate-threshold-rule.asciidoc

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -88,28 +88,31 @@ You an also specify {kibana-ref}/rule-action-variables.html[variables common to
8888
Link to the alert troubleshooting view for further context and details. This will be an empty string if the server.publicBaseUrl is not configured.
8989

9090
`context.environment`::
91-
The transaction type the alert is created for
91+
The transaction type the alert is created for.
92+
93+
`context.grouping`::
94+
The object containing groups that are reporting data.
9295

9396
`context.interval`::
94-
The length and unit of the time period where the alert conditions were met
97+
The length and unit of the time period where the alert conditions were met.
9598

9699
`context.reason`::
97-
A concise description of the reason for the alert
100+
A concise description of the reason for the alert.
98101

99102
`context.serviceName`::
100-
The service the alert is created for
103+
The service the alert is created for.
101104

102105
`context.threshold`::
103-
Any trigger value above this value will cause the alert to fire
106+
Any trigger value above this value will cause the alert to fire.
104107

105108
`context.transactionName`::
106-
The transaction name the alert is created for
109+
The transaction name the alert is created for.
107110

108111
`context.transactionType`::
109-
The transaction type the alert is created for
112+
The transaction type the alert is created for.
110113

111114
`context.triggerValue`::
112-
The value that breached the threshold and triggered the alert
115+
The value that breached the threshold and triggered the alert.
113116

114117
`context.viewInAppUrl`::
115-
Link to the alert source
118+
Link to the alert source.

docs/en/observability/apm-latency-threshold-rule.asciidoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,9 @@ Link to the alert troubleshooting view for further context and details. This wil
9292
`context.environment`::
9393
The transaction type the alert is created for.
9494

95+
`context.grouping`::
96+
The object containing groups that are reporting data.
97+
9598
`context.interval`::
9699
The length and unit of the time period where the alert conditions were met.
97100

docs/en/observability/slo-burn-rate-alert.asciidoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,7 @@ You an also specify {kibana-ref}/rule-action-variables.html[variables common to
6464

6565
`context.alertDetailsUrl`:: Link to the alert troubleshooting view for further context and details. This will be an empty string if the `server.publicBaseUrl` is not configured.
6666
`context.burnRateThreshold`:: The burn rate threshold value.
67+
`context.grouping`:: The object containing groups that are reporting data.
6768
`context.longWindow`:: The window duration with the associated burn rate value.
6869
`context.reason`:: A concise description of the reason for the alert.
6970
`context.shortWindow`:: The window duration with the associated burn rate value.

0 commit comments

Comments
 (0)