#2470: changelog + documentation

This commit is contained in:
Czar Echavez
2024-04-18 15:57:02 +01:00
parent 94ca13c0f9
commit 2a1203675d
2 changed files with 25 additions and 0 deletions

View File

@@ -7,6 +7,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
## 3.0.0b9
- Removed deprecated `PrimaiteSession` class.
- Added ability to set log levels via configuration.
## [Unreleased]
- Made requests fail to reach their target if the node is off

View File

@@ -18,6 +18,30 @@ This section configures how PrimAITE saves data during simulation and training.
save_step_metadata: False
save_pcap_logs: False
save_sys_logs: False
log_level: INFO
``log_level``
-------------
Optional. Default value is ``INFO``.
The level of logging that should be visible in the sys logs or the logs output to the terminal.
Available options are:
- ``OFF``: No logs
- ``DEBUG``: Debug level items and the items below
- ``INFO``: Info level items and the items below
- ``WARNING``: Warning level items and the items below
- ``ERROR``: Error level items and the items below
- ``CRITICAL``: Only critical level logs
See also |logging_levels|
.. |logging_levels| raw:: html
<a href="https://docs.python.org/3/library/logging.html#logging-levels" target="blank">Python logging levels</a>
``save_logs``