Merge pull request #15 from avaje/feature/propertyNames

Support json property name override via logger.propertyNames

Author: rbygrave

README.md

@@ -120,6 +120,17 @@ By default, the log format is JSON. Example:
 }
 ```
 
+To override the json property names use `logger.propertyNames` delimited by `=` and `,` like:
+```properties
+## delimited by comma and equals
+logger.propertyNames=logger=loggerName,env=environment,timestamp=@timestamp
+```
+
+Example overriding a single property:
+```properties
+logger.propertyNames=logger=loggerName
+```
+
 #### component
 
 A `component` key value is added if:

avaje-simple-json-logger/src/main/java/io/avaje/simplelogger/encoder/Bootstrap.java

@@ -57,6 +57,7 @@ private static LogWriter createWriter(Properties properties, String writerType)
     var jsonEncoder = new JsonEncoderBuilder()
       .component(property(properties, "logger.component"))
       .environment(property(properties,"logger.environment"))
+      .propertyNames(property(properties,"logger.propertyNames"))
       .customFields(property(properties, "logger.customFields"))
       .timestampPattern(timestampPattern)
       .timeZone(timeZone)

avaje-simple-json-logger/src/main/java/io/avaje/simplelogger/encoder/JsonEncoder.java

@@ -24,9 +24,19 @@ final class JsonEncoder {
   private final String environment;
   private final boolean includeStackHash;
 
-  JsonEncoder(JsonStream json, String component, String environment, StackHasher stackHasher, DateTimeFormatter formatter, boolean includeStackHash, Map<String, String> customFieldsMap, ThrowableConverter throwableConverter) {
+  JsonEncoder(
+        String[] propertyNames,
+        JsonStream json,
+        String component,
+        String environment,
+        StackHasher stackHasher,
+        DateTimeFormatter formatter,
+        boolean includeStackHash,
+        Map<String, String> customFieldsMap,
+        ThrowableConverter throwableConverter) {
+
     this.json = json;
-    this.properties = this.json.properties("component", "env", "timestamp", "level", "logger", "message", "thread", "stackhash", "stacktrace");
+    this.properties = this.json.properties(propertyNames);
     this.component = component;
     this.environment = environment;
     this.stackHasher = stackHasher;

avaje-simple-json-logger/src/main/java/io/avaje/simplelogger/encoder/JsonEncoderBuilder.java

@@ -22,6 +22,7 @@ final class JsonEncoderBuilder {
   private String timestampPattern;
   private String component;
   private String environment;
+  private String propertyNames;
   private boolean includeStackHash = true;
 
   JsonEncoderBuilder json(JsonStream json) {
@@ -59,6 +60,11 @@ JsonEncoderBuilder environment(String environment) {
     return this;
   }
 
+  JsonEncoderBuilder propertyNames(String propertyNames) {
+    this.propertyNames = propertyNames;
+    return this;
+  }
+
   JsonEncoderBuilder includeStackHash(boolean includeStackHash) {
     this.includeStackHash = includeStackHash;
     return this;
@@ -96,8 +102,38 @@ JsonEncoder build() {
     if (stackHasher == null) {
       stackHasher = new StackHasher(StackElementFilter.builder().allFilters().build());
     }
+    String[] mappedPropertyNames = toPropertyNames(propertyNames);
     final DateTimeFormatter formatter = TimeZoneUtils.jsonFormatter(timestampPattern, timeZone.toZoneId());
-    return new JsonEncoder(json, component, environment, stackHasher, formatter, includeStackHash, customFieldsMap, throwableConverter);
+    return new JsonEncoder(mappedPropertyNames, json, component, environment, stackHasher, formatter, includeStackHash, customFieldsMap, throwableConverter);
+  }
+
+  static String[] toPropertyNames(String mapping) {
+    String[] keys = {"component", "env", "timestamp", "level", "logger", "message", "thread", "stackhash", "stacktrace"};
+    if (mapping == null || mapping.isEmpty()) {
+      return keys;
+    }
+    return toPropertyNames(parseNameMapping(mapping), keys);
+  }
+
+  private static Map<String,String> parseNameMapping(String mapping) {
+    Map<String,String> map = new HashMap<>();
+    String[] split = mapping.split("[,;]");
+    for (String keyVal : split) {
+      String[] nameVal = keyVal.trim().split("=");
+      if (nameVal.length == 2) {
+       map.put(nameVal[0].toLowerCase().trim(), nameVal[1].trim());
+      }
+    }
+    return map;
+  }
+
+  private static String[] toPropertyNames(Map<String,String> map, String[] baseNames) {
+    String[] names = new String[baseNames.length];
+    for (int i = 0; i < baseNames.length; i++) {
+      String overrideName = map.get(baseNames[i]);
+      names[i] = overrideName != null ? overrideName : baseNames[i];
+    }
+    return names;
   }
 
 }

avaje-simple-json-logger/src/main/resources/META-INF/native-image/io.avaje.simplelogger/avaje-simplelogger/resource-config.json

@@ -1,7 +1,7 @@
 {
  "resources": [
   {
-   "pattern": "avaje-logger.*properties"
+   "pattern": "avaje-logger*.properties"
   }
  ]
 }

avaje-simple-json-logger/src/test/java/io/avaje/simplelogger/encoder/JsonEncoderBuilderTest.java

@@ -0,0 +1,31 @@
+package io.avaje.simplelogger.encoder;
+
+import org.junit.jupiter.api.Test;
+
+import java.util.Arrays;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.junit.jupiter.api.Assertions.*;
+
+class JsonEncoderBuilderTest {
+
+  String[] baseKeys = {"component", "env", "timestamp", "level", "logger", "message", "thread", "stackhash", "stacktrace"};
+
+  @Test
+  void toPropertyNames_when_null() {
+    String[] names = JsonEncoderBuilder.toPropertyNames(null);
+    assertThat(Arrays.equals(names, baseKeys)).isTrue();
+  }
+
+  @Test
+  void toPropertyNames_several() {
+    String[] names = JsonEncoderBuilder.toPropertyNames("component = c; env=e,thread=_foo  ");
+    assertThat(names).isEqualTo(new String[]{"c", "e", "timestamp", "level", "logger", "message", "_foo", "stackhash", "stacktrace"});
+  }
+
+  @Test
+  void toPropertyNames_onlyOne() {
+    String[] names = JsonEncoderBuilder.toPropertyNames("logger=loggerName");
+    assertThat(names).isEqualTo(new String[]{"component", "env", "timestamp", "level", "loggerName", "message", "thread", "stackhash", "stacktrace"});
+  }
+}