2 * ============LICENSE_START=======================================================
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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=========================================================
21 package org.onap.so.logging.spring.interceptor;
23 import java.util.Collections;
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.logging.jaxrs.filter.MDCSetup;
34 import org.slf4j.Logger;
35 import org.slf4j.LoggerFactory;
37 import org.springframework.beans.factory.annotation.Autowired;
38 import org.springframework.stereotype.Component;
39 import org.springframework.web.servlet.ModelAndView;
40 import org.springframework.web.servlet.handler.HandlerInterceptorAdapter;
43 public class LoggingInterceptor extends HandlerInterceptorAdapter {
45 Logger logger = LoggerFactory.getLogger(LoggingInterceptor.class);
48 private MDCSetup mdcSetup;
51 private Providers providers;
54 public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
57 Map<String, String> headers = Collections.list((request).getHeaderNames())
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);
75 protected void logRequestInformation(HttpServletRequest request) {
76 Map<String, String> headers = Collections.list((request).getHeaderNames())
78 .collect(Collectors.toMap(h -> h, request::getHeader));
80 logger.debug("===========================request begin================================================");
81 logger.debug("URI : {}", request.getRequestURI());
82 logger.debug("Method : {}", request.getMethod());
83 logger.debug("Headers : {}", headers);
84 logger.debug("==========================request end================================================");
89 public void postHandle(
90 HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView)
92 setResponseStatusCode(response);
93 MDC.put(ONAPLogConstants.MDCs.RESPONSE_DESCRIPTION,"");
94 MDC.put(ONAPLogConstants.MDCs.RESPONSE_CODE,String.valueOf(response.getStatus()));
95 logger.info(ONAPLogConstants.Markers.EXIT, "Exiting.");
99 protected void setResponseStatusCode(HttpServletResponse response) {
101 if(Response.Status.Family.familyOf(response.getStatus()).equals(Response.Status.Family.SUCCESSFUL)){
102 statusCode=ONAPLogConstants.ResponseStatus.COMPLETED.toString();
104 statusCode= ONAPLogConstants.ResponseStatus.ERROR.toString();
106 MDC.put(ONAPLogConstants.MDCs.RESPONSE_STATUS_CODE, statusCode);
109 protected void setServiceName(HttpServletRequest request) {
110 MDC.put(ONAPLogConstants.MDCs.SERVICE_NAME, request.getRequestURI());
113 protected void setRequestId(Map<String, String> headers) {
114 String requestId=headers.get(ONAPLogConstants.Headers.REQUEST_ID.toLowerCase());
115 if(requestId == null || requestId.isEmpty())
116 requestId = UUID.randomUUID().toString();
117 MDC.put(ONAPLogConstants.MDCs.REQUEST_ID,requestId);
120 protected void setInvocationId(Map<String, String> headers) {
121 String invocationId = headers.get(ONAPLogConstants.Headers.INVOCATION_ID.toLowerCase());
122 if(invocationId == null || invocationId.isEmpty())
123 invocationId =UUID.randomUUID().toString();
124 MDC.put(ONAPLogConstants.MDCs.INVOCATION_ID, invocationId);
127 protected void setMDCPartnerName(Map<String, String> headers) {
128 String partnerName=headers.get(ONAPLogConstants.Headers.PARTNER_NAME.toLowerCase());
129 if(partnerName == null || partnerName.isEmpty())
131 MDC.put(ONAPLogConstants.MDCs.PARTNER_NAME,partnerName);