lighthouse/common
Mac L fe75a0a9a1 Add background file logging (#2762)
## Issue Addressed

Closes #1996 

## Proposed Changes

Run a second `Logger` via `sloggers` which logs to a file in the background with:
- separate `debug-level` for background and terminal logging
- the ability to limit log size
- rotation through a customizable number of log files
- an option to compress old log files (`.gz` format)

Add the following new CLI flags:
- `--logfile-debug-level`: The debug level of the log files
- `--logfile-max-size`: The maximum size of each log file
- `--logfile-max-number`: The number of old log files to store
- `--logfile-compress`: Whether to compress old log files

By default background logging uses the `debug` log level and saves logfiles to:
- Beacon Node:  `$HOME/.lighthouse/$network/beacon/logs/beacon.log`
- Validator Client:  `$HOME/.lighthouse/$network/validators/logs/validator.log`

Or, when using the `--datadir` flag:
`$datadir/beacon/logs/beacon.log` and `$datadir/validators/logs/validator.log`

Once rotated, old logs are stored like so: `beacon.log.1`, `beacon.log.2` etc. 
> Note: `beacon.log.1` is always newer than `beacon.log.2`.

## Additional Info

Currently the default value of `--logfile-max-size` is 200 (MB) and `--logfile-max-number` is 5.
This means that the maximum storage space that the logs will take up by default is 1.2GB. 
(200MB x 5 from old log files + <200MB the current logfile being written to)
Happy to adjust these default values to whatever people think is appropriate. 

It's also worth noting that when logging to a file, we lose our custom `slog` formatting. This means the logfile logs look like this:
```
Oct 27 16:02:50.305 INFO Lighthouse started, version: Lighthouse/v2.0.1-8edd9d4+, module: lighthouse:413
Oct 27 16:02:50.305 INFO Configured for network, name: prater, module: lighthouse:414
```
2021-11-30 03:25:32 +00:00
..
account_utils Update zeroize_derive (#2625) 2021-09-25 05:58:37 +00:00
clap_utils Remove unused deps (#2592) 2021-09-30 04:31:42 +00:00
compare_fields Check for unused deps in CI (#1262) 2020-06-14 10:59:50 +10:00
compare_fields_derive Update external deps (#1711) 2020-10-05 08:22:19 +00:00
deposit_contract Implement SSZ union type (#2579) 2021-09-25 05:58:36 +00:00
directory Add background file logging (#2762) 2021-11-30 03:25:32 +00:00
eth2 Update Lighthouse Dependencies (#2818) 2021-11-18 05:08:42 +00:00
eth2_config Remove unused deps (#2592) 2021-09-30 04:31:42 +00:00
eth2_interop_keypairs Fix nightly bump num bigint (#2591) 2021-09-12 23:55:20 +00:00
eth2_network_config Resolve Rust 1.56 lints and warnings (#2728) 2021-10-19 00:30:42 +00:00
eth2_wallet_manager Remove unused deps (#2592) 2021-09-30 04:31:42 +00:00
fallback Improve eth1 fallback logging (#2490) 2021-08-30 00:51:26 +00:00
filesystem Fix linting error on Windows (#2759) 2021-11-01 07:44:42 +00:00
hashset_delay Update Lighthouse Dependencies (#2818) 2021-11-18 05:08:42 +00:00
lighthouse_metrics Update prometheus to v0.13.0 (#2757) 2021-11-01 05:52:30 +00:00
lighthouse_version Release v2.0.1 (#2726) 2021-10-18 03:08:32 +00:00
lockfile Enable Compatibility with Windows (#2333) 2021-05-19 23:05:16 +00:00
logging Add background file logging (#2762) 2021-11-30 03:25:32 +00:00
lru_cache Keep track of failed head chains and prevent re-lookups (#1534) 2020-08-18 03:54:09 +00:00
malloc_utils Avoid negative values in malloc_utils metrics (#2692) 2021-10-11 00:10:34 +00:00
monitoring_api Update Lighthouse Dependencies (#2818) 2021-11-18 05:08:42 +00:00
sensitive_url Add SensitiveUrl to redact user secrets from endpoints (#2326) 2021-05-04 01:59:51 +00:00
slot_clock Validator monitor support for sync committees (#2476) 2021-08-31 23:31:36 +00:00
target_check Improve compilation error on 32-bit (#2424) 2021-06-30 04:56:22 +00:00
task_executor Update Lighthouse Dependencies (#2818) 2021-11-18 05:08:42 +00:00
test_random_derive Update external deps (#1711) 2020-10-05 08:22:19 +00:00
validator_dir Remove unused deps (#2592) 2021-09-30 04:31:42 +00:00
warp_utils Update Lighthouse Dependencies (#2818) 2021-11-18 05:08:42 +00:00
README.md Directory Restructure (#1163) 2020-05-18 21:24:23 +10:00

eth2

Common crates containing eth2-specific logic.