Support type definitions for DynamicMdcField Patterns

src/main/java/biz/paluch/logging/gelf/GelfMessageAssembler.java

@@ -6,6 +6,7 @@
 import java.io.StringWriter;
 import java.text.SimpleDateFormat;
 import java.util.*;
+import java.util.regex.Pattern;
 
 import biz.paluch.logging.RuntimeContainer;
 import biz.paluch.logging.StackTraceFilter;
@@ -50,6 +51,7 @@ public class GelfMessageAssembler implements HostAndPortProvider {
 
     private List<MessageField> fields = new ArrayList<MessageField>();
     private Map<String, String> additionalFieldTypes = new HashMap<String, String>();
+    private Map<Pattern, String> dynamicMdcFieldTypes = new HashMap<Pattern, String>();
 
     private String timestampPattern = "yyyy-MM-dd HH:mm:ss,SSS";
 
@@ -104,6 +106,7 @@ public void initialize(PropertyProvider propertyProvider) {
 
         setupStaticFields(propertyProvider);
         setupAdditionalFieldTypes(propertyProvider);
+        setupDynamicMdcFieldTypes(propertyProvider);
         facility = propertyProvider.getProperty(PropertyProvider.PROPERTY_FACILITY);
         String version = propertyProvider.getProperty(PropertyProvider.PROPERTY_VERSION);
 
@@ -148,6 +151,7 @@ public GelfMessage createGelfMessage(LogEvent logEvent) {
         builder.withLevel(logEvent.getSyslogLevel());
         builder.withVersion(getVersion());
         builder.withAdditionalFieldTypes(additionalFieldTypes);
+        builder.withDynamicMdcFieldTypes(dynamicMdcFieldTypes);
 
         for (MessageField field : fields) {
 
@@ -267,10 +271,37 @@ private void setupAdditionalFieldTypes(PropertyProvider propertyProvider) {
         }
     }
 
+    private void setupDynamicMdcFieldTypes(PropertyProvider propertyProvider) {
+        int fieldNumber = 0;
+        while (true) {
+            String property = propertyProvider.getProperty(PropertyProvider.PROPERTY_DYNAMIC_MDC_FIELD_TYPES + fieldNumber);
+            if (null == property) {
+                break;
+            }
+            int index = property.indexOf('=');
+            if (-1 != index) {
+
+                String field = property.substring(0, index);
+                String type = property.substring(index + 1);
+                setDynamicMdcFieldType(field, type);
+            }
+
+            fieldNumber++;
+        }
+    }
+
     public void setAdditionalFieldType(String field, String type) {
         additionalFieldTypes.put(field, type);
     }
 
+    public void setDynamicMdcFieldType(String fieldPattern, String type) {
+        Pattern pattern = Pattern.compile(fieldPattern);
+        setDynamicMdcFieldType(pattern, type);
+    }
+
+    public void setDynamicMdcFieldType(Pattern fieldPattern, String type) {
+        dynamicMdcFieldTypes.put(fieldPattern, type);
+    }
     public void addField(MessageField field) {
         if (!fields.contains(field)) {
             this.fields.add(field);

src/main/java/biz/paluch/logging/gelf/GelfMessageBuilder.java

@@ -2,6 +2,7 @@
 
 import java.util.HashMap;
 import java.util.Map;
+import java.util.regex.Pattern;
 
 import biz.paluch.logging.gelf.intern.GelfMessage;
 
@@ -23,6 +24,7 @@ public class GelfMessageBuilder {
     protected int maximumMessageSize = GelfMessage.DEFAULT_MESSAGE_SIZE;
     protected Map<String, String> additionalFields = new HashMap<String, String>();
     protected Map<String, String> additionalFieldTypes = new HashMap<String, String>();
+    protected Map<Pattern, String> dynamicMdcFieldTypes = new HashMap<Pattern, String>();
 
     protected GelfMessageBuilder() {
     }
@@ -158,6 +160,18 @@ public GelfMessageBuilder withAdditionalFieldTypes(Map<String, String> additiona
         return this;
     }
 
+
+    /**
+     * Set dynamic mdc field types
+     *
+     * @param dynamicMdcFieldTypes the type map
+     * @return GelfMessageBuilder
+     */
+    public GelfMessageBuilder withDynamicMdcFieldTypes(Map<Pattern, String> dynamicMdcFieldTypes) {
+        this.dynamicMdcFieldTypes.putAll(dynamicMdcFieldTypes);
+        return this;
+    }
+
     /**
      * Build a new Gelf message based on the builder settings.
      * 
@@ -173,6 +187,7 @@ public GelfMessage build() {
         gelfMessage.setJavaTimestamp(javaTimestamp);
         gelfMessage.setFacility(facility);
         gelfMessage.setAdditionalFieldTypes(additionalFieldTypes);
+        gelfMessage.setDynamicMdcFieldTypes(dynamicMdcFieldTypes);
 
         return gelfMessage;
     }

src/main/java/biz/paluch/logging/gelf/PropertyProvider.java

@@ -34,6 +34,7 @@ public interface PropertyProvider {
     String PROPERTY_ADDITIONAL_FIELD_TYPE = "additionalFieldType.";
     String PROPERTY_ADDITIONAL_FIELDS = "additionalFields";
     String PROPERTY_ADDITIONAL_FIELD_TYPES = "additionalFieldTypes";
+    String PROPERTY_DYNAMIC_MDC_FIELD_TYPES = "dynamicMdcFieldTypes";
     String PROPERTY_TIMESTAMP_PATTERN = "timestampPattern";
 
     String PROPERTY_FILTER = "filter";

src/main/java/biz/paluch/logging/gelf/intern/ConfigurationSupport.java

@@ -18,7 +18,7 @@ private ConfigurationSupport() {
 
     /**
      * Set the additional (static) fields.
-     * 
+     *
      * @param spec field=value,field1=value1, ...
      * @param gelfMessageAssembler the Gelf message assembler to apply the configuration
      */
@@ -38,7 +38,7 @@ public static void setAdditionalFields(String spec, GelfMessageAssembler gelfMes
 
     /**
      * Set the MDC fields.
-     * 
+     *
      * @param spec field, field2, field3
      * @param gelfMessageAssembler the Gelf message assembler to apply the configuration
      */
@@ -54,7 +54,7 @@ public static void setMdcFields(String spec, GelfMessageAssembler gelfMessageAss
 
     /**
      * Set the dynamic MDC fields.
-     * 
+     *
      * @param spec field, .*FieldSuffix, fieldPrefix.*
      * @param gelfMessageAssembler the {@link GelfMessageAssembler}.
      */
@@ -70,7 +70,7 @@ public static void setDynamicMdcFields(String spec, GelfMessageAssembler gelfMes
 
     /**
      * Set the additional field types.
-     * 
+     *
      * @param spec field=String,field1=Double, ... See {@link GelfMessage} for supported types.
      * @param gelfMessageAssembler the Gelf message assembler to apply the configuration
      */
@@ -87,4 +87,22 @@ public static void setAdditionalFieldTypes(String spec, GelfMessageAssembler gel
         }
     }
 
+    /**
+     * Set the dynamic mdc field types.
+     *
+     * @param spec field=String,field1=Double, ... See {@link GelfMessage} for supported types.
+     * @param gelfMessageAssembler the Gelf message assembler to apply the configuration
+     */
+    public static void setDynamicMdcFieldTypes(String spec, GelfMessageAssembler gelfMessageAssembler) {
+        if (null != spec) {
+            String[] properties = spec.split(MULTI_VALUE_DELIMITTER);
+
+            for (String field : properties) {
+                final int index = field.indexOf(EQ);
+                if (-1 != index) {
+                    gelfMessageAssembler.setDynamicMdcFieldType(field.substring(0, index), field.substring(index + 1));
+                }
+            }
+        }
+    }
 }

src/main/java/biz/paluch/logging/gelf/intern/GelfMessage.java

@@ -9,6 +9,7 @@
 import java.util.Arrays;
 import java.util.HashMap;
 import java.util.Map;
+import java.util.regex.Pattern;
 import java.util.zip.GZIPOutputStream;
 
 import biz.paluch.logging.gelf.intern.ValueDiscovery.Result;
@@ -91,6 +92,7 @@ public class GelfMessage {
     private String facility = DEFAULT_FACILITY;
     private Map<String, String> additonalFields = new HashMap<String, String>();
     private Map<String, String> additionalFieldTypes = new HashMap<String, String>();
+    private Map<Pattern, String> dynamicMdcFieldTypes = new HashMap<Pattern, String>();
     private int maximumMessageSize = DEFAULT_MESSAGE_SIZE;
 
     public GelfMessage() {
@@ -187,7 +189,10 @@ protected void toJson(OutputAccessor out, String additionalFieldPrefix) {
                 String value = additionalField.getValue();
                 String fieldType = additionalFieldTypes.get(additionalField.getKey());
                 if (fieldType == null) {
-                    fieldType = FIELD_TYPE_DEFAULT;
+                    fieldType = getMatchingDynamicMdcFieldType(additionalField.getKey());
+                    if (fieldType == null) {
+                        fieldType = FIELD_TYPE_DEFAULT;
+                    }
                 }
                 Object result = getAdditionalFieldValue(value, fieldType);
                 if (result != null) {
@@ -420,6 +425,18 @@ private static byte[] lastFourAsciiBytes(String host) {
         return Charsets.ascii(shortHost);
     }
 
+    private String getMatchingDynamicMdcFieldType(String fieldName) {
+        String fieldType = null;
+        for (Map.Entry<Pattern, String> entry : dynamicMdcFieldTypes.entrySet()) {
+            if(entry.getKey().matcher(fieldName).matches()) {
+                fieldType = entry.getValue();
+                break;
+            }
+        }
+
+        return fieldType;
+    }
+
     public String getVersion() {
         return version;
     }
@@ -495,6 +512,14 @@ public void setAdditionalFieldTypes(Map<String, String> additionalFieldTypes) {
         this.additionalFieldTypes.putAll(additionalFieldTypes);
     }
 
+    public Map<Pattern, String> getDynamicMdcFieldTypes() {
+        return dynamicMdcFieldTypes;
+    }
+
+    public void setDynamicMdcFieldTypes(Map<Pattern, String> dynamicMdcFieldTypes) {
+        this.dynamicMdcFieldTypes.putAll(dynamicMdcFieldTypes);
+    }
+
     /**
      * Add multiple fields (key/value pairs)
      *

src/main/java/biz/paluch/logging/gelf/intern/PoolingGelfMessageBuilder.java

@@ -81,6 +81,7 @@ public GelfMessage build() {
         gelfMessage.setJavaTimestamp(javaTimestamp);
         gelfMessage.setFacility(facility);
         gelfMessage.setAdditionalFieldTypes(additionalFieldTypes);
+        gelfMessage.setDynamicMdcFieldTypes(dynamicMdcFieldTypes);
 
         return gelfMessage;
     }

src/main/java/biz/paluch/logging/gelf/jboss7/JBoss7GelfLogHandler.java

@@ -126,6 +126,10 @@ public void setDynamicMdcFields(String fieldSpec) {
         super.setDynamicMdcFields(fieldSpec);
     }
 
+    public void setDynamicMdcFieldTypes(String fieldSpec) {
+        super.setDynamicMdcFieldTypes(fieldSpec);
+    }
+
     public boolean isMdcProfiling() {
         return getGelfMessageAssembler().isMdcProfiling();
     }

src/main/java/biz/paluch/logging/gelf/jul/GelfLogHandler.java

@@ -176,6 +176,10 @@ public void setDynamicMdcFields(String spec) {
         ConfigurationSupport.setDynamicMdcFields(spec, gelfMessageAssembler);
     }
 
+    public void setDynamicMdcFieldTypes(String spec) {
+        ConfigurationSupport.setDynamicMdcFieldTypes(spec, gelfMessageAssembler);
+    }
+
     public String getGraylogHost() {
         return gelfMessageAssembler.getHost();
     }

src/main/java/biz/paluch/logging/gelf/log4j/GelfLogAppender.java

@@ -150,6 +150,10 @@ public void setDynamicMdcFields(String spec) {
         ConfigurationSupport.setDynamicMdcFields(spec, gelfMessageAssembler);
     }
 
+    public void setDynamicMdcFieldTypes(String spec) {
+        ConfigurationSupport.setDynamicMdcFieldTypes(spec, gelfMessageAssembler);
+    }
+
     public String getGraylogHost() {
         return gelfMessageAssembler.getHost();
     }

src/main/java/biz/paluch/logging/gelf/log4j2/GelfDynamicMdcFieldType.java

@@ -0,0 +1,57 @@
+package biz.paluch.logging.gelf.log4j2;
+
+import org.apache.logging.log4j.Logger;
+import org.apache.logging.log4j.core.config.Configuration;
+import org.apache.logging.log4j.core.config.plugins.Plugin;
+import org.apache.logging.log4j.core.config.plugins.PluginAttribute;
+import org.apache.logging.log4j.core.config.plugins.PluginConfiguration;
+import org.apache.logging.log4j.core.config.plugins.PluginFactory;
+import org.apache.logging.log4j.status.StatusLogger;
+import org.apache.logging.log4j.util.Strings;
+
+import java.util.regex.Pattern;
+
+/**
+ * Configuration for dynamic log fields pulled from MDC.
+ *
+ * @author Thomas Herzog
+ */
+@Plugin(name = "DynamicMdcFieldTypes", category = "Core", printObject = true)
+public class GelfDynamicMdcFieldType {
+
+    private static final Logger LOGGER = StatusLogger.getLogger();
+
+    private final Pattern pattern;
+    private final String type;
+
+    public GelfDynamicMdcFieldType(Pattern pattern, String type) {
+        this.pattern = pattern;
+        this.type = type;
+    }
+
+    public Pattern getPattern() {
+        return pattern;
+    }
+
+    public String getType() {
+        return type;
+    }
+
+    @PluginFactory
+    public static GelfDynamicMdcFieldType createField(@PluginConfiguration final Configuration config,
+                                                      @PluginAttribute("regex") String regex,
+                                                      @PluginAttribute("type") String type) {
+
+        Pattern pattern;
+        if (Strings.isEmpty(regex) || Strings.isEmpty(type)) {
+            throw new IllegalArgumentException(String.format("regex=%s or type=%s is empty or null", regex, type));
+        }
+        try {
+            pattern = Pattern.compile(regex);
+        } catch (Exception e) {
+            throw new IllegalArgumentException(String.format("Regex is invalid: regex=%s", regex), e);
+        }
+
+        return new GelfDynamicMdcFieldType(pattern, type);
+    }
+}

src/main/java/biz/paluch/logging/gelf/log4j2/GelfLogAppender.java

@@ -205,6 +205,7 @@ public static GelfLogAppender createAppender(@PluginConfiguration final Configur
             @PluginAttribute("name") String name, @PluginElement("Filter") Filter filter,
             @PluginElement("Field") final GelfLogField[] fields,
             @PluginElement("DynamicMdcFields") final GelfDynamicMdcLogFields[] dynamicFieldArray,
+            @PluginElement("DynamicMdcFieldTypes") final GelfDynamicMdcFieldType[] dynamicFieldTypeArray,
             @PluginAttribute("graylogHost") String graylogHost, @PluginAttribute("host") String host,
             @PluginAttribute("graylogPort") String graylogPort, @PluginAttribute("port") String port,
             @PluginAttribute("version") String version, @PluginAttribute("extractStackTrace") String extractStackTrace,
@@ -284,6 +285,12 @@ public static GelfLogAppender createAppender(@PluginConfiguration final Configur
             ConfigurationSupport.setAdditionalFieldTypes(additionalFieldTypes, mdcGelfMessageAssembler);
         }
 
+        if (dynamicFieldTypeArray != null) {
+            for (GelfDynamicMdcFieldType gelfDynamicMdcFieldType : dynamicFieldTypeArray) {
+                mdcGelfMessageAssembler.setDynamicMdcFieldType(gelfDynamicMdcFieldType.getPattern(), gelfDynamicMdcFieldType.getType());
+            }
+        }
+
         configureFields(mdcGelfMessageAssembler, fields, dynamicFieldArray);
 
         return new GelfLogAppender(name, filter, mdcGelfMessageAssembler, ignoreExceptions);

src/main/java/biz/paluch/logging/gelf/logback/GelfLogbackAppender.java

@@ -148,6 +148,10 @@ public void setDynamicMdcFields(String spec) {
         ConfigurationSupport.setDynamicMdcFields(spec, gelfMessageAssembler);
     }
 
+    public void setDynamicMdcFieldTypes(String spec) {
+        ConfigurationSupport.setDynamicMdcFieldTypes(spec, gelfMessageAssembler);
+    }
+
     public String getGraylogHost() {
         return gelfMessageAssembler.getHost();
     }

src/main/java/biz/paluch/logging/gelf/wildfly/WildFlyGelfLogHandler.java

@@ -126,6 +126,10 @@ public void setDynamicMdcFields(String fieldSpec) {
         super.setDynamicMdcFields(fieldSpec);
     }
 
+    public void setDynamicMdcFieldTypes(String fieldSpec) {
+        super.setDynamicMdcFieldTypes(fieldSpec);
+    }
+
     public boolean isMdcProfiling() {
         return getGelfMessageAssembler().isMdcProfiling();
     }