From 2a1203675dd50587acb6f3547a1082a6f7467bbe Mon Sep 17 00:00:00 2001 From: Czar Echavez Date: Thu, 18 Apr 2024 15:57:02 +0100 Subject: [PATCH] #2470: changelog + documentation --- CHANGELOG.md | 1 + docs/source/configuration/io_settings.rst | 24 +++++++++++++++++++++++ 2 files changed, 25 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index d30ae5e2..d11c4ec7 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -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 diff --git a/docs/source/configuration/io_settings.rst b/docs/source/configuration/io_settings.rst index 67734751..085074a1 100644 --- a/docs/source/configuration/io_settings.rst +++ b/docs/source/configuration/io_settings.rst @@ -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 + + Python logging levels ``save_logs``