Globales Logging

Klassendiagramm

Konfigurations-Parameter

Konfiguration des Moduls log.logger

class einsatzserver.log.logconfig.LogConfig

LogConfig ist von Config abgeleitet

Ueber die Klasse LogConfig wird auf die Schluessel der Konfig-Gruppe Logging in der globalen config.json zugegriffen.

property log_path

Liefert den absoluten Pfad zu dem Log-Verzeichnis

Ist das Verzeichnis nicht konfiguriert, so wird der default Pfad „{Projektverzeichnis}/_Log“ als Log-Verzeichnis verwendet. Bei relativen Pfadangaben wird immer vom Projektverzeichnis aus navigiert.

property log_filename

Liefert den Dateinamen des Logfiles

Die Dateiendung muss zwingend auf *.log enden. Fehlt die Dateiendung oder ist diese Fehlerhaft, so wird der Dateiname um diese ergaenzt.

property log_level

Liefert das Log-Level

Folgende Loglevel koennen gesetzt werden:

- CRITICAL = 50

- ERROR = 40

- WARNING = 30

- INFO = 20

- DEBUG = 10

- NOTSET = 0

Ist kein oder ein falscher Wert fuer das Loglevel gesetzt so wird WARNING als default Wert verwendet.

property log_multiple_file

Aktiviert Logging mit rotierenden Log-Files

Soll das Rotierende Logging verwendet werden, so ist der Wert auf true zu setzen. Zusaetzlich muss noch die Anzahl derrotierenden Files, sowie die File-Groesse konfiguriert werden, bei der ein Backup des Logfiles angelegt werden soll.

Ist kein Wert gesetzt, so wird das rotierende Logging per default aktiviert.

property log_file_size

Definiert die Log_file Groesse, bei der ein neues Logfile generiert werden soll

Dieser Wert ist nur aktiv wenn das rotierende Logging aktiviert ist. Die Dateigroesse wird in Bytes angegeben. Ist das rotierende Logging aktiviert und kein Wert fuer die Dateigroesse gesetzt, so wird diese auf 5MB per default gesetzt.

property log_backup_files

Definiert die Anzahl der rotierenden Log-Files

Definiert die Anzahl der rotierenden Logfiles. Ist die maximale Anzahl Files erreicht wird das aelteste Logfile geloescht. Ist der Wert nicht gesetzt wird der Wert per default auf 5 gesetzt.

Schnittstellen

Modul logger

class einsatzserver.log.logger.Logger

Die Klasse Logger definiert das globale Verhalten des Loggings.

nach dem instanziieren des Log-Objektes muss das log_setup() einmalig ausgefuehrt werden.

log_setup()

Konfiguriert das globale Logging

Die Einstellungen werden aus der globalen config.json uebernommen. Die EInstellungen werden in der log.logconfig auf Plausibilitaet ueberprueft und wenn noetig auf default werte gesetzt.