eelf-logger/eelf-logger-logback-impl/src/main/java/org/onap/dcae/utils/eelf/logger/logback/layout/AuditLogLayout.java

   1 /*
   2  * ================================================================================
   3  * Copyright (c) 2018 AT&T Intellectual Property. All rights reserved.
   4  * ================================================================================
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at
   8  *
   9  *      http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  * ============LICENSE_END=========================================================
  17  *
  18  */
  19
  20 package org.onap.dcae.utils.eelf.logger.logback.layout;
  21
  22 import ch.qos.logback.classic.spi.ILoggingEvent;
  23 import ch.qos.logback.core.LayoutBase;
  24 import org.onap.dcae.utils.eelf.logger.api.info.LogLevelCategory;
  25 import org.onap.dcae.utils.eelf.logger.api.spec.AppLogSpec;
  26 import org.onap.dcae.utils.eelf.logger.api.spec.AuditLogSpec;
  27 import org.onap.dcae.utils.eelf.logger.api.spec.OptionalLogSpec;
  28 import org.onap.dcae.utils.eelf.logger.logback.utils.LogUtils;
  29
  30
  31 /**
  32  * Audit log layout generates log messages as per EELF Audit Log Specifications
  33  *
  34  * @author Rajiv Singla
  35  */
  36 public class AuditLogLayout extends LayoutBase<ILoggingEvent> {
  37
  38     @Override
  39     public String doLayout(final ILoggingEvent event) {
  40
  41         final AppLogSpec appLogSpec = LogUtils.getAppLogSpec();
  42         final LogLevelCategory logLevelCategory = LogUtils.getLogLevelCategory();
  43         final Class<?> loggerClass = LogUtils.getLoggerClass();
  44         final OptionalLogSpec optionalLogSpec = LogUtils.getOptionalLogSpec(loggerClass, logLevelCategory);
  45         final AuditLogSpec auditLogSpec = LogUtils.getAuditLogSpec();
  46
  47         final String beginTimestamp = LogUtils.formatDate(auditLogSpec.getBeginTimestamp());
  48         final String endTimestamp = LogUtils.formatDate(auditLogSpec.getEndTimestamp());
  49
  50         final String[] auditLogValues = {
  51                 beginTimestamp,
  52                 endTimestamp,
  53                 auditLogSpec.getRequestId(),
  54                 appLogSpec.getServiceInstanceID(),
  55                 event.getThreadName(),
  56                 appLogSpec.getVirtualServerName(),
  57                 auditLogSpec.getServiceName(),
  58                 auditLogSpec.getPartnerName(),
  59                 optionalLogSpec.getStatusCode().name(),
  60                 auditLogSpec.getResponseCode().toString(),
  61                 auditLogSpec.getResponseDescription(),
  62                 appLogSpec.getInstanceUUID(),
  63                 logLevelCategory != null ? logLevelCategory.name() : "",
  64                 optionalLogSpec.getAlertSeverity().getSeverityCode(),
  65                 appLogSpec.getServerIPAddress(),
  66                 auditLogSpec.getElapsedTime().toString(),
  67                 appLogSpec.getServerFQDN(),
  68                 auditLogSpec.getClientIPAddress(),
  69                 optionalLogSpec.getClassName(),
  70                 optionalLogSpec.getUnused(),
  71                 optionalLogSpec.getProcessId(),
  72                 optionalLogSpec.getCustomField1(),
  73                 optionalLogSpec.getCustomField2(),
  74                 optionalLogSpec.getCustomField3(),
  75                 optionalLogSpec.getCustomField4(),
  76                 event.getFormattedMessage()
  77         };
  78
  79         return LogUtils.createLogMessageString(auditLogValues);
  80     }
  81 }