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
|
/*-
* ============LICENSE_START=======================================================
* SDC
* ================================================================================
* 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.openecomp.sdc.be.filters;
import com.google.gson.GsonBuilder;
import org.openecomp.sdc.be.config.BeEcompErrorManager;
import org.openecomp.sdc.be.config.Configuration;
import org.openecomp.sdc.be.config.ConfigurationManager;
import org.openecomp.sdc.be.dao.api.ActionStatus;
import org.openecomp.sdc.be.dao.jsongraph.TitanDao;
import org.openecomp.sdc.be.impl.ComponentsUtils;
import org.openecomp.sdc.be.impl.WebAppContextWrapper;
import org.openecomp.sdc.common.api.Constants;
import org.openecomp.sdc.common.log.elements.LogFieldsMdcHandler;
import org.openecomp.sdc.common.log.enums.LogLevel;
import org.openecomp.sdc.common.log.enums.Severity;
import org.openecomp.sdc.common.log.wrappers.Logger;
import org.openecomp.sdc.common.log.wrappers.LoggerSdcAudit;
import org.openecomp.sdc.common.util.ThreadLocalsHolder;
import org.openecomp.sdc.exception.ResponseFormat;
import org.slf4j.MDC;
import org.springframework.web.context.WebApplicationContext;
import javax.annotation.Priority;
import javax.servlet.ServletContext;
import javax.servlet.http.HttpServletRequest;
import javax.ws.rs.container.ContainerRequestContext;
import javax.ws.rs.container.ContainerRequestFilter;
import javax.ws.rs.container.ContainerResponseContext;
import javax.ws.rs.container.ContainerResponseFilter;
import javax.ws.rs.core.Context;
import javax.ws.rs.core.Response;
import javax.ws.rs.ext.Provider;
import java.io.IOException;
import java.util.UUID;
@Provider
@Priority(1)
public class BeServletFilter implements ContainerRequestFilter, ContainerResponseFilter {
@Context
private HttpServletRequest sr;
private static final Logger log = Logger.getLogger(BeServletFilter.class);
private static LoggerSdcAudit audit = new LoggerSdcAudit(BeServletFilter.class);
@Override
public void filter(ContainerRequestContext requestContext) throws IOException {
try {
MDC.clear();
audit.startLog(requestContext);
// In case of 405 response code, this function is not entered, then
// we'll process
// the MDC fields and UUID during the response
ThreadLocalsHolder.setMdcProcessed(true);
// Timing HTTP request
ThreadLocalsHolder.setRequestStartTime(System.currentTimeMillis());
String uuid = processMdcFields(requestContext);
ThreadLocalsHolder.setUuid(uuid);
inHttpRequest();
} catch (Exception e) {
BeEcompErrorManager.getInstance().logBeRestApiGeneralError("Error during request filter");
log.debug("Error during request filter: {} ", e);
}
}
@Override
public void filter(ContainerRequestContext requestContext, ContainerResponseContext responseContext) throws IOException {
try {
// Formatting the response in case of 405
if (responseContext.getStatus() == Response.Status.METHOD_NOT_ALLOWED.getStatusCode()) {
ResponseFormat responseFormat = getComponentsUtils().getResponseFormat(ActionStatus.NOT_ALLOWED);
responseContext.setEntity(new GsonBuilder().setPrettyPrinting().create().toJson(responseFormat.getRequestError()));
}
if (ThreadLocalsHolder.isMdcProcessed()) {
// filter() was executed during request - this is the regular
// flow
responseContext.getHeaders().add(Constants.X_ECOMP_REQUEST_ID_HEADER, ThreadLocalsHolder.getUuid());
Long startTime = ThreadLocalsHolder.getRequestStartTime();
if (startTime != null) {
long endTime = System.currentTimeMillis();
MDC.put("timer", Long.toString(endTime - startTime));
}
} else {
// this is the 405 response code case
// we have no MDC fields since filter() wasn't executed during
// request
String uuid = processMdcFields(requestContext);
responseContext.getHeaders().add(Constants.X_ECOMP_REQUEST_ID_HEADER, uuid);
// call to start-log method to fill mandatory fields
audit.startLog(requestContext);
}
writeToTitan(responseContext);
//write to Audit log in case it's valuable action
// (e.g. ignoring healthCheck and any other unlogged urls as in yaml
if (isInfoLog()) {
audit.log(sr.getRemoteAddr(),
requestContext,
responseContext.getStatusInfo(),
LogLevel.INFO,
Severity.OK,
LogFieldsMdcHandler.getInstance()
.getAuditMessage());
}
outHttpResponse(responseContext);
} catch (Exception e) {
BeEcompErrorManager.getInstance().logBeRestApiGeneralError("Error during request filter");
log.debug("Error during response filter: {} ", e);
} finally {
// Cleaning up
MDC.clear();
ThreadLocalsHolder.cleanup();
}
}
private void writeToTitan(ContainerResponseContext responseContext) {
log.debug("Close transaction from filter");
TitanDao titanDao = getTitanDao();
if (titanDao != null) {
if (responseContext.getStatus() == Response.Status.OK.getStatusCode() ||
responseContext.getStatus() == Response.Status.CREATED.getStatusCode()) {
titanDao.commit();
log.debug("Doing commit from filter");
} else {
titanDao.rollback();
log.debug("Doing rollback from filter");
}
}
}
private String processMdcFields(ContainerRequestContext requestContext) {
// UserId for logging
String userId = requestContext.getHeaderString(Constants.USER_ID_HEADER);
MDC.put("userId", userId);
String serviceInstanceID = requestContext.getHeaderString(Constants.X_ECOMP_SERVICE_ID_HEADER);
MDC.put("serviceInstanceID", serviceInstanceID);
MDC.put("remoteAddr", sr.getRemoteAddr());
MDC.put("localAddr", sr.getLocalAddr());
// UUID
String uuid = requestContext.getHeaderString(Constants.X_ECOMP_REQUEST_ID_HEADER);
if (uuid == null) {
// Generate the UUID
uuid = UUID.randomUUID().toString();
// Add to MDC for logging
MDC.put("uuid", uuid);
// This log message should already be with the UUID
uuidGeneration(uuid);
} else {
// According to Ella, in case this header exists, we don't have to
// perform any validations
// since it's not our responsibilty, so we log the UUID just as it
// was received.
MDC.put("uuid", uuid);
}
return uuid;
}
private ComponentsUtils getComponentsUtils() {
ServletContext context = this.sr.getSession().getServletContext();
WebAppContextWrapper webApplicationContextWrapper = (WebAppContextWrapper) context.getAttribute(Constants.WEB_APPLICATION_CONTEXT_WRAPPER_ATTR);
WebApplicationContext webApplicationContext = webApplicationContextWrapper.getWebAppContext(context);
return webApplicationContext.getBean(ComponentsUtils.class);
}
private TitanDao getTitanDao() {
ServletContext context = this.sr.getSession().getServletContext();
WebAppContextWrapper webApplicationContextWrapper = (WebAppContextWrapper) context.getAttribute(Constants.WEB_APPLICATION_CONTEXT_WRAPPER_ATTR);
WebApplicationContext webApplicationContext = webApplicationContextWrapper.getWebAppContext(context);
return webApplicationContext.getBean(TitanDao.class);
}
// Extracted for purpose of clear method name, for logback %M parameter
private void inHttpRequest() {
if (isInfoLog()) {
log.info("{} {} {}", sr.getMethod(), sr.getRequestURI(), sr.getProtocol());
} else {
log.debug("{} {} {}", sr.getMethod(), sr.getRequestURI(), sr.getProtocol());
}
}
// Extracted for purpose of clear method name, for logback %M parameter
private void outHttpResponse(ContainerResponseContext responseContext) {
if (isInfoLog()) {
log.info("{} {} {} SC=\"{}\"", sr.getMethod(), sr.getRequestURI(), sr.getProtocol(), responseContext.getStatus());
} else {
log.debug("{} {} {} SC=\"{}\"", sr.getMethod(), sr.getRequestURI(), sr.getProtocol(), responseContext.getStatus());
}
}
private boolean isInfoLog() {
boolean logRequest = true;
Configuration configuration = ConfigurationManager.getConfigurationManager().getConfiguration();
String requestURI = sr.getRequestURI();
if (requestURI != null && configuration.getUnLoggedUrls() != null) {
logRequest = !configuration.getUnLoggedUrls().contains(requestURI);
}
return logRequest;
}
// Extracted for purpose of clear method name, for logback %M parameter
private void uuidGeneration(String uuid) {
log.info("No requestID provided -> Generated UUID {}", uuid);
}
}
|
