catalog-fe/src/main/java/org/openecomp/sdc/fe/servlets/LoggingServlet.java

   1 package org.openecomp.sdc.fe.servlets;
   2
   3 import com.google.common.cache.Cache;
   4 import com.google.common.cache.CacheBuilder;
   5 import org.openecomp.sdc.common.api.Constants;
   6 import org.openecomp.sdc.common.servlets.BasicServlet;
   7 import org.openecomp.sdc.fe.impl.MdcData;
   8 import org.slf4j.Logger;
   9 import org.slf4j.LoggerFactory;
  10 import org.slf4j.MDC;
  11
  12 import javax.servlet.http.HttpServletRequest;
  13 import javax.ws.rs.core.Response;
  14 import java.util.concurrent.TimeUnit;
  15
  16 public abstract class LoggingServlet extends BasicServlet {
  17
  18     private static final Logger log = LoggerFactory.getLogger(BasicServlet.class.getName());
  19     private static final Cache<String, MdcData> mdcDataCache = CacheBuilder.newBuilder().expireAfterWrite(10, TimeUnit.SECONDS).build();
  20
  21     /**
  22      * log incoming requests
  23      * @param httpRequest the http request
  24      */
  25     protected void logFeRequest(HttpServletRequest httpRequest) {
  26
  27         MDC.clear();
  28
  29         Long transactionStartTime = System.currentTimeMillis();
  30         String uuid = httpRequest.getHeader(Constants.X_ECOMP_REQUEST_ID_HEADER);
  31         String serviceInstanceID = httpRequest.getHeader(Constants.X_ECOMP_SERVICE_ID_HEADER);
  32
  33         if (uuid != null && uuid.length() > 0) {
  34             String userId = httpRequest.getHeader(Constants.USER_ID_HEADER);
  35
  36             String remoteAddr = httpRequest.getRemoteAddr();
  37             String localAddr = httpRequest.getLocalAddr();
  38
  39             mdcDataCache.put(uuid, new MdcData(serviceInstanceID, userId, remoteAddr, localAddr, transactionStartTime));
  40
  41             updateMdc(uuid, serviceInstanceID, userId, remoteAddr, localAddr, null);
  42         }
  43         inHttpRequest(httpRequest);
  44     }
  45
  46     /**
  47      * log response
  48      * @param request orig request
  49      * @param response returned response
  50      */
  51     protected void logFeResponse(HttpServletRequest request, Response response) {
  52         String uuid = request.getHeader(Constants.X_ECOMP_REQUEST_ID_HEADER);
  53         String transactionRoundTime = null;
  54
  55         if (uuid != null) {
  56             MdcData mdcData = mdcDataCache.getIfPresent(uuid);
  57             if (mdcData != null) {
  58                 Long transactionStartTime = mdcData.getTransactionStartTime();
  59                 if (transactionStartTime != null) {// should'n ever be null, but
  60                     // just to be defensive
  61                     transactionRoundTime = Long.toString(System.currentTimeMillis() - transactionStartTime);
  62                 }
  63                 updateMdc(uuid, mdcData.getServiceInstanceID(), mdcData.getUserId(), mdcData.getRemoteAddr(), mdcData.getLocalAddr(), transactionRoundTime);
  64             }
  65         }
  66         outHttpResponse(response);
  67
  68         MDC.clear();
  69     }
  70
  71     /**
  72      * Extracted for purpose of clear method name, for logback %M parameter
  73      * @param httpRequest http request
  74      */
  75     protected abstract void inHttpRequest(HttpServletRequest httpRequest) ;
  76
  77
  78     /**
  79      * Extracted for purpose of clear method name, for logback %M parameter
  80      * @param response http response
  81      */
  82     protected abstract void outHttpResponse(Response response);
  83
  84     /**
  85      * update mdc with values from the request
  86      * @param uuid service uuid
  87      * @param serviceInstanceID serviceInstanceID
  88      * @param userId userId
  89      * @param remoteAddr remoteAddr
  90      * @param localAddr localAddr
  91      * @param transactionStartTime transactionStartTime
  92      */
  93     private void updateMdc(String uuid, String serviceInstanceID, String userId, String remoteAddr, String localAddr, String transactionStartTime) {
  94         MDC.put("uuid", uuid);
  95         MDC.put("serviceInstanceID", serviceInstanceID);
  96         MDC.put("userId", userId);
  97         MDC.put("remoteAddr", remoteAddr);
  98         MDC.put("localAddr", localAddr);
  99         MDC.put("timer", transactionStartTime);
 100     }
 101 }