summaryrefslogtreecommitdiffstats
path: root/reference/logging-filter/logging-filter-base/src/main/java/org/onap/logging/filter/base/MDCSetup.java
diff options
context:
space:
mode:
authorSmokowski, Kevin (ks6305) <kevin.smokowski@att.com>2019-09-10 18:14:41 +0000
committerSmokowski, Kevin (ks6305) <kevin.smokowski@att.com>2019-09-10 18:28:15 +0000
commit390e0476092c59676406512f8ce8cdda5dfdd328 (patch)
tree56ce27080712c844059103c9663ce7da86467d1e /reference/logging-filter/logging-filter-base/src/main/java/org/onap/logging/filter/base/MDCSetup.java
parentcce9554c9771c0227edc17181c2011d28a9c052b (diff)
updating logging filters
maximize re-use in logging filter classes Issue-ID: LOG-1125 Signed-off-by: Smokowski, Kevin (ks6305) <kevin.smokowski@att.com> Change-Id: I063d57635fe56a60d97945873d0c7b64852182a5
Diffstat (limited to 'reference/logging-filter/logging-filter-base/src/main/java/org/onap/logging/filter/base/MDCSetup.java')
-rw-r--r--reference/logging-filter/logging-filter-base/src/main/java/org/onap/logging/filter/base/MDCSetup.java212
1 files changed, 0 insertions, 212 deletions
diff --git a/reference/logging-filter/logging-filter-base/src/main/java/org/onap/logging/filter/base/MDCSetup.java b/reference/logging-filter/logging-filter-base/src/main/java/org/onap/logging/filter/base/MDCSetup.java
deleted file mode 100644
index 16fa210..0000000
--- a/reference/logging-filter/logging-filter-base/src/main/java/org/onap/logging/filter/base/MDCSetup.java
+++ /dev/null
@@ -1,212 +0,0 @@
-/*-
- * ============LICENSE_START=======================================================
- * ONAP - Logging
- * ================================================================================
- * Copyright (C) 2019 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.logging.filter.base;
-
-import java.net.InetAddress;
-import java.net.UnknownHostException;
-import java.time.ZoneOffset;
-import java.time.ZonedDateTime;
-import java.time.format.DateTimeFormatter;
-import java.time.temporal.ChronoUnit;
-import java.util.UUID;
-import javax.servlet.http.HttpServletRequest;
-import javax.ws.rs.core.HttpHeaders;
-import javax.ws.rs.core.Response;
-import org.onap.logging.ref.slf4j.ONAPLogConstants;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
-import org.slf4j.MDC;
-
-public class MDCSetup {
-
- protected static Logger logger = LoggerFactory.getLogger(MDCSetup.class);
-
- private static final String INSTANCE_UUID = UUID.randomUUID().toString();
-
- public void setInstanceID() {
- MDC.put(ONAPLogConstants.MDCs.INSTANCE_UUID, INSTANCE_UUID);
- }
-
- public void setServerFQDN() {
- String serverFQDN = "";
- InetAddress addr = null;
- try {
- addr = InetAddress.getLocalHost();
- serverFQDN = addr.getCanonicalHostName();
- MDC.put(ONAPLogConstants.MDCs.SERVER_IP_ADDRESS, addr.getHostAddress());
- } catch (UnknownHostException e) {
- logger.warn("Cannot Resolve Host Name");
- serverFQDN = "";
- }
- MDC.put(ONAPLogConstants.MDCs.SERVER_FQDN, serverFQDN);
- }
-
- public void setClientIPAddress(HttpServletRequest httpServletRequest) {
- String clientIpAddress = "";
- if (httpServletRequest != null) {
- // This logic is to avoid setting the client ip address to that of the load
- // balancer in front of the application
- String getForwadedFor = httpServletRequest.getHeader("X-Forwarded-For");
- if (getForwadedFor != null) {
- clientIpAddress = getForwadedFor;
- } else {
- clientIpAddress = httpServletRequest.getRemoteAddr();
- }
- }
- MDC.put(ONAPLogConstants.MDCs.CLIENT_IP_ADDRESS, clientIpAddress);
- }
-
- public void setEntryTimeStamp() {
- MDC.put(ONAPLogConstants.MDCs.ENTRY_TIMESTAMP,
- ZonedDateTime.now(ZoneOffset.UTC).format(DateTimeFormatter.ISO_INSTANT));
- }
-
- public void setServiceName(HttpServletRequest request) {
- MDC.put(ONAPLogConstants.MDCs.SERVICE_NAME, request.getRequestURI());
- }
-
- public String getRequestId(SimpleMap headers) {
- logger.trace("Checking X-ONAP-RequestID header for requestId.");
- String requestId = headers.get(ONAPLogConstants.Headers.REQUEST_ID);
- if (requestId != null && !requestId.isEmpty()) {
- return requestId;
- }
-
- logger.trace("No valid X-ONAP-RequestID header value. Checking X-RequestID header for requestId.");
- requestId = headers.get(Constants.HttpHeaders.HEADER_REQUEST_ID);
- if (requestId != null && !requestId.isEmpty()) {
- return requestId;
- }
-
- logger.trace("No valid X-RequestID header value. Checking X-TransactionID header for requestId.");
- requestId = headers.get(Constants.HttpHeaders.TRANSACTION_ID);
- if (requestId != null && !requestId.isEmpty()) {
- return requestId;
- }
-
- logger.trace("No valid X-TransactionID header value. Checking X-ECOMP-RequestID header for requestId.");
- requestId = headers.get(Constants.HttpHeaders.ECOMP_REQUEST_ID);
- if (requestId != null && !requestId.isEmpty()) {
- return requestId;
- }
-
- logger.trace("No valid requestId headers. Generating requestId: {}", requestId);
- return UUID.randomUUID().toString();
- }
-
- public void setInvocationId(SimpleMap headers) {
- String invocationId = headers.get(ONAPLogConstants.Headers.INVOCATION_ID);
- if (invocationId == null || invocationId.isEmpty())
- invocationId = UUID.randomUUID().toString();
- MDC.put(ONAPLogConstants.MDCs.INVOCATION_ID, invocationId);
- }
-
- public void setInvocationIdFromMDC() {
- String invocationId = MDC.get(ONAPLogConstants.MDCs.INVOCATION_ID);
- if (invocationId == null || invocationId.isEmpty())
- invocationId = UUID.randomUUID().toString();
- MDC.put(ONAPLogConstants.MDCs.INVOCATION_ID, invocationId);
- }
-
- public void setMDCPartnerName(SimpleMap headers) {
- logger.trace("Checking X-ONAP-PartnerName header for partnerName.");
- String partnerName = headers.get(ONAPLogConstants.Headers.PARTNER_NAME);
- if (partnerName == null || partnerName.isEmpty()) {
- logger.trace("No valid X-ONAP-PartnerName header value. Checking User-Agent header for partnerName.");
- partnerName = headers.get(HttpHeaders.USER_AGENT);
- if (partnerName == null || partnerName.isEmpty()) {
- logger.trace("No valid User-Agent header value. Checking X-ClientID header for partnerName.");
- partnerName = headers.get(Constants.HttpHeaders.CLIENT_ID);
- if (partnerName == null || partnerName.isEmpty()) {
- logger.trace("No valid partnerName headers. Defaulting partnerName to UNKNOWN.");
- partnerName = Constants.DefaultValues.UNKNOWN;
- }
- }
- }
- MDC.put(ONAPLogConstants.MDCs.PARTNER_NAME, partnerName);
- }
-
- public void setLogTimestamp() {
- MDC.put(ONAPLogConstants.MDCs.LOG_TIMESTAMP,
- ZonedDateTime.now(ZoneOffset.UTC).format(DateTimeFormatter.ISO_INSTANT));
- }
-
- public void setElapsedTime() {
- DateTimeFormatter timeFormatter = DateTimeFormatter.ISO_ZONED_DATE_TIME;
- ZonedDateTime entryTimestamp =
- ZonedDateTime.parse(MDC.get(ONAPLogConstants.MDCs.ENTRY_TIMESTAMP), timeFormatter);
- ZonedDateTime endTimestamp = ZonedDateTime.parse(MDC.get(ONAPLogConstants.MDCs.LOG_TIMESTAMP), timeFormatter);
-
- MDC.put(ONAPLogConstants.MDCs.ELAPSED_TIME,
- Long.toString(ChronoUnit.MILLIS.between(entryTimestamp, endTimestamp)));
- }
-
- public void setElapsedTimeInvokeTimestamp() {
- DateTimeFormatter timeFormatter = DateTimeFormatter.ISO_ZONED_DATE_TIME;
- ZonedDateTime entryTimestamp =
- ZonedDateTime.parse(MDC.get(ONAPLogConstants.MDCs.INVOKE_TIMESTAMP), timeFormatter);
- ZonedDateTime endTimestamp = ZonedDateTime.parse(MDC.get(ONAPLogConstants.MDCs.LOG_TIMESTAMP), timeFormatter);
-
- MDC.put(ONAPLogConstants.MDCs.ELAPSED_TIME,
- Long.toString(ChronoUnit.MILLIS.between(entryTimestamp, endTimestamp)));
- }
-
- public void setResponseStatusCode(int code) {
- String statusCode;
- if (Response.Status.Family.familyOf(code).equals(Response.Status.Family.SUCCESSFUL)) {
- statusCode = ONAPLogConstants.ResponseStatus.COMPLETE.toString();
- } else {
- statusCode = ONAPLogConstants.ResponseStatus.ERROR.toString();
- setErrorCode(code);
- setErrorDesc(code);
- }
- MDC.put(ONAPLogConstants.MDCs.RESPONSE_STATUS_CODE, statusCode);
- }
-
- public void setTargetEntity(ONAPComponentsList targetEntity) {
- MDC.put(ONAPLogConstants.MDCs.TARGET_ENTITY, targetEntity.toString());
- }
-
- public 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_CODE);
- MDC.remove(ONAPLogConstants.MDCs.TARGET_ENTITY);
- MDC.remove(ONAPLogConstants.MDCs.TARGET_SERVICE_NAME);
- MDC.remove(ONAPLogConstants.MDCs.INVOKE_TIMESTAMP);
- MDC.remove(ONAPLogConstants.MDCs.ERROR_CODE);
- MDC.remove(ONAPLogConstants.MDCs.ERROR_DESC);
- }
-
- public void setResponseDescription(int statusCode) {
- MDC.put(ONAPLogConstants.MDCs.RESPONSE_DESCRIPTION, Response.Status.fromStatusCode(statusCode).toString());
- }
-
- public void setErrorCode(int statusCode) {
- MDC.put(ONAPLogConstants.MDCs.ERROR_CODE, String.valueOf(statusCode));
- }
-
- public void setErrorDesc(int statusCode) {
- MDC.put(ONAPLogConstants.MDCs.ERROR_DESC, Response.Status.fromStatusCode(statusCode).toString());
- }
-
-}