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
|
/*-
* ============LICENSE_START=======================================================
* ONAP - SO
* ================================================================================
* 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.so.logging.jaxrs.filter;
import org.apache.commons.io.IOUtils;
import org.onap.logging.ref.slf4j.ONAPLogConstants;
import org.onap.so.utils.TargetEntity;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.slf4j.MDC;
import org.slf4j.MarkerFactory;
import org.springframework.stereotype.Component;
import javax.annotation.Priority;
import javax.ws.rs.client.ClientRequestContext;
import javax.ws.rs.client.ClientRequestFilter;
import javax.ws.rs.client.ClientResponseContext;
import javax.ws.rs.client.ClientResponseFilter;
import javax.ws.rs.container.ContainerRequestContext;
import javax.ws.rs.container.ContainerResponseContext;
import javax.ws.rs.core.Context;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.MultivaluedMap;
import javax.ws.rs.core.Response;
import javax.ws.rs.ext.MessageBodyWriter;
import javax.ws.rs.ext.Providers;
import java.io.*;
import java.lang.annotation.Annotation;
import java.lang.reflect.Type;
import java.time.ZoneOffset;
import java.time.ZonedDateTime;
import java.time.format.DateTimeFormatter;
import java.util.Map;
import java.util.UUID;
@SuppressWarnings("SpringJavaInjectionPointsAutowiringInspection")
@Component
@Priority(0)
public class JaxRsClientLogging implements ClientRequestFilter,ClientResponseFilter {
@Context
private Providers providers;
private static final String TRACE = "trace-#";
private static final String SO = "SO";
private static Logger logger = LoggerFactory.getLogger(JaxRsClientLogging.class);
public void setTargetService(TargetEntity targetEntity){
MDC.put("TargetEntity", targetEntity.toString());
}
@Override
public void filter(ClientRequestContext clientRequest) {
try{
setupMDC(clientRequest);
setupHeaders(clientRequest);
logger.info(ONAPLogConstants.Markers.INVOKE, "Invoke");
} catch (Exception e) {
logger.warn("Error in incoming JAX-RS Inteceptor", e);
}
}
private void setupHeaders(ClientRequestContext clientRequest) {
MultivaluedMap<String, Object> headers = clientRequest.getHeaders();
headers.add(ONAPLogConstants.Headers.REQUEST_ID, extractRequestID(clientRequest));
headers.add(ONAPLogConstants.Headers.INVOCATION_ID, MDC.get(ONAPLogConstants.MDCs.INVOCATION_ID));
headers.add(ONAPLogConstants.Headers.PARTNER_NAME, SO);
}
private void setupMDC(ClientRequestContext clientRequest) {
MDC.put(ONAPLogConstants.MDCs.INVOKE_TIMESTAMP, ZonedDateTime.now(ZoneOffset.UTC).format(DateTimeFormatter.ISO_INSTANT));
MDC.put(ONAPLogConstants.MDCs.TARGET_SERVICE_NAME, clientRequest.getUri().toString());
MDC.put(ONAPLogConstants.MDCs.RESPONSE_STATUS_CODE, ONAPLogConstants.ResponseStatus.INPROGRESS.toString());
setInvocationId();
MDC.put("TargetEntity",MDC.get("TargetEntity"));
}
private String extractRequestID(ClientRequestContext clientRequest) {
String requestId = MDC.get(ONAPLogConstants.MDCs.REQUEST_ID);
if(requestId == null || requestId.isEmpty() || requestId.equals(TRACE)){
requestId = UUID.randomUUID().toString();
logger.warn("Could not Find Request ID Generating New One: {}",clientRequest.getUri().getPath());
}
return requestId;
}
private void setInvocationId() {
String invocationId = MDC.get(ONAPLogConstants.MDCs.INVOCATION_ID);
if(invocationId == null || invocationId.isEmpty())
invocationId =UUID.randomUUID().toString();
MDC.put(ONAPLogConstants.MDCs.INVOCATION_ID, invocationId);
}
@Override
public void filter(ClientRequestContext requestContext, ClientResponseContext responseContext) {
try {
String statusCode;
if(Response.Status.Family.familyOf(responseContext.getStatus()).equals(Response.Status.Family.SUCCESSFUL)){
statusCode=ONAPLogConstants.ResponseStatus.COMPLETED.toString();
}else{
statusCode=ONAPLogConstants.ResponseStatus.ERROR.toString();
}
MDC.put(ONAPLogConstants.MDCs.RESPONSE_CODE, String.valueOf(responseContext.getStatus()));
MDC.put(ONAPLogConstants.MDCs.RESPONSE_DESCRIPTION,getStringFromInputStream(responseContext));
MDC.put(ONAPLogConstants.MDCs.RESPONSE_STATUS_CODE, statusCode);
logger.info(MarkerFactory.getMarker("INVOKE_RETURN"), "InvokeReturn");
clearClientMDCs();
} catch ( Exception e) {
logger.warn("Error in outgoing JAX-RS Inteceptor", e);
}
}
private void clearClientMDCs() {
MDC.remove(ONAPLogConstants.MDCs.INVOCATION_ID);
MDC.remove(ONAPLogConstants.MDCs.RESPONSE_DESCRIPTION);
MDC.remove(ONAPLogConstants.MDCs.RESPONSE_STATUS_CODE);
MDC.remove(ONAPLogConstants.MDCs.RESPONSE_DESCRIPTION);
MDC.remove(ONAPLogConstants.MDCs.RESPONSE_CODE);
}
private static String getStringFromInputStream(ClientResponseContext clientResponseContext) {
InputStream is = clientResponseContext.getEntityStream();
ByteArrayOutputStream boas = new ByteArrayOutputStream();
try {
IOUtils.copy(is,boas);
InputStream copiedStream = new ByteArrayInputStream(boas.toByteArray());
clientResponseContext.setEntityStream(copiedStream);
return boas.toString();
} catch (IOException e) {
logger.warn("Failed to read response body", e);
}
return "Unable to read input stream";
}
}
|
