Code Review / portal.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | review | tree
raw | inline | side by side
Updated code for audit logs
[portal.git] / ecomp-portal-BE-common / src / main / java / org / onap / portalapp / portal / logging / aop / EPEELFLoggerAdvice.java
diff --git a/ecomp-portal-BE-common/src/main/java/org/onap/portalapp/portal/logging/aop/EPEELFLoggerAdvice.java b/ecomp-portal-BE-common/src/main/java/org/onap/portalapp/portal/logging/aop/EPEELFLoggerAdvice.java
index 71338a8..43ea4c3 100644 (file)
--- a/ecomp-portal-BE-common/src/main/java/org/onap/portalapp/portal/logging/aop/EPEELFLoggerAdvice.java
+++ b/ecomp-portal-BE-common/src/main/java/org/onap/portalapp/portal/logging/aop/EPEELFLoggerAdvice.java
@@ -54,6 +54,7 @@ import org.onap.portalsdk.core.exception.SessionExpiredException;
 import org.onap.portalsdk.core.logging.format.AlarmSeverityEnum;
 import org.onap.portalsdk.core.logging.format.AuditLogFormatter;
 import org.onap.portalsdk.core.logging.logic.EELFLoggerDelegate;
+import org.onap.portalsdk.core.logging.logic.LoggerProperties;
 import org.onap.portalsdk.core.util.SystemProperties;
 import org.onap.portalsdk.core.util.SystemProperties.SecurityEventTypeEnum;
 import org.onap.portalsdk.core.web.support.UserUtils;
@@ -108,6 +109,7 @@ public class EPEELFLoggerAdvice {
         * @return Object array
         */
        public Object[] before(SecurityEventTypeEnum securityEventType, Object[] args, Object[] passOnArgs) {
+               try {
                String className = "";
                if (passOnArgs.length > 0 && passOnArgs[0] != null)
                        className = passOnArgs[0].toString();
@@ -117,6 +119,7 @@ public class EPEELFLoggerAdvice {
 
                // Initialize Request defaults only for controller methods.
                MDC.put(className + methodName + EPCommonSystemProperties.METRICSLOG_BEGIN_TIMESTAMP, getCurrentDateTimeUTC());
+               MDC.put(EPCommonSystemProperties.METRICSLOG_BEGIN_TIMESTAMP, getCurrentDateTimeUTC());
                MDC.put(EPCommonSystemProperties.TARGET_ENTITY, EPCommonSystemProperties.ECOMP_PORTAL_BE);
                MDC.put(EPCommonSystemProperties.TARGET_SERVICE_NAME, methodName);
                if (MDC.get(Configuration.MDC_KEY_REQUEST_ID) == null||MDC.get(Configuration.MDC_KEY_REQUEST_ID).isEmpty()){
@@ -124,20 +127,62 @@ public class EPEELFLoggerAdvice {
                        MDC.put(Configuration.MDC_KEY_REQUEST_ID, requestId);
                }
                MDC.put(EPCommonSystemProperties.PARTNER_NAME, "Unknown");
-               MDC.put(Configuration.MDC_SERVICE_NAME, EPCommonSystemProperties.ECOMP_PORTAL_BE);
 
+               EELFLoggerDelegate logger = EELFLoggerDelegate.getLogger(className);
+               MDC.put(EPCommonSystemProperties.STATUS_CODE, "INPROGRESS");
+
+               // Log security message, if necessary
                if (securityEventType != null) {
                        MDC.put(className + methodName + EPCommonSystemProperties.AUDITLOG_BEGIN_TIMESTAMP,
                                        getCurrentDateTimeUTC());
+                       MDC.put(EPCommonSystemProperties.AUDITLOG_BEGIN_TIMESTAMP,getCurrentDateTimeUTC());
+                       MDC.put(EPCommonSystemProperties.AUDITLOG_END_TIMESTAMP, getCurrentDateTimeUTC());
+                       this.calculateDateTimeDifference(MDC.get(EPCommonSystemProperties.AUDITLOG_BEGIN_TIMESTAMP),MDC.get(EPCommonSystemProperties.AUDITLOG_END_TIMESTAMP));
                        HttpServletRequest req = null;
                        if (args.length > 0 && args[0] != null && args[0] instanceof HttpServletRequest) {
                                req = (HttpServletRequest) args[0];
                                this.setHttpRequestBasedDefaultsIntoGlobalLoggingContext(req, securityEventType, methodName);
                        }
-               }
+                       try {
+                               MDC.put(Configuration.MDC_SERVER_FQDN, InetAddress.getLocalHost().getCanonicalHostName());
+                       } catch (Exception e) {
+                               adviceLogger.error(EELFLoggerDelegate.errorLogger,
+                                               " while setting the IP address ", e);
+                       }
+                       MDC.put(SystemProperties.CUSTOM_FIELD1, "ENTRY");
+                       MDC.put(SystemProperties.CUSTOM_FIELD2, "InvocationID="+MDC.get(Configuration.MDC_KEY_REQUEST_ID));
+                       this.logSecurityMessage(logger, securityEventType, methodName);
 
-               EELFLoggerDelegate logger = EELFLoggerDelegate.getLogger(className);
+                       // Outgoing & LDAP messages are part of Incoming requests so,
+                       // keep "RequestId", "PartnerName", "ServiceName", "LoginId" &
+                       // "ResponseCode" etc. in memory and remove it only when
+                       // finished processing the parent incoming message.
+                       if (securityEventType != SecurityEventTypeEnum.OUTGOING_REST_MESSAGE
+                                       && securityEventType != SecurityEventTypeEnum.LDAP_PHONEBOOK_USER_SEARCH) {
+                               MDC.remove(Configuration.MDC_KEY_REQUEST_ID);
+                               MDC.remove(EPCommonSystemProperties.PARTNER_NAME);
+                               MDC.remove(Configuration.MDC_SERVICE_NAME);
+                               MDC.remove(EPCommonSystemProperties.MDC_LOGIN_ID);
+                               MDC.remove(EPCommonSystemProperties.EXTERNAL_API_RESPONSE_CODE);
+                       }else{
+                               MDC.remove(Configuration.MDC_KEY_REQUEST_ID);
+                               MDC.remove(EPCommonSystemProperties.PARTNER_NAME);
+                               MDC.remove(Configuration.MDC_SERVICE_NAME);
+                       }
+                       logger.debug(EELFLoggerDelegate.debugLogger, "{} was invoked.", methodName);
+                       
+                       MDC.remove(Configuration.MDC_SERVER_FQDN);
+               } else {
+                       MDC.put(SystemProperties.METRICSLOG_END_TIMESTAMP, getCurrentDateTimeUTC());
+                       this.calculateDateTimeDifference(MDC.get(SystemProperties.METRICSLOG_BEGIN_TIMESTAMP),MDC.get(SystemProperties.METRICSLOG_END_TIMESTAMP));
+                       MDC.put(SystemProperties.CUSTOM_FIELD1, "INVOKE");
+                       MDC.put(SystemProperties.CUSTOM_FIELD2, " InvocationID="+MDC.get(Configuration.MDC_KEY_REQUEST_ID));
+                       logger.info(EELFLoggerDelegate.metricsLogger, methodName + " operation is started.");           
+               }
                logger.debug(EELFLoggerDelegate.debugLogger, "EPEELFLoggerAdvice#before: entering {}", methodName);
+               } catch (Exception e) {
+                       adviceLogger.error(EELFLoggerDelegate.errorLogger, "before failed", e);
+               }
                return new Object[] { "" };
        }
 
@@ -152,6 +197,7 @@ public class EPEELFLoggerAdvice {
         */
        public void after(SecurityEventTypeEnum securityEventType, String statusCode, String responseCode, Object[] args,
                        Object[] returnArgs, Object[] passOnArgs) {
+               try {
                String className = "";
                if (passOnArgs.length > 0 && passOnArgs[0] != null)
                        className = passOnArgs[0].toString();
@@ -177,8 +223,6 @@ public class EPEELFLoggerAdvice {
                        MDC.put(EPCommonSystemProperties.PARTNER_NAME, "Unknown");
                }
                
-               MDC.put(Configuration.MDC_SERVICE_NAME, EPCommonSystemProperties.ECOMP_PORTAL_BE);
-
 
                MDC.put(EPCommonSystemProperties.METRICSLOG_BEGIN_TIMESTAMP,
                                MDC.get(className + methodName + EPCommonSystemProperties.METRICSLOG_BEGIN_TIMESTAMP));
@@ -207,12 +251,9 @@ public class EPEELFLoggerAdvice {
                        MDC.put(EPCommonSystemProperties.RESPONSE_CODE, externalAPIResponseCode);
                        MDC.put(EPCommonSystemProperties.STATUS_CODE, "ERROR");
                }
-
+               MDC.put(EPCommonSystemProperties.STATUS_CODE, "COMPLETE");
                EELFLoggerDelegate logger = EELFLoggerDelegate.getLogger(className);
-               logger.debug(EELFLoggerDelegate.debugLogger, "EPEELFLoggerAdvice#after: finished {}", methodName);
-               // add the metrics log
-               logger.info(EELFLoggerDelegate.metricsLogger,  methodName + " operation is completed.");
-
+               
                // Log security message, if necessary
                if (securityEventType != null) {
                        MDC.put(EPCommonSystemProperties.AUDITLOG_BEGIN_TIMESTAMP,
@@ -220,7 +261,14 @@ public class EPEELFLoggerAdvice {
                        MDC.put(EPCommonSystemProperties.AUDITLOG_END_TIMESTAMP, getCurrentDateTimeUTC());
                        this.calculateDateTimeDifference(MDC.get(EPCommonSystemProperties.AUDITLOG_BEGIN_TIMESTAMP),
                                        MDC.get(EPCommonSystemProperties.AUDITLOG_END_TIMESTAMP));
-
+                       MDC.put(SystemProperties.CUSTOM_FIELD1, "EXIT");
+                       MDC.put(SystemProperties.CUSTOM_FIELD2, "InvocationID="+MDC.get(Configuration.MDC_KEY_REQUEST_ID));
+                       try {
+                               MDC.put(Configuration.MDC_SERVER_FQDN, InetAddress.getLocalHost().getCanonicalHostName());
+                       } catch (Exception e) {
+                               adviceLogger.error(EELFLoggerDelegate.errorLogger,
+                                               " while setting the IP address ", e);
+                       }
                        this.logSecurityMessage(logger, securityEventType, methodName);
 
                        // Outgoing & LDAP messages are part of Incoming requests so,
@@ -241,6 +289,7 @@ public class EPEELFLoggerAdvice {
                        }
 
                        // clear when finishes audit logging
+                       MDC.remove(Configuration.MDC_SERVER_FQDN);
                        MDC.remove(EPCommonSystemProperties.FULL_URL);
                        MDC.remove(EPCommonSystemProperties.PROTOCOL);
                        MDC.remove(EPCommonSystemProperties.STATUS_CODE);
@@ -248,13 +297,25 @@ public class EPEELFLoggerAdvice {
                        MDC.remove(EPCommonSystemProperties.AUDITLOG_BEGIN_TIMESTAMP);
                        MDC.remove(EPCommonSystemProperties.AUDITLOG_END_TIMESTAMP);
                        MDC.remove(EPCommonSystemProperties.RESPONSE_CODE);
+                       
+               } else {
+                       MDC.put(SystemProperties.CUSTOM_FIELD1, "INVOKE-RETURN");
+                       MDC.put(SystemProperties.CUSTOM_FIELD2, " InvocationID="+MDC.get(Configuration.MDC_KEY_REQUEST_ID));
+                       // add the metrics log
+                       logger.info(EELFLoggerDelegate.metricsLogger,  methodName + " operation is completed.");
                }
+               logger.debug(EELFLoggerDelegate.debugLogger, "EPEELFLoggerAdvice#after: finished {}", methodName);
+               MDC.remove(SystemProperties.CUSTOM_FIELD1);
+               MDC.remove(SystemProperties.CUSTOM_FIELD2);
                MDC.remove(className + methodName + EPCommonSystemProperties.METRICSLOG_BEGIN_TIMESTAMP);
                MDC.remove(EPCommonSystemProperties.METRICSLOG_BEGIN_TIMESTAMP);
                MDC.remove(EPCommonSystemProperties.METRICSLOG_END_TIMESTAMP);
                MDC.remove(EPCommonSystemProperties.MDC_TIMER);
                MDC.remove(EPCommonSystemProperties.TARGET_ENTITY);
                MDC.remove(EPCommonSystemProperties.TARGET_SERVICE_NAME);
+               } catch (Exception e) {
+                       adviceLogger.error(EELFLoggerDelegate.errorLogger, "after failed", e);
+               }
        
        }
 
ARCHIVED- 2022-02-15 at the request of the project