filters/provider/src/main/java/org/openecomp/sdnc/filters/LogFilter.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * openECOMP : SDN-C
   4  * ================================================================================
   5  * Copyright (C) 2017 AT&T Intellectual Property. All rights
   6  *                                              reserved.
   7  * ================================================================================
   8  * Licensed under the Apache License, Version 2.0 (the "License");
   9  * you may not use this file except in compliance with the License.
  10  * You may obtain a copy of the License at
  11  *
  12  *      http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  * Unless required by applicable law or agreed to in writing, software
  15  * distributed under the License is distributed on an "AS IS" BASIS,
  16  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  17  * See the License for the specific language governing permissions and
  18  * limitations under the License.
  19  * ============LICENSE_END=========================================================
  20  */
  21
  22 package org.openecomp.sdnc.filters;
  23
  24 import java.io.IOException;
  25 import java.util.UUID;
  26
  27 import javax.servlet.Filter;
  28 import javax.servlet.FilterChain;
  29 import javax.servlet.FilterConfig;
  30 import javax.servlet.ServletException;
  31 import javax.servlet.ServletRequest;
  32 import javax.servlet.ServletResponse;
  33 import javax.servlet.http.HttpServletRequest;
  34 import javax.servlet.http.HttpServletResponse;
  35
  36 import org.apache.commons.codec.binary.Base64;
  37
  38 import org.slf4j.Logger;
  39 import org.slf4j.LoggerFactory;
  40 import org.slf4j.MDC;
  41
  42 import java.text.DateFormat;
  43 import java.text.SimpleDateFormat;
  44 import java.util.Date;
  45 import java.util.TimeZone;
  46
  47
  48
  49 /**
  50  * Logs IN request according ECOMP Logging Guidelines at https://tspace.web.att.com/viewer/app/lcfiles/ae5f7751-39da-4c6b-8a83-5836c8c815e1/content
  51  */
  52 public class LogFilter implements Filter {
  53
  54     //X-ECOMP is shared between audit and metric
  55     public static final String BEGIN_TIMESTAMP = "AUDIT-BeginTimestamp";
  56     public static final String END_TIMESTAMP = "AUDIT-EndTimestamp";
  57     public static final String REQUEST_ID = "X-ECOMP-RequestID";
  58     public static final String SERVICE_INSTANCE = "X-ECOMP-ServiceInstanceID";
  59     public static final String THREAD_ID ="X-ECOMP-ThreadId"; //optional
  60     public static final String PHYSICAL_SERVER_NAME="X-ECOMP-PhysicalServerName"; //optional
  61     public static final String SERVICE_NAME="X-ECOMP-ServiceName";
  62     public static final String PARTNER_NAME="X-ECOMP-PartnerName";
  63     public static final String STATUS_CODE="AUDIT-StatusCode";
  64     public static final String RESP_CODE="AUDIT-ResponseCode";
  65     public static final String RESP_DESC="AUDIT-ResponseDescription";
  66     public static final String INSTANCE_UUID="AUDIT-InstanceUUID";
  67     public static final String CATEGORY="AUDIT-INFO";
  68     public static final String SEVERITY ="AUDIT-Severity"; //optional
  69     public static final String SERVER_IP="AUDIT-ServerIP"; //by chef node['ip']
  70     public static final String ELAPSED_TIME="AUDIT-ElapsedTime";
  71     public static final String SERVER_HOST="AUDIT-Server";//by chef node['fqdn']
  72     public static final String CLIENT_IP="AUDIT-ClientIPaddress";
  73     public static final String CLASS="AUDIT-Classname"; //optional
  74     public static final String UNUSED="AUDIT-Unused"; //empty
  75     public static final String PROCESS_KEY="AUDIT-ProcessKey"; //optional
  76     public static final String CUST_1="AUDIT-CustomField1";//optional
  77     public static final String CUST_2="AUDIT-CustomField2"; //optional
  78     public static final String CUST_3="AUDIT-CustomField3"; //optional
  79     public static final String CUST_4="AUDIT-CustomField4"; //optional
  80     public static final String DETAIL_MESSAGE="AUDIT-DetailMessage";//optional
  81
  82
  83     private static final Logger log = LoggerFactory.getLogger(LogFilter.class);
  84     private static final Logger AUDIT = LoggerFactory.getLogger("org.openecomp.sdnc.filters.audit");
  85     @Override
  86     public void destroy() {
  87         }
  88
  89     @Override
  90     public void doFilter(final ServletRequest request, final ServletResponse response,
  91                 final FilterChain filterChain) throws IOException, ServletException {
  92
  93             long startTime = System.currentTimeMillis();
  94             try {
  95
  96                 if ( request != null && request instanceof HttpServletRequest ) {
  97                     pre((HttpServletRequest)request);
  98                 }
  99                 filterChain.doFilter(request, response);
 100
 101
 102             } finally {
 103
 104                 if (request != null && request instanceof HttpServletRequest ) {
 105                     post((HttpServletRequest)request,(HttpServletResponse)response,startTime);
 106                 }
 107                 MDC.clear();
 108             }
 109
 110         }
 111
 112     @Override
 113     public void init(FilterConfig filterConfig) throws ServletException {
 114         }
 115
 116
 117
 118     private void pre(HttpServletRequest request) {
 119
 120         UUID uuid = UUID.randomUUID();
 121         // check if uuid is in header X-ECOMP-RequestID
 122
 123         String ecompUUID = request.getHeader(REQUEST_ID);
 124
 125         if (ecompUUID != null && ecompUUID.length() > 0) {
 126             try {
 127                 uuid = UUID.fromString(ecompUUID);
 128                 log.info("UUID is ECOMP UUID " + uuid.toString());
 129             } catch (Exception ex){
 130                 log.warn("Failed to convert ECOMP UUID to java.util.UUID format:" + ecompUUID,ex);
 131             }
 132         }
 133         MDC.put(REQUEST_ID, uuid.toString());
 134
 135         String userName="unknown";
 136
 137         /* below returning org.opendaylight.aaa.shiro.realm.TokenAuthRealm$ODLPrincipal@745dfcfe
 138            if ( request.getUserPrincipal() != null) {
 139            userName = request.getUserPrincipal().getName();
 140            }
 141          */
 142         // going directly after Authorization header
 143         if (request.getHeader("Authorization") != null) {
 144             String authzHeader = request.getHeader("Authorization");
 145             String usernameAndPassword = new String(Base64.decodeBase64(authzHeader.substring(6).getBytes()));
 146
 147             int userNameIndex = usernameAndPassword.indexOf(":");
 148             String username = usernameAndPassword.substring(0, userNameIndex);
 149             userName = username;
 150
 151         }
 152
 153
 154         MDC.put(PARTNER_NAME, userName);
 155         //just to initilaze for metric logger (outbound calls)
 156         MDC.put("X-ECOMP-TargetEntity","");
 157         MDC.put("X-ECOMP-TargetServiceName","");
 158
 159         MDC.put(SERVICE_NAME,request.getRequestURL().toString());
 160         MDC.put(SERVICE_INSTANCE,"");
 161
 162     }
 163
 164
 165     private void post(HttpServletRequest request,HttpServletResponse response,long startTime) {
 166
 167         //AUDIT.info("{}|{}|{}{}",request.getRemoteHost(),request.getMethod(),request.getRequestURL().toString(),request.getQueryString());
 168         //AUDIT.info(request.getRemoteHost() + D + request.getMethod() + D + request.getRequestURL().toString() + D + request.getQueryString());
 169         //METRIC.info(request.getMethod() + D + response.getStatus() + D + request.getRequestURL().toString() + D + (System.currentTimeMillis() - startTime) + " ms");
 170         MDC.put(BEGIN_TIMESTAMP,asIso8601(startTime));
 171         MDC.put(END_TIMESTAMP,asIso8601(System.currentTimeMillis()));
 172         //MDC.put(REQUEST_ID,"already done above");
 173         MDC.put(SERVICE_NAME,request.getRequestURL().toString());
 174         int idx = request.getPathInfo().toString().lastIndexOf(":");
 175         String instance = "";
 176         if ( idx != -1 ) {
 177                         instance = request.getPathInfo().substring(idx+1);
 178                 }
 179         MDC.put(SERVICE_INSTANCE,instance);
 180         MDC.put(THREAD_ID,"");
 181         MDC.put(PHYSICAL_SERVER_NAME,"");
 182         //MDC.put(PARTNER_NAME,"already done above");
 183         if ( response.getStatus() >= 400 ) {
 184                         MDC.put(STATUS_CODE,"ERROR");
 185                 } else {
 186                         MDC.put(STATUS_CODE,"COMPLETE");
 187                 }
 188
 189         MDC.put(RESP_CODE,"" + response.getStatus());
 190         MDC.put(RESP_DESC,"");
 191         MDC.put(INSTANCE_UUID,"");
 192         MDC.put(CATEGORY,"");
 193         MDC.put(SEVERITY,"");
 194         //MDC.put(SERVER_IP,""); //by chef
 195         MDC.put(ELAPSED_TIME,"" + (System.currentTimeMillis() - startTime));
 196         //MDC.put(SERVER_HOST,""); //by chef
 197         MDC.put(CLIENT_IP,request.getRemoteHost());
 198         MDC.put(CLASS,"");
 199         MDC.put(UNUSED,"");
 200         MDC.put(PROCESS_KEY,"");
 201         MDC.put(CUST_1,"");
 202         MDC.put(CUST_2,"");
 203         MDC.put(CUST_3,"");
 204         MDC.put(CUST_4,"");
 205         MDC.put(DETAIL_MESSAGE,request.getMethod());
 206
 207         AUDIT.info("");
 208     }
 209
 210     private String asIso8601(Date date) {
 211         TimeZone tz = TimeZone.getTimeZone("UTC");
 212         DateFormat df = new SimpleDateFormat("yyy-MM-dd'T'hh:mm:ss:SS'+00:00'");
 213         df.setTimeZone(tz);
 214         return df.format(date);
 215     }
 216
 217     private String asIso8601(long tsInMillis) {
 218         return asIso8601(new Date(tsInMillis));
 219     }
 220
 221
 222 }