Skip to content

[Observability][8.19] Docs new context.grouping variable added to Obs rules #4921

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Aug 1, 2025
Merged

[Observability][8.19] Docs new context.grouping variable added to Obs rules #4921

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
2ddaef0
First draft
nastasha-solomon Jul 31, 2025
015c4a2
Updates metric threshold docs
nastasha-solomon Jul 31, 2025
6b24b0e
Removes var from metric threshold
nastasha-solomon Jul 31, 2025
4887769
uno reverse
nastasha-solomon Jul 31, 2025
a066487
Update docs/en/observability/apm-error-count-threshold-rule.asciidoc
nastasha-solomon Aug 1, 2025
61bb382
Update docs/en/observability/apm-failed-transaction-rate-threshold-ru…
nastasha-solomon Aug 1, 2025
dea9cbe
Update docs/en/observability/apm-latency-threshold-rule.asciidoc
nastasha-solomon Aug 1, 2025
b6d55ee
Update docs/en/observability/slo-burn-rate-alert.asciidoc
nastasha-solomon Aug 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 13 additions & 10 deletions docs/en/observability/apm-error-count-threshold-rule.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,31 +95,34 @@ You an also specify {kibana-ref}/rule-action-variables.html[variables common to
Link to the alert troubleshooting view for further context and details. This will be an empty string if the server.publicBaseUrl is not configured.

`context.environment`::
The transaction type the alert is created for
The transaction type the alert is created for.

`context.grouping``::
The object containing groups that are reporting data.

`context.errorGroupingKey`::
The error grouping key the alert is created for
The error grouping key the alert is created for.

`context.errorGroupingName`::
The error grouping name the alert is created for
The error grouping name the alert is created for.

`context.interval`::
The length and unit of the time period where the alert conditions were met
The length and unit of the time period where the alert conditions were met.

`context.reason`::
A concise description of the reason for the alert
A concise description of the reason for the alert.

`context.serviceName`::
The service the alert is created for
The service the alert is created for.

`context.threshold`::
Any trigger value above this value will cause the alert to fir
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🌲

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

xmas

Any trigger value above this value will cause the alert to fire.

`context.transactionName`::
The transaction name the alert is created for
The transaction name the alert is created for.

`context.triggerValue`::
The value that breached the threshold and triggered the alert
The value that breached the threshold and triggered the alert.

`context.viewInAppUrl`::
Link to the alert source
Link to the alert source.
21 changes: 12 additions & 9 deletions docs/en/observability/apm-failed-transaction-rate-threshold-rule.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,28 +88,31 @@ You an also specify {kibana-ref}/rule-action-variables.html[variables common to
Link to the alert troubleshooting view for further context and details. This will be an empty string if the server.publicBaseUrl is not configured.

`context.environment`::
The transaction type the alert is created for
The transaction type the alert is created for.

`context.grouping``::
The object containing groups that are reporting data.

`context.interval`::
The length and unit of the time period where the alert conditions were met
The length and unit of the time period where the alert conditions were met.

`context.reason`::
A concise description of the reason for the alert
A concise description of the reason for the alert.

`context.serviceName`::
The service the alert is created for
The service the alert is created for.

`context.threshold`::
Any trigger value above this value will cause the alert to fire
Any trigger value above this value will cause the alert to fire.

`context.transactionName`::
The transaction name the alert is created for
The transaction name the alert is created for.

`context.transactionType`::
The transaction type the alert is created for
The transaction type the alert is created for.

`context.triggerValue`::
The value that breached the threshold and triggered the alert
The value that breached the threshold and triggered the alert.

`context.viewInAppUrl`::
Link to the alert source
Link to the alert source.
3 changes: 3 additions & 0 deletions docs/en/observability/apm-latency-threshold-rule.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,9 @@ Link to the alert troubleshooting view for further context and details. This wil
`context.environment`::
The transaction type the alert is created for.

`context.grouping``::
The object containing groups that are reporting data.

`context.interval`::
The length and unit of the time period where the alert conditions were met.

Expand Down
1 change: 1 addition & 0 deletions docs/en/observability/slo-burn-rate-alert.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,7 @@ You an also specify {kibana-ref}/rule-action-variables.html[variables common to

`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.
`context.burnRateThreshold`:: The burn rate threshold value.
`context.grouping``:: The object containing groups that are reporting data.
`context.longWindow`:: The window duration with the associated burn rate value.
`context.reason`:: A concise description of the reason for the alert.
`context.shortWindow`:: The window duration with the associated burn rate value.
Expand Down