aboutsummaryrefslogtreecommitdiffstats
path: root/reference/logging-filter/logging-filter-base/src/main/java/org/onap/logging/filter/base/AbstractMetricLogFilter.java
blob: bdba9b610b1a4961e1326970571e7f2a5a356e4b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
/*-
 * ============LICENSE_START=======================================================
 * ONAP - Logging
 * ================================================================================
 * Copyright (C) 2019 AT&T Intellectual Property. All rights reserved.
 * ================================================================================
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * ============LICENSE_END=========================================================
 */

package org.onap.logging.filter.base;

import org.onap.logging.ref.slf4j.ONAPLogConstants;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public abstract class AbstractMetricLogFilter<Request, Response, RequestHeaders>
        extends AbstractBaseMetricLogFilter<Request, Response> {
    protected static final Logger logger = LoggerFactory.getLogger(AbstractMetricLogFilter.class);

    public AbstractMetricLogFilter() {
        super();
    }

    protected abstract void addHeader(RequestHeaders requestHeaders, String headerName, String headerValue);

    protected void pre(Request request, RequestHeaders requestHeaders) {
        try {
            setupMDC(request);
            setupHeaders(request, requestHeaders, extractRequestID(), setInvocationId());
            additionalPre(request);
            additionalPre(request, requestHeaders);
            logRequest();
        } catch (Exception e) {
            logger.warn("Error in AbstractMetricLogFilter pre", e);
        }
    }

    protected void additionalPre(Request request, RequestHeaders requestHeaders) {
        // override to add application specific logic
    }

    protected void setupHeaders(Request clientRequest, RequestHeaders requestHeaders, String requestId,
            String invocationId) {
        addHeader(requestHeaders, ONAPLogConstants.Headers.REQUEST_ID, requestId);
        addHeader(requestHeaders, Constants.HttpHeaders.HEADER_REQUEST_ID, requestId);
        addHeader(requestHeaders, Constants.HttpHeaders.TRANSACTION_ID, requestId);
        addHeader(requestHeaders, Constants.HttpHeaders.ECOMP_REQUEST_ID, requestId);
        addHeader(requestHeaders, ONAPLogConstants.Headers.PARTNER_NAME, partnerName);
        logger.trace("Setting X-InvocationID header for outgoing request: {}", invocationId);
        addHeader(requestHeaders, ONAPLogConstants.Headers.INVOCATION_ID, invocationId);
    }

}