report

Documentation

Overview

Package report renders a Snapshot to analyst-facing formats: JSON, GraphML, and a self-contained HTML terrain report. Every format is a pure function of the Snapshot.

Index

• func DriftHTML(w io.Writer, d snapshot.Diff) error
• func GraphML(w io.Writer, snap graph.Snapshot) error
• func GraphMLMap(w io.Writer, m *mapview.Model) error
• func HTML(w io.Writer, snap graph.Snapshot) error
• func HTMLMap(w io.Writer, m *mapview.Model) error
• func JSON(w io.Writer, snap graph.Snapshot) error
• func ReconcileHTML(w io.Writer, r reconcile.Result) error
• func SVGMap(w io.Writer, m *mapview.Model) error

Functions

func DriftHTML

func DriftHTML(w io.Writer, d snapshot.Diff) error

DriftHTML writes a self-contained Phase 2 drift report.

func GraphML

func GraphML(w io.Writer, snap graph.Snapshot) error

GraphML writes a minimal GraphML document: nodes carry ip/role/composite/ subnet attributes, edges carry service/conn_count. yEd/draw.io group geometry extensions come in Phase 1.5; this is the analyst-report baseline.

func GraphMLMap

func GraphMLMap(w io.Writer, m *mapview.Model) error

GraphMLMap writes the briefing map as GraphML with subnet groups as nested subgraphs — the structure yEd and draw.io import as group nodes. Node data carries role/tier/criticality so imported diagrams can be styled there.

ponytail: no yFiles geometry extensions — importers re-layout anyway (that's the point of the draw.io/yEd path: orthogonal "Visio-style" routing). Add <y:...> geometry only if a real yEd round-trip demands it.

func HTML

func HTML(w io.Writer, snap graph.Snapshot) error

HTML writes a self-contained analyst terrain report: a ranked table with per-node expandable evidence, plus a sensor-coverage / blind-spot panel. No external assets — everything inlined so it opens offline (§1 constraint).

func HTMLMap

func HTMLMap(w io.Writer, m *mapview.Model) error

HTMLMap writes the self-contained interactive briefing map (§8.1): Cytoscape compound nodes (subnet boxes), fcose/dagre layout toggle, layer toggles, click-for-evidence panel, embedded legend. All JS embedded.

func JSON

func JSON(w io.Writer, snap graph.Snapshot) error

JSON writes the snapshot as indented JSON.

func ReconcileHTML

func ReconcileHTML(w io.Writer, r reconcile.Result) error

ReconcileHTML writes the self-contained Phase 3 doc-vs-reality report, worded to hand directly to the supported unit's staff.

func SVGMap

func SVGMap(w io.Writer, m *mapview.Model) error