2 * ============LICENSE_START=======================================================
4 * ================================================================================
5 * Copyright (C) 2019 AT&T Intellectual Property. All rights reserved.
6 * ================================================================================
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
18 * ============LICENSE_END=========================================================
21 package org.onap.logging.filter.base;
23 import java.net.InetAddress;
24 import java.net.UnknownHostException;
25 import java.time.ZoneOffset;
26 import java.time.ZonedDateTime;
27 import java.time.format.DateTimeFormatter;
28 import java.time.temporal.ChronoUnit;
29 import java.util.Base64;
30 import java.util.UUID;
31 import javax.servlet.http.HttpServletRequest;
32 import javax.ws.rs.core.HttpHeaders;
33 import javax.ws.rs.core.Response;
34 import org.onap.logging.ref.slf4j.ONAPLogConstants;
35 import org.slf4j.Logger;
36 import org.slf4j.LoggerFactory;
39 public class MDCSetup {
41 protected static Logger logger = LoggerFactory.getLogger(MDCSetup.class);
43 private static final String INSTANCE_UUID = UUID.randomUUID().toString();
45 public void setInstanceID() {
46 MDC.put(ONAPLogConstants.MDCs.INSTANCE_UUID, INSTANCE_UUID);
49 public void setServerFQDN() {
50 String serverFQDN = "";
51 InetAddress addr = null;
53 addr = InetAddress.getLocalHost();
54 serverFQDN = addr.getCanonicalHostName();
55 MDC.put(ONAPLogConstants.MDCs.SERVER_IP_ADDRESS, addr.getHostAddress());
56 } catch (UnknownHostException e) {
57 logger.trace("Cannot Resolve Host Name");
60 MDC.put(ONAPLogConstants.MDCs.SERVER_FQDN, serverFQDN);
63 public void setClientIPAddress(HttpServletRequest httpServletRequest) {
64 String clientIpAddress = "";
65 if (httpServletRequest != null) {
66 // This logic is to avoid setting the client ip address to that of the load
67 // balancer in front of the application
68 String getForwadedFor = httpServletRequest.getHeader("X-Forwarded-For");
69 if (getForwadedFor != null) {
70 clientIpAddress = getForwadedFor;
72 clientIpAddress = httpServletRequest.getRemoteAddr();
75 MDC.put(ONAPLogConstants.MDCs.CLIENT_IP_ADDRESS, clientIpAddress);
78 public void setEntryTimeStamp() {
79 MDC.put(ONAPLogConstants.MDCs.ENTRY_TIMESTAMP,
80 ZonedDateTime.now(ZoneOffset.UTC).format(DateTimeFormatter.ISO_INSTANT));
83 public String getRequestId(SimpleMap headers) {
84 logger.trace("Checking X-ONAP-RequestID header for requestId.");
85 String requestId = headers.get(ONAPLogConstants.Headers.REQUEST_ID);
86 if (requestId != null && !requestId.isEmpty()) {
90 logger.trace("No valid X-ONAP-RequestID header value. Checking X-RequestID header for requestId.");
91 requestId = headers.get(Constants.HttpHeaders.HEADER_REQUEST_ID);
92 if (requestId != null && !requestId.isEmpty()) {
96 logger.trace("No valid X-RequestID header value. Checking X-TransactionID header for requestId.");
97 requestId = headers.get(Constants.HttpHeaders.TRANSACTION_ID);
98 if (requestId != null && !requestId.isEmpty()) {
102 logger.trace("No valid X-TransactionID header value. Checking X-ECOMP-RequestID header for requestId.");
103 requestId = headers.get(Constants.HttpHeaders.ECOMP_REQUEST_ID);
104 if (requestId != null && !requestId.isEmpty()) {
108 logger.trace("No valid requestId headers. Generating requestId: {}", requestId);
109 return UUID.randomUUID().toString();
112 public void setInvocationId(SimpleMap headers) {
113 String invocationId = headers.get(ONAPLogConstants.Headers.INVOCATION_ID);
114 if (invocationId == null || invocationId.isEmpty())
115 invocationId = UUID.randomUUID().toString();
116 MDC.put(ONAPLogConstants.MDCs.SERVER_INVOCATION_ID, invocationId);
117 MDC.put(ONAPLogConstants.MDCs.INVOCATION_ID, invocationId);
120 public void setMDCPartnerName(SimpleMap headers) {
121 String partnerName = getMDCPartnerName(headers);
122 MDC.put(ONAPLogConstants.MDCs.PARTNER_NAME, partnerName);
125 protected String getMDCPartnerName(SimpleMap headers) {
126 String checkHeaderLogPattern = "Checking {} header to determine the value of {}";
128 logger.trace(checkHeaderLogPattern, HttpHeaders.AUTHORIZATION, ONAPLogConstants.MDCs.PARTNER_NAME);
129 String partnerName = getBasicAuthUserName(headers);
130 if (partnerName != null && !partnerName.isEmpty()) {
134 logger.trace(checkHeaderLogPattern, ONAPLogConstants.Headers.PARTNER_NAME, ONAPLogConstants.MDCs.PARTNER_NAME);
135 partnerName = headers.get(ONAPLogConstants.Headers.PARTNER_NAME);
136 if (partnerName != null && !partnerName.isEmpty()) {
140 logger.trace(checkHeaderLogPattern, HttpHeaders.USER_AGENT, ONAPLogConstants.MDCs.PARTNER_NAME);
141 partnerName = headers.get(HttpHeaders.USER_AGENT);
142 if (partnerName != null && !partnerName.isEmpty()) {
146 logger.trace("{} value could not be determined, defaulting partnerName to {}.",
147 ONAPLogConstants.MDCs.PARTNER_NAME, Constants.DefaultValues.UNKNOWN);
148 return Constants.DefaultValues.UNKNOWN;
151 public void setLogTimestamp() {
152 MDC.put(ONAPLogConstants.MDCs.LOG_TIMESTAMP,
153 ZonedDateTime.now(ZoneOffset.UTC).format(DateTimeFormatter.ISO_INSTANT));
156 public void setElapsedTime() {
158 DateTimeFormatter timeFormatter = DateTimeFormatter.ISO_ZONED_DATE_TIME;
159 ZonedDateTime entryTimestamp =
160 ZonedDateTime.parse(MDC.get(ONAPLogConstants.MDCs.ENTRY_TIMESTAMP), timeFormatter);
161 ZonedDateTime endTimestamp =
162 ZonedDateTime.parse(MDC.get(ONAPLogConstants.MDCs.LOG_TIMESTAMP), timeFormatter);
164 MDC.put(ONAPLogConstants.MDCs.ELAPSED_TIME,
165 Long.toString(ChronoUnit.MILLIS.between(entryTimestamp, endTimestamp)));
166 } catch (Exception e) {
167 logger.trace("Unable to calculate elapsed time due to error: {}", e.getMessage());
171 public void setElapsedTimeInvokeTimestamp() {
173 DateTimeFormatter timeFormatter = DateTimeFormatter.ISO_ZONED_DATE_TIME;
174 ZonedDateTime entryTimestamp =
175 ZonedDateTime.parse(MDC.get(ONAPLogConstants.MDCs.INVOKE_TIMESTAMP), timeFormatter);
176 ZonedDateTime endTimestamp =
177 ZonedDateTime.parse(MDC.get(ONAPLogConstants.MDCs.LOG_TIMESTAMP), timeFormatter);
179 MDC.put(ONAPLogConstants.MDCs.ELAPSED_TIME,
180 Long.toString(ChronoUnit.MILLIS.between(entryTimestamp, endTimestamp)));
181 } catch (Exception e) {
182 logger.trace("Unable to calculate elapsed time due to error: {}", e.getMessage());
186 public void setResponseStatusCode(int code) {
188 if (Response.Status.Family.familyOf(code).equals(Response.Status.Family.SUCCESSFUL)) {
189 statusCode = ONAPLogConstants.ResponseStatus.COMPLETE.toString();
191 statusCode = ONAPLogConstants.ResponseStatus.ERROR.toString();
195 MDC.put(ONAPLogConstants.MDCs.RESPONSE_STATUS_CODE, statusCode);
198 public void setTargetEntity(ONAPComponentsList targetEntity) {
199 MDC.put(ONAPLogConstants.MDCs.TARGET_ENTITY, targetEntity.toString());
202 public void clearClientMDCs() {
203 MDC.remove(ONAPLogConstants.MDCs.CLIENT_INVOCATION_ID);
204 MDC.remove(ONAPLogConstants.MDCs.RESPONSE_DESCRIPTION);
205 MDC.remove(ONAPLogConstants.MDCs.RESPONSE_STATUS_CODE);
206 MDC.remove(ONAPLogConstants.MDCs.RESPONSE_CODE);
207 MDC.remove(ONAPLogConstants.MDCs.TARGET_ENTITY);
208 MDC.remove(ONAPLogConstants.MDCs.TARGET_SERVICE_NAME);
209 MDC.remove(ONAPLogConstants.MDCs.INVOKE_TIMESTAMP);
210 MDC.remove(ONAPLogConstants.MDCs.ERROR_CODE);
211 MDC.remove(ONAPLogConstants.MDCs.ERROR_DESC);
214 public void setResponseDescription(int statusCode) {
215 MDC.put(ONAPLogConstants.MDCs.RESPONSE_DESCRIPTION, Response.Status.fromStatusCode(statusCode).toString());
218 public void setErrorCode(int statusCode) {
219 MDC.put(ONAPLogConstants.MDCs.ERROR_CODE, String.valueOf(statusCode));
222 public void setErrorDesc(int statusCode) {
223 MDC.put(ONAPLogConstants.MDCs.ERROR_DESC, Response.Status.fromStatusCode(statusCode).toString());
226 public String getProperty(String property) {
227 String propertyValue = System.getProperty(property);
228 if (propertyValue == null || propertyValue.isEmpty()) {
229 propertyValue = System.getenv(property);
230 if (propertyValue == null || propertyValue.isEmpty()) {
231 propertyValue = Constants.DefaultValues.UNKNOWN;
234 return propertyValue;
237 protected String getBasicAuthUserName(SimpleMap headers) {
238 String encodedAuthorizationValue = headers.get(HttpHeaders.AUTHORIZATION);
239 if (encodedAuthorizationValue != null && encodedAuthorizationValue.startsWith("Basic")) {
241 // This will strip the word Basic and single space
242 encodedAuthorizationValue = encodedAuthorizationValue.substring(6);
243 byte[] decodedBytes = Base64.getDecoder().decode(encodedAuthorizationValue);
244 String decodedString = new String(decodedBytes);
245 int idx = decodedString.indexOf(':');
246 return decodedString.substring(0, idx);
247 } catch (IllegalArgumentException e) {
248 logger.error("could not decode basic auth value " + encodedAuthorizationValue, e);