CDESK LOGGING-ANWENDUNG

FÜR SKRIPTE (DOCKER-VERSION)

Übersicht

Diese Anwendung bietet die Visualisierung von Logs aus CDESK-Skripten und eine grafische Oberfläche für deren manuellen Start. Die Skript-Logs können nach Datum, Nachrichtentyp (zum Beispiel INFO, WARNING, ERROR…) und Quellskript gefiltert werden. Teil dieses Verzeichnisses ist auch ein Cron zum Löschen von Logs, die älter als 7 Tage sind.

Dateien und Verzeichnisse

app.py

Diese Datei enthält die Anwendung, in der die Endpunkte und die Funktionalität zur Anzeige und Filterung von Logs sowie zum manuellen Start von Skripten definiert sind.

templates

Verzeichnis mit den verschiedenen Seiten der Anwendung.

logs

Verzeichnis, das die Logs enthält. Die Logs sind nach Erstellungsdatum aufgeteilt. Zum Beispiel sieht eine Log-Datei für das Datum 11.01.2021 wie 2021-01-11.log aus. Das Programm kann jedoch alle Log-Dateien mit der Endung .log. verarbeiten

Dockerfile

Dieses Dockerfile wird zur Einrichtung des Containers für die Log-Bereinigung benötigt, um Logs zu entfernen, die älter als 7 Tage sind. Diese empfohlene Funktionalität entfernt ältere Skript-Logs und gibt so belegten Speicher frei.

Einstellung und Konfiguration

Python

Um diese Anwendung zu starten, müssen Sie Python auf Ihrem PC/Server installiert haben. Es wird eine neuere Version empfohlen, zum Beispiel 3.11 oder 3.12.

Adresse und Port der Anwendung

Die Standardadresse dieser Anwendung ist localhost (127.0.0.1) mit dem Port 5001. Der Port kann in der Datei app.py ganz an deren Ende geändert werden, wo die Anwendung initialisiert wird.

Einrichtungsschritte

1. Erstellen Sie im Stammverzeichnis dieser Anwendung (wo sich app.py befindet) eine neue virtuelle Umgebung (python -m venv .venv) und aktivieren Sie sie (.venv\Scripts\activate für Windows, source .venv/bin/activate für macOS und Linux).
2. Führen Sie pip install -r requirements.txt aus, um alle für diese Anwendung notwendigen Abhängigkeiten zu installieren.
3. Führen Sie python app.py aus, um diese Anwendung zu starten. Im Terminal sehen Sie die Adresse der Anwendung (standardmäßig http://127.0.0.1:5001), wo Sie die Skript-Logs finden und bereits bestehende CDESK-Skripte manuell starten können.

Es wird auch empfohlen, einen Docker-Container zur Log-Bereinigung zu starten, damit Logs, die älter als 7 Tage sind, automatisch entfernt werden. Verwenden Sie aus dem Stammverzeichnis der Anwendung den Befehl: docker rm -f log-cleaner-container && docker build -t log-cleaner . && docker run -d –name log-cleaner-container -v „</cesta/k/logs>:/app/logs“ log-cleaner

wobei </cesta/k/logs> der Pfad zum Verzeichnis mit den Logs (/logs) im Stammverzeichnis der Anwendung ist.

Hinweise zur Anwendung

Diese Anwendung ist nur von dem lokalen Computer aus zugänglich, auf dem sie gestartet wurde. Die Adresse der Anwendung wird in der Konsole ausgegeben, in der Sie den Befehl python app.py eingegeben haben; es sollte eine localhost-Adresse mit dem von Ihnen gewählten Port sein (127.0.0.1:<Ihr Port>). Wenn mehrere Personen mit der Anwendung arbeiten werden, wird empfohlen, sie auf einem Server/virtuellen Rechner zu starten.

Verwendung der Anwendung

Die Anwendung hat 2 Hauptteile – die Anzeige von Logs und den manuellen Start von Skripten. Nach dem Wechsel zur Startseite der Anwendung (standardmäßig 127.0.0.1:5001) werden Sie zu /logs weitergeleitet, wo die Skript-Logs angezeigt werden. Um Skripte manuell zu starten, gehen Sie zur Seite /run-scripts. Für eine einfachere Bedienung verwenden Sie die Navigationsleiste im oberen Teil der Seite.

Skript-Logs

In der Anwendung können Sie verschiedene Filter einstellen, um nur einen Teil der Logs anzuzeigen. Zu diesen Filtern gehören Datum, Nachrichtentyp, Skriptname und Anzahl der pro Seite angezeigten Logs.

Wann immer ein neuer Filter verwendet wird oder durch ein anderes Skript neue Logs hinzugefügt werden, sollte die Liste der Logs durch Drücken der Schaltfläche „Filter“ neu geladen werden, um die Änderungen anzuwenden.

Manuelles Starten des Skripts

Auf dieser Seite der Anwendung können Sie jeden bestehenden Container mit einem Skript starten, dessen Name mit ‚cdesk-script‘ beginnt. Wenn der Container ausgeschaltet ist, wird er gestartet. Andernfalls, wenn er bereits läuft, führt er den Befehl python3 /app/main.py innerhalb des Containers aus. Daher ist es wichtig, diese zwei Bedingungen zu erfüllen, damit Ihre eigenen Skripte angezeigt und korrekt gestartet werden:

• Der Name des Containers beginnt mit ‚cdesk-script‘
• Die Datei zum Starten des Skripts heißt ‚main.py‘