adding version 0.0.2 feature

Author: ksadayamuthu

README.adoc

@@ -13,7 +13,7 @@ maven { url "https://dl.bintray.com/m2/release"}
 ## Dependencies
 
 ```
-compile ("io.devxchange:logmetrics:0.0.1")
+compile ("io.devxchange:logmetrics:0.0.2")
 
 ```
 
@@ -25,6 +25,10 @@ compile ("io.devxchange:logmetrics:0.0.1")
 logmetrics.logging.enabled=true
 logmetrics.logging.request.enabled=true
 logmetrics.logging.response.enabled=true
+logmetrics.logging.obfuscate.enabled=false
+logmetrics.logging.obfuscate.md5.fields= #comma seperated fields
+logmetrics.logging.obfuscate.sha256.fields= #comma seperated fields
+logmetrics.logging.obfuscate.fields= #comma seperated fields
 
 ```
 
@@ -42,18 +46,96 @@ public class AppConfig extends WebMvcConfigurerAdapter
 	@Override
 	public void addInterceptors(InterceptorRegistry registry) 
 	{
-		registry.addInterceptor(new RestTransactionInterceptor(logWriterManager));
+		registry.addInterceptor(new FrontendRestInterceptor(logWriterManager));
 	}
 }
 
 ```
 
+### logmetrics json schema
+
+```
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "type": "LogMetrics",
+  "properties": {
+    "Node": {
+      "type": "string",
+      "description": "Application Host IP Address"
+    },
+    "message_type": {
+      "type": "string",
+      "description": "Logmetrics message type",
+      "value": "LOGMETRICS_MESSAGE"
+    },
+    "Duration": {
+      "type": "integer",
+      "description": "Response time of the API"
+    },
+    "Host": {
+      "type": "string",
+      "description": "Application Host Name"
+    },
+    "Fault": {
+      "type": "boolean",
+      "description": "API Success or Failed status "
+    },
+    "Method": {
+      "type": "string",
+      "description": "API Method name"
+    },
+    "ResponseBody": {
+      "type": "string",
+      "description": "API Response Body"
+    },
+    "StartDateTime": {
+      "type": "string",
+      "description": "API Start Time"
+    },
+    "EndDateTime": {
+      "type": "string",
+      "description": "API End time"
+    },
+    "HttpMethod": {
+      "type": "string",
+      "description": "Http Method Type"
+    },
+    "RequestBody": {
+      "type": "string",
+      "description": "API Request Body"
+    }
+  }
+}
+
+
+```
+
+### sample logmetrics message
+```
+{
+  "Node": "127.0.0.1",
+  "message_type": "LOGMETRICS_MESSAGE",
+  "Duration": 106,
+  "Host": "hostname",
+  "Fault": false,
+  "Method": "/user-service/api/v1/user/{id}",
+  "ResponseBody": "{\"id\":1,\"name\":\"02adcec2263d2127269fcd769c33f029\",\"age\":\"35135aaa6cc23891b40cb3f378c53a17a1127210ce60e125ccf03efcfdaec458\",\"salary\":\"********\"}",
+  "StartDateTime": "Tue Nov 26 23:22:54 EST 2019",
+  "EndDateTime": "Tue Nov 26 23:22:54 EST 2019",
+  "HttpMethod": "GET",
+  "RequestBody": ""
+}
+```
+
 ### Demo Project 
 
 https://github.com/devxchange-blog/logmetrics-demo.git[logmetrics-demo]
 
 ## Release History
 
+** 0.0.2
+    * adding request and response payload obfuscation (masking sensitive information)
+
 ** 0.0.1
     * logging rest verb & payload to console.
     * feature to enable/disable payload logging

build.gradle

@@ -22,16 +22,19 @@ apply plugin: 'com.jfrog.bintray'
 
 
 group 'io.devxchange'
-version '0.0.1'
+version '0.0.2'
 
 repositories {
     mavenCentral()
     maven { url "https://repo.spring.io/snapshot" }
     maven { url "https://repo.spring.io/milestone" }
+    maven { url "https://dl.bintray.com/m2/release/"}
+
 }
 
 dependencies {
     compile gradleApi()
+    compile ("io.devxchange:obfuscator:0.0.1")
     compile group: 'org.springframework', name: 'spring-webmvc', version: '4.3.2.RELEASE'
     compile("javax.servlet:javax.servlet-api:3.1.0")
     compile group: 'commons-io', name: 'commons-io', version: '2.4'

src/main/java/io/devxchange/logmetrics/interceptor/RestPayloadInterceptor.java renamed to src/main/java/io/devxchange/logmetrics/interceptor/FrontendRestInterceptor.java

@@ -11,36 +11,29 @@
 import org.slf4j.LoggerFactory;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.beans.factory.annotation.Qualifier;
-import org.springframework.beans.factory.annotation.Value;
 import org.springframework.stereotype.Component;
 import org.springframework.web.context.request.RequestContextHolder;
 import org.springframework.web.context.request.ServletRequestAttributes;
 import org.springframework.web.servlet.HandlerMapping;
 import org.springframework.web.servlet.ModelAndView;
 import org.springframework.web.servlet.handler.HandlerInterceptorAdapter;
 
-import io.devxchange.logmetrics.types.PayloadMessageBuilder;
+import io.devxchange.logmetrics.types.LogMetricsBuilder;
 import io.devxchange.logmetrics.util.LogUtil;
 import io.devxchange.logmetrics.writer.LogWriterManager;
 
 /**
  * Created by devxchange.io on 2/10/17.
  */
 @Component
-public class RestPayloadInterceptor extends HandlerInterceptorAdapter {
+public class FrontendRestInterceptor extends HandlerInterceptorAdapter {
 
-	Logger log = LoggerFactory.getLogger(RestPayloadInterceptor.class);
+	Logger log = LoggerFactory.getLogger(FrontendRestInterceptor.class);
 
 	private LogWriterManager logWriter;
 
-	@Value("${io.oneclicklabs.logging.request.obfuscated.fields}")
-	private String[] requestObfuscation;
-
-	@Value("${io.oneclicklabs.logging.response.obfuscated.fields}")
-	private String[] responseObfuscation;
-
 	@Autowired
-	public RestPayloadInterceptor(@Qualifier("manager.logwriter") LogWriterManager logWriter) {
+	public FrontendRestInterceptor(@Qualifier("manager.logwriter") LogWriterManager logWriter) {
 
 		this.logWriter = logWriter;
 	}
@@ -77,7 +70,7 @@ private void logTransactions(HttpServletRequest servletRequest, HttpServletRespo
 		Date endDateTime = new Date((Long) servletRequest.getAttribute("ENDTIME"));
 		long duration = ((Long) servletRequest.getAttribute("ENDTIME")
 				- (Long) servletRequest.getAttribute("STARTTIME"));
-		PayloadMessageBuilder messageBuilder = new PayloadMessageBuilder(hostname, node, null, getServiceOperation(),
+		LogMetricsBuilder messageBuilder = new LogMetricsBuilder(hostname, node, null, getServiceOperation(),
 				servletRequest.getMethod(), duration);
 		messageBuilder.aspects(null).query(servletRequest.getQueryString()).startDateTime(startDateTime)
 				.endDateTime(endDateTime).requestBody(requestPayload).contentType(servletRequest.getContentType())

src/main/java/io/devxchange/logmetrics/types/PayloadMessage.java renamed to src/main/java/io/devxchange/logmetrics/types/LogMetrics.java

@@ -3,20 +3,23 @@
 import java.util.Date;
 import java.util.HashMap;
 import java.util.Map;
+import java.util.Set;
 
 import com.google.gson.GsonBuilder;
+import io.devxchange.logmetrics.util.Validation;
+import io.devxchange.obfuscator.Obfuscator;
 
 /**
  * Created by devxchange.io on 2/10/17.
  */
-public class PayloadMessage {
+public class LogMetrics {
 
 	public enum params {
 		messageType("message_type"), duration("Duration"), host("Host"), level("Level"), method("Method"), node(
 				"Node"), service("Service"), system("System"), serviceVersion("ServiceVersion"), startDateTime(
 						"StartDateTime"), endDateTime("EndDateTime"), error("Fault"), errorCode(
 								"FaultCode"), errorMessage(
-										"FaultString"), aspects("Aspects"), requestBody("RequestBody"), responseBody(
+				"FaultString"), aspects("Aspects"), requestBody("RequestBody"), responseBody(
 												"ResponseBody"), applicationName("ApplicationName"), httpMethod(
 														"HttpMethod"), query("Query"), contentType("ContentType");
 
@@ -53,12 +56,12 @@ public String getKeyName() {
 	private final String query;
 	private final String contentType;
 
-	public PayloadMessage(String message_type, Long duration, String host, String level, String method, String node,
-			String service, String system,
+	public LogMetrics(String message_type, Long duration, String host, String level, String method, String node,
+					  String service, String system,
 
-			String serviceVersion, Date startDateTime, Date endDateTime, Boolean error, String errorCode,
-			String errorMessage, Map<String, String> aspects, String requestBody, String responseBody,
-			String applicationName, String httpMethod, String query, String contentType) {
+					  String serviceVersion, Date startDateTime, Date endDateTime, Boolean error, String errorCode,
+					  String errorMessage, Map<String, String> aspects, String requestBody, String responseBody,
+					  String applicationName, String httpMethod, String query, String contentType) {
 		this.message_type = message_type;
 		this.duration = duration;
 		this.host = host;
@@ -119,6 +122,31 @@ public String toJson(boolean includeReq, boolean includeResp) {
 		return this.toJson(map);
 	}
 
+	public String toJson(boolean includeReq, boolean includeResp, boolean obfuscate, Map<String, Set<String>> fields) {
+		Map<String, Object> originalMap = this.toMap();
+		HashMap<String, Object> map = new HashMap<>();
+		map.putAll(originalMap);
+		if (!includeReq) {
+			map.remove(params.requestBody.keyName);
+		}else if(obfuscate){
+			String payload = (String) originalMap.get(params.requestBody.keyName);
+			if(payload!=null && Validation.isJson(payload))
+				map.put(params.requestBody.keyName,Obfuscator.obfuscateJsonString(payload,fields));
+			else if(payload!=null)
+				map.put(params.requestBody.keyName, Obfuscator.obfuscateXmlString(payload, fields));
+		}
+		if (!includeResp)
+			map.remove(params.responseBody.keyName);
+		else if(obfuscate){
+			String payload = (String) originalMap.get(params.responseBody.keyName);
+			if(payload!=null && Validation.isJson(payload))
+				map.put(params.responseBody.keyName,Obfuscator.obfuscateJsonString(payload,fields));
+			else if(payload!=null)
+				map.put(params.responseBody.keyName, Obfuscator.obfuscateXmlString(payload, fields));
+		}
+		return this.toJson(map);
+	}
+
 	public String toJson(Map<String, Object> map) {
 		return new GsonBuilder().disableHtmlEscaping().setDateFormat("EEE MMM dd HH:mm:ss zzz yyyy").create()
 				.toJson(map);