[fix] #4030, #4063, #4064, #4079: re-architect logger and dynamic configuration

[0x009922]

Description

Started by updating configuration endpoints according to #4063, this PR expanded to major update of dynamic configuration mechanism, Logger configuration (#4030, #4064) and initialisation.

Logger initialisation is a global one-time thing, which was done with iroha_logger::init(Configuration) function, which might accept the config and initialise logger, or might not, without an error. While initialising, it injected a ReloadHandle into the configuration instance, so that all updates to config.logger.max_log_level would trigger updates set up within iroha_logger::init. Than that config was copied many times in Torii and log level was actually reloaded on POST /configuration updates.

However, the configuration value update was not reflected in subsequent GET /configuration requests (#4079), because each time config is copied (it was copied for each request), it was editing a copy of config without affecting an original one. Since a copy of config was still containing ReloadHandle from Logger, the log level was updated.

Another problem appeared because of combination of configuration & logger architecture, in tests. It appeared that some tests ran concurrently, each calling iroha_logger::init with independent Configurations. However, only one iroha_logger::init might succeed, and another silently pretends that everything is ok. It worked fine, until one of Iroha instances fails to update the log level, because its Configuration passed into iroha_logger::init was not injected with a ReloadHandle.

Shortly, the system was unsound, i.e. it was easy to misuse.

Changes in this PR:

• Remove ReloadHandle and SyncValue from configuration
• Introduce Kiso (jp 基礎 - foundation; basis): an actor responsible for holding the configuration state and broadcasting its updates across the system in a fire-and-forget way
• Update Logger configuration according to [suggestion] Move logger.terminal_colors setting to the CLI layer #4030 and [suggestion] Simplify logger's behaviour and configuration #4064
• Introduce Logger actor, which might be initialised only once per process, and which is responsible for log level reloading and telemetry subscriptions
• Update Logger initialisation: split init(Configuration) -> Result<Option<Telemetries>> into
  • init_global(Configuration) -> Result<LoggerHandle>, initialising the Logger actor once per process, and failing if it was done already
  • test_logger() -> LoggerHandle, lazily initialising the Logger actor with pre-defined configuration, suitable for tests

Chores:

• Remove redundant fields from Kura configuration
• Refactor telemetry broadcasting mechanisms

Linked issue

Closes #4030 #4063 #4064 #4079

Benefits

• Improves configuration UX
• Improves system soundness

Checklist

• Refactor Kiso in a fire-and-forget manner
• Play with logger manually
  • Check if bunyan can parse current JSON output
• Update logger config in py test env
• Update README logger documentation
• Use 202 Accepted for POST /configuration

Migration guide

Update Logger configuration

In the configuration file, under LOGGER.* namespace:

• Rename MAX_LOG_LEVEL to LEVEL
• Remove COMPACT_MODE; use FORMAT: "full" (if false) and FORMAT: "compact" (if true) instead
• Remove LOG_FILE_PATH; use FORMAT: "json" instead and redirect stdout to a file, e.g. iroha > log.json
• Remove TERMINAL_COLORS; use --terminal-colors/--no-terminal-colors CLI arguments instead
• Remove TELEMETRY_CAPACITY

Env variables:

• LOG_LEVEL: instead of MAX_LOG_LEVEL
• LOG_FORMAT: new parameter
• LOG_TOKIO_CONSOLE_ADDR: instead of TOKIO_CONSOLE_ADDR

Example file before:

{
  "LOGGER": {
    "MAX_LOG_LEVEL": "INFO",
    "TELEMETRY_CAPACITY": 1000,
    "COMPACT_MODE": false,
    "LOG_FILE_PATH": null,
    "TERMINAL_COLORS": true
  }
}

Example file after:

{
  "LOGGER": {
    "LEVEL": "INFO",
    "FORMAT": "full"
  }
}

Update Kura configuration

In the configuration file, under KURA.* namespace, remove ACTOR_CHANNEL_CAPACITY and BLOCKS_PER_STORAGE_FILE fields.

Update configuration endpoints usage

• GET /configuration now returns JSON with only { logger: { level } }.
• POST /configuration now accepts JSON in the same shape

POST /configuration request before:

{"LogLevel":"DEBUG"}

POST /configuration request after:

{"logger":{"level":"DEBUG"}}

[coveralls]

Pull Request Test Coverage Report for Build 7175878272

• 273 of 483 (56.52%) changed or added relevant lines in 21 files are covered.
• 6921 unchanged lines in 128 files lost coverage.
• Overall coverage decreased (-3.1%) to 56.349%

---

Changes Missing Coverage	Covered Lines	Changed/Added Lines	%
cli/src/torii/mod.rs	0	2	0.0%
logger/src/telemetry.rs	16	18	88.89%
telemetry/src/futures.rs	0	2	0.0%
cli/src/style.rs	0	3	0.0%
core/test_network/src/lib.rs	0	4	0.0%
logger/src/lib.rs	43	47	91.49%
telemetry/src/dev.rs	0	5	0.0%
client/src/client.rs	0	6	0.0%
config/src/client_api.rs	23	31	74.19%
core/src/kiso.rs	87	102	85.29%

Files with Coverage Reduction	New Missed Lines	%
cli/src/style.rs	1	0.0%
config/base/derive/src/view.rs	1	99.37%
config/src/block_sync.rs	1	95.0%
config/src/network.rs	1	93.75%
config/src/torii.rs	1	95.45%
config/src/wasm.rs	1	87.5%
core/src/smartcontracts/isi/block.rs	1	87.5%
logger/src/lib.rs	1	93.98%
ffi/src/option.rs	2	71.43%
config/src/genesis.rs	3	72.92%

Totals
Change from base Build 5423219773:	-3.1%
Covered Lines:	23057
Relevant Lines:	40918

---

💛 - Coveralls