v1.1.0 - now with added metadata

Author: penkiln

README.md

@@ -6,6 +6,8 @@ This small library provides an appender for [logback](https://logback.qos.ch) (a
 
 The appender pushes log entries to LogDNA via HTTPS
 
+Logback's thread-bound storage, the MDC, is sent to LogDNA as metadata to be indexed and then searchable. (See screenshot, and more below) 
+
 ## How To
 
 Logback uses XML file in known locations with the most common being `classpath:/logback.xml`
@@ -67,7 +69,7 @@ and has some sensible options for dealing with buffer management. [Read more her
     <dependency>
       <groupId>net._95point2.utils</groupId>
       <artifactId>logback-logdna</artifactId>
-      <version>1.0.0</version>
+      <version>1.1.0</version>
     </dependency>
 
 #### Or, plain ol' download
@@ -76,19 +78,35 @@ Or just download the Jar and it's dependencies from https://github.com/robshep/l
 
 ## Configure
 
-You can go to town on most other logback configurations but the LogDNA only has a couple of settings
+You can go to town on most other logback configurations but the LogDNA only has a couple of settings (shown as the default)
 
 * `<appName>LogDNA-Logback-Test</appName>` set this for good log management in LogDNA
 * `<ingestKey>${LOGDNA_INGEST_KEY}</ingestKey>` signup to LogDNA and find this in your account profile
 * `<includeStacktrace>true</includeStacktrace>` this library can send multiline stacktraces (see image) - Raw syslog transport cannot
+* `<sendMDC>true</sendMDC>` copies over logback's Mapped Diagnostic Context [(MDC)](https://logback.qos.ch/manual/mdc.html) as LogDNA Metadata which are then indexed and searchable.
 
 ## More Info
 
 * The log line displays the thread, the logger (class) and the message
-
+* LogDNA's metadata is populated with the logger as an indexable/searchable property.
 * The HTTP Transport is done by the very lightweight [DavidWebb](https://github.com/hgoebl/DavidWebb) REST Library and so doesn't introduce bulky dependencies
 
+## Using the MDC for Meta Data
+
+The combination of logback's MDC and LogDNA's metadata support is pretty powerful and means you can correlate web-requests, or a userId, or something else that happens in a thread in your application.  
+
+For example, doing this _anywhere_ in your application...
+
+	MDC.put("customerId", "C-1");
+	MDC.put("requestId", "cafebabe1");
+
+... means that you can then go and search for say, **that** customer in logDNA like this:
+
+	meta.customerId:"C-1"
+
+
+	
 
-## Screenshot of the LogDNA log viewer
+## Screenshot of the LogDNA log viewer, including extra metadata
 
-![Optional Text](../master/src/test/resources/logdna.png)
+![The Spoils of these toils](../master/src/test/resources/logdna-meta.png)

pom.xml

@@ -4,7 +4,7 @@
   <groupId>net._95point2.utils</groupId>
   <artifactId>logback-logdna</artifactId>
   <packaging>jar</packaging>
-  <version>1.0.0</version>
+  <version>1.1.0</version>
   <name>logback-logdna</name>
   <url>http://maven.apache.org</url>
   <properties>

src/main/java/net/_95point2/utils/LogDNAAppender.java

@@ -5,6 +5,7 @@
 import java.net.URLEncoder;
 import java.net.UnknownHostException;
 import java.util.HashMap;
+import java.util.Map.Entry;
 
 import org.json.JSONArray;
 import org.json.JSONException;
@@ -33,6 +34,7 @@ public class LogDNAAppender extends UnsynchronizedAppenderBase<ILoggingEvent>
 	 */
 	private String appName;
 	private boolean includeStacktrace = true;
+	private boolean sendMDC = true;
 
 	public LogDNAAppender() {
 		try {
@@ -81,6 +83,17 @@ protected void append(ILoggingEvent ev)
 			line.put("app", this.appName);
 			line.put("line", sb.toString());
 
+			JSONObject meta = new JSONObject();
+			meta.put("logger", ev.getLoggerName());
+			line.put("meta", meta);
+			
+			if(this.sendMDC && !ev.getMDCPropertyMap().isEmpty()){
+				for(Entry<String,String> entry : ev.getMDCPropertyMap().entrySet()){
+					meta.put(entry.getKey(), entry.getValue());
+				}
+			}
+			
+			
 			lines.put(line);
 
 			HashMap<String,Object> params = new HashMap<>();
@@ -114,6 +127,10 @@ public void setAppName(String appName) {
 	public void setIngestKey(String ingestKey) {
 		this.http.setDefaultHeader("apikey", ingestKey);
 	}
+	
+	public void setSendMDC(boolean sendMDC) {
+		this.sendMDC = sendMDC;
+	}
 
 	public void setIncludeStacktrace(boolean includeStacktrace) {
 		this.includeStacktrace = includeStacktrace;

src/test/java/net/_95point2/utils/LogDNATest.java

@@ -3,6 +3,7 @@
 import org.junit.Test;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
+import org.slf4j.MDC;
 
 public class LogDNATest 
 {
@@ -15,6 +16,9 @@ public class LogDNATest
 	@Test
 	public void testLogDNALogbackConf() throws InterruptedException
 	{
+		MDC.put("customerId", "C-1");
+		MDC.put("requestId", "cafebabe1");
+		
 	    Logger logger = LoggerFactory.getLogger(LogDNATest.class);
 
 	    logger.info("Okay");
@@ -24,5 +28,7 @@ public void testLogDNALogbackConf() throws InterruptedException
 	    logger.error("Ah Sh*t!", new RuntimeException("Bang!"));
 
 	    logger.info("Well, Bye!");
+	    
+	    Thread.sleep(2000);
 	}
 }