d8caab500d
By enabling the validator monitor, more precise information about the lifecycle of an attestation is logged at the higher `NOTICE` log level while current `sent` messages are logged at `INF` instead, since they are less interesting. In particular, missed attestations and those that vote for the wrong head are now detected and logged at NOTICE. In addition to logging, this feature enables rich metrics around attestation and sync committee performance - by default, validators are tracked in aggregate but a detailed mode exists as well This feature has been available since early Nimbus days, but it has now been tuned and optimised such that it is safe to enable by default, even for large setups. * enable automatic validator monitoring by default * replace `--validator-monitor-totals` flag with `--validator-monitor-details` - the detailed mode is disabled by default * lower "sent" log level to `INF` for several messages - in particular those that are traced by the validator monitor This is a retake on #3531 which was later reverted in #3578. |
||
|---|---|---|
| .. | ||
| nbc_audit_2020 | ||
| the_auditors_handbook | ||
| the_nimbus_book | ||
| .gitignore | ||
| Makefile | ||
| README.md | ||
| attestation_flow.dot | ||
| attestation_flow.md | ||
| attestation_flow.png | ||
| block_flow.dot | ||
| block_flow.md | ||
| block_flow.png | ||
| cpu_features.md | ||
| e2store.md | ||
| eth2-finalization.png | ||
| kiln_geth_local_testnet.md | ||
| kiln_geth_logs.png | ||
| logging.md | ||
| nimbus_localhost_run.png | ||
| requirements.in | ||
| requirements.txt | ||
README.md
Documentation
material for mkdocs
The Nimbus guide is generated using Material for mkdocs, and installed using a python VENV (see Makefile).
mdbook
Some books in this folder were produced using mdBook - see installation guide.
# Install or update tooling (make sure you add "~/.cargo/bin" to PATH):
cargo install mdbook --version 0.4.18
cargo install mdbook-toc --version 0.8.0
cargo install mdbook-open-on-gh --version 2.1.0
cargo install mdbook-admonish --version 1.7.0
# Work on the book locally - open "http://localhost:4000" for live version
cd docs/the_nimbus_book
mdbook serve -p 4000
# Create a local copy of the book
make book
# Publish book using makefile (in the top-level dir)
make publish-book