mirror of
https://github.com/Akkudoktor-EOS/EOS.git
synced 2025-06-27 16:36:53 +00:00
bd38b3c5ef
Some checks failed
docker-build / platform-excludes (push) Has been cancelled
pre-commit / pre-commit (push) Has been cancelled
Run Pytest on Pull Request / test (push) Has been cancelled
docker-build / build (push) Has been cancelled
docker-build / merge (push) Has been cancelled
Close stale pull requests/issues / Find Stale issues and PRs (push) Has been cancelled
* Fix logging configuration issues that made logging stop operation. Switch to Loguru logging (from Python logging). Enable console and file logging with different log levels. Add logging documentation. * Fix logging configuration and EOS configuration out of sync. Added tracking support for nested value updates of Pydantic models. This used to update the logging configuration when the EOS configurationm for logging is changed. Should keep logging config and EOS config in sync as long as all changes to the EOS logging configuration are done by set_nested_value(), which is the case for the REST API. * Fix energy management task looping endlessly after the second update when trying to update the last_update datetime. * Fix get_nested_value() to correctly take values from the dicts in a Pydantic model instance. * Fix usage of model classes instead of model instances in nested value access when evaluation the value type that is associated to each key. * Fix illegal json format in prediction documentation for PVForecastAkkudoktor provider. * Fix documentation qirks and add EOS Connect to integrations. * Support deprecated fields in configuration in documentation generation and EOSdash. * Enhance EOSdash demo to show BrightSky humidity data (that is often missing) * Update documentation reference to German EOS installation videos. Signed-off-by: Bobby Noelte <b0661n0e17e@gmail.com>
76 lines
1.6 KiB
Markdown
76 lines
1.6 KiB
Markdown
% SPDX-License-Identifier: Apache-2.0
|
||
(logging-page)=
|
||
|
||
# Logging
|
||
|
||
EOS automatically records important events and messages to help you understand what’s happening and
|
||
to troubleshoot problems.
|
||
|
||
## How Logging Works
|
||
|
||
- By default, logs are shown in your terminal (console).
|
||
- You can also save logs to a file for later review.
|
||
- Log files are rotated automatically to avoid becoming too large.
|
||
|
||
## Controlling Log Details
|
||
|
||
### 1. Command-Line Option
|
||
|
||
Set the amount of log detail shown on the console by using `--log-level` when starting EOS.
|
||
|
||
Example:
|
||
|
||
```{eval-rst}
|
||
.. tabs::
|
||
|
||
.. tab:: Windows
|
||
|
||
.. code-block:: powershell
|
||
|
||
.venv\Scripts\python src/akkudoktoreos/server/eos.py --log-level DEBUG
|
||
|
||
.. tab:: Linux
|
||
|
||
.. code-block:: bash
|
||
|
||
.venv/bin/python src/akkudoktoreos/server/eos.py --log-level DEBUG
|
||
|
||
```
|
||
|
||
Common levels:
|
||
|
||
- DEBUG (most detail)
|
||
- INFO (default)
|
||
- WARNING
|
||
- ERROR
|
||
- CRITICAL (least detail)
|
||
|
||
### 2. Configuration File
|
||
|
||
You can also set logging options in your EOS configuration file (EOS.config.json).
|
||
|
||
```Json
|
||
{
|
||
"logging": {
|
||
"console_level": "INFO",
|
||
"file_level": "DEBUG"
|
||
}
|
||
}
|
||
```
|
||
|
||
### 3. Environment Variable
|
||
|
||
You can also control the log level by setting the `EOS_LOGGING__CONSOLE_LEVEL` and the
|
||
`EOS_LOGGING__FILE_LEVEL` environment variables.
|
||
|
||
```bash
|
||
EOS_LOGGING__CONSOLE_LEVEL="INFO"
|
||
EOS_LOGGING__FILE_LEVEL="DEBUG"
|
||
```
|
||
|
||
## File Logging
|
||
|
||
If the `file_level` configuration is set, log records are written to a rotating log file. The log
|
||
file is in the data output directory and named `eos.log`. You may directly read the file or use
|
||
the `/v1/logging/log` endpoint to access the file log.
|