Merge pull request #303 from NOAA-OWP/issue290

Towards consistent logging in all contexts, #290.
NOAA-OWP · Sep 4, 2024 · be40f00 · be40f00
2 parents a54811a + 4ab1243
commit be40f00
Show file tree

Hide file tree

Showing 7 changed files with 28 additions and 38 deletions.
diff --git 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
@@ -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
@@ -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,21 +23,20 @@
             <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>
 
             <!-- %nopexception: suppress stacktrace here -->
             <!-- %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
@@ -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
@@ -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
@@ -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,21 +22,20 @@
             <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>
 
             <!-- %nopexception: suppress stacktrace here -->
             <!-- %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
@@ -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>