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
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
|
/*-
* ============LICENSE_START=======================================================
* SDC
* ================================================================================
* Copyright (C) 2020 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=========================================================
* Modifications copyright (c) 2020 Nordix Foundation
* ================================================================================
*/
package org.openecomp.sdc.common.log.elements;
import com.google.common.annotations.VisibleForTesting;
import java.util.Arrays;
import java.util.List;
import java.util.UUID;
import javax.servlet.http.HttpServletRequest;
import org.apache.commons.lang3.StringUtils;
import org.onap.logging.ref.slf4j.ONAPLogConstants;
import org.openecomp.sdc.common.log.api.ILogFieldsHandler;
import org.openecomp.sdc.common.log.api.ILogger;
import org.openecomp.sdc.common.log.enums.ConstantsLogging;
import org.openecomp.sdc.common.log.enums.LogLevel;
import org.openecomp.sdc.common.log.enums.LogMarkers;
import org.openecomp.sdc.common.log.utils.LoggingThreadLocalsHolder;
import org.slf4j.Logger;
import org.slf4j.Marker;
import org.slf4j.MarkerFactory;
/**
* Created by mm288v on 12/27/2017. This class holds the common behavior of all Loger-Typed classes. The Concrete
* loggers shoudl derive from this one.
*/
public abstract class LoggerBase implements ILogger {
private static final String missingLogFieldsMsg = "mandatory parameters for ECOMP logging, missing fields: %s, original message: %s";
protected final ILogFieldsHandler ecompLogFieldsHandler;
private final Logger myLogger;
private final Marker myMarker;
LoggerBase(ILogFieldsHandler ecompLogFieldsHandler, Marker marker, Logger logger) {
this.ecompLogFieldsHandler = ecompLogFieldsHandler;
this.myMarker = marker;
this.myLogger = logger;
setKeyRequestIdIfNotSetYet();
}
public static String generateKeyRequestId() {
return UUID.randomUUID().toString();
}
public static String getRequestId(HttpServletRequest httpRequest) {
String onapRequestId = httpRequest.getHeader(ONAPLogConstants.Headers.REQUEST_ID);
String requestId = httpRequest.getHeader(ConstantsLogging.X_REQUEST_ID);
String transactionReId = httpRequest.getHeader(ConstantsLogging.X_TRANSACTION_ID_HEADER);
String ecompRequestId = httpRequest.getHeader(ConstantsLogging.X_ECOMP_REQUEST_ID_HEADER);
return Arrays.asList(onapRequestId, requestId, transactionReId, ecompRequestId).stream()
.filter(id -> !StringUtils.isEmpty(id)).findFirst().orElse(generateKeyRequestId());
}
public static String getPartnerName(HttpServletRequest httpRequest) {
String userId = httpRequest.getHeader(ConstantsLogging.USER_ID_HEADER);
String onapPartnerName = httpRequest.getHeader(ONAPLogConstants.Headers.PARTNER_NAME);
String reqUri = httpRequest.getHeader(ConstantsLogging.USER_AGENT_HEADER);
return Arrays.asList(userId, onapPartnerName, reqUri).stream()
.filter(pn -> !StringUtils.isEmpty(pn)).findFirst().orElse(ConstantsLogging.PartnerName_Unknown);
}
protected void setKeyRequestIdIfNotSetYet() {
if (StringUtils.isEmpty(ecompLogFieldsHandler.getKeyRequestId())) {
setKeyRequestId(LoggingThreadLocalsHolder.getUuid());
}
}
private void validateMandatoryFields(String originMsg) {
// this method only checks if the mandatory fields have been initialized
String filedNameThatHasNotBeenInitialized = checkMandatoryFieldsExistInMDC();
if (myLogger.isDebugEnabled() && !"".equalsIgnoreCase(filedNameThatHasNotBeenInitialized)) {
myLogger.debug(MarkerFactory.getMarker(LogMarkers.DEBUG_MARKER.getText()),
String.format(missingLogFieldsMsg, filedNameThatHasNotBeenInitialized, originMsg));
}
}
@VisibleForTesting
String checkMandatoryFieldsExistInMDC() {
// this method returns a String of uninitialised fields
StringBuilder missingFields = new StringBuilder();
getMandatoryFields().forEach(field -> {
if (ecompLogFieldsHandler.isMDCParamEmpty(field)) {
missingFields.append(field).append(" ");
}
});
return missingFields.toString();
}
public abstract List<String> getMandatoryFields();
protected String convertExceptionStackToString(Exception ex) {
StringBuilder stackTrack = new StringBuilder();
Arrays.asList(ex.getStackTrace()).forEach(item -> stackTrack.append(item.toString()).append("\n"));
return stackTrack.toString();
}
@Override
public void log(LogLevel logLevel, String message) {
log(logLevel, message, (Object) null);
}
@Override
public void log(Marker marker, LogLevel logLevel, String message) {
log(marker, logLevel, message, (Object) null);
}
@Override
public void log(LogLevel logLevel, String message, Object... params) {
validateMandatoryFields(message);
switch (logLevel) {
case ERROR:
case FATAL: //TODO check how to log "FATAL" word
myLogger.error(myMarker, message, params);
break;
case WARN:
myLogger.warn(myMarker, message, params);
break;
case INFO:
myLogger.info(myMarker, message, params);
break;
case DEBUG:
myLogger.debug(myMarker, message, params);
break;
case TRACE:
myLogger.trace(myMarker, message, params);
break;
default:
break;
}
}
@Override
public void log(LogLevel logLevel, String message, Throwable throwable) {
validateMandatoryFields(message);
switch (logLevel) {
case ERROR:
case FATAL: //TODO check how to log "FATAL" word
myLogger.error(myMarker, createErrorMessage(message, throwable));
break;
case WARN:
myLogger.warn(myMarker, createErrorMessage(message, throwable));
break;
case INFO:
myLogger.info(myMarker, createErrorMessage(message, throwable));
break;
case DEBUG:
myLogger.debug(myMarker, message, throwable);
break;
case TRACE:
myLogger.trace(myMarker, message, throwable);
break;
default:
break;
}
}
@Override
public void log(Marker marker, LogLevel logLevel, String message, Object... params) {
validateMandatoryFields(message);
switch (logLevel) {
case ERROR:
case FATAL: //TODO check how to log "FATAL" word
myLogger.error(marker, message, params);
break;
case WARN:
myLogger.warn(marker, message, params);
break;
case INFO:
myLogger.info(marker, message, params);
break;
case DEBUG:
myLogger.debug(marker, message, params);
break;
case TRACE:
myLogger.trace(marker, message, params);
break;
default:
break;
}
}
protected String createErrorMessage(String message, Throwable throwable) {
return String.format("%s: %s", message, throwable.getLocalizedMessage());
}
@Override
public ILogger clear() {
ecompLogFieldsHandler.clear();
return this;
}
@Override
public ILogger setKeyRequestId(String keyRequestId) {
ecompLogFieldsHandler.setKeyRequestId(keyRequestId);
return this;
}
@Override
public ILogger setKeyInvocationId(String keyInvocationId) {
ecompLogFieldsHandler.setKeyInvocationId(keyInvocationId);
return this;
}
}
|
