Fehlerbehandlung

• Ab Version S 39.5.9 werden zwei Versionen der Konfigurationsdatei geliefert (logback.xml und logback_debug.xml). Um die Erstellung eines session-basierten Logfiles zu aktivieren, müssen die Dateien lediglich wie nachfolgend beschrieben umbenannt werden.

Vorgehensweise

• NEU Im Verzeichnis des PLANTA-Servers die Datei logback.xml beliebig umbenennen.
• NEU Die Datei logback_debug.xml in logback.xml umbenennen.
• PLANTA project neustarten.
  • Bei Neustart von PLANTA project wird im Ordner log des Server-Serverzeichnisses das Logfile oder unter Umständen mehrere Logfiles abgelegt.
• Den Fehler reproduzieren.
  • Um die Größe des Logfiles so gering wie möglich zu halten und damit die Analyse des Logfiles zu vereinfachen, führen Sie bitte ausschließlich die Schritte aus, die für die Reproduktion dieses Fehlers benötigt werden.
• Den gesamten Server-Log-Ordner an PLANTA schicken mit der Angabe der ID der Session, in der der Fehler auftritt. Die Session-ID finden Sie im Modul Systeminformation (STRG+B) im Datenfeld Session-ID.
  • Bitte denken Sie ggf. an die Verschlüsselung der Daten, wenn Sie den Log-Ordner an PLANTA schicken, da die Logfiles unter Umständen sensible Daten enthalten können.
• Anschließend die am Anfang getätigten Dateien-Umbenennungen wieder rückgängig machen, um das Logfile zu deaktivieren.

• Um die Erstellung eines session-basierten Logfiles für die Fehleranalyse zu aktivieren, müssen bestimmte Anpassungen in der Konfigurationsdatei logback.xml vorgenommen werden. Die Datei befindet sich im Installationsverzeichnis unter conf/logback.xml.

Vorgehensweise

• Um den Grad der Ausführlichkeit für die Fehleranalyse zu erhöhen, muss zunächst das Log-Level für den PLANTA Namespace "de.planta.server" angepasst werden:

[...]
<!-- enable this for tracing/debugging logs in the PLANTA namespace -->
<logger name="de.planta.server" level="debug"/>
[...]

• Weiterhin muss das session-basierte Logging eingeschaltet werden. Hierzu ist der folgende Block in der mitgelieferten Konfiguration einzukommentieren:

[...]
<!-- enable the following to enable session logs; don't forget to
uncommment the appender-ref to SESSIONLOG additionally
-->
<appender name="SESSIONLOG" class="ch.qos.logback.classic.sift.SiftingAppender">
<discriminator>
<key>sessionId</key>
<defaultValue>global</defaultValue>
</discriminator>
<sift>
<appender name="FILE-${sessionId}" class="ch.qos.logback.core.FileAppender">
<file>log/PlantaSession-${sessionId}.log</file>
<append>false</append>
<encoder>
<pattern>%d{HH:mm:ss.SSS} %level %marker %logger{35} - %msg%n</pattern>
</encoder>
</appender>
</sift>
</appender>
[...]

• Der Appender "SESSIONLOG" muss nun auch referenziert werden:

[...]
<!-- enable logging for messages with level <= info -->
<root level="info">
<appender-ref ref="CONSOLE" />
<appender-ref ref="SERVERLOG" />
<appender-ref ref="SESSIONLOG" />
</root>

</configuration>

• PLANTA project neustarten.
  • Bei Neustart von PLANTA project wird im Ordner log des Server-Verzeichnisses das Logfile oder unter Umständen mehrere Logfiles abgelegt.
• Den Fehler reproduzieren.
  • Um die Größe der Logfiles so gering wie möglich zu halten und damit die Analyse der Logfiles zu vereinfachen, führen Sie bitte ausschließlich die Schritte aus, die für die Reproduktion dieses Fehlers benötigt werden.Tritt der Fehler nicht auf, bittet lassen sie das Logging eingeschaltet, bis der Fehler auftritt.
• Den gesamten Server-Log-Ordner als zip-Archiv an PLANTA schicken mit der Angabe der ID der Session, in der der Fehler auftritt. Die Session-ID finden den Sie im Modul Systeminformation (STRG+B) im Datenfeld Session-ID.
  • Bitte denken Sie ggf. an die Verschlüsselung der Daten, wenn Sie den Log-Ordner an PLANTA schicken, da die Logfiles unter Umständen sensible Daten enthalten können.
• Anschließend die am Anfang durchgeführten Änderungen an der logback.xml -Datei zurücksetzen, um das Logfile zu deaktivieren.

• Im Verzeichnis des PLANTA-Servers in der ppms.conf oder planta.conf (je nach dem welche PLANTA-Version bei Ihnen im Einsatz ist) die folgenden Parameter setzen:
  • LOG_LEVEL = 15
  • PLANTA_LOG_VERBOSE_SQL = 1
• Im Falle eines Programmabsturzes zusätzlich:
  • PLANTA_LOG_FLUSH = 1
• NEU Der Server muss neu gestartet werden. Dies kann in PLANTA project über den Button Server-Neustart im Modul Dataitems, den Menüpunkt Server-Neustart oder über die Python-Funktion reload_server(). Die Änderungen an der .conf gelten nun für alle neu geöffneten Sessions ( Wurden Änderungen an Dataitems, Datentabellen etc. durchgeführt, gelten diese nach Neustart auch für alle neu gestarteten Sessions.)
  • Wird der PLANTA-Dienst neugestartet, werden alle geöffneten Sessions geschlossen.
• PLANTA project neustarten.
• Bei Neustart von PLANTA project wird im Server-Verzeichnis ein Ordner log angelegt. In diesem werden pro Session zwei Server-Logfiles abgelegt.
  • NEU planta.Session-ID.yyyy-mm-dd_hh-mm-ss.debug.log
  • NEU planta.Session-ID.yyyy-mm-dd_hh-mm-ss.log
    • Das Debug-Logfile beinhaltet alle Informationen, während der andere Logfile-Typ nur bestimmte Informationen ausgibt.
    • NEU Sind mehrere Sessions gleichzeitig offen, kann das entsprechende Logfile über die Session-ID identifiziert werden. Dieses finden Sie im Modul Systeminformation (STRG+B) im Datenfeld Session-ID.
• Den Fehler reproduzieren.
  • Um die Größe des Logfiles so gering wie möglich zu halten und damit die Analyse des Logfiles zu vereinfachen, führen Sie bitte ausschließlich die Schritte aus, die für die Reproduktion dieses Fehlers benötigt werden.
• Die Logfiles der betreffenden Session an PLANTA schicken.
• Anschließend das Logfile wieder deaktivieren.

Details

• Bei dem Datum bzw. der Uhrzeit in den Namen der Logfiles handelt es sich um die Startzeit der entsprechenden Session.

Vorgehensweise

• Im Verzeichnis des PLANTA-Servers in der ppms.conf oder planta.conf (je nach dem welche PLANTA-Version bei Ihnen im Einsatz ist) die folgenden Parameter setzen:
  • LOG_LEVEL = 15
  • PLANTA_LOG_VERBOSE_SQL = 1
• Im Falle eines Programmabsturzes zusätzlich:
  • PLANTA_LOG_FLUSH = 1
• Läuft PLANTA project auf Windows, muss an der Stelle der Server neu gestartet werden.
• PLANTA project neustarten. Dabei wird im Server-Verzeichnis ein Ordner log angelegt. In diesem werden pro Session drei Server-Logfiles abgelegt.
  • ppms.PID.yyyy-mm-dd_hh-mm-ss.debug.log
  • ppms.PID.yyyy-mm-dd_hh-mm-ss.log
  • ppms.PID.stderr.log
    • Das Debug-Logfile beinhaltet alle Informationen, während die anderen Logfiles nur bestimmte Informationen ausgeben.
    • Sind mehrere Sessions gleichzeitig offen, kann das entsprechende Logfile über die PID identifiziert werden. Dieses finden Sie im Modul Systeminformation (STRG+B) im Datenfeld PID.
• Den Fehler reproduzieren.
  • Um die Größe des Logfiles so gering wie möglich zu halten und damit die Analyse des Logfiles zu vereinfachen, führen Sie bitte ausschließlich die Schritte aus, die für die Reproduktion dieses Fehlers benötigt werden.
• Die Logfiles der betreffenden Session an PLANTA schicken.
• Anschließend das Logfile wieder deaktivieren.

Details

• Bei dem Datum bzw. der Uhrzeit in den Namen der Logfiles handelt es sich um die Startzeit der entsprechenden Session.