Documentation, fix config flag for logging

BOSWatch · May 23, 2022 · efeb271 · efeb271
1 parent a16f67f
commit efeb271
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 4 deletions.
diff --git a/boswatch/router/routerManager.py b/boswatch/router/routerManager.py
@@ -118,7 +118,7 @@ def runRouters(self, routerRunList, bwPacket):
             else:
                 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
 
     def cleanup(self):

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

diff --git a/docu/docs/config.md b/docu/docs/config.md
@@ -157,15 +157,16 @@ decoder:
 ```
 
 ---
-## Server
+<h2 id="server-configuration">Server</h2>
 Nachfolgend alle Paramater der Server Konfiguration
 
 ### `server:`
 |Feld|Beschreibung|Default|
 |----|------------|-------|
-|port|Port auf dem der Server lauscht|8080
+|port|Port auf dem der Server lauscht| 8080  
 |name|Name zur Identifizierung der Server Instanz||
 |useBroadcast|Verbindungsdaten per Broadcast Server bereitstellen|no|
+|logging|Aktivieren / Deaktivieren des Schreibens von Statistik-Dateien|False|
 
 ---
 ### `alarmRouter:`
@@ -215,3 +216,16 @@ router:
 ## Module/Plugins
 
 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))