aboutsummaryrefslogtreecommitdiffstats
path: root/sli/common/src/main/java/org/onap/ccsdk/sli/core/sli/MetricLogger.java
blob: 30340d47690202b698b85c1a67bae4aef74d0de4 (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
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
/*-
 * ============LICENSE_START=======================================================
 * ONAP : CCSDK
 * ================================================================================
 * Copyright (C) 2017 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.ccsdk.sli.core.sli;

import java.text.DateFormat;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.TimeZone;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.slf4j.MDC;
import org.slf4j.Marker;
import org.slf4j.MarkerFactory;

/**
 * @author dt5972
 *
 */
public class MetricLogger {

    private static final Logger METRIC = LoggerFactory.getLogger("org.onap.ccsdk.sli.core.filters.metric");
    
    //TODO use ONAPLogConstants
    public static final String BEGIN_TIMESTAMP = "InvokeTimestamp";
    public static final String LOG_TIMESTAMP = "LogTimestamp";
    public static final String REQUEST_ID = "RequestID";
    public static final String SERVICE_INSTANCE_ID = "ServiceInstanceID";
    public static final String TARGET_ENTITY = "TargetEntity";
    public static final String TARGET_SERVICE_NAME = "TargetServiceName";
    public static final String STATUS_CODE = "StatusCode";
    public static final String RESPONSE_CODE = "ResponseCode";
    public static final String RESPONSE_DESCRIPTION = "ResponseDesc";
    public static final String INSTANCE_UUID = "InstanceID";
    public static final String ELAPSED_TIME = "ElapsedTime";
    public static final String CLIENT_IP = "ClientIPaddress";
    public static final String TARGET_VIRTUAL_ENTITY = "TargetElement";
    private static final Marker INVOKE_RETURN = MarkerFactory.getMarker("INVOKE-RETURN");
    private static final Marker INVOKE = MarkerFactory.getMarker("INVOKE");

    private String lastMsg = null;

    public String getRequestID() {
        return MDC.get(REQUEST_ID);
    }
    
    public MetricLogger() {

    }

    public static String asIso8601(Date date) {
        TimeZone tz = TimeZone.getTimeZone("UTC");
        DateFormat df = new SimpleDateFormat("yyy-MM-dd'T'HH:mm:ss.SS'+00:00'");
        df.setTimeZone(tz);
        return df.format(date);
    }

    public static String asIso8601(long tsInMillis) {
        return MetricLogger.asIso8601(new Date(tsInMillis));
    }

    @Deprecated
    public void logRequest(String svcInstanceId, String svcName, String partnerName, String targetEntity, String targetServiceName, String targetVirtualEntity, String msg) {
        logRequest(svcInstanceId,targetEntity,targetServiceName,targetVirtualEntity,msg);
    }

    public void logRequest(String svcInstanceId, String targetEntity, String targetServiceName, String targetVirtualEntity, String msg) {
        long start = System.currentTimeMillis();
        MDC.put(BEGIN_TIMESTAMP, MetricLogger.asIso8601(start));

        if (svcInstanceId != null) {
            MDC.put(SERVICE_INSTANCE_ID, svcInstanceId);
        }
        if (targetEntity != null) {
            MDC.put(TARGET_ENTITY, targetEntity);
        }

        if (targetServiceName != null) {
            MDC.put(TARGET_SERVICE_NAME, targetServiceName);
        }

        if (targetVirtualEntity != null) {
            MDC.put(TARGET_VIRTUAL_ENTITY, targetVirtualEntity);
        }
        this.lastMsg = msg;
        METRIC.info(INVOKE, "Invoke");
    }
    
    public void logResponse(String statusCode, String responseCode, String responseDescription) {
        long start = System.currentTimeMillis();
        MDC.put(BEGIN_TIMESTAMP, MetricLogger.asIso8601(start));

        if (statusCode != null) {
            MDC.put(STATUS_CODE, statusCode);
        }
        if (responseCode != null) {
            MDC.put(RESPONSE_CODE, responseCode);
        }
        if (responseDescription != null) {
            MDC.put(RESPONSE_DESCRIPTION, formatString(responseDescription));
        }
        long end = System.currentTimeMillis();
        MDC.put(LOG_TIMESTAMP, MetricLogger.asIso8601(end));
        MDC.put(ELAPSED_TIME, Long.toString(end-start));
        METRIC.info(INVOKE_RETURN, formatString(lastMsg));
        resetContext();
    }

    protected String formatString(String str) {
        if (str != null) {
            str = str.replaceAll("\\R", ""); // this will strip all new line characters
            str = str.replaceAll("\\|", "%7C"); // log records should not contain a pipe, encode the pipe character
        }
        return str;
    }

    public static void resetContext() {
        MDC.remove(TARGET_ENTITY);
        MDC.remove(TARGET_SERVICE_NAME);
        MDC.remove(TARGET_VIRTUAL_ENTITY);
        MDC.remove(STATUS_CODE);
        MDC.remove(RESPONSE_CODE);
        MDC.remove(RESPONSE_DESCRIPTION);
    }
}