reference/logging-filter/logging-filter-spring/src/main/java/org/onap/logging/filter/spring/LoggingInterceptor.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * ONAP - Logging
   4  * ================================================================================
   5  * Copyright (C) 2019 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.logging.filter.spring;
  22
  23 import java.util.Collections;
  24 import java.util.Map;
  25 import java.util.stream.Collectors;
  26 import javax.servlet.http.HttpServletRequest;
  27 import javax.servlet.http.HttpServletResponse;
  28 import javax.ws.rs.core.Context;
  29 import javax.ws.rs.ext.Providers;
  30 import org.onap.logging.filter.base.MDCSetup;
  31 import org.onap.logging.filter.base.SimpleMap;
  32 import org.onap.logging.filter.base.SimpleServletHeadersMap;
  33 import org.onap.logging.ref.slf4j.ONAPLogConstants;
  34 import org.slf4j.Logger;
  35 import org.slf4j.LoggerFactory;
  36 import org.slf4j.MDC;
  37 import org.springframework.stereotype.Component;
  38 import org.springframework.web.servlet.ModelAndView;
  39 import org.springframework.web.servlet.handler.HandlerInterceptorAdapter;
  40
  41 @Component
  42 public class LoggingInterceptor extends HandlerInterceptorAdapter {
  43
  44     private static final Logger logger = LoggerFactory.getLogger(LoggingInterceptor.class);
  45
  46     private MDCSetup mdcSetup = new MDCSetup();
  47
  48     @Context
  49     private Providers providers;
  50
  51     @Override
  52     public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
  53             throws Exception {
  54         SimpleMap headers = new SimpleServletHeadersMap(request);
  55         String requestId = mdcSetup.getRequestId(headers);
  56         MDC.put(ONAPLogConstants.MDCs.REQUEST_ID, requestId);
  57         mdcSetup.setInvocationId(headers);
  58         mdcSetup.setServiceName(request);
  59         mdcSetup.setMDCPartnerName(headers);
  60         mdcSetup.setClientIPAddress(request);
  61         mdcSetup.setEntryTimeStamp();
  62         mdcSetup.setInstanceID();
  63         mdcSetup.setServerFQDN();
  64         MDC.put(ONAPLogConstants.MDCs.RESPONSE_STATUS_CODE, ONAPLogConstants.ResponseStatus.INPROGRESS.toString());
  65         mdcSetup.setLogTimestamp();
  66         mdcSetup.setElapsedTime();
  67         logger.info(ONAPLogConstants.Markers.ENTRY, "Entering");
  68         if (logger.isDebugEnabled())
  69             logRequestInformation(request);
  70         return true;
  71     }
  72
  73     protected void logRequestInformation(HttpServletRequest request) {
  74         Map<String, String> headers = Collections.list((request).getHeaderNames()).stream()
  75                 .collect(Collectors.toMap(h -> h, request::getHeader));
  76
  77         logger.debug("===========================request begin================================================");
  78         logger.debug("URI         : {}", request.getRequestURI());
  79         logger.debug("Method      : {}", request.getMethod());
  80         logger.debug("Headers     : {}", headers);
  81         logger.debug("==========================request end================================================");
  82
  83     }
  84
  85     @Override
  86     public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler,
  87             ModelAndView modelAndView) throws Exception {
  88         mdcSetup.setResponseStatusCode(response.getStatus());
  89         mdcSetup.setLogTimestamp();
  90         mdcSetup.setElapsedTime();
  91         mdcSetup.setResponseDescription(response.getStatus());
  92         MDC.put(ONAPLogConstants.MDCs.RESPONSE_CODE, String.valueOf(response.getStatus()));
  93         logger.info(ONAPLogConstants.Markers.EXIT, "Exiting.");
  94         MDC.clear();
  95     }
  96 }