From 4ab1243da75d0c9f44240923670eddf9af948e58 Mon Sep 17 00:00:00 2001
From: James Brown <64858662+james-d-brown@users.noreply.github.com>
Date: Wed, 4 Sep 2024 16:58:23 +0100
Subject: [PATCH] Towards consistent logging in all contexts, #290.

---
 dist/lib/conf/logback.xml                   | 11 +++++------
 wres-eventsbroker/dist/lib/conf/logback.xml |  5 +++--
 wres-tasker/dist/lib/conf/logback.xml       | 10 ++++------
 wres-vis/dist/lib/conf/logback.xml          | 10 ++++------
 wres-worker/dist/lib/conf/inner_logback.xml | 10 ++++------
 wres-worker/dist/lib/conf/logback.xml       | 10 ++++------
 wres-writing/dist/lib/conf/logback.xml      | 10 ++++------
 7 files changed, 28 insertions(+), 38 deletions(-)

diff --git a/dist/lib/conf/logback.xml b/dist/lib/conf/logback.xml
index 26ae49d39f..2b1c3d8602 100644
--- a/dist/lib/conf/logback.xml
+++ b/dist/lib/conf/logback.xml
@@ -1,5 +1,4 @@
 <configuration>
-    <!-- Some prefer timestamps, thread name, level, class name, etc. -->
     <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
 
         <!-- Stop multiple JVMs from stepping on one another, see #52867 -->
@@ -23,13 +22,13 @@
           <!-- Always write the log files in UTF-8. -->
           <charset>UTF-8</charset>
 
-          <!-- %exception{full}: full stacktrace in log file.
-               %X{pid}: pid disambiguates multiple wres processes running. -->
-          <pattern>%d{yyyy-MM-dd'T'HH:mm:ss.SSSZ} %X{pid} [%thread] %level %logger - %msg%n%exception{full}</pattern>
+          <!-- %exception{full}: full stacktrace in log file. -->
+          <!-- %X{pid}: pid disambiguates multiple wres processes running. -->
+          <!-- %logger{0}: show only rightmost part of logger name (class) -->
+          <pattern>%d{yyyy-MM-dd'T'HH:mm:ss.SSSZ} %X{pid} [%thread] %level %logger{0} - %msg%n%exception{full}</pattern>
         </encoder>
     </appender>
 
-    <!-- some prefer the message to be printed as formatted in the code -->
     <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
 
         <!-- To allow DEBUG in FILE but only INFO on STDOUT, uncomment the
@@ -48,7 +47,7 @@
           <!-- %exception{short}: just the first line for each exception -->
           <!-- %exception{full}: full stacktrace for each exception -->
           <!-- %logger{0}: show only rightmost part of logger name (class) -->
-          <pattern>%d{yyyy-MM-dd'T'HH:mm:ss.SSSZ} %level %logger{0} %msg%n%exception{full}</pattern>
+          <pattern>%d{yyyy-MM-dd'T'HH:mm:ss.SSSZ} %X{pid} [%thread] %level %logger{0} - %msg%n%exception{full}</pattern>
         </encoder>
     </appender>
 
diff --git a/wres-eventsbroker/dist/lib/conf/logback.xml b/wres-eventsbroker/dist/lib/conf/logback.xml
index 45a239121e..0ec63eca51 100644
--- a/wres-eventsbroker/dist/lib/conf/logback.xml
+++ b/wres-eventsbroker/dist/lib/conf/logback.xml
@@ -2,8 +2,9 @@
     <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
         <encoder>
 
-            <!-- %exception{full}: full stacktrace in log file. -->
-            <pattern>%d{yyyy-MM-dd'T'HH:mm:ss.SSSZ} [%thread] %level %logger - %msg%n%exception{full}</pattern>
+            <!-- %exception{full}: full stacktrace for each exception -->
+            <!-- %logger{0}: show only rightmost part of logger name (class) -->
+            <pattern>%d{yyyy-MM-dd'T'HH:mm:ss.SSSZ} %X{pid} [%thread] %level %logger{0} - %msg%n%exception{full}</pattern>
         </encoder>
     </appender>
 
diff --git a/wres-tasker/dist/lib/conf/logback.xml b/wres-tasker/dist/lib/conf/logback.xml
index 10db181956..4945f398be 100644
--- a/wres-tasker/dist/lib/conf/logback.xml
+++ b/wres-tasker/dist/lib/conf/logback.xml
@@ -1,5 +1,4 @@
 <configuration>
-    <!-- Some prefer timestamps, thread name, level, class name, etc. -->
     <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
 
         <!-- Stop multiple JVMs from stepping on one another, see #52867 -->
@@ -24,13 +23,12 @@
             <cleanHistoryOnStart> true </cleanHistoryOnStart>
         </rollingPolicy>
         <encoder>
-            <!-- %exception{full}: full stacktrace in log file.
-                 %X{pid}: pid disambiguates multiple wres processes running. -->
-            <pattern>%d{yyyy-MM-dd'T'HH:mm:ss.SSSZ} %X{pid} [%thread] %level %logger - %msg%n%exception{full}</pattern>
+            <!-- %exception{full}: full stacktrace for each exception -->
+            <!-- %logger{0}: show only rightmost part of logger name (class) -->
+            <pattern>%d{yyyy-MM-dd'T'HH:mm:ss.SSSZ} %X{pid} [%thread] %level %logger{0} - %msg%n%exception{full}</pattern>
         </encoder>
     </appender>
 
-    <!-- some prefer the message to be printed as formatted in the code -->
     <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
         <encoder>
 
@@ -38,7 +36,7 @@
             <!-- %exception{short}: just the first line for each exception -->
             <!-- %exception{full}: full stacktrace for each exception -->
             <!-- %logger{0}: show only rightmost part of logger name (class) -->
-            <pattern>%d{yyyy-MM-dd'T'HH:mm:ss.SSSZ} %level %logger{0} %msg%n%exception{full}</pattern>
+            <pattern>%d{yyyy-MM-dd'T'HH:mm:ss.SSSZ} %X{pid} [%thread] %level %logger{0} - %msg%n%exception{full}</pattern>
         </encoder>
     </appender>
 
diff --git a/wres-vis/dist/lib/conf/logback.xml b/wres-vis/dist/lib/conf/logback.xml
index 474a2616e6..604a998679 100644
--- a/wres-vis/dist/lib/conf/logback.xml
+++ b/wres-vis/dist/lib/conf/logback.xml
@@ -1,5 +1,4 @@
 <configuration>
-    <!-- Some prefer timestamps, thread name, level, class name, etc. -->
     <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
 
         <!-- Stop multiple JVMs from stepping on one another, see #52867 -->
@@ -22,13 +21,12 @@
           <totalSizeCap>2048MB</totalSizeCap>
         </rollingPolicy>
         <encoder>
-          <!-- %exception{full}: full stacktrace in log file.
-               %X{pid}: pid disambiguates multiple wres processes running. -->
-          <pattern>%d{yyyy-MM-dd'T'HH:mm:ss.SSSZ} %X{pid} [%thread] %level %logger - %msg%n%exception{full}</pattern>
+          <!-- %exception{full}: full stacktrace for each exception -->
+          <!-- %logger{0}: show only rightmost part of logger name (class) -->
+          <pattern>%d{yyyy-MM-dd'T'HH:mm:ss.SSSZ} %X{pid} [%thread] %level %logger{0} - %msg%n%exception{full}</pattern>
         </encoder>
     </appender>
 
-    <!-- some prefer the message to be printed as formatted in the code -->
     <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
 
         <!-- To allow DEBUG in FILE but only INFO on STDOUT, uncomment the
@@ -46,7 +44,7 @@
           <!-- %exception{short}: just the first line for each exception -->
           <!-- %exception{full}: full stacktrace for each exception -->
           <!-- %logger{0}: show only rightmost part of logger name (class) -->
-          <pattern>%d{yyyy-MM-dd'T'HH:mm:ss.SSSZ} %level %logger{0} %msg%n%exception{full}</pattern>
+          <pattern>%d{yyyy-MM-dd'T'HH:mm:ss.SSSZ} %X{pid} [%thread] %level %logger{0} - %msg%n%exception{full}</pattern>
         </encoder>
     </appender>
 
diff --git a/wres-worker/dist/lib/conf/inner_logback.xml b/wres-worker/dist/lib/conf/inner_logback.xml
index 51ee187f15..72de5fd603 100644
--- a/wres-worker/dist/lib/conf/inner_logback.xml
+++ b/wres-worker/dist/lib/conf/inner_logback.xml
@@ -1,6 +1,5 @@
 <!-- Logback override for server deploys -->
 <configuration>
-    <!-- Some prefer timestamps, thread name, level, class name, etc. -->
     <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
 
         <!-- Stop multiple JVMs from stepping on one another, see #52867 -->
@@ -26,13 +25,12 @@
             <!-- Always write the log files in UTF-8. -->
             <charset>UTF-8</charset>
 
-            <!-- %exception{full}: full stacktrace in log file.
-                 %X{pid}: pid disambiguates multiple wres processes running. -->
-            <pattern>%d{yyyy-MM-dd'T'HH:mm:ss.SSSZ} %X{pid} [%thread] %level %logger - %msg%n%exception{full}</pattern>
+            <!-- %exception{full}: full stacktrace for each exception -->
+            <!-- %logger{0}: show only rightmost part of logger name (class) -->
+          <pattern>%d{yyyy-MM-dd'T'HH:mm:ss.SSSZ} %X{pid} [%thread] %level %logger{0} - %msg%n%exception{full}</pattern>
         </encoder>
     </appender>
 
-    <!-- some prefer the message to be printed as formatted in the code -->
     <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
 
         <!-- To allow DEBUG in FILE but only INFO on STDOUT, uncomment the
@@ -51,7 +49,7 @@
             <!-- %exception{short}: just the first line for each exception -->
             <!-- %exception{full}: full stacktrace for each exception -->
             <!-- %logger{0}: show only rightmost part of logger name (class) -->
-            <pattern>%d{yyyy-MM-dd'T'HH:mm:ss.SSSZ} %level %logger{0} %msg%n%exception{full}</pattern>
+            <pattern>%d{yyyy-MM-dd'T'HH:mm:ss.SSSZ} %X{pid} [%thread] %level %logger{0} - %msg%n%exception{full}</pattern>
         </encoder>
     </appender>
 
diff --git a/wres-worker/dist/lib/conf/logback.xml b/wres-worker/dist/lib/conf/logback.xml
index 2055f2b3b9..d1bd77ceda 100644
--- a/wres-worker/dist/lib/conf/logback.xml
+++ b/wres-worker/dist/lib/conf/logback.xml
@@ -1,5 +1,4 @@
 <configuration>
-    <!-- Some prefer timestamps, thread name, level, class name, etc. -->
     <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
         <!-- Stop multiple JVMs from stepping on one another, see #52867 -->
         <prudent>true</prudent>
@@ -23,13 +22,12 @@
             <cleanHistoryOnStart> true </cleanHistoryOnStart>
         </rollingPolicy>
         <encoder>
-            <!-- %exception{full}: full stacktrace in log file.
-                 %X{pid}: pid disambiguates multiple wres processes running. -->
-            <pattern>%d{yyyy-MM-dd'T'HH:mm:ss.SSSZ} %X{pid} [%thread] %level %logger - %msg%n%exception{full}</pattern>
+            <!-- %exception{full}: full stacktrace for each exception -->
+            <!-- %logger{0}: show only rightmost part of logger name (class) -->
+            <pattern>%d{yyyy-MM-dd'T'HH:mm:ss.SSSZ} %X{pid} [%thread] %level %logger{0} - %msg%n%exception{full}</pattern>
         </encoder>
     </appender>
 
-    <!-- some prefer the message to be printed as formatted in the code -->
     <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
         <encoder>
 
@@ -37,7 +35,7 @@
             <!-- %exception{short}: just the first line for each exception -->
             <!-- %exception{full}: full stacktrace for each exception -->
             <!-- %logger{0}: show only rightmost part of logger name (class) -->
-            <pattern>%d{yyyy-MM-dd'T'HH:mm:ss.SSSZ} %level %logger{0} %msg%n%exception{full}</pattern>
+            <pattern>%d{yyyy-MM-dd'T'HH:mm:ss.SSSZ} %X{pid} [%thread] %level %logger{0} - %msg%n%exception{full}</pattern>
         </encoder>
     </appender>
 
diff --git a/wres-writing/dist/lib/conf/logback.xml b/wres-writing/dist/lib/conf/logback.xml
index 7aa0d5cc42..8e3bec874f 100644
--- a/wres-writing/dist/lib/conf/logback.xml
+++ b/wres-writing/dist/lib/conf/logback.xml
@@ -1,5 +1,4 @@
 <configuration>
-    <!-- Some prefer timestamps, thread name, level, class name, etc. -->
     <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
 
         <!-- Stop multiple JVMs from stepping on one another, see #52867 -->
@@ -22,13 +21,12 @@
           <totalSizeCap>2048MB</totalSizeCap>
         </rollingPolicy>
         <encoder>
-          <!-- %exception{full}: full stacktrace in log file.
-               %X{pid}: pid disambiguates multiple wres processes running. -->
-          <pattern>%d{yyyy-MM-dd'T'HH:mm:ss.SSSZ} %X{pid} [%thread] %level %logger - %msg%n%exception{full}</pattern>
+          <!-- %exception{full}: full stacktrace for each exception -->
+          <!-- %logger{0}: show only rightmost part of logger name (class) -->
+          <pattern>%d{yyyy-MM-dd'T'HH:mm:ss.SSSZ} %X{pid} [%thread] %level %logger{0} - %msg%n%exception{full}</pattern>
         </encoder>
     </appender>
 
-    <!-- some prefer the message to be printed as formatted in the code -->
     <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
 
         <!-- To allow DEBUG in FILE but only INFO on STDOUT, uncomment the
@@ -46,7 +44,7 @@
           <!-- %exception{short}: just the first line for each exception -->
           <!-- %exception{full}: full stacktrace for each exception -->
           <!-- %logger{0}: show only rightmost part of logger name (class) -->
-          <pattern>%d{yyyy-MM-dd'T'HH:mm:ss.SSSZ} %level %logger{0} %msg%n%exception{full}</pattern>
+          <pattern>%d{yyyy-MM-dd'T'HH:mm:ss.SSSZ} %X{pid} [%thread] %level %logger{0} - %msg%n%exception{full}</pattern>
         </encoder>
     </appender>