Files
logpile/bible-local/04-data-models.md
T
Mikhail ChusavitinandClaude Sonnet 5 475318fc2b refactor: extract parsers and Redfish replay/analysis to external module
logpile no longer carries its own archive/vendor parsers or Redfish
raw-payload replay/analysis engine. Both now live in
git.mchus.pro/reanimator/parser/v13 (already used by the sibling `core`
project), reached through parser.NewService().AnalyzeArchivePayload /
AnalyzeRedfishRawPayloads. logpile keeps live BMC/Redfish collection,
the DB, exporter, server and UI.

- Deleted internal/parser/ (interface, registry, archive extraction,
  all vendor packages), internal/collector/redfish_replay*.go (replay
  engine, confirmed near-identical to the module's redfish/ package),
  internal/ingest/ (pure duplicate of the module's Service),
  internal/models/ (repointed every import to the module's models
  package instead), and internal/rar5 (only used by the deleted
  archive extractor). Removed the now-unused third_party/pciids
  submodule.
- internal/collector/redfish.go: Collect() now calls
  parser.NewService().AnalyzeRedfishRawPayloads(...) at the one place
  it used to call the local ReplayRedfishFromRawPayloads (an existing
  "unified tunnel" between live collection and raw import). A
  deadcode-driven pass then removed ~150 doc-to-model conversion
  helpers in redfish.go that duplicated the module's redfish/ package
  and were already unreachable before this change; kept the small
  generic dedup/scoring helpers the live crawler still calls.
- internal/collector/redfishprofile/ stays whole: Collect() depends on
  it directly for acquisition-time tuning. Its analysis-only methods
  (ApplyAnalysisProfiles/PostAnalyze) are now dead but left in place
  rather than splitting the package's single Profile interface.
- pciids moved with the module (now a public package there); logpile's
  live collector and exporter import it from there instead of keeping
  a local copy.
- go.mod: new require on git.mchus.pro/reanimator/parser/v13 v13.0.0
  (plain module dependency, not a submodule like reanimator/chart,
  since this module is independently versioned and shared with core).
- bible-local docs rewritten for the new boundary; see ADL-080.

See also the companion change in git.mchus.pro/reanimator/parser
(tagged v13.0.0): new top-level exports
(IsSupportedArchiveFilename/SupportedArchiveExtensions/
ParseInDefaultArchiveLocation/PrivacyScanEnabled) and pciids moved to
a public package, both needed to complete this migration.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
2026-10-08 12:59:39 +03:00

3.2 KiB

04 — Data Models

Core contract: AnalysisResult

git.mchus.pro/reanimator/parser/v13/models (models.go) defines the shared result passed between the parser module, collectors, server handlers, and exporters. logpile has no local models package anymore (ADL-080) — every import in this repo points at the module's package directly.

Stability rule:

  • do not rename or remove JSON fields from AnalysisResult
  • additive fields are allowed
  • UI and exporter compatibility depends on this shape remaining stable

Key fields:

Field Meaning
filename Original upload name or synthesized live source name
source_type archive or api
protocol redfish, ipmi, or empty for archive uploads
target_host Hostname or IP for live collection
source_timezone Source timezone/offset if known
collected_at Canonical collection/upload time
raw_payloads Raw source data used for replay or diagnostics
events Parsed event timeline
fru FRU-derived inventory details
sensors Sensor readings
hardware Normalized hardware inventory

HardwareConfig

Main sections:

hardware.board
hardware.devices
hardware.cpus
hardware.memory
hardware.storage
hardware.volumes
hardware.pcie_devices
hardware.gpus
hardware.network_adapters
hardware.network_cards
hardware.power_supplies
hardware.firmware
hardware.platform_config

network_cards is legacy/alternate source data. hardware.devices is the canonical cross-section inventory.

Canonical inventory: hardware.devices

hardware.devices is the single source of truth for device-oriented UI and Reanimator export.

Required rules:

  1. UI hardware views must read from hardware.devices
  2. Reanimator conversion must derive device sections from hardware.devices
  3. UI/export mismatches are bugs, not accepted divergence
  4. New shared device fields belong in HardwareDevice first

NUMA affinity

NUMA affinity is nullable throughout the internal and Reanimator export path. In Go it is represented as *int: nil means not reported / not applicable, while a pointer to 0 means the real NUMA node 0. Numeric zero must never be used as an absence sentinel.

Topology relationships outside the Reanimator ingest contract live in the separate versioned topology.json document and are not added to reanimator.json.

Deduplication priority:

Priority Key
1 usable serial_number
2 bdf
3 keep records separate

A serial repeated across records with different canonical BDFs is not usable as a deduplication identity for those records; preserve the distinct devices and retain the reported serial as source data.

Raw payloads

raw_payloads is authoritative for replayable sources.

Current important payloads:

  • redfish_tree
  • redfish_fetch_errors
  • source_timezone

Normalized hardware fields are derived output, not the long-term source of truth.

Raw export package

/api/export/json produces a reopenable raw-export artifact.

Design rules:

  • raw source stays authoritative
  • uploads of raw-export artifacts must re-analyze from raw source
  • parsed snapshots inside the bundle are diagnostic only