@skyhook-io/radar-app 1.13.4 → 1.13.5

package/src/components/diagnose/investigationEvidenceKinds.ts

@@ -0,0 +1,218 @@
+import {
+  Activity,
+  BellRing,
+  Boxes,
+  Bug,
+  ChartLine,
+  CheckCircle2,
+  CircleAlert,
+  Clock3,
+  FileClock,
+  KeyRound,
+  ListTree,
+  Network,
+  Package,
+  ScrollText,
+  ShieldAlert,
+  type LucideIcon,
+} from "lucide-react";
+
+import type { InvestigationEvidenceKind } from "./investigationEvidence";
+
+/**
+ * Everything the pane needs to know about a kind of evidence, in one place.
+ *
+ * Five decisions that are easy to answer separately and wrong to forget, the
+ * sharpest being whether a card may contradict a model's all-clear: miss that
+ * one for a kind and a firing alert naming the workload sits under a green
+ * "no problem found" banner. This is a `Record` over the kind union with no
+ * optional fields, so the compiler refuses a new kind until each is decided.
+ *
+ * Not everything per-kind lives here. Rendering the card body, whether it can
+ * expand, how a subject is read off it and what a source excerpt shows are
+ * still dispatched where they are used, because each needs the observation's
+ * data rather than a constant.
+ */
+export interface InvestigationEvidenceKindTraits {
+  /**
+   * A card of this kind can contradict an all-clear. Radar captured a fact
+   * about the investigated resource that says something is wrong right now,
+   * so a model concluding otherwise has to be qualified rather than trusted.
+   * False for kinds that describe context, configuration or a shape of the
+   * cluster: those are worth reading and are not evidence of a live problem.
+   */
+  adverse: boolean;
+  /**
+   * One card of this kind is one unambiguous subject, so citing its source
+   * promotes exactly that fact. A broad read (issues, inventory, events)
+   * yields many rows from one source and a citation cannot pick one of them.
+   */
+  focused: boolean;
+  /** The card carries enough detail to want the full width of a grid row. */
+  fullRow: boolean;
+  icon: LucideIcon;
+  /**
+   * One sentence about what this kind of evidence can and cannot establish,
+   * shown under the card. `changes` has its own tooltip instead, because its
+   * wording depends on whether the age was collected.
+   */
+  caveat: string | undefined;
+}
+
+export const EVIDENCE_KIND_TRAITS: Readonly<
+  Record<InvestigationEvidenceKind, InvestigationEvidenceKindTraits>
+> = {
+  // Radar classified a live problem on the resource.
+  issue: {
+    adverse: true,
+    focused: false,
+    fullRow: false,
+    icon: CircleAlert,
+    caveat: undefined,
+  },
+  // A pod of the workload cannot start.
+  startup: {
+    adverse: true,
+    focused: false,
+    fullRow: false,
+    icon: ShieldAlert,
+    caveat: undefined,
+  },
+  // A container exited or is restarting.
+  crash: {
+    adverse: true,
+    focused: true,
+    fullRow: false,
+    icon: Bug,
+    caveat: undefined,
+  },
+  // The object's own status: unready replicas, a failed condition.
+  resource: {
+    adverse: true,
+    focused: true,
+    fullRow: false,
+    icon: Boxes,
+    caveat: undefined,
+  },
+  logs: {
+    adverse: true,
+    focused: true,
+    fullRow: true,
+    icon: ScrollText,
+    caveat: undefined,
+  },
+  events: {
+    adverse: true,
+    focused: false,
+    fullRow: true,
+    icon: Clock3,
+    caveat:
+      "Events support the timeline; proximity alone does not establish cause.",
+  },
+  // A change is a thing that happened, not a thing that is wrong.
+  changes: {
+    adverse: false,
+    focused: false,
+    fullRow: false,
+    icon: FileClock,
+    caveat: undefined,
+  },
+  dns: {
+    adverse: true,
+    focused: false,
+    fullRow: false,
+    icon: Activity,
+    caveat: undefined,
+  },
+  network: {
+    adverse: true,
+    focused: false,
+    fullRow: false,
+    icon: Network,
+    caveat: undefined,
+  },
+  relationships: {
+    adverse: false,
+    focused: false,
+    fullRow: false,
+    icon: Network,
+    caveat:
+      "This shows direct relationships Radar found, not an inferred blast radius.",
+  },
+  topology: {
+    adverse: false,
+    focused: false,
+    fullRow: false,
+    icon: Network,
+    caveat:
+      "This shows direct relationships Radar found, not an inferred blast radius.",
+  },
+  inventory: {
+    adverse: false,
+    focused: false,
+    fullRow: false,
+    icon: ListTree,
+    caveat: undefined,
+  },
+  // A receipt records a check that found nothing, so it can never contradict.
+  receipt: {
+    adverse: false,
+    focused: false,
+    fullRow: false,
+    icon: CheckCircle2,
+    caveat: undefined,
+  },
+  // A rule firing about this workload is the most literal statement Radar
+  // holds that something is wrong with it.
+  alerts: {
+    adverse: true,
+    focused: true,
+    fullRow: true,
+    icon: BellRing,
+    caveat:
+      "Instances are matched to this investigation by their Prometheus labels; a firing rule alone does not establish the cause.",
+  },
+  // A failed or stuck release is a live problem with the thing that owns the
+  // workload, not background colour.
+  helm: {
+    adverse: true,
+    focused: true,
+    fullRow: false,
+    icon: Package,
+    caveat: undefined,
+  },
+  // A permission verdict describes a grant, not a runtime failure: a
+  // ServiceAccount that cannot read Secrets may be exactly as intended.
+  permissions: {
+    adverse: false,
+    focused: true,
+    fullRow: false,
+    icon: KeyRound,
+    caveat:
+      "This is what RBAC grants the subject, not what the workload has exercised.",
+  },
+  // A chart is a measurement; the reading, not the kind, is what alarms.
+  metrics: {
+    adverse: false,
+    focused: true,
+    fullRow: true,
+    icon: ChartLine,
+    caveat: undefined,
+  },
+};
+
+/** Kinds whose card can contradict a model's all-clear. */
+export function evidenceKindIsAdverse(kind: string): boolean {
+  return (
+    Object.hasOwn(EVIDENCE_KIND_TRAITS, kind) &&
+    EVIDENCE_KIND_TRAITS[kind as InvestigationEvidenceKind].adverse
+  );
+}
+
+/** Kinds a citation of the source can promote as one fact. */
+export function evidenceKindIsFocused(kind: string): boolean {
+  return (
+    Object.hasOwn(EVIDENCE_KIND_TRAITS, kind) &&
+    EVIDENCE_KIND_TRAITS[kind as InvestigationEvidenceKind].focused
+  );
+}

package/src/components/diagnose/investigationEvidencePresentation.test.ts

@@ -1,4 +1,5 @@
 import { describe, expect, it } from "vitest";
+import type { HPADiagnosisState } from "@skyhook-io/k8s-ui";
 import {
   evidenceDisplaySnapshot,
   groupEvidenceCoverage,
@@ -445,3 +446,33 @@ describe("coverage presentation", () => {
     expect(groupEvidenceCoverage([])).toEqual([]);
   });
 });
+
+describe("evidenceDisplaySnapshot scaler diagnosis", () => {
+  const scaledBy = (state: HPADiagnosisState) => [
+    {
+      kind: "HorizontalPodAutoscaler",
+      namespace: "dev",
+      name: "api-hpa",
+      hpaSummary: {
+        state,
+        summary: "summary",
+        bounds: { min: 1, max: 5, current: 5, desired: 5 },
+      },
+    },
+  ];
+  const withScaler = (state: HPADiagnosisState): InvestigationEvidenceData => ({
+    type: "resource",
+    resource,
+    resourceContext: { tier: "basic", scaledBy: scaledBy(state) },
+    warnings: [],
+  });
+
+  it("treats a change in the HPA's state as a new observation", () => {
+    expect(
+      evidenceDisplaySnapshot(observation(withScaler("limited_max"))),
+    ).not.toBe(evidenceDisplaySnapshot(observation(withScaler("ok"))));
+    expect(
+      evidenceDisplaySnapshot(observation(withScaler("limited_max"))),
+    ).toBe(evidenceDisplaySnapshot(observation(withScaler("limited_max"))));
+  });
+});

package/src/components/diagnose/investigationEvidencePresentation.ts

@@ -30,6 +30,7 @@ export function evidenceDisplaySnapshot(
         // These summaries can carry live state even when the raw object is cached.
         status: statusWithoutObservationTimes(context?.statusSummary),
         workload: context?.workloadSummary,
+        scalers: context?.scaledBy,
         issues: context?.issueSummary,
         gitOps: data.gitOpsDiagnosis,
         warnings: data.warnings.map(warningWithoutElapsedTime),