Elevate docs, add decision/architecture records, harden reader, and expand tests #198
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR brings Chronicle Logger up to the common OpenHFT standards for documentation, decision tracking, and test coverage. It also makes the
ChronicleLogReadermore robust when optional fields are absent or unknown, keeping CLI tools and programmatic processors in sync.Highlights
ChronicleLogReaderto iterate optional fields deterministically (preservesthrowableandargs, skips unknowns).Motivation
Architectural & Documentation changes
adoc/architecture-overview.adocadoc/decision-log.adocRecords:
CLG-DOC-001Adopt Nine-Box requirements catalogue.CLG-OPS-002Hard-fail on missing/unwritable queue paths.CLG-NF-P-003Zero-allocation budget for readers.adoc/project-requirements.adocFunctional code & tests
Reader hardening
ChronicleLogReaderwire.readEventName(..)to iterate remaining fields.throwableandargsif present.IllegalArgumentException: primitive: voidwhen optional sequences were missing.Tests
logger-tools/ChronicleLogReaderTestRewritten to use a self-contained writer + reader:
DefaultChronicleLogWriter.logger-core/ChronicleLogManagerTestValidates explicit property-file load and reload that switches queue paths:
logger-core/ChronicleLogConfig&ChronicleLogWriter(Javadoc tweaks)