Log API Improvements (#974)

mrodbratschi · claudiamurialdo · web-flow · commit fef68cbce5f1 · 2025-07-31T17:35:05.000Z
* Add custom JSON logging support with unescaped `data` and plain `message` fields

- Ensured `data` field is unescaped JSON, while `message` remains a simple String
- Updated `EcsLayout.json` to include `message`, `data`, and `context` fields (or add a new template)
- `context` is populated via MDC (`ThreadContext.put`) and supports simple key-value pairs

* Restore some changes

* New methods added

* A custom resolver is added to handle messages other than MapMessages to be compatible with the existing implementation of the log (the old implementation remains unchanged).

* Add a custom .json template that uses the custom resolver

* Refactoring

* Fix cyclic referencing of gxClassR

* Fix: AndroidLogger is not abstract and does not override abstract method isEnabled

* Fix: AndroidLogger is not abstract and does not override abstract methods

* Remove unnecessary comment

* Avoid code duplication

* Uses org.json instead of Gson

* Remove casting

* Ensure type safety

* Move it to the resources folder. When compiling it will be in the root of the jar

* Rename constant to WARN

* Explicitly prevent instantiation

* Plugin rename

* Build the message only if the loglevel is enabled

* Check if the log format is JSON once.

* Filters the stack trace to ignore the first lines called from this package

* Refactoring

* Maintain insertion order when logging JSONs

* The string "null" is written as a string and not as a null object (same as in .NET)

---------

Co-authored-by: claudiamurialdo &lt;33756655+claudiamurialdo@users.noreply.github.com&gt;
diff --git a/common/src/main/java/com/genexus/diagnostics/Log.java b/common/src/main/java/com/genexus/diagnostics/Log.java
@@ -7,63 +7,60 @@ public class Log {
 	private static ILogger getLogger() {
 		return getLogger("");
 	}
-	
+
 	public static ILogger getMainLogger() {
 		return LogManager.getLogger("com.genexus.logging");
 	}
-		
+
 	private static ILogger getLogger(String topic) {
 		ILogger log;
 		if (topic != null && topic.length() > 0) {
 			log = LogManager.getLogger(topic);
-		}
-		else {
+		} else {
 			log = getMainLogger();
 		}
 		return log;
 	}
-	
+
 	public static void write(int logLevel, String message, String topic) {
 		write(message, topic, logLevel);
 	}
-		
+
 	public static void write(String message, String topic, int logLevel) {
 		ILogger log = getLogger(topic);
-	
-		switch (logLevel) {			
-			case LogLevel.OFF: //LogLevel off
+		LogLevel level = LogLevel.fromInt(logLevel);
+
+		switch (level) {
+			case OFF: //LogLevel off
 				break;
-			case LogLevel.TRACE:
+			case TRACE:
 				log.trace(message);
 				break;
-			case LogLevel.DEBUG:
-				log.debug(message);
-				break;
-			case LogLevel.INFO:
+			case INFO:
 				log.info(message);
 				break;
-			case LogLevel.WARNING:
+			case WARN:
 				log.warn(message);
 				break;
-			case LogLevel.ERROR:
+			case ERROR:
 				log.error(message);
 				break;
-			case LogLevel.FATAL:
+			case FATAL:
 				log.fatal(message);
 				break;
 			default:
-				log.debug(message);			
-		}		
+				log.debug(message);
+		}
 	}
-	
+
 	public static void write(String message) {
 		getLogger().debug(message);
 	}
-	
+
 	public static void write(String message, String topic) {
 		getLogger(topic).debug(message);
 	}
-	
+
 	public static void error(String message) {
 		getLogger().error(message);
 	}
@@ -87,7 +84,7 @@ public static void fatal(String message, String topic) {
 	public static void fatal(String message, String topic, Throwable ex) {
 		getLogger(topic).fatal(message, ex);
 	}
-	
+
 	public static void warning(String message) {
 		getLogger().warn(message);
 	}
@@ -115,7 +112,7 @@ public static void debug(String message) {
 	public static void debug(String message, String topic) {
 		getLogger(topic).debug(message);
 	}
-	
+
 	public static void debug(String message, String topic, Throwable ex) {
 		getLogger(topic).debug(message, ex);
 	}
diff --git a/common/src/main/java/com/genexus/diagnostics/LogLevel.java b/common/src/main/java/com/genexus/diagnostics/LogLevel.java
@@ -1,14 +1,24 @@
 package com.genexus.diagnostics;
 
-public class LogLevel {
-	
-	static final int OFF = 0;
-	static final int TRACE = 1;
-	static final int DEBUG = 5;
-	static final int INFO = 10;
-	static final int WARNING = 15;
-	static final int ERROR = 20;
-	static final int FATAL = 30;
-	
-	
+public enum LogLevel {
+	OFF(0),
+	TRACE(1),
+	DEBUG(5),
+	INFO(10),
+	WARN(15),
+	ERROR(20),
+	FATAL(30);
+
+	private final int lvl;
+	LogLevel(int lvl) { this.lvl = lvl; }
+	public int intValue() { return lvl; }
+
+	public static LogLevel fromInt(int lvl) {
+		for (LogLevel level : LogLevel.values()) {
+			if (level.intValue() == lvl) {
+				return level;
+			}
+		}
+		return LogLevel.OFF;
+	}
 }
diff --git a/common/src/main/java/com/genexus/diagnostics/UserLog.java b/common/src/main/java/com/genexus/diagnostics/UserLog.java
@@ -19,37 +19,34 @@ public static ILogger getMainLogger() {
 	private static ILogger getLogger(String topic) {
 		ILogger log;
 		if (topic != null && topic.length() > 0) {
-			String loggerName = topic.startsWith("$") ? topic.substring(1): String.format("%s.%s", defaultUserLogNamespace, topic.trim());
+			String loggerName = topic.startsWith("$") ? topic.substring(1) : String.format("%s.%s", defaultUserLogNamespace, topic.trim());
 			log = LogManager.getLogger(loggerName);
-		}
-		else {
+		} else {
 			log = getMainLogger();
 		}
 		return log;
 	}
 
-	public static void write( int logLevel, String message, String topic) {
+	public static void write(int logLevel, String message, String topic) {
 		ILogger log = getLogger(topic);
+		LogLevel level = LogLevel.fromInt(logLevel);
 
-		switch (logLevel) {
-			case LogLevel.OFF: //LogLevel off
+		switch (level) {
+			case OFF: //LogLevel off
 				break;
-			case LogLevel.TRACE:
+			case TRACE:
 				log.trace(message);
 				break;
-			case LogLevel.DEBUG:
-				log.debug(message);
-				break;
-			case LogLevel.INFO:
+			case INFO:
 				log.info(message);
 				break;
-			case LogLevel.WARNING:
+			case WARN:
 				log.warn(message);
 				break;
-			case LogLevel.ERROR:
+			case ERROR:
 				log.error(message);
 				break;
-			case LogLevel.FATAL:
+			case FATAL:
 				log.fatal(message);
 				break;
 			default:
@@ -120,4 +117,51 @@ public static void debug(String message, String topic) {
 	public static void debug(String message, String topic, Throwable ex) {
 		getLogger(topic).debug(message, ex);
 	}
+
+	public static void setContext(String key, Object value) {
+		// Topic is ignored, also if you put something
+		getLogger("$").setContext(key, value);
+	}
+
+	public static void write(String message, String topic, int logLevel, Object data, boolean stackTrace) {
+		getLogger(topic).write(message, logLevel, data, stackTrace);
+	}
+
+	public static void write(String message, String topic, int logLevel, Object data) {
+		write(message, topic, logLevel, data, false);
+	}
+
+	public static boolean isDebugEnabled() {
+		return getLogger().isDebugEnabled();
+	}
+
+	public static boolean isErrorEnabled() {
+		return getLogger().isErrorEnabled();
+	}
+
+	public static boolean isFatalEnabled() {
+		return getLogger().isFatalEnabled();
+	}
+
+	public static boolean isInfoEnabled() {
+		return getLogger().isInfoEnabled();
+	}
+
+	public static boolean isWarnEnabled() {
+		return getLogger().isWarnEnabled();
+	}
+
+	public static boolean isTraceEnabled() {
+		return getLogger().isTraceEnabled();
+	}
+
+	public static boolean isEnabled(int logLevel) {
+		return getLogger().isEnabled(logLevel);
+	}
+
+	public static boolean isEnabled(int logLevel, String topic) {
+		return getLogger(topic).isEnabled(logLevel);
+	}
+
+
 }
diff --git a/common/src/main/java/com/genexus/diagnostics/core/ILogger.java b/common/src/main/java/com/genexus/diagnostics/core/ILogger.java
@@ -1,37 +1,37 @@
 package com.genexus.diagnostics.core;
 
 public interface ILogger {
-	
+
 	void fatal(String msg, Throwable ex);
 
 	void fatal(String msg1, String msg2, Throwable ex);
 
 	void fatal(Throwable ex, String[] list);
 
 	void fatal(String[] list);
-	
+
 	void fatal(String msg);
-	
+
 	void error(String msg, Throwable ex);
 
 	void error(String msg1, String msg2, Throwable ex);
 
 	void error(Throwable ex, String[] list);
 
 	void error(String[] list);
-	
+
 	void error(String msg);
 
 	void warn(String msg);
-	
+
 	void warn(Throwable ex, String[] list);
 
 	void warn(String[] list);
 
 	void warn(String msg, Throwable ex);
 
 	void debug(String msg);
-	
+
 	void debug(Throwable ex, String[] list);
 
 	void debug(String[] list);
@@ -41,19 +41,19 @@ public interface ILogger {
 	void debug(String msg, Throwable ex);
 
 	void info(String[] list);
-	
+
 	void info(String msg);
 
 	void trace(String msg);
-	
+
 	void trace(Throwable ex, String[] list);
 
 	void trace(String[] list);
 
 	void trace(String msg1, String msg2, Throwable ex);
 
 	void trace(String msg, Throwable ex);
-	
+
 	boolean isDebugEnabled();
 
 	boolean isErrorEnabled();
@@ -65,5 +65,18 @@ public interface ILogger {
 	 * msg); } }
 	 */
 
-	
+	default void setContext(String key, Object value) {}
+
+	default void write(String message, int logLevel, Object data, boolean stackTrace) {}
+
+	default boolean isFatalEnabled() { return false; }
+
+	default boolean isWarnEnabled() { return false; }
+
+	default boolean isInfoEnabled() { return false; }
+
+	default boolean isTraceEnabled() { return false; }
+
+	default boolean isEnabled(int logLevel) { return false; }
+
 }
diff --git a/wrappercommon/pom.xml b/wrappercommon/pom.xml
@@ -33,8 +33,13 @@
 			<groupId>org.apache.ws.security</groupId>
 			<artifactId>wss4j</artifactId>
 			<version>1.6.19</version>			
-		</dependency>		        			
-	</dependencies>	
+		</dependency>
+        <dependency>
+            <groupId>org.apache.logging.log4j</groupId>
+            <artifactId>log4j-layout-template-json</artifactId>
+            <version>2.24.3</version>
+        </dependency>
+    </dependencies>
 
 	<build>
 		<finalName>gxwrappercommon</finalName>
diff --git a/wrappercommon/src/main/java/com/genexus/diagnostics/core/provider/CustomMessageFactory.java b/wrappercommon/src/main/java/com/genexus/diagnostics/core/provider/CustomMessageFactory.java
@@ -0,0 +1,30 @@
+package com.genexus.diagnostics.core.provider;
+
+import org.apache.logging.log4j.core.config.plugins.Plugin;
+import org.apache.logging.log4j.core.config.plugins.PluginFactory;
+import org.apache.logging.log4j.layout.template.json.resolver.EventResolverContext;
+import org.apache.logging.log4j.layout.template.json.resolver.EventResolverFactory;
+import org.apache.logging.log4j.layout.template.json.resolver.TemplateResolverConfig;
+import org.apache.logging.log4j.layout.template.json.resolver.TemplateResolverFactory;
+
+
+@Plugin(name = "CustomMessage", category = TemplateResolverFactory.CATEGORY)
+public final class CustomMessageFactory implements EventResolverFactory {
+	private static final CustomMessageFactory INSTANCE = new CustomMessageFactory();
+	private CustomMessageFactory() { /* no instances */ }
+
+	@PluginFactory
+	public static CustomMessageFactory getInstance() {
+		return INSTANCE;
+	}
+
+	@Override
+	public String getName() {
+		return CustomMessageResolver.getName();
+	}
+
+	@Override
+	public CustomMessageResolver create(EventResolverContext context, TemplateResolverConfig config) {
+		return new CustomMessageResolver(config);
+	}
+}
diff --git a/wrappercommon/src/main/java/com/genexus/diagnostics/core/provider/CustomMessageResolver.java b/wrappercommon/src/main/java/com/genexus/diagnostics/core/provider/CustomMessageResolver.java
diff --git a/wrappercommon/src/main/java/com/genexus/diagnostics/core/provider/Log4J2Logger.java b/wrappercommon/src/main/java/com/genexus/diagnostics/core/provider/Log4J2Logger.java
diff --git a/wrappercommon/src/main/resources/CustomEcsLayout.json b/wrappercommon/src/main/resources/CustomEcsLayout.json
