From 2ddaef0fbc3f88f58e169d664d455c71021e7048 Mon Sep 17 00:00:00 2001 From: Nastasha Solomon Date: Thu, 31 Jul 2025 00:40:59 -0400 Subject: [PATCH 1/8] First draft --- .../apm-error-count-threshold-rule.asciidoc | 23 +++++++++++-------- ...d-transaction-rate-threshold-rule.asciidoc | 21 +++++++++-------- .../apm-latency-threshold-rule.asciidoc | 3 +++ .../slo-burn-rate-alert.asciidoc | 1 + 4 files changed, 29 insertions(+), 19 deletions(-) diff --git a/docs/en/observability/apm-error-count-threshold-rule.asciidoc b/docs/en/observability/apm-error-count-threshold-rule.asciidoc index 213a3fe70b..9a2e6b831a 100644 --- a/docs/en/observability/apm-error-count-threshold-rule.asciidoc +++ b/docs/en/observability/apm-error-count-threshold-rule.asciidoc @@ -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 +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. diff --git a/docs/en/observability/apm-failed-transaction-rate-threshold-rule.asciidoc b/docs/en/observability/apm-failed-transaction-rate-threshold-rule.asciidoc index d92ff8f79b..f4804ab0eb 100644 --- a/docs/en/observability/apm-failed-transaction-rate-threshold-rule.asciidoc +++ b/docs/en/observability/apm-failed-transaction-rate-threshold-rule.asciidoc @@ -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 \ No newline at end of file +Link to the alert source. \ No newline at end of file diff --git a/docs/en/observability/apm-latency-threshold-rule.asciidoc b/docs/en/observability/apm-latency-threshold-rule.asciidoc index 0915b6816d..2369ecf683 100644 --- a/docs/en/observability/apm-latency-threshold-rule.asciidoc +++ b/docs/en/observability/apm-latency-threshold-rule.asciidoc @@ -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. diff --git a/docs/en/observability/slo-burn-rate-alert.asciidoc b/docs/en/observability/slo-burn-rate-alert.asciidoc index 26b14e3c38..c7438be911 100644 --- a/docs/en/observability/slo-burn-rate-alert.asciidoc +++ b/docs/en/observability/slo-burn-rate-alert.asciidoc @@ -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. From 015c4a26b343baba011eb6c46a8bd7a1b1806f3b Mon Sep 17 00:00:00 2001 From: Nastasha Solomon Date: Thu, 31 Jul 2025 14:43:57 -0400 Subject: [PATCH 2/8] Updates metric threshold docs --- docs/en/observability/metrics-threshold-alert.asciidoc | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/en/observability/metrics-threshold-alert.asciidoc b/docs/en/observability/metrics-threshold-alert.asciidoc index e69648ebec..18e9bc7b63 100644 --- a/docs/en/observability/metrics-threshold-alert.asciidoc +++ b/docs/en/observability/metrics-threshold-alert.asciidoc @@ -104,6 +104,7 @@ You an also specify {kibana-ref}/rule-action-variables.html[variables common to `context.cloud`:: The cloud object defined by ECS if available in the source. `context.container`:: The container object defined by ECS if available in the source. `context.group`:: Name of the group(s) reporting data. For accessing each group key, use `context.groupByKeys`. +`context.grouping``:: The object containing groups that are reporting data. `context.groupByKeys`:: The object containing groups that are reporting data. `context.host`:: The host object defined by ECS if available in the source. `context.labels`:: List of labels associated with the entity where this alert triggered. From 6b24b0e03877c86eabce57a36b3392d37596f6da Mon Sep 17 00:00:00 2001 From: Nastasha Solomon Date: Thu, 31 Jul 2025 14:51:25 -0400 Subject: [PATCH 3/8] Removes var from metric threshold --- docs/en/observability/metrics-threshold-alert.asciidoc | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/en/observability/metrics-threshold-alert.asciidoc b/docs/en/observability/metrics-threshold-alert.asciidoc index 18e9bc7b63..c160ec530c 100644 --- a/docs/en/observability/metrics-threshold-alert.asciidoc +++ b/docs/en/observability/metrics-threshold-alert.asciidoc @@ -103,7 +103,6 @@ You an also specify {kibana-ref}/rule-action-variables.html[variables common to `context.alertState`:: Current state of the alert. `context.cloud`:: The cloud object defined by ECS if available in the source. `context.container`:: The container object defined by ECS if available in the source. -`context.group`:: Name of the group(s) reporting data. For accessing each group key, use `context.groupByKeys`. `context.grouping``:: The object containing groups that are reporting data. `context.groupByKeys`:: The object containing groups that are reporting data. `context.host`:: The host object defined by ECS if available in the source. From 48877694e0b5f9378e436fd113cc5f412aa8624b Mon Sep 17 00:00:00 2001 From: Nastasha Solomon Date: Thu, 31 Jul 2025 14:53:19 -0400 Subject: [PATCH 4/8] uno reverse --- docs/en/observability/metrics-threshold-alert.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/en/observability/metrics-threshold-alert.asciidoc b/docs/en/observability/metrics-threshold-alert.asciidoc index c160ec530c..e69648ebec 100644 --- a/docs/en/observability/metrics-threshold-alert.asciidoc +++ b/docs/en/observability/metrics-threshold-alert.asciidoc @@ -103,7 +103,7 @@ You an also specify {kibana-ref}/rule-action-variables.html[variables common to `context.alertState`:: Current state of the alert. `context.cloud`:: The cloud object defined by ECS if available in the source. `context.container`:: The container object defined by ECS if available in the source. -`context.grouping``:: The object containing groups that are reporting data. +`context.group`:: Name of the group(s) reporting data. For accessing each group key, use `context.groupByKeys`. `context.groupByKeys`:: The object containing groups that are reporting data. `context.host`:: The host object defined by ECS if available in the source. `context.labels`:: List of labels associated with the entity where this alert triggered. From a0664872399e6e70b33ff831a27dd2805ae2080f Mon Sep 17 00:00:00 2001 From: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com> Date: Fri, 1 Aug 2025 09:06:39 -0400 Subject: [PATCH 5/8] Update docs/en/observability/apm-error-count-threshold-rule.asciidoc Co-authored-by: Bena Kansara <69037875+benakansara@users.noreply.github.com> --- docs/en/observability/apm-error-count-threshold-rule.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/en/observability/apm-error-count-threshold-rule.asciidoc b/docs/en/observability/apm-error-count-threshold-rule.asciidoc index 9a2e6b831a..1acd550d7a 100644 --- a/docs/en/observability/apm-error-count-threshold-rule.asciidoc +++ b/docs/en/observability/apm-error-count-threshold-rule.asciidoc @@ -97,7 +97,7 @@ 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``:: +`context.grouping`:: The object containing groups that are reporting data. `context.errorGroupingKey`:: From 61bb382c67619c00f71cedf4ed03d01120e05feb Mon Sep 17 00:00:00 2001 From: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com> Date: Fri, 1 Aug 2025 09:51:19 -0400 Subject: [PATCH 6/8] Update docs/en/observability/apm-failed-transaction-rate-threshold-rule.asciidoc Co-authored-by: Bena Kansara <69037875+benakansara@users.noreply.github.com> --- .../apm-failed-transaction-rate-threshold-rule.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/en/observability/apm-failed-transaction-rate-threshold-rule.asciidoc b/docs/en/observability/apm-failed-transaction-rate-threshold-rule.asciidoc index f4804ab0eb..11ff386a7e 100644 --- a/docs/en/observability/apm-failed-transaction-rate-threshold-rule.asciidoc +++ b/docs/en/observability/apm-failed-transaction-rate-threshold-rule.asciidoc @@ -90,7 +90,7 @@ 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``:: +`context.grouping`:: The object containing groups that are reporting data. `context.interval`:: From dea9cbe4f44d69ecda8c3b402649400f4b33c949 Mon Sep 17 00:00:00 2001 From: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com> Date: Fri, 1 Aug 2025 09:51:25 -0400 Subject: [PATCH 7/8] Update docs/en/observability/apm-latency-threshold-rule.asciidoc Co-authored-by: Bena Kansara <69037875+benakansara@users.noreply.github.com> --- docs/en/observability/apm-latency-threshold-rule.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/en/observability/apm-latency-threshold-rule.asciidoc b/docs/en/observability/apm-latency-threshold-rule.asciidoc index 2369ecf683..b2e52997c7 100644 --- a/docs/en/observability/apm-latency-threshold-rule.asciidoc +++ b/docs/en/observability/apm-latency-threshold-rule.asciidoc @@ -92,7 +92,7 @@ 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``:: +`context.grouping`:: The object containing groups that are reporting data. `context.interval`:: From b6d55eef6e60aef0f557bd9cb9813dc795c7b3cd Mon Sep 17 00:00:00 2001 From: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com> Date: Fri, 1 Aug 2025 09:51:31 -0400 Subject: [PATCH 8/8] Update docs/en/observability/slo-burn-rate-alert.asciidoc Co-authored-by: Bena Kansara <69037875+benakansara@users.noreply.github.com> --- docs/en/observability/slo-burn-rate-alert.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/en/observability/slo-burn-rate-alert.asciidoc b/docs/en/observability/slo-burn-rate-alert.asciidoc index c7438be911..da84209a8c 100644 --- a/docs/en/observability/slo-burn-rate-alert.asciidoc +++ b/docs/en/observability/slo-burn-rate-alert.asciidoc @@ -64,7 +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.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.