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
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
|
/*
* Copyright © 2019 AT&T Intellectual Property.
*
* 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.
*
*
* Unless otherwise specified, all documentation contained herein is licensed under the Creative
* Commons License, Attribution 4.0 Intl. (the "License"); you may not use this documentation except
* in compliance with the License. You may obtain a copy of the License at
*
* https://creativecommons.org/licenses/by/4.0/
*
* Unless required by applicable law or agreed to in writing, documentation 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.
*/
package org.onap.observations;
import static com.att.eelf.configuration.Configuration.MDC_BEGIN_TIMESTAMP;
import static com.att.eelf.configuration.Configuration.MDC_END_TIMESTAMP;
import static com.att.eelf.configuration.Configuration.MDC_KEY_REQUEST_ID;
import static com.att.eelf.configuration.Configuration.MDC_PARTNER_NAME;
import static com.att.eelf.configuration.Configuration.MDC_REMOTE_HOST;
import static com.att.eelf.configuration.Configuration.MDC_RESPONSE_CODE;
import static com.att.eelf.configuration.Configuration.MDC_RESPONSE_DESC;
import static com.att.eelf.configuration.Configuration.MDC_STATUS_CODE;
import static com.att.eelf.configuration.Configuration.MDC_TARGET_ENTITY;
import static com.att.eelf.configuration.Configuration.MDC_TARGET_SERVICE_NAME;
import com.att.eelf.utils.Stopwatch;
import java.net.URI;
import java.util.Date;
import java.util.Map;
import java.util.UUID;
import javax.servlet.http.HttpServletRequest;
import javax.ws.rs.client.ClientRequestContext;
import javax.ws.rs.client.ClientResponseContext;
import javax.ws.rs.container.ContainerRequestContext;
import javax.ws.rs.container.ContainerResponseContext;
import javax.ws.rs.core.MultivaluedMap;
import javax.ws.rs.core.Response.StatusType;
import org.onap.observations.MessageHeaders.HeadersEnum;
import org.slf4j.MDC;
/**
* EELF logging MDC fields not defined in the MDC Configuration (i.e. MDC_ALERT_SEVERITY)
**/
public class Mdc {
/** The Constant SERVICE_NAME. */
public static final String SERVICE_NAME = "CSS-Scheduler";
/**
* The Enum Enum.
*/
public enum Enum {
// BeginTimestamp,
// EndTimeStamp,
// RequestId,
// ServiceInstanceId,
VirtualServerName,
// ServiceName,
// PartnerName,
// StatusCOde,
// ResponseCode,
// ResponseDescription,
// InstanceUUID,
// AlertSeverity,
// ServerIPAddress,
// ElapsedTime,
// ServerFQDN,
// RemoteHost,
ClassName,
Unused,
// ProcessKey,
CustomField1,
CustomField2,
CustomField3,
CustomField4,
// TargetVirtualEntity,
// TargetEntity,
// TargetServiceName,
ErrorCode,
ErrorDescription,
Timer,
}
/**
* Gets the caller.
*
* @param back the back
* @return the caller
*/
public static String getCaller(int back) {
StackTraceElement[] stackTraceElements = Thread.currentThread().getStackTrace();
return stackTraceElements[back].getClassName() + "." + stackTraceElements[back].getMethodName();
}
/**
* Sets the caller.
*
* @param back the new caller
*/
public static void setCaller(int back) {
String caller = MDC.get(Enum.ClassName.name());
if (caller == null) {
MDC.put(Enum.ClassName.name(), getCaller(back));
}
}
/**
* Sets the observation.
*
* @param obs the new observation
*/
public static void setObservation(ObservationInterface obs) {
MDC.put(Enum.CustomField4.name(), obs.name());
}
/**
* Clear caller.
*/
public static void clearCaller() {
MDC.remove(Enum.ClassName.name());
}
/**
* Save.
*
* @return the map
*/
public static Map<String, String> save() {
return MDC.getCopyOfContextMap();
}
/**
* Restore.
*
* @param mdcSave the mdc save
*/
public static void restore(Map<String, String> mdcSave) {
MDC.clear();
for (String name : mdcSave.keySet()) {
MDC.put(name, mdcSave.get(name));
}
}
/**
* Sets the request id if not set.
*
* @param requestId the new request id if not set
*/
public static void setRequestIdIfNotSet(String requestId) {
if (MDC.get(MDC_KEY_REQUEST_ID) == null || MDC.get(MDC_KEY_REQUEST_ID).equals("")) {
setRequestId(requestId);
}
}
/**
* Sets the request id.
*
* @param requestId the new request id
*/
public static void setRequestId(String requestId) {
MDC.put(MDC_KEY_REQUEST_ID, requestId);
}
/**
* Metric start.
*
* @param requestContext the request context
*/
public static void metricStart(ClientRequestContext requestContext) {
MDC.put(MDC_BEGIN_TIMESTAMP, Stopwatch.isoFormatter.format(new Date()));
MDC.put(MDC_END_TIMESTAMP, MDC.get(MDC_BEGIN_TIMESTAMP));
setPartnerTargetFromUri(requestContext.getUri());
}
/**
* Metric end.
*
* @param response the response
*/
public static void metricEnd(ClientResponseContext response) {
Date now = new Date();
MDC.put(MDC_END_TIMESTAMP, Stopwatch.isoFormatter.format(now));
setResponseInfo(response.getStatusInfo());
}
/**
* Audit start.
*
* @param requestContext the request context
* @param servletRequest the servlet request
*/
public static void auditStart(ContainerRequestContext requestContext, HttpServletRequest servletRequest) {
MDC.put(MDC_BEGIN_TIMESTAMP, Stopwatch.isoFormatter.format(new Date()));
MDC.put(MDC_END_TIMESTAMP, MDC.get(MDC_BEGIN_TIMESTAMP));
MDC.put(MDC_REMOTE_HOST, servletRequest.getRemoteHost());
MDC.put(Enum.ClassName.name(), getCaller(4));
MultivaluedMap<String, String> headers = requestContext.getHeaders();
String transactionId = headers.getFirst(HeadersEnum.TransactionID.toString());
if (transactionId != null) {
setRequestId(transactionId);
} else {
setRequestId(UUID.randomUUID().toString());
}
}
/**
* Audit end.
*
* @param requestContext the request context
* @param response the response
*/
public static void auditEnd(ContainerRequestContext requestContext, ContainerResponseContext response) {
Date now = new Date();
// MDC.put(MDC_BEGIN_TIMESTAMP, Stopwatch.isoFormatter.format(now));
MDC.put(MDC_END_TIMESTAMP, Stopwatch.isoFormatter.format(now));
MDC.put(Enum.ClassName.name(), getCaller(4));
setResponseInfo(response.getStatusInfo());
}
private static void setResponseInfo(StatusType statusInfo) {
Integer status = statusInfo.getStatusCode();
String completed = "ERROR";
if (status >= 200 && status < 300) {
completed = "COMPLETE";
}
MDC.put(MDC_RESPONSE_CODE, status.toString());
MDC.put(MDC_RESPONSE_DESC, statusInfo.getReasonPhrase());
MDC.put(MDC_STATUS_CODE, completed);
}
/**
* Sets the event.
*
* @param requestId the new event
*/
public static void setEvent(String requestId) {
MDC.put(MDC_BEGIN_TIMESTAMP, Stopwatch.isoFormatter.format(new Date()));
MDC.put(MDC_END_TIMESTAMP, MDC.get(MDC_BEGIN_TIMESTAMP));
setRequestId(requestId);
}
private static void setPartnerTargetFromUri(URI uri) {
try {
MDC.put(MDC_PARTNER_NAME, uri.getHost());
MDC.put(MDC_TARGET_ENTITY, uri.getScheme() + "://" + uri.getHost() + ":" + uri.getPort());
MDC.put(MDC_TARGET_SERVICE_NAME, uri.getPath());
} catch (Exception e) {
MDC.put(MDC_PARTNER_NAME, "UNKNOWN");
MDC.put(MDC_TARGET_ENTITY, "UNKNOWN");
MDC.put(MDC_TARGET_SERVICE_NAME, "UNKNOWN");
}
}
}
|
