diff --git a/docs/asl/ref/clamp-max.md b/docs/asl/ref/clamp-max.md index 13a8dd20..5e5e63a2 100644 --- a/docs/asl/ref/clamp-max.md +++ b/docs/asl/ref/clamp-max.md @@ -24,6 +24,7 @@ and handling occasional data spikes. ## Problem and Solution The axis parameters for controlling [axis bounds](../../api/graph/axis-bounds.md) have limitations: + - They apply to everything on the axis and cannot target specific lines - For data with occasional spikes, they can hide important details in the rest of the data diff --git a/docs/asl/ref/cq.md b/docs/asl/ref/cq.md index a1b5c41e..d5b005c0 100644 --- a/docs/asl/ref/cq.md +++ b/docs/asl/ref/cq.md @@ -26,6 +26,7 @@ Apply a common application filter to an expression with multiple queries: @@@ This transforms: + - `name,ssCpuUser,:eq` becomes `name,ssCpuUser,:eq,nf.app,alerttest,:eq,:and` - `name,DiscoveryStatus_UP,:eq` becomes `name,DiscoveryStatus_UP,:eq,nf.app,alerttest,:eq,:and` diff --git a/docs/asl/ref/derivative.md b/docs/asl/ref/derivative.md index f1d1afe9..d34a6d12 100644 --- a/docs/asl/ref/derivative.md +++ b/docs/asl/ref/derivative.md @@ -15,6 +15,7 @@ converting cumulative values back to rates or identifying trends in the data. ## Behavior Each output value represents the difference between consecutive datapoints: + - `derivative[i] = input[i] - input[i-1]` - The first datapoint will typically be NaN since there's no previous value - Missing values (NaN) are handled as 0 for the calculation @@ -32,11 +33,13 @@ Integral Then Derivative: /api/v1/graph?w=200&h=125&s=e-3h&e=2012-01-01T07:00&tz ## Relationship with Integral `:derivative` and `:integral` have an asymmetric relationship: + - Applying `:integral` then `:derivative` approximates the original signal - Applying `:derivative` then `:integral` does NOT restore the original signal The derivative operation loses information that cannot be recovered with integral. For example, with a constant input like `1`: + - `1,:derivative` produces `0` (derivative of constant is zero) - `0,:integral` produces `0` (integral of zero stays zero) - The original constant value `1` is permanently lost diff --git a/docs/asl/ref/des-simple.md b/docs/asl/ref/des-simple.md index 5f400398..bab81a19 100644 --- a/docs/asl/ref/des-simple.md +++ b/docs/asl/ref/des-simple.md @@ -20,6 +20,7 @@ the default values may not be optimal for all use cases. ## Default Configuration This operator is equivalent to calling `:des` with these default parameters: + - **Training**: 10 data points - **Alpha**: 0.1 (level smoothing factor) - **Beta**: 0.5 (trend smoothing factor) diff --git a/docs/asl/ref/div.md b/docs/asl/ref/div.md index 699c6178..00416a47 100644 --- a/docs/asl/ref/div.md +++ b/docs/asl/ref/div.md @@ -9,6 +9,7 @@ Compute a new time series where each interval has the value `(a / b)` where `a` and `b` are the corresponding intervals in the input time series. Special handling for division by zero: + - If both `a` and `b` are 0, the result is 0 (instead of NaN) - If only `b` (divisor) is 0, the result is NaN diff --git a/docs/asl/ref/eureka-avg.md b/docs/asl/ref/eureka-avg.md index d27332f4..f9812d5c 100644 --- a/docs/asl/ref/eureka-avg.md +++ b/docs/asl/ref/eureka-avg.md @@ -23,6 +23,7 @@ through Eureka. ## When to Use This operator is specifically designed for scenarios where: + - Metrics represent incoming traffic routed through Eureka service discovery - You want average per active instance, not per total deployed instance - The goal is to measure per-node load for traffic-bearing services @@ -47,6 +48,7 @@ Computing average requests per second per active instance: ## Infrastructure Tag Scoping The operator automatically uses common tags to ensure the denominator matches the numerator scope: + - `nf.app` - Application name - `nf.cluster` - Cluster identifier - `nf.region` - AWS region diff --git a/docs/asl/ref/limit.md b/docs/asl/ref/limit.md index 8cf5a2e5..477adb0c 100644 --- a/docs/asl/ref/limit.md +++ b/docs/asl/ref/limit.md @@ -18,6 +18,7 @@ when dealing with large result sets. ## Selection Behavior The limit operation selects the first N series based on the current ordering: + - If no sort is specified, series are ordered by legend text (alphabetical) - If [:sort](sort.md) is used, series are ordered by the specified statistic - The [:order](order.md) operation controls ascending vs. descending sort direction diff --git a/docs/asl/ref/percentiles-heatmap.md b/docs/asl/ref/percentiles-heatmap.md index c2bfedf8..297d6a53 100644 --- a/docs/asl/ref/percentiles-heatmap.md +++ b/docs/asl/ref/percentiles-heatmap.md @@ -31,6 +31,7 @@ name,requestLatency,:eq,(,percentile,),:by,:heatmap ``` The resulting heatmap shows: + - **X-axis**: Time progression - **Y-axis**: Percentile levels (P50, P90, P95, P99, etc.) - **Color intensity**: Magnitude of values at each percentile/time combination diff --git a/docs/asl/ref/sdes-simple.md b/docs/asl/ref/sdes-simple.md index eb67355e..82c9403e 100644 --- a/docs/asl/ref/sdes-simple.md +++ b/docs/asl/ref/sdes-simple.md @@ -15,6 +15,7 @@ stability than the standard [:des-simple](des-simple.md) operator. ## Default Configuration This operator is equivalent to calling `:sdes` with these default parameters: + - **Training**: 10 data points - **Alpha**: 0.1 (level smoothing factor) - **Beta**: 0.5 (trend smoothing factor) diff --git a/docs/asl/ref/sdes.md b/docs/asl/ref/sdes.md index c22cd294..25aa186b 100644 --- a/docs/asl/ref/sdes.md +++ b/docs/asl/ref/sdes.md @@ -37,6 +37,7 @@ Result: ``` Where: + - **A**: Both functions wait for training window boundary - **T1/T2**: Training phases for each function - **P1/P2**: Prediction phases alternating between functions diff --git a/docs/asl/ref/stddev.md b/docs/asl/ref/stddev.md index 1fbc0648..29e7ec7e 100644 --- a/docs/asl/ref/stddev.md +++ b/docs/asl/ref/stddev.md @@ -29,6 +29,7 @@ from the different time series in the group using the computational formula: ``` Where: + - `N` = number of non-NaN values at that timestamp - `sum(x)` = sum of all time series values at that timestamp - `sum(x²)` = sum of squared time series values at that timestamp diff --git a/docs/asl/ref/time-span.md b/docs/asl/ref/time-span.md index 814e5e90..a48c0ad5 100644 --- a/docs/asl/ref/time-span.md +++ b/docs/asl/ref/time-span.md @@ -48,6 +48,7 @@ Absolute: /api/v1/graph?w=200&h=125&s=e-3h&e=2012-01-01T07:00&tz=UTC&q=2014-02-2 ## Signal Output The operator produces a signal time series where: + - **Value 1**: Time falls within the specified range [startTime, endTime] - **Value 0**: Time falls outside the specified range - This creates a boolean-like signal suitable for logical operations