Hallo,
da ich auch immer wieder interessiert bin schnell ins Log zu schauen ohne erst das Backend öffnen zu müssen habe ich eine Modul für die Tile View gebaut wo man die Log Datei schnell einsehen und auswerten kann. Wer Interesse hat, kann gerne davon Gebrauch nehmen.
Im Store zu finden unter genauer Eingabe von “LogAnalyzer” im Suchfeld.
Ansonsten unter Github:
LogAnalyzer
Das Modul LogAnalyzer ermöglicht die Analyse und Filterung von IP-Symcon Logdateien direkt im WebFront.
Logeinträge können gefiltert, durchsucht und seitenweise geladen werden. Dabei stehen verschiedene Betriebsmodi zur Verfügung.
Hinweis: Dieses Modul ist ausschließlich für die neue Kachelansicht (Tile View) von IP-Symcon entwickelt.
Die klassische WebFront-Ansicht wird nicht unterstützt.
Inhaltsverzeichnis
-
Funktionsumfang
-
Voraussetzungen
-
Software-Installation
-
Einrichten der Instanzen in Symcon
-
Statusvariablen und Profile
-
Visualisierung
-
PHP-Befehlsreferenz
-
Screenshots
1. Funktionsumfang
-
Anzeige von IP-Symcon Logdateien in der Kachelvisualisierung
-
Seitenweise Darstellung großer Logdateien
-
Filterung nach:
-
Objekt-ID
-
Meldungstyp inklusive dynamischer Trefferanzahl
-
Sender inklusive dynamischer Trefferanzahl
-
Freitext (Meldung)
-
-
Dynamische Filterlisten basierend auf Logdaten
-
Navigation durch Logseiten (ältere / neuere Einträge)
-
Anzeige von Trefferbereich und Gesamtmenge
-
Lade- und Statusindikator während der Verarbeitung
-
Umschaltbares Theme (Dark / Light)
-
Umschaltbarer kompakter Darstellungsmodus
-
Auswahl verschiedener Betriebsmodi zur Performance-Optimierung
-
Auswahl der Logdatei direkt in der Tile
-
CSV-Export im Ultra-Modus
-
Temporäre Downloadlinks für CSV-Exporte
-
Automatische Bereinigung abgelaufener Exportdateien
Betriebsmodi
Das Modul stellt drei Betriebsmodi zur Verfügung:
Standard
-
Reine PHP-Verarbeitung
-
Maximale Kompatibilität
-
Geeignet für kleinere Logdateien
System
-
Nutzung von Systemwerkzeugen
-
Unter Unix/Linux werden native Werkzeuge wie grep und awk verwendet
-
Unter Windows wird PowerShell gezielt als plattformspezifischer Fallback verwendet
-
Höhere Performance bei großen Logdateien
Ultra
-
Nutzung eines externen Ultra CLI Tools
-
Höchste Performance
-
Unterstützt:
-
schnelle Seitenabfragen
-
Trefferzählung
-
Filtermetadaten
-
CSV-Export
-
-
Erfordert ein installiertes Ultra CLI Tool
CSV-Export (Ultra-Modus)
Im Ultra-Modus stehen Exportfunktionen zur Verfügung:
-
Gesamtes Filterergebnis exportieren
-
Aktuellen Seitenbereich exportieren
Eigenschaften:
-
Export erfolgt über Ultra CLI
-
Datei wird temporär gespeichert
-
Download erfolgt über signierten Token-Link
-
Mehrere Exporte gleichzeitig möglich
-
Automatische TTL-basierte Bereinigung
Ultra CLI Tool
Der Ultra-Modus verwendet optional das externe CLI Tool LogAnalyzerUltra:
https://github.com/BugForgeNerd/LogAnalyzerUltra
Das Tool wurde speziell für dieses Modul entwickelt und dient ausschließlich der performanten Analyse großer IP-Symcon Logdateien. Es wird nur verwendet, wenn der Ultra-Modus aktiv ist und das CLI Tool im Backend konfiguriert wurde. Ohne dieses Tool kann das Modul weiterhin im Standard- oder Systemmodus verwendet werden.
Im Ultra-Modus können Index- und Cache-Dateien als Sidecar-Dateien zur jeweiligen Logdatei erzeugt werden. Diese Dateien dienen ausschließlich der Beschleunigung der Analyse und werden nicht zur allgemeinen Manipulation anderer Systembereiche verwendet.
Dateizugriff
Das Modul liest ausschließlich IP-Symcon Logdateien aus dem von IPS_GetLogDir() gelieferten Logverzeichnis. Frei wählbare externe Dateipfade werden nicht verarbeitet.
Der Zugriff auf lokale Dateien ist Bestandteil der Kernfunktion des Moduls, da Logdateien analysiert, gefiltert und optional exportiert werden. Dateioperationen beschränken sich auf die Logdateien, temporäre Exportdateien sowie im Ultra-Modus auf zugehörige Index- und Cache-Dateien.
Sicherheit (Download-Hook)
Der CSV-Download erfolgt über einen internen WebHook:
/hook/loganalyzer/<InstanceID>/download?token=<token>
Sicherheitsmechanismen:
-
Zufälliger Token pro Export
-
Token-Formatprüfung
-
Serverseitige Token-Validierung
-
Kein Zugriff auf beliebige Dateien möglich
-
Keine Ausführung von Befehlen über URL
-
Zugriff nur auf intern registrierte Exportdateien
-
Automatische TTL-basierte Löschung
-
Kein Directory Traversal möglich
Der Hook ist somit auch bei aktivem Connect-Dienst sicher nutzbar.
Unterstützte Betriebssysteme
Getestete Systeme:
-
Linux Debian 13
-
Windows 11
-
Docker (Debian basierend)
-
Tinker Board R2.0 mit ARM32
Weitere Systeme sollten grundsätzlich funktionieren, sind jedoch nicht getestet:
-
macOS
-
NAS-Systeme
-
andere Linux Distributionen
2. Voraussetzungen
-
IP-Symcon ab Version 8.1 empfohlen
-
Zugriff auf eine gültige Logdatei
-
Ultra CLI Tool LogAnalyzerUltra (nur für Ultra-Modus erforderlich): https://github.com/BugForgeNerd/LogAnalyzerUltra
3. Software-Installation
-
Über den Module Store das Modul LogAnalyzer installieren
-
Alternativ über das Module Control eine entsprechende Repository-URL hinzufügen
4. Einrichten der Instanzen in Symcon
Unter „Instanz hinzufügen“ kann das Modul LogAnalyzer über den Schnellfilter gefunden und hinzugefügt werden.
Weitere Informationen:
https://www.symcon.de/service/dokumentation/konzepte/instanzen/#Instanz_hinzufügen
Konfigurationsseite:
Die meisten Einstellungen erfolgen direkt in der Tile-Visualisierung.
Für den Ultra-Modus muss zusätzlich der Pfad zur Ultra CLI im Backend hinterlegt werden.
Der Ultra-Modus ist optional. Ist das externe CLI Tool nicht vorhanden oder nicht verwendbar, bleibt das Modul weiterhin funktionsfähig und kann über die internen Modi verwendet werden.
5. Statusvariablen und Profile
Dieses Modul legt keine eigenen Statusvariablen oder Profile an.
Die gesamte Darstellung erfolgt direkt über die Visualisierung.
6. Visualisierung
Die Visualisierung stellt eine interaktive Oberfläche zur Analyse der Logdaten bereit.
Funktionen
Filterbereich
-
Logdatei-Auswahl
-
Zeilen pro Seite
-
Objekt-ID Filter
-
Meldungstyp (Multi-Select mit Trefferanzahl je Typ)
-
Sender (Multi-Select mit Trefferanzahl je Sender)
-
Freitextsuche
Bedienelemente
-
Filter anwenden
-
Aktualisieren
-
Navigation zu älteren / neueren Einträgen
-
Theme-Auswahl (Dark / Light)
-
Kompaktmodus
-
Auswahl des Betriebsmodus (Standard / System / Ultra)
-
CSV Export (Ultra)
Statusanzeige
-
Aktuelle Datei
-
Dateigröße
-
Trefferbereich
-
Gesamtanzahl Treffer
-
Ladezeit Tabelle
-
Ladezeit Filter
-
Zeitstempel der Daten
Tabelle
-
Zeitstempel
-
Objekt-ID
-
Meldungstyp
-
Sender
-
Meldung
7. PHP-Befehlsreferenz
Dieses Modul stellt keine öffentlichen PHP-Funktionen zur direkten Verwendung bereit.
Die Kommunikation erfolgt ausschließlich über die interne Visualisierung (RequestAction).
8. Screenshots
WebFront Ansicht
Ansicht im Webfront der neuen Kacheloberfläche - hier DarkMode:
Ansicht im Webfront der neuen Kacheloberfläche - hier LightMode:
Konfigurationsformular (Backend)
Ansicht im Konfigurationsformular des Moduls:
Hinweise
-
Große Logdateien werden seitenweise geladen
-
Ultra-Modus benötigt das externe CLI Tool LogAnalyzerUltra
-
Ohne Ultra CLI bleibt das Modul im Standard- und Systemmodus nutzbar
-
CSV-Export nur im Ultra-Modus verfügbar
-
Exportdateien werden automatisch gelöscht
-
Verhalten kann je nach Plattform variieren
Wir sind halt nur noch nicht da angekommen
.