@checkstack/common 0.8.0 → 0.9.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @checkstack/common
 
+## 0.9.0
+
+### Minor Changes
+
+- 42abfff: Add practical-significance floors to anomaly detection.
+
+  Two new schema annotations — `x-anomaly-min-absolute-delta` and `x-anomaly-min-relative-delta` — let plugin authors and operators suppress alerts whose statistical deviation is large but practical impact is negligible. Both floors must clear in addition to the existing μ ± Nσ trigger; defaults are 0 (disabled) so existing behaviour is unchanged.
+
+  This is the fix for cases like a 6 ms latency baseline whose σ ≈ 1 ms causes routine 20 ms blips to fire as anomalies despite Δ=14 ms being operationally irrelevant. With `min-absolute-delta: 50` and `min-relative-delta: 0.5`, those blips stay silent while a 6 ms → 200 ms spike still fires.
+
+  Built-in plugins ship with sensible defaults applied to every per-run field: 50 ms + 50 % for ms-unit fields, 5 percentage points for `%`-unit fields, 1 + 25 % for counter fields, 1 GB + 5 % for disk fields, 50 MB + 10 % for memory fields, 1 day for TLS expiry, 0.5 + 25 % for load average, 1 + 5 % for Minecraft TPS. Operators can override per-system or per-field via the assignment UI.
+
 ## 0.8.0
 
 ### Minor Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@checkstack/common",
-  "version": "0.8.0",
+  "version": "0.9.0",
   "license": "Elastic-2.0",
   "type": "module",
   "main": "./src/index.ts",
@@ -19,8 +19,8 @@
   },
   "devDependencies": {
     "typescript": "^5.7.2",
-    "@checkstack/tsconfig": "0.0.6",
-    "@checkstack/scripts": "0.1.2"
+    "@checkstack/tsconfig": "0.0.7",
+    "@checkstack/scripts": "0.3.0"
   },
   "scripts": {
     "typecheck": "tsgo -b",

package/src/chart-types.ts

@@ -22,6 +22,18 @@ export type ChartType =
   | "text"
   | "status";
 
+/**
+ * Numeric anomaly directions — these operate on a μ ± Nσ statistical band
+ * over a continuous metric, so practical-significance floors apply.
+ */
+export type NumericAnomalyDirection =
+  | "higher-is-better"
+  | "lower-is-better"
+  | "deviation";
+
+/** Categorical anomaly direction — fires on dominance flips, no σ band. */
+export type CategoricalAnomalyDirection = "dominance";
+
 /**
  * Base metadata for all health check result schema fields.
  */
@@ -63,14 +75,56 @@ export interface BaseHealthResultMeta {
 }
 
 /**
- * Metadata for a field that exposes a chart AND has anomaly detection enabled.
+ * Metadata for a chartable field with numeric anomaly detection.
+ * Carries the practical-significance floors (`x-anomaly-min-*-delta`)
+ * because they only make sense against a μ ± Nσ band.
+ */
+export interface ChartMetaAnomalyNumeric extends BaseHealthResultMeta {
+  "x-chart-type": ChartType;
+  "x-anomaly-enabled": true;
+  "x-anomaly-direction": NumericAnomalyDirection;
+  /**
+   * Practical-significance floor on absolute deviation. Default 0 (disabled).
+   * An anomaly only fires when |value − μ| ≥ this floor — even if the
+   * statistical trigger (μ ± Nσ) is exceeded. Use to suppress alerts on
+   * statistically-unusual but operationally-irrelevant swings on
+   * low-baseline metrics (e.g. 6 ms → 20 ms latency).
+   * Same field unit as the metric itself.
+   */
+  "x-anomaly-min-absolute-delta"?: number;
+  /**
+   * Practical-significance floor on relative deviation. Default 0 (disabled).
+   * An anomaly only fires when |value − μ| / max(|μ|, ε) ≥ this floor — even
+   * if the statistical trigger is exceeded. Expressed as a fraction
+   * (e.g. 0.5 = 50%). Use to suppress alerts whose proportional change is
+   * small on high-magnitude metrics.
+   */
+  "x-anomaly-min-relative-delta"?: number;
+}
+
+/**
+ * Metadata for a chartable field with categorical (dominance) anomaly
+ * detection. Practical-significance floors are deliberately disallowed
+ * because they have no meaning against a categorical baseline — there's
+ * no μ to subtract from.
  */
-export interface ChartMetaAnomalyEnabled extends BaseHealthResultMeta {
+export interface ChartMetaAnomalyCategorical extends BaseHealthResultMeta {
   "x-chart-type": ChartType;
   "x-anomaly-enabled": true;
-  "x-anomaly-direction": "higher-is-better" | "lower-is-better" | "deviation" | "dominance";
+  "x-anomaly-direction": CategoricalAnomalyDirection;
+  "x-anomaly-min-absolute-delta"?: never;
+  "x-anomaly-min-relative-delta"?: never;
 }
 
+/**
+ * Union of the two anomaly-enabled variants. Kept for back-compat with
+ * existing callers — new code should narrow against the discriminated
+ * union directly via `x-anomaly-direction`.
+ */
+export type ChartMetaAnomalyEnabled =
+  | ChartMetaAnomalyNumeric
+  | ChartMetaAnomalyCategorical;
+
 /**
  * Metadata for a field that exposes a chart but explicitly disables anomaly detection.
  */
@@ -78,6 +132,8 @@ export interface ChartMetaAnomalyDisabled extends BaseHealthResultMeta {
   "x-chart-type": ChartType;
   "x-anomaly-enabled": false;
   "x-anomaly-direction"?: never;
+  "x-anomaly-min-absolute-delta"?: never;
+  "x-anomaly-min-relative-delta"?: never;
 }
 
 /**
@@ -87,6 +143,8 @@ export interface NonChartMeta extends BaseHealthResultMeta {
   "x-chart-type"?: never;
   "x-anomaly-enabled"?: never;
   "x-anomaly-direction"?: never;
+  "x-anomaly-min-absolute-delta"?: never;
+  "x-anomaly-min-relative-delta"?: never;
 }
 
 /**
@@ -94,8 +152,8 @@ export interface NonChartMeta extends BaseHealthResultMeta {
  * Provides autocompletion and enforces that ANY field exposing a chart
  * MUST explicitly define its anomaly behavior.
  */
-export type HealthResultMeta = 
-  | ChartMetaAnomalyEnabled 
-  | ChartMetaAnomalyDisabled 
+export type HealthResultMeta =
+  | ChartMetaAnomalyNumeric
+  | ChartMetaAnomalyCategorical
+  | ChartMetaAnomalyDisabled
   | NonChartMeta;
-