filters/provider/src/main/java/org/onap/ccsdk/sli/core/filters/LogFilter.java

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