Merge pull request #83 from j-denner/use-static-loggers

KarstenSchnitter · web-flow · commit 8758ff815d78 · 2020-11-26T14:21:06.000+01:00
Use static loggers (or on-demand creation by holder)
diff --git a/cf-java-logging-support-core/src/main/java/com/sap/hcp/cf/logging/common/LogContext.java b/cf-java-logging-support-core/src/main/java/com/sap/hcp/cf/logging/common/LogContext.java
@@ -112,11 +112,14 @@ private static void setOrGenerateCorrelationId(String correlationId) {
         }
     }
 
+    private static class LoggerHolder {
+        static final Logger LOG = LoggerFactory.getLogger(LoggerHolder.class.getEnclosingClass());
+    }
+
     private static void generateAndSetCorrelationId() {
         String generatedCorrelationId = String.valueOf(UUID.randomUUID());
         setCorrelationId(generatedCorrelationId);
 
-        Logger logger = LoggerFactory.getLogger(LogContext.class);
-        logger.info("generated new correlation id");
+        LoggerHolder.LOG.info("generated new correlation id");
     }
 }
diff --git a/cf-java-logging-support-core/src/main/java/com/sap/hcp/cf/logging/common/VcapEnvReader.java b/cf-java-logging-support-core/src/main/java/com/sap/hcp/cf/logging/common/VcapEnvReader.java
@@ -4,6 +4,7 @@
 import java.util.Map;
 import java.util.Set;
 
+import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 import com.fasterxml.jackson.jr.ob.JSON;
@@ -22,6 +23,8 @@
  */
 public class VcapEnvReader {
 
+    private static final Logger LOG = LoggerFactory.getLogger(VcapEnvReader.class);
+
     public static final String ENV_VCAP_APPLICATION = "VCAP_APPLICATION";
     public static final String ENV_CF_INSTANCE_IP = "CF_INSTANCE_IP";
     public static final String ENV_LANSCAPE_ID = "LANDSCAPE_ID";
@@ -85,7 +88,7 @@ public static void getAppInfos(Map<String, String> tags, Set<String> envKeys) {
                 addField(tags, envKeys, envMap, CF_ORGANIZATION_ID, Fields.ORGANIZATION_ID);
                 addField(tags, envKeys, envMap, CF_ORGANIZATION_NAME, Fields.ORGANIZATION_NAME);
             } catch (Exception ex) {
-                LoggerFactory.getLogger(VcapEnvReader.class).error("Cannot get infos from environment", ex);
+                LOG.error("Cannot get infos from environment", ex);
                 return;
             }
         }
diff --git a/cf-java-logging-support-core/src/main/java/com/sap/hcp/cf/logging/common/converter/DefaultCustomFieldsConverter.java b/cf-java-logging-support-core/src/main/java/com/sap/hcp/cf/logging/common/converter/DefaultCustomFieldsConverter.java
@@ -6,6 +6,7 @@
 import java.util.List;
 import java.util.Map;
 
+import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 import com.fasterxml.jackson.core.JsonProcessingException;
@@ -33,6 +34,10 @@ public void setCustomFieldKeyNames(List<String> customFieldKeyNames) {
 		this.customFieldKeyNames = customFieldKeyNames;
 	}
 
+    private static class LoggerHolder {
+        static final Logger LOG = LoggerFactory.getLogger(LoggerHolder.class.getEnclosingClass());
+    }
+
 	public void convert(StringBuilder appendTo, Map<String, String> mdcPropertiesMap, Object... arguments) {
 		if (customFieldKeyNames.isEmpty()) {
 			return;
@@ -46,7 +51,7 @@ public void convert(StringBuilder appendTo, Map<String, String> mdcPropertiesMap
 				finishJson(oc, appendTo);
 			} catch (Exception ex) {
 				/* -- avoids substitute logger warnings on startup -- */
-				LoggerFactory.getLogger(DefaultCustomFieldsConverter.class).error("Conversion failed ", ex);
+				LoggerHolder.LOG.error("Conversion failed ", ex);
 			}
 		}
 	}
diff --git a/cf-java-logging-support-core/src/main/java/com/sap/hcp/cf/logging/common/converter/DefaultMessageConverter.java b/cf-java-logging-support-core/src/main/java/com/sap/hcp/cf/logging/common/converter/DefaultMessageConverter.java
@@ -1,5 +1,6 @@
 package com.sap.hcp.cf.logging.common.converter;
 
+import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 import com.fasterxml.jackson.jr.ob.JSON;
@@ -29,6 +30,10 @@ public void setEscape(boolean escape) {
         this.escape = escape;
     }
 
+    private static class LoggerHolder {
+        static final Logger LOG = LoggerFactory.getLogger(LoggerHolder.class.getEnclosingClass());
+    }
+
     public void convert(String message, StringBuilder appendTo) {
         if (message != null) {
             String result;
@@ -42,7 +47,7 @@ public void convert(String message, StringBuilder appendTo) {
                     appendTo.append(JSON.std.asString(result));
                 } catch (Exception ex) {
                     /* -- avoids substitute logger warnings on startup -- */
-                    LoggerFactory.getLogger(DefaultMessageConverter.class).error("Conversion failed ", ex);
+                    LoggerHolder.LOG.error("Conversion failed ", ex);
                     appendTo.append(result);
                 }
             } else {
diff --git a/cf-java-logging-support-core/src/main/java/com/sap/hcp/cf/logging/common/converter/DefaultPropertiesConverter.java b/cf-java-logging-support-core/src/main/java/com/sap/hcp/cf/logging/common/converter/DefaultPropertiesConverter.java
@@ -7,6 +7,7 @@
 import java.util.Map.Entry;
 import java.util.Set;
 
+import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.slf4j.MDC;
 
@@ -30,6 +31,10 @@ public void setExclusions(List<String> exclusionList) {
         }
     }
 
+    private static class LoggerHolder {
+        static final Logger LOG = LoggerFactory.getLogger(LoggerHolder.class.getEnclosingClass());
+    }
+
     public void convert(StringBuilder appendTo, Map<String, String> eventProperties) {
         Map<String, String> properties = mergeContextMaps(eventProperties);
         if (properties != null && !properties.isEmpty()) {
@@ -48,7 +53,7 @@ public void convert(StringBuilder appendTo, Map<String, String> eventProperties)
                 appendTo.append(result.substring(1, result.length() - 1));
             } catch (Exception ex) {
                 /* -- avoids substitute logger warnings on startup -- */
-                LoggerFactory.getLogger(DefaultPropertiesConverter.class).error("Conversion failed ", ex);
+                LoggerHolder.LOG.error("Conversion failed ", ex);
             }
         }
     }
diff --git a/cf-java-logging-support-core/src/main/java/com/sap/hcp/cf/logging/common/converter/DefaultStacktraceConverter.java b/cf-java-logging-support-core/src/main/java/com/sap/hcp/cf/logging/common/converter/DefaultStacktraceConverter.java
@@ -3,6 +3,7 @@
 import java.io.PrintWriter;
 import java.util.List;
 
+import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 import com.fasterxml.jackson.jr.ob.JSON;
@@ -21,6 +22,10 @@ public DefaultStacktraceConverter() {
         this.maxSize = maxSize;
     }
 
+    private static class LoggerHolder {
+        static final Logger LOG = LoggerFactory.getLogger(LoggerHolder.class.getEnclosingClass());
+    }
+
     @Override
     public void convert(Throwable t, StringBuilder appendTo) {
         if (t == null) {
@@ -50,7 +55,7 @@ public void convert(Throwable t, StringBuilder appendTo) {
             appendTo.append(ac.end().finish());
         } catch (Exception ex) {
             /* -- avoids substitute logger warnings on startup -- */
-            LoggerFactory.getLogger(DefaultStacktraceConverter.class).error("Conversion failed ", ex);
+            LoggerHolder.LOG.error("Conversion failed ", ex);
         }
     }
 }
diff --git a/cf-java-logging-support-logback/src/main/java/com/sap/hcp/cf/logback/converter/CategoriesConverter.java b/cf-java-logging-support-logback/src/main/java/com/sap/hcp/cf/logback/converter/CategoriesConverter.java
@@ -3,6 +3,7 @@
 import java.io.IOException;
 import java.util.Iterator;
 
+import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.slf4j.Marker;
 
@@ -33,13 +34,17 @@ public void start() {
         super.start();
     }
 
+    private static class LoggerHolder {
+        static final Logger LOG = LoggerFactory.getLogger(LoggerHolder.class.getEnclosingClass());
+    }
+
     private void getMarkers(Marker marker, StringBuilder appendTo) {
         try {
             ArrayComposer<JSONComposer<String>> ac = JSON.std.composeString().startArray();
             getMarkersRecursively(marker, ac);
             appendTo.append(ac.end().finish());
         } catch (IOException ex) {
-            LoggerFactory.getLogger(CategoriesConverter.class).error("conversion failed", ex);
+            LoggerHolder.LOG.error("conversion failed", ex);
         }
     }
 

Original file line number	Diff line number	Diff line change
`@@ -112,11 +112,14 @@ private static void setOrGenerateCorrelationId(String correlationId) {`
`112`	`112`	`}`
`113`	`113`	`}`
`114`	`114`
	`115`	`+ private static class LoggerHolder {`
	`116`	`+ static final Logger LOG = LoggerFactory.getLogger(LoggerHolder.class.getEnclosingClass());`
	`117`	`+ }`
	`118`	`+`
`115`	`119`	`private static void generateAndSetCorrelationId() {`
`116`	`120`	`String generatedCorrelationId = String.valueOf(UUID.randomUUID());`
`117`	`121`	`setCorrelationId(generatedCorrelationId);`
`118`	`122`
`119`		`- Logger logger = LoggerFactory.getLogger(LogContext.class);`
`120`		`- logger.info("generated new correlation id");`
	`123`	`+ LoggerHolder.LOG.info("generated new correlation id");`
`121`	`124`	`}`
`122`	`125`	`}`
Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,7 @@`
`6`	`6`	`import java.util.List;`
`7`	`7`	`import java.util.Map;`
`8`	`8`
	`9`	`+import org.slf4j.Logger;`
`9`	`10`	`import org.slf4j.LoggerFactory;`
`10`	`11`
`11`	`12`	`import com.fasterxml.jackson.core.JsonProcessingException;`
`@@ -33,6 +34,10 @@ public void setCustomFieldKeyNames(List<String> customFieldKeyNames) {`
`33`	`34`	`this.customFieldKeyNames = customFieldKeyNames;`
`34`	`35`	`}`
`35`	`36`
	`37`	`+ private static class LoggerHolder {`
	`38`	`+ static final Logger LOG = LoggerFactory.getLogger(LoggerHolder.class.getEnclosingClass());`
	`39`	`+ }`
	`40`	`+`
`36`	`41`	`public void convert(StringBuilder appendTo, Map<String, String> mdcPropertiesMap, Object... arguments) {`
`37`	`42`	`if (customFieldKeyNames.isEmpty()) {`
`38`	`43`	`return;`
`@@ -46,7 +51,7 @@ public void convert(StringBuilder appendTo, Map<String, String> mdcPropertiesMap`
`46`	`51`	`finishJson(oc, appendTo);`
`47`	`52`	`} catch (Exception ex) {`
`48`	`53`	`/* -- avoids substitute logger warnings on startup -- */`
`49`		`- LoggerFactory.getLogger(DefaultCustomFieldsConverter.class).error("Conversion failed ", ex);`
	`54`	`+ LoggerHolder.LOG.error("Conversion failed ", ex);`
`50`	`55`	`}`
`51`	`56`	`}`
`52`	`57`	`}`
Original file line number	Diff line number	Diff line change
`@@ -7,6 +7,7 @@`
`7`	`7`	`import java.util.Map.Entry;`
`8`	`8`	`import java.util.Set;`
`9`	`9`
	`10`	`+import org.slf4j.Logger;`
`10`	`11`	`import org.slf4j.LoggerFactory;`
`11`	`12`	`import org.slf4j.MDC;`
`12`	`13`
`@@ -30,6 +31,10 @@ public void setExclusions(List<String> exclusionList) {`
`30`	`31`	`}`
`31`	`32`	`}`
`32`	`33`
	`34`	`+ private static class LoggerHolder {`
	`35`	`+ static final Logger LOG = LoggerFactory.getLogger(LoggerHolder.class.getEnclosingClass());`
	`36`	`+ }`
	`37`	`+`
`33`	`38`	`public void convert(StringBuilder appendTo, Map<String, String> eventProperties) {`
`34`	`39`	`Map<String, String> properties = mergeContextMaps(eventProperties);`
`35`	`40`	`if (properties != null && !properties.isEmpty()) {`
`@@ -48,7 +53,7 @@ public void convert(StringBuilder appendTo, Map<String, String> eventProperties)`
`48`	`53`	`appendTo.append(result.substring(1, result.length() - 1));`
`49`	`54`	`} catch (Exception ex) {`
`50`	`55`	`/* -- avoids substitute logger warnings on startup -- */`
`51`		`- LoggerFactory.getLogger(DefaultPropertiesConverter.class).error("Conversion failed ", ex);`
	`56`	`+ LoggerHolder.LOG.error("Conversion failed ", ex);`
`52`	`57`	`}`
`53`	`58`	`}`
`54`	`59`	`}`
Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,7 @@`
`3`	`3`	`import java.io.PrintWriter;`
`4`	`4`	`import java.util.List;`
`5`	`5`
	`6`	`+import org.slf4j.Logger;`
`6`	`7`	`import org.slf4j.LoggerFactory;`
`7`	`8`
`8`	`9`	`import com.fasterxml.jackson.jr.ob.JSON;`
`@@ -21,6 +22,10 @@ public DefaultStacktraceConverter() {`
`21`	`22`	`this.maxSize = maxSize;`
`22`	`23`	`}`
`23`	`24`
	`25`	`+ private static class LoggerHolder {`
	`26`	`+ static final Logger LOG = LoggerFactory.getLogger(LoggerHolder.class.getEnclosingClass());`
	`27`	`+ }`
	`28`	`+`
`24`	`29`	`@Override`
`25`	`30`	`public void convert(Throwable t, StringBuilder appendTo) {`
`26`	`31`	`if (t == null) {`
`@@ -50,7 +55,7 @@ public void convert(Throwable t, StringBuilder appendTo) {`
`50`	`55`	`appendTo.append(ac.end().finish());`
`51`	`56`	`} catch (Exception ex) {`
`52`	`57`	`/* -- avoids substitute logger warnings on startup -- */`
`53`		`- LoggerFactory.getLogger(DefaultStacktraceConverter.class).error("Conversion failed ", ex);`
	`58`	`+ LoggerHolder.LOG.error("Conversion failed ", ex);`
`54`	`59`	`}`
`55`	`60`	`}`
`56`	`61`	`}`