Logging

Das Vertec Logging protokolliert Informationen und Fehlermeldungen aller Vorgänge in und um Vertec (Vertec Apps, Vertec Addins, und Cloud Server). Jede Log Information ist einem Level zugeordnet.

Log Levels:

• 10: Debug
• 20: Info
• 30: Warning
• 40: Error
• 50: Fatal

Alle Informationen ab Level 20 werden standardmässig protokolliert. Log-Einträge mit dem Level 10 (Debug) werden nur geschrieben, wenn sie explizit eingeschaltet werden. Dafür gibt es sogenannte DebugCategories, welche in der Log-Section im Vertec.ini-File gesetzt werden.

Vertec legt dafür diverse Logfiles an, in welchen die verschiedenen Vorgänge aufgelistet werden. Es sind folgende Logfiles verfügbar:

Ist in der Log-Section im Vertec.ini-File kein LogFileFolder angegeben, werden diese Logfiles pro Client unter Benutzer\AppData\Roaming\Vertec angelegt. Ein einfacher Weg, diesen Ordner direkt aufzurufen, ist über den Befehl %appdata%.

• Geben Sie %appdata% direkt in die Adressleiste des Windows Explorers ein, oder
• Klicken Sie auf Start > Ausführen (oder Windows+R) und geben Sie %appdata% ein

Damit öffnet sich direkt der Ordner Anwendungsdaten des angemeldeten Benutzers. Die Logfiles werden in einem Unterordner abgelegt, welcher den Namen des Ordners trägt, in welchem das entsprechende Programm liegt. Wenn also die Programme im Ordner C:\Programme\Vertec liegen, so werden die Logfiles in %appdata%\Vertec zu finden sein.

Sie können in der Log-Section im Vertec.ini-File einen eigenen LogFileName angeben. Vorgänge der Desktop App und der Cloud App werden dann in dieses File geloggt.

Dieses wird beim Programmstart nicht überschrieben, sondern alle Log-Informationen hinten angefügt.

Die maximale Grösse von Log-Dateien ist auf 1 MB beschränkt. Ältere Daten werden in Backup-Dateien 1-9 geführt (zum Beispiel: Vertec.Desktop.1.Log). Dieser Vorgang geschieht automatisch.

Ist in der Log-Section im Vertec.ini-File kein LogFileFolder angegeben, befinden sich diese Logfiles im Ordner C:\ProgramData\. Analog zum Ordner %appdata% (siehe oben) können Sie diesen Ordner direkt über %programdata% aufrufen.

Ist die Option Restrict Session Process in der [CloudServer] Section im Vertec.ini-File eingeschaltet, befindet sich das Logfile Vertec.Session.log im Ordner C:\WINDOWS\system32\config\systemprofile\AppData\LocalLow.

Alle oben genannten Log-Einträge können zusätzlich systemweit in die Tabelle LOGDATA in der Datenbank geschrieben werden. Der Vorteil des SQL Loggings gegenüber den Logfiles ist, dass die Log-Outputs aller Clients zentral in der Datenbank gesammelt sind.

Dieser Vorgang sollte nur temporär eingesetzt und danach wieder abgeschaltet werden, da sich durch das endlose Befüllen von Log-Einträgen mit der Zeit Performance Probleme ergeben können.

Im Abschnitt [Log] des Vertec.ini Files kann mit

SqlLogTable=True

das Logging in eine Tabelle namens LOGDATA aktiviert werden. Die Tabelle wird automatisch in der DB erstellt und enthält alle Log-Ausgaben, die auch in ein Logfile geschrieben würden.

Die Log-Tabelle LOGDATA enthält folgende Spalten:

Die LOGDATA Tabelle wird bei einem Update gelöscht.

Die python Methode log übergibt die Informationen direkt an das Vertec Logging System. Diese werden gleich verarbeitet wie oben, also in das entsprechende Logfile und/oder als Einträge in die Datenbank geschrieben.

Registriert als Eventscript auf Löschen.

# coding: windows-1252
#
#---Bezeichnung: EventLog:
#   Klassen: N
#   ObjectScript: N
#   ContainerScript: N
#   EventType: Kein
#   EventClass: To specify
#   EventMembers: To specify
#   ExtendedRights: N

import vtcapp

def main():
    #aktuell angemeldeter Benutzer
    vertecUserName = vtcapp.evalocl("Timsession.allInstances->first.login.asstring")
    #spezifiziere Kategorie
    logCategory = "ExampleCategory"
    #spezifiziere Level
    logLevel = 20
    #setze die Message zusammen
    logObjectType = argobject.eval("self->oclType.asstring")
    logObjectId = argobject.eval("boldid")
    vtcapp.log(logCategory,logLevel,"'%s' mit der ID '%i' gelöscht durch '%s'"  %(logObjectType,logObjectId,vertecUserName))
main()

Die Einträge im Script haben das Level 20, deshalb erscheinen sie automatisch im Logfile.

Werden die Einträge dem Level 10 zugeordnet, muss die Log-Section im Vertec.ini-File um die im Script spezifizierte Debug Kategorie vertec.ExampleCategory ergänzt werden, damit die Einträge gelistet werden.

Ab Vertec Version 6.7.0.12

Sobald eine OpenObserve Server URL sowie ein Benutzername konfiguriert sind (siehe unten), schickt Vertec LogMessages an OpenObserve .

Folgende Variablen müssen in der Log-Section im Vertec.ini-File gesetzt werden:

[Log]
OpenObserveUrl=<URL>
OpenObserveUsername=<USERNAME>
OpenObservePassword=<PASSWORD>

Als OpenObserveUrl muss die URL des _multi-Endpunkts angegeben werden. Nach dem Setzen dieser Werte muss der Vertec Cloud Server neu gestartet werden.

Folgende Werte werden an OpenObserve gesendet:

• _timestamp: Zeitpunkt des Logeintrags im ISO-8601 Format
• hostName: Hostname des Rechners, auf dem der Prozess läuft
• level: Log-Level der Information (z.B. ERROR)
• licensee: Firmenname des Lizenznehmers
• loggerName: Name des betroffenen Loggers (z.B. Vertec.Session.BaseSessionContext)
• Message: Die eigentliche Log-Information (z.B. Handling message with low priority)
• process: Name des betroffenen Prozesses (z.B. Vertec.Session)
• threadname: Name oder ID des aktuellen Threads

Vor Vertec Version 6.7.0.12

Der Log Output kann aus den Vertec Prozessen (Vertec.Desktop, Vertec.CloudServer, Vertec.Session) an den cloudbasierten Logger Dienst Loggly gesendet werden.

Dafür müssen folgende Werte im Vertec.ini File im Abschnitt [Log] gesetzt werden:

• LogglyToken: Hier wird das kundenspezifische Loggly Token eingegeben. Ist dieser Wert gesetzt, wird der Log Output an Loggly bzw. an die angegebene LogglyUrl gesendet.
• LogglyUrl: Hier wird die gewünschte URL für Loggly angegeben. Falls nichts angegeben wird, wird der Output an ​https://logs-01.loggly.com/ gesendet.

Nach dem Setzen dieser Werte muss der Vertec Cloud Server neu gestartet werden.

Folgende Werte werden an Loggly gesendet:

• hostName: Hostname des Rechners, auf dem der Prozess läuft
• level: Log-Level der Information (z.B. ERROR)
• loggerName: Name des betroffenen Loggers (z.B. Vertec.Session.BaseSessionContext)
• Message: Die eigentliche Log-Information
• process: Name des betroffenen Prozesses (z.B. Vertec.Session)
• timestamp: Zeitpunkt des Logeintrags im ISO-8601 Format

Der Kundenname aus den Lizenzinformationen wird als Tag mitgeschickt, sofern er zum Zeitpunkt des Logeintrags verfügbar ist (sehr früh im Aufstartprozess sind diese Informationen noch nicht vorhanden).