@checkstack/healthcheck-script-backend 0.8.7 → 0.8.8

package/CHANGELOG.md

@@ -1,5 +1,54 @@
 # @checkstack/healthcheck-script-backend
 
+## 0.8.8
+
+### Patch Changes
+
+- c55d7c6: Unify the healthcheck chart system on the `@checkstack/ui` SVG kit and
+  redesign the HealthCheck drawer.
+
+  - `@checkstack/ui` gains six chart primitives (each with a Storybook story):
+    `StackedTimeline` (stacked status counts per bucket on the colorblind-safe
+    status triad), `ChartTooltip` + `useBandHover` (the one shared chart
+    tooltip and its cursor hit-testing), `ChartCard` / `chartCardChromeClass`
+    (the premium gradient card chrome, flat on low-power devices), `StatTile`
+    (number-led metric tile with delta chip, sparkline/ribbon footer, and
+    click-to-expand disclosure), `DistributionBar` (stacked horizontal
+    distribution + legend, replaces pies), and `CategoryRibbon` (categorical
+    history ribbon). `TimeSeriesChart` gains a hover tooltip with a crosshair
+    marker.
+  - `@checkstack/common` adds four optional chart metadata keys to
+    `BaseHealthResultMeta`: `x-chart-priority` (tile sort weight, lower first,
+    default 100), `x-chart-good-direction` (`"up" | "down"`, which direction
+    of change is an improvement; consumers fall back to
+    `x-anomaly-direction`), and `x-chart-true-label` / `x-chart-false-label`
+    (prose for a boolean field's values wherever they surface in text, e.g. a
+    dominance chip reading "Usually successful (98%)" instead of "Usually
+    true"). Built-in collector backends annotate their headline metrics and
+    boolean fields accordingly (purely additive metadata).
+  - `@checkstack/healthcheck-frontend` rebuilds the drawer: a hero status
+    banner (status pill, healthy %, avg latency, interval, last run with the
+    exact datetime on hover, full-width status ribbon) replaces the metric
+    tiles; the status timeline and latency heroes share the `ChartCard`
+    chrome; the auto-generated charts become a prioritized, click-to-expand
+    2-up tile grid (collector ids demoted to hover titles); the anomaly
+    Expected/Trend derivation is consolidated into one tested module shared by
+    the latency hero and the tiles.
+
+  BREAKING CHANGES: `recharts` is removed from `@checkstack/healthcheck-frontend`
+  (and the unused dependency from `@checkstack/ui`); the
+  `HealthCheckStatusTimeline` and `SparklineTooltip` components are deleted.
+  Extensions rendering into `HealthCheckDiagramSlot` should build on the
+  `@checkstack/ui` chart primitives instead.
+
+- Updated dependencies [c55d7c6]
+- Updated dependencies [c55d7c6]
+  - @checkstack/healthcheck-common@1.13.0
+  - @checkstack/common@0.21.0
+  - @checkstack/backend-api@0.29.1
+  - @checkstack/script-packages-backend@0.3.23
+  - @checkstack/secrets-common@0.3.1
+
 ## 0.8.7
 
 ### Patch Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@checkstack/healthcheck-script-backend",
-  "version": "0.8.7",
+  "version": "0.8.8",
   "type": "module",
   "main": "src/index.ts",
   "checkstack": {
@@ -14,17 +14,17 @@
     "pack": "bunx @checkstack/scripts plugin-pack"
   },
   "dependencies": {
-    "@checkstack/backend-api": "0.29.0",
-    "@checkstack/common": "0.20.0",
-    "@checkstack/healthcheck-common": "1.12.0",
-    "@checkstack/script-packages-backend": "0.3.22",
-    "@checkstack/secrets-common": "0.3.0"
+    "@checkstack/backend-api": "0.29.1",
+    "@checkstack/common": "0.21.0",
+    "@checkstack/healthcheck-common": "1.13.0",
+    "@checkstack/script-packages-backend": "0.3.23",
+    "@checkstack/secrets-common": "0.3.1"
   },
   "devDependencies": {
     "@types/bun": "^1.0.0",
     "typescript": "^5.0.0",
     "@checkstack/tsconfig": "0.0.7",
-    "@checkstack/scripts": "0.7.1"
+    "@checkstack/scripts": "0.7.2"
   },
   "description": "Checkstack healthcheck-script-backend plugin",
   "author": {

package/src/execute-collector.ts

@@ -179,6 +179,8 @@ const executeResultSchema = healthResultSchema({
     // covered by `success`. Charting it stays useful; alerting on it just
     // double-fires (and flaps for scripts that vary their nonzero codes).
     "x-anomaly-enabled": false,
+    "x-chart-priority": 20,
+    "x-chart-good-direction": "down",
   }),
   stdout: healthResultString({
     "x-chart-type": "text",
@@ -202,20 +204,29 @@ const executeResultSchema = healthResultSchema({
     "x-anomaly-confirmation-window": 3,
     "x-anomaly-min-absolute-delta": 50,
     "x-anomaly-min-relative-delta": 0.5,
+    "x-chart-priority": 10,
   }),
   success: healthResultBoolean({
     "x-chart-type": "boolean",
     "x-chart-label": "Success",
+    "x-chart-true-label": "successful",
+    "x-chart-false-label": "failing",
     "x-anomaly-enabled": true,
     "x-anomaly-direction": "dominance",
+    "x-chart-priority": 20,
+    "x-chart-good-direction": "up",
   }),
   timedOut: healthResultBoolean({
     "x-chart-type": "boolean",
     "x-chart-label": "Timed Out",
+    "x-chart-true-label": "timed out",
+    "x-chart-false-label": "completed in time",
     // A timeout always implies `success: false`, so alerting here on top of
     // `success` double-fires on the same incident. Keep it chartable, let
     // `success` carry the alert.
     "x-anomaly-enabled": false,
+    "x-chart-priority": 90,
+    "x-chart-good-direction": "down",
   }),
 });
 
@@ -233,6 +244,7 @@ const executeAggregatedFields = {
     "x-anomaly-confirmation-window": 3,
     "x-anomaly-min-absolute-delta": 50,
     "x-anomaly-min-relative-delta": 0.5,
+    "x-chart-priority": 10,
   }),
   successRate: aggregatedRate({
     "x-chart-type": "gauge",
@@ -244,6 +256,7 @@ const executeAggregatedFields = {
     // jitter in the rate.
     "x-anomaly-confirmation-window": 3,
     "x-anomaly-min-absolute-delta": 5,
+    "x-chart-priority": 20,
   }),
 };
 

package/src/inline-script-collector.ts

@@ -142,8 +142,12 @@ const inlineScriptResultSchema = healthResultSchema({
   success: healthResultBoolean({
     "x-chart-type": "boolean",
     "x-chart-label": "Success",
+    "x-chart-true-label": "successful",
+    "x-chart-false-label": "failing",
     "x-anomaly-enabled": true,
     "x-anomaly-direction": "dominance",
+    "x-chart-priority": 20,
+    "x-chart-good-direction": "up",
   }),
   message: healthResultString({
     "x-chart-type": "text",
@@ -170,13 +174,18 @@ const inlineScriptResultSchema = healthResultSchema({
     "x-anomaly-confirmation-window": 3,
     "x-anomaly-min-absolute-delta": 50,
     "x-anomaly-min-relative-delta": 0.5,
+    "x-chart-priority": 10,
   }),
   timedOut: healthResultBoolean({
     "x-chart-type": "boolean",
     "x-chart-label": "Timed Out",
+    "x-chart-true-label": "timed out",
+    "x-chart-false-label": "completed in time",
     // Always implies `success: false`; alerting here as well double-fires
     // on the same incident. Keep chartable, let `success` carry the alert.
     "x-anomaly-enabled": false,
+    "x-chart-priority": 90,
+    "x-chart-good-direction": "down",
   }),
 });
 
@@ -194,6 +203,7 @@ const inlineScriptAggregatedFields = {
     "x-anomaly-confirmation-window": 3,
     "x-anomaly-min-absolute-delta": 50,
     "x-anomaly-min-relative-delta": 0.5,
+    "x-chart-priority": 10,
   }),
   successRate: aggregatedRate({
     "x-chart-type": "gauge",
@@ -203,6 +213,7 @@ const inlineScriptAggregatedFields = {
     "x-anomaly-direction": "higher-is-better",
     "x-anomaly-confirmation-window": 3,
     "x-anomaly-min-absolute-delta": 5,
+    "x-chart-priority": 20,
   }),
 };
 

package/src/strategy.ts

@@ -64,8 +64,12 @@ const scriptResultSchema = healthResultSchema({
   executed: healthResultBoolean({
     "x-chart-type": "boolean",
     "x-chart-label": "Executed",
+    "x-chart-true-label": "executed",
+    "x-chart-false-label": "not executed",
     "x-anomaly-enabled": true,
     "x-anomaly-direction": "dominance",
+    "x-chart-priority": 30,
+    "x-chart-good-direction": "up",
   }),
   executionTimeMs: healthResultNumber({
     "x-chart-type": "line",
@@ -77,6 +81,7 @@ const scriptResultSchema = healthResultSchema({
     "x-anomaly-confirmation-window": 3,
     "x-anomaly-min-absolute-delta": 50,
     "x-anomaly-min-relative-delta": 0.5,
+    "x-chart-priority": 10,
   }),
   exitCode: healthResultNumber({
     "x-chart-type": "counter",
@@ -84,19 +89,29 @@ const scriptResultSchema = healthResultSchema({
     // Arbitrary integer with no stable distribution; the pass/fail signal
     // it carries is already covered by `success`. Keep chartable only.
     "x-anomaly-enabled": false,
+    "x-chart-priority": 20,
+    "x-chart-good-direction": "down",
   }).optional(),
   success: healthResultBoolean({
     "x-chart-type": "boolean",
     "x-chart-label": "Success",
+    "x-chart-true-label": "successful",
+    "x-chart-false-label": "failing",
     "x-anomaly-enabled": true,
     "x-anomaly-direction": "dominance",
+    "x-chart-priority": 20,
+    "x-chart-good-direction": "up",
   }),
   timedOut: healthResultBoolean({
     "x-chart-type": "boolean",
     "x-chart-label": "Timed Out",
+    "x-chart-true-label": "timed out",
+    "x-chart-false-label": "completed in time",
     // Always implies `success: false`; alerting here as well double-fires
     // on the same incident. Keep chartable, let `success` carry the alert.
     "x-anomaly-enabled": false,
+    "x-chart-priority": 90,
+    "x-chart-good-direction": "down",
   }),
   error: healthResultString({
     "x-chart-type": "status",
@@ -119,6 +134,7 @@ const scriptAggregatedFields = {
     "x-anomaly-confirmation-window": 3,
     "x-anomaly-min-absolute-delta": 50,
     "x-anomaly-min-relative-delta": 0.5,
+    "x-chart-priority": 10,
   }),
   successRate: aggregatedRate({
     "x-chart-type": "gauge",
@@ -128,6 +144,7 @@ const scriptAggregatedFields = {
     "x-anomaly-direction": "higher-is-better",
     "x-anomaly-confirmation-window": 3,
     "x-anomaly-min-absolute-delta": 5,
+    "x-chart-priority": 20,
   }),
   errorCount: aggregatedCounter({
     "x-chart-type": "counter",
@@ -136,6 +153,8 @@ const scriptAggregatedFields = {
     // with bucket volume and has no stable baseline. Prefer the percent
     // form (`successRate`) for alerting and keep this chartable only.
     "x-anomaly-enabled": false,
+    "x-chart-priority": 90,
+    "x-chart-good-direction": "down",
   }),
   timeoutCount: aggregatedCounter({
     "x-chart-type": "counter",
@@ -143,6 +162,8 @@ const scriptAggregatedFields = {
     // Same as errorCount: a volume-scaled absolute twin of the failure
     // rate already expressed by `successRate`. Chartable only.
     "x-anomaly-enabled": false,
+    "x-chart-priority": 90,
+    "x-chart-good-direction": "down",
   }),
 };