Files
nmon/docs/DEVIATIONS.md

3.4 KiB
Raw Permalink Blame History

Deviations from the spec

Every place the build departs from docs/spec/, with the reason. The spec is the contract; a line here is a conscious, reviewed exception.

# Spec says Build does Why Milestone
1 Fixtures run on snmpsim (Python) via compose internal/simagent, a Go agent that serves standard .snmprec files (v1/v2c/v3, dynamic counters, slow/flaky/toobig). deploy/snmpsim-compose.yml is kept for anyone using the reference simulator. 2,000 agents for the loadtest in one process; no Python in CI; same file format, so real snmpsim recordings still work. M1
2 "Two VictoriaMetrics executables are embedded" One VictoriaMetrics single-node executable per architecture is embedded and run as two processes (hot and long) with different -retentionPeriod. Both stores are the same program; embedding it twice would double the binary size for no gain. M1
3 Libraries: huma, gosnmp, gnmic, go-oidc, bun; standard library elsewhere Also: oklog/ulid (ULIDs), gopkg.in/yaml.v3 (profiles, config), golang.org/x/net (unprivileged ICMP), golang.org/x/crypto (bcrypt, ACME), bun's SQLite (modernc.org/sqlite) and Postgres (pgdriver) drivers, golang/snappy + protobuf (remote write). Each one fills a gap the standard library doesn't cover; each is small and widely used. M1+
4 Integration tests use a VictoriaMetrics container Integration tests run the VictoriaMetrics binary that make fetch-vm downloaded (the same pinned, checksummed one that is embedded). Faster, and it tests the exact binary that ships. M1
5 (not specified) M1 has no auth Until M6, nmon serve requires --insecure-http and has no auth. Auth is M6 in the build order. M1–M5
6 "No MIB file is ever shipped in the repo or the binary"; vendor MIBs are the operator's to fetch MIBs are bundled as a sidecar (user decision, 2026-10-22). All 4,865 LibreNMS MIBs are vendored under mibs/ and shipped in the release tarball (installed to /usr/share/nmon/mibs). None is embedded in the binary, not even the IETF/IANA set. They are read via --mibs-dir (default <data-dir>/mibs, then /usr/share/nmon/mibs). The poller never reads a MIB. Operators get nmon profile new --mib working out of the box while the binary stays small. Each MIB keeps its publisher's terms (see mibs/README.md). M2
7 import-librenms reads includes/definitions/*.yaml and includes/definitions/discovery/*.yaml Reads resources/definitions/os_detection/*.yaml and resources/definitions/os_discovery/*.yaml, with the old paths as a fallback. LibreNMS moved them; the spec's paths no longer exist upstream. M2
8 Real recordings replace synthetic fixtures when available LibreNMS's tests/snmpsim/*.snmprec (2,054 real device recordings) are used by optional tests when NMON_LIBRENMS_DIR points at a checkout. They are never copied into this repo. Real-device coverage without vendoring GPL test data into an Apache-2.0 repo. M2
9 nmon profile import-librenms <repo-path> is an nmon subcommand A separate binary, nmon-librenms-import (cmd/nmon-librenms-import), run offline before nmon. It writes draft profiles that the operator reviews and copies into <data-dir>/profiles/. nmon neither links nor exposes it. User decision (2026-10-22). It keeps the importer out of the product binary and makes "the converter never runs at serve time" structural. M2