reference/logging-filter/logging-filter-base/src/main/java/org/onap/logging/filter/base/AbstractMetricLogFilter.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.base;
  22
  23 import org.onap.logging.ref.slf4j.ONAPLogConstants;
  24 import org.slf4j.Logger;
  25 import org.slf4j.LoggerFactory;
  26
  27 public abstract class AbstractMetricLogFilter<Request, Response, RequestHeaders>
  28         extends AbstractBaseMetricLogFilter<Request, Response> {
  29     protected static final Logger logger = LoggerFactory.getLogger(AbstractMetricLogFilter.class);
  30
  31     public AbstractMetricLogFilter() {
  32         super();
  33     }
  34
  35     protected abstract void addHeader(RequestHeaders requestHeaders, String headerName, String headerValue);
  36
  37     protected void pre(Request request, RequestHeaders requestHeaders) {
  38         try {
  39             setupMDC(request);
  40             setupHeaders(request, requestHeaders, extractRequestID(), setInvocationId());
  41             additionalPre(request);
  42             additionalPre(request, requestHeaders);
  43             logRequest();
  44         } catch (Exception e) {
  45             logger.warn("Error in AbstractMetricLogFilter pre", e);
  46         }
  47     }
  48
  49     protected void additionalPre(Request request, RequestHeaders requestHeaders) {
  50         // override to add application specific logic
  51     }
  52
  53     protected void setupHeaders(Request clientRequest, RequestHeaders requestHeaders, String requestId,
  54             String invocationId) {
  55         addHeader(requestHeaders, ONAPLogConstants.Headers.REQUEST_ID, requestId);
  56         addHeader(requestHeaders, Constants.HttpHeaders.HEADER_REQUEST_ID, requestId);
  57         addHeader(requestHeaders, Constants.HttpHeaders.TRANSACTION_ID, requestId);
  58         addHeader(requestHeaders, Constants.HttpHeaders.ECOMP_REQUEST_ID, requestId);
  59         addHeader(requestHeaders, ONAPLogConstants.Headers.PARTNER_NAME, partnerName);
  60         logger.trace("Setting X-InvocationID header for outgoing request: {}", invocationId);
  61         addHeader(requestHeaders, ONAPLogConstants.Headers.INVOCATION_ID, invocationId);
  62     }
  63
  64 }