major
#29383
Dead SOCKET_APPENDER (Chainsaw, localhost:4445) in default logging config can stall logging and abort operations under load
Die Standardkonfiguration für die Protokollierung (tl-core, WEB-INF/conf/logging/default.xml) definiert einen log4j2 -Socket -Appender namens SOCKET_APPENDER, der auf localhost:4445 ausgerichtet ist (vorgesehen für einen Chainsaw-Entwicklerempfänger). Er wird durch den SystemPropertyArbiter „tl_developerMode=true“ gesteuert und von <Root> referenziert, sodass im Entwicklermodus jedes protokollierte Ereignis an ihn weitergeleitet wird.
Wenn kein Empfänger auf Port 4445 lauscht (was im Entwicklermodus üblicherweise der Fall ist), hält der TcpSocketManager von log4j einen Reconnector im Hintergrund bereit und puffert Schreibvorgänge an den nicht erreichbaren Endpunkt. Bei einer Flut von Protokollmeldungen füllt sich der Sendepuffer des Sockets. Da das Framework unter der „AwaitCompletionReliabilityStrategy“ von log4j läuft, blockiert der Protokollierungsaufruf daraufhin und/oder löst innerhalb von `Logger.info(...)` eine `AppenderLoggingException` aus. Zwei Folgen:
- Die gesamte Protokollierungspipeline kommt zum Stillstand – der FILE_APPENDER empfängt keine Ereignisse mehr, sodass „top-logic.main.log“ einfriert, während die Anwendung weiterläuft.
- Der Fehler überträgt sich auf den aufrufenden Anwendungscode, der den Logging-Aufruf ausgelöst hat.
Beobachtete Auswirkung: Bei einem lang andauernden Hintergrundvorgang, der den Fortschritt über die TL-Script-Funktion log(...) protokollierte (~3200 Meldungen innerhalb weniger Sekunden), kam es zu einem Abbruch der Protokollierungspipeline; das Hauptprotokoll fror während der Ausführung ein und der Vorgang wurde stillschweigend an einer sauberen Batch-Grenze abgebrochen. Verkürzter Stack:
org.apache.logging.log4j.core.appender.AppenderLoggingException: Fehler beim Schreiben an TCP:localhost:4445: Socket nicht verfügbar
bei org.apache.logging.log4j.core.net.TcpSocketManager.write(TcpSocketManager.java:264)
bei org.apache.logging.log4j.core.appender.SocketAppender.directEncodeEvent(SocketAppender.java:598)
bei org.apache.logging.log4j.core.appender.AbstractOutputStreamAppender.append(...)
bei org.apache.logging.log4j.core.config.AwaitCompletionReliabilityStrategy.log(AwaitCompletionReliabilityStrategy.java:92)
bei org.apache.logging.log4j.core.Logger.log(Logger.java:187)
bei com.top_logic.basic.Logger.info(Logger.java:174)
Ein inaktiver/optionaler Entwicklungs-Appender darf niemals die Protokollierung in Datei oder Konsole blockieren oder die Anwendung zum Absturz bringen. Gewünschte Korrektur (eine der folgenden):
- Entfernen Sie SOCKET_APPENDER aus der Standardkonfiguration; oder
- Machen Sie ihn robust: Setzen Sie `ignoreExceptions="true"`, verpacken Sie ihn in einen Async-Appender und/oder aktivieren Sie ihn nur, wenn ein Empfänger auf Port 4445 tatsächlich erreichbar ist.
Workaround in einer Anwendung: Überschreiben Sie WEB-INF/conf/logging/default.xml und entfernen Sie die Definition des SOCKET_APPENDER- Appenders sowie dessen <Root> AppenderRef.
Migration
Entwickler, die Protokollereignisse an einen externen Protokoll-Viewer weiterleiten (z. B. Chainsaw, das auf localhost:4445 lauscht), müssen den SOCKET_APPENDER nun explizit aktivieren: Fügen Sie Folgendes hinzu
-Dtl_logReceiver=true
zu den VM-Argumenten der Startkonfiguration hinzu. Der Entwicklermodus (tl_developerMode=true) allein aktiviert den Appender nicht mehr. Host, Port und das serialisierte Ereignisformat bleiben unverändert. Entwickler, die keinen Log-Empfänger betreiben, müssen nichts ändern – der Appender ist nicht mehr Teil ihrer Logging-Konfiguration.
Anwendungen, die eine eigene Kopie der Protokollierungskonfiguration `WEB-INF/conf/logging/default.xml ` oder `debug.xml ` (geändert in `com.top_logic ` und `com.top_logic.kafka`) mitliefern, müssen die Änderung manuell in ihre Kopie übernehmen.
find . -path '*WEB-INF/conf/logging/*.xml'
Hinweis für Nutzer, die sich dafür entschieden haben: Der Appender läuft mit der Einstellung `ignoreExceptions="true"`; solange kein Empfänger erreichbar ist, werden für den Socket bestimmte Ereignisse stillschweigend verworfen – die Protokollierung in Dateien und auf der Konsole bleibt davon unberührt.