BOSWatch/BW3-Core
1
0
Fork 0
mirror of https://github.com/BOSWatch/BW3-Core.git synced 2025-12-06 07:12:04 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

Documentation, fix config flag for logging

Browse source
This commit is contained in:
Jan Speller 2022-05-23 23:20:54 +02:00
parent a16f67fe2e
commit efeb271de4
3 changed files with 18 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
boswatch/router/routerManager.py
View file

@ -118,7 +118,7 @@ class RouterManager:
else: else:
logging.warning("unknown router: %s", routerName) logging.warning("unknown router: %s", routerName)
if self.config.get('server.logging', False): if self.config.get("server", "logging", default=False):
self._saveStats() # write stats to stats file self._saveStats() # write stats to stats file
def cleanup(self): def cleanup(self):

2
config/server.yaml
View file

@ -11,7 +11,7 @@ server:
port: 8080 port: 8080
name: BW3 Server # name of the BW3 Server instance name: BW3 Server # name of the BW3 Server instance
useBroadcast: no # serve server ip on broadcast request useBroadcast: no # serve server ip on broadcast request
log: false # enable log file logging: False # enable log file
alarmRouter: alarmRouter:
- Router 1 - Router 1

16
docu/docs/config.md
View file

@ -157,7 +157,7 @@ decoder:
``` ```
--- ---
## Server <h2 id="server-configuration">Server</h2>
Nachfolgend alle Paramater der Server Konfiguration Nachfolgend alle Paramater der Server Konfiguration
### `server:` ### `server:`
@ -166,6 +166,7 @@ Nachfolgend alle Paramater der Server Konfiguration
|port|Port auf dem der Server lauscht| 8080 |port|Port auf dem der Server lauscht| 8080
|name|Name zur Identifizierung der Server Instanz|| |name|Name zur Identifizierung der Server Instanz||
|useBroadcast|Verbindungsdaten per Broadcast Server bereitstellen|no| |useBroadcast|Verbindungsdaten per Broadcast Server bereitstellen|no|
|logging|Aktivieren / Deaktivieren des Schreibens von Statistik-Dateien|False|
--- ---
### `alarmRouter:` ### `alarmRouter:`
@ -215,3 +216,16 @@ router:
## Module/Plugins ## Module/Plugins
Die möglichen Einstellungen der einzelnen Module und Plugins sind im jeweiligen Kapitel aufgelistet. Die möglichen Einstellungen der einzelnen Module und Plugins sind im jeweiligen Kapitel aufgelistet.
---
## Logging
Um den Datenträger, auf dem Boswatch läuft, zu schützen ist das Logging in
Dateien standartmäßig auf Fehlermeldungen begrenzt.
In den Dateien `logger_client.ini` bzw `logger_server.ini` kann dies
entsprechend im Bereich `handler_file` unter `level=` angepasst werden.
Das Schreiben einer Statistik-Datei, welche die Durchläufe aller Module
und Plugins dokumentiert, kann in der Server-Konfiguration über den Parameter
`logging` aktiviert werden.
(siehe [Server-Konfiguration](#server-configuration))