From 04715b9b18f0838f2e04591dc4bea00c9de2f090 Mon Sep 17 00:00:00 2001 From: Haus Owens <98408+haus@users.noreply.github.com> Date: Thu, 18 Sep 2025 15:28:54 -0700 Subject: [PATCH] docs: Update aggregation_delay docs for nrql alert The docs appear to be wrong in how they describe aggregation_delay as there is do default delay and it is strictly required with the event_flow or cadence aggregation methods. I tried to update the wording to make that clear. --- website/docs/r/nrql_alert_condition.html.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/r/nrql_alert_condition.html.markdown b/website/docs/r/nrql_alert_condition.html.markdown index 158246f85..043566346 100644 --- a/website/docs/r/nrql_alert_condition.html.markdown +++ b/website/docs/r/nrql_alert_condition.html.markdown @@ -95,7 +95,7 @@ The following arguments are supported: - `close_violations_on_expiration` - (Optional) Whether to close all open incidents when the signal expires. - `ignore_on_expected_termination` - (Optional) Whether an alert condition should ignore expected termination of a signal when considering whether to create a loss of signal incident. Defaults to false. - `aggregation_method` - (Optional) Determines when we consider an aggregation window to be complete so that we can evaluate the signal for incidents. Possible values are `cadence`, `event_flow` or `event_timer`. Default is `event_flow`. `aggregation_method` cannot be set with `nrql.evaluation_offset`. -- `aggregation_delay` - (Optional) How long we wait for data that belongs in each aggregation window. Depending on your data, a longer delay may increase accuracy but delay notifications. Use `aggregation_delay` with the `event_flow` and `cadence` methods. The maximum delay is 1200 seconds (20 minutes) when using `event_flow` and 3600 seconds (60 minutes) when using `cadence`. In both cases, the minimum delay is 0 seconds and the default is 120 seconds. `aggregation_delay` cannot be set with `nrql.evaluation_offset`. +- `aggregation_delay` - (Optional) How long we wait for data that belongs in each aggregation window. Depending on your data, a longer delay may increase accuracy but delay notifications. Required with the `event_flow` and `cadence` methods. The maximum delay is 1200 seconds (20 minutes) when using `event_flow` and 3600 seconds (60 minutes) when using `cadence`. In both cases, the minimum delay is 0 seconds and there is no default value. `aggregation_delay` cannot be set with `nrql.evaluation_offset`. - `aggregation_timer` - (Optional) How long we wait after each data point arrives to make sure we've processed the whole batch. Use `aggregation_timer` with the `event_timer` method. The timer value can range from 0 seconds to 1200 seconds (20 minutes); the default is 60 seconds. `aggregation_timer` cannot be set with `nrql.evaluation_offset`. - `evaluation_delay` - (Optional) How long we wait until the signal starts evaluating. The maximum delay is 7200 seconds (120 minutes). - `slide_by` - (Optional) Gathers data in overlapping time windows to smooth the chart line, making it easier to spot trends. The `slide_by` value is specified in seconds and must be smaller than and a factor of the `aggregation_window`.