common/src/main/java/org/onap/so/logging/spring/interceptor/LoggingInterceptor.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * ONAP - SO
   4  * ================================================================================
   5  * Copyright (C) 2017 - 2018 AT&T Intellectual Property. All rights reserved.
   6  * ================================================================================
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  * ============LICENSE_END=========================================================
  19  */
  20
  21 package org.onap.so.logging.spring.interceptor;
  22
  23 import java.util.Collections;
  24 import java.util.Map;
  25 import java.util.UUID;
  26 import java.util.stream.Collectors;
  27 import javax.servlet.http.HttpServletRequest;
  28 import javax.servlet.http.HttpServletResponse;
  29 import javax.ws.rs.core.Context;
  30 import javax.ws.rs.core.Response;
  31 import javax.ws.rs.ext.Providers;
  32 import org.onap.logging.ref.slf4j.ONAPLogConstants;
  33 import org.onap.so.logger.LogConstants;
  34 import org.onap.so.logging.jaxrs.filter.MDCSetup;
  35 import org.slf4j.Logger;
  36 import org.slf4j.LoggerFactory;
  37 import org.slf4j.MDC;
  38 import org.springframework.beans.factory.annotation.Autowired;
  39 import org.springframework.stereotype.Component;
  40 import org.springframework.web.servlet.ModelAndView;
  41 import org.springframework.web.servlet.handler.HandlerInterceptorAdapter;
  42
  43 @Component
  44 public class LoggingInterceptor extends HandlerInterceptorAdapter {
  45
  46     Logger logger = LoggerFactory.getLogger(LoggingInterceptor.class);
  47
  48     @Autowired
  49     private MDCSetup mdcSetup;
  50
  51     @Context
  52     private Providers providers;
  53
  54     @Override
  55     public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
  56             throws Exception {
  57
  58         Map<String, String> headers = Collections.list((request).getHeaderNames()).stream()
  59                 .collect(Collectors.toMap(h -> h, request::getHeader));
  60         setRequestId(headers);
  61         setInvocationId(headers);
  62         setServiceName(request);
  63         setMDCPartnerName(headers);
  64         mdcSetup.setClientIPAddress(request);
  65         mdcSetup.setEntryTimeStamp();
  66         mdcSetup.setInstanceUUID();
  67         mdcSetup.setServerFQDN();
  68         MDC.put(ONAPLogConstants.MDCs.RESPONSE_STATUS_CODE, ONAPLogConstants.ResponseStatus.INPROGRESS.toString());
  69         logger.info(ONAPLogConstants.Markers.ENTRY, "Entering");
  70         if (logger.isDebugEnabled())
  71             logRequestInformation(request);
  72         return true;
  73     }
  74
  75     protected void logRequestInformation(HttpServletRequest request) {
  76         Map<String, String> headers = Collections.list((request).getHeaderNames()).stream()
  77                 .collect(Collectors.toMap(h -> h, request::getHeader));
  78
  79         logger.debug("===========================request begin================================================");
  80         logger.debug("URI         : {}", request.getRequestURI());
  81         logger.debug("Method      : {}", request.getMethod());
  82         logger.debug("Headers     : {}", headers);
  83         logger.debug("==========================request end================================================");
  84
  85     }
  86
  87     @Override
  88     public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler,
  89             ModelAndView modelAndView) throws Exception {
  90         setResponseStatusCode(response);
  91         MDC.put(ONAPLogConstants.MDCs.RESPONSE_DESCRIPTION, "");
  92         MDC.put(ONAPLogConstants.MDCs.RESPONSE_CODE, String.valueOf(response.getStatus()));
  93         logger.info(ONAPLogConstants.Markers.EXIT, "Exiting.");
  94         MDC.clear();
  95     }
  96
  97     protected void setResponseStatusCode(HttpServletResponse response) {
  98         String statusCode;
  99         if (Response.Status.Family.familyOf(response.getStatus()).equals(Response.Status.Family.SUCCESSFUL)) {
 100             statusCode = ONAPLogConstants.ResponseStatus.COMPLETED.toString();
 101         } else {
 102             statusCode = ONAPLogConstants.ResponseStatus.ERROR.toString();
 103         }
 104         MDC.put(ONAPLogConstants.MDCs.RESPONSE_STATUS_CODE, statusCode);
 105     }
 106
 107     protected void setServiceName(HttpServletRequest request) {
 108         MDC.put(ONAPLogConstants.MDCs.SERVICE_NAME, request.getRequestURI());
 109     }
 110
 111     protected void setRequestId(Map<String, String> headers) {
 112         String requestId = headers.get(ONAPLogConstants.Headers.REQUEST_ID.toLowerCase());
 113         if (requestId == null || requestId.isEmpty())
 114             requestId = UUID.randomUUID().toString();
 115         MDC.put(ONAPLogConstants.MDCs.REQUEST_ID, requestId);
 116     }
 117
 118     protected void setInvocationId(Map<String, String> headers) {
 119         String invocationId = headers.get(ONAPLogConstants.Headers.INVOCATION_ID.toLowerCase());
 120         if (invocationId == null || invocationId.isEmpty())
 121             invocationId = UUID.randomUUID().toString();
 122         MDC.put(ONAPLogConstants.MDCs.INVOCATION_ID, invocationId);
 123     }
 124
 125     protected void setMDCPartnerName(Map<String, String> headers) {
 126         String partnerName = headers.get(ONAPLogConstants.Headers.PARTNER_NAME.toLowerCase());
 127         if (partnerName == null || partnerName.isEmpty())
 128             partnerName = "";
 129         MDC.put(ONAPLogConstants.MDCs.PARTNER_NAME, partnerName);
 130     }
 131
 132
 133 }