--- /dev/null
+/*
+ * Copyright © 2016-2018 European Support Limited
+ *
+ * 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.
+ */
+
+package org.openecomp.sdc.logging.api;
+
+/**
+ * @author KATYR
+ * @since February 15, 2018
+ * This interface defines part of the Audit log application is responsible to provide.
+ * Fields list is according to ONAP application logging guidelines
+ * (https://wiki.onap.org/download/attachments/1015849/ONAP%20application%20logging%20guidelines.pdf?api=v2)
+ * StartTime -> BeginTimestamp (Date-time that processing for the activities begins)
+ * EndTime-> EndTimestamp (Date-time that processing for the activities being logged ends)
+ * StatusCode -> StatusCode (indicate high level success or failure of the operation activities that is invoked)
+ * ResponseCode -> ResponseCode(application-specific response code returned by the operation activities)
+ * ResponseDescription - > ResponseDescription (human readable description of the response code)
+ * ClientIpAddress -> ClientIpAddress (Requesting remote client application’s IP address)
+ */
+
+public interface AuditData {
+
+ enum StatusCode {
+ COMPLETE, ERROR
+ }
+
+ long getStartTime();
+
+ long getEndTime();
+
+ StatusCode getStatusCode();
+
+ String getResponseCode();
+
+ String getResponseDescription();
+
+ String getClientIpAddress();
+}
/*
- * Copyright © 2016-2017 European Support Limited
+ * Copyright © 2016-2018 European Support Limited
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
boolean isAuditEnabled();
- void audit(String msg);
-
- void audit(String msg, Object arg);
-
- void audit(String msg, Object arg1, Object arg2);
-
- void audit(String msg, Object... arguments);
-
- void audit(String msg, Throwable t);
+ void audit(AuditData data);
boolean isDebugEnabled();
void error(String msg, Object... arguments);
void error(String msg, Throwable t);
-}
+}
\ No newline at end of file
/*
- * Copyright © 2016-2017 European Support Limited
+ * Copyright © 2016-2018 European Support Limited
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
}
@Override
- public void audit(String msg) {
- // no-op
- }
-
- @Override
- public void audit(String msg, Object arg) {
- // no-op
- }
-
- @Override
- public void audit(String msg, Object arg1, Object arg2) {
- // no-op
- }
-
- @Override
- public void audit(String msg, Object... arguments) {
- // no-op
- }
-
- @Override
- public void audit(String msg, Throwable t) {
+ public void audit(AuditData data) {
// no-op
}
}
}
}
+
logger.warn("");
logger.info("");
logger.debug("");
- logger.audit("");
+ logger.audit(new SpyAuditData());
logger.metrics("");
}
}
--- /dev/null
+/*
+ * Copyright © 2016-2018 European Support Limited
+ *
+ * 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.
+ */
+package org.openecomp.sdc.logging.api;
+
+import java.util.HashSet;
+import java.util.Set;
+
+public class SpyAuditData implements AuditData{
+ private final Set<String> calledMethods = new HashSet<>();
+
+ @Override
+ public long getStartTime() {
+ calledMethods.add("getStartTime");
+ return 0;
+ }
+
+ @Override
+ public long getEndTime() {
+ calledMethods.add("getEndTime");
+ return 0;
+ }
+
+ @Override
+ public AuditData.StatusCode getStatusCode() {
+ calledMethods.add("getEndTime");
+ return null;
+ }
+
+ @Override
+ public String getResponseCode() {
+ calledMethods.add("getResponseCode");
+ return null;
+ }
+
+ @Override
+ public String getResponseDescription() {
+ calledMethods.add("getResponseDescription");
+ return null;
+ }
+
+ @Override
+ public String getClientIpAddress() {
+ calledMethods.add("getClientIpAddress");
+ return null;
+ }
+
+ public boolean wasCalled(String method) {
+ return calledMethods.contains(method);
+ }
+}
/*
- * Copyright © 2016-2017 European Support Limited
+ * Copyright © 2016-2018 European Support Limited
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
package org.openecomp.sdc.logging.slf4j;
+import org.openecomp.sdc.logging.api.AuditData;
import org.openecomp.sdc.logging.api.Logger;
import org.slf4j.LoggerFactory;
+import org.slf4j.MDC;
+
+import java.text.SimpleDateFormat;
+import java.util.Date;
+
+import static org.openecomp.sdc.logging.slf4j.SLF4JLoggingServiceProvider.PREFIX;
/**
* @author EVITALIY
*/
class SLF4JLoggerWrapper implements Logger {
+ private static final String BEGIN_TIMESTAMP = PREFIX + "BeginTimestamp";
+ private static final String END_TIMESTAMP = PREFIX + "EndTimestamp";
+ private static final String ELAPSED_TIME = PREFIX + "ElapsedTime";
+ private static final String STATUS_CODE = PREFIX + "StatusCode";
+ private static final String RESPONSE_CODE = PREFIX + "ResponseCode";
+ private static final String RESPONSE_DESCRIPTION = PREFIX + "ResponsDescription";
+ private static final String CLIENT_IP_ADDRESS = PREFIX + "ClientIpAddress";
+
+ //The specified format presents time in UTC formatted per ISO 8601, as required by ONAP logging guidelines
+ private final SimpleDateFormat DATE_FORMAT = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss.SSSXXX");
private final org.slf4j.Logger logger;
SLF4JLoggerWrapper(Class<?> clazz) {
}
@Override
- public void audit(String msg) {
- logger.info(Markers.AUDIT, msg);
- }
+ public void audit(AuditData data) {
- @Override
- public void audit(String msg, Object arg) {
- logger.info(Markers.AUDIT, msg, arg);
- }
+ if (data == null) {
+ return;
+ }
- @Override
- public void audit(String msg, Object arg1, Object arg2) {
- logger.info(Markers.AUDIT, msg, arg1, arg2);
- }
+ MDC.put(BEGIN_TIMESTAMP, DATE_FORMAT.format(new Date(data.getStartTime())));
+ MDC.put(END_TIMESTAMP, DATE_FORMAT.format(new Date(data.getEndTime())));
+ MDC.put(ELAPSED_TIME, String.valueOf(data.getEndTime() - data.getStartTime()));
- @Override
- public void audit(String msg, Object... arguments) {
- logger.info(Markers.AUDIT, msg, arguments);
- }
+ if (data.getStatusCode() != null) {
+ MDC.put(STATUS_CODE, data.getStatusCode() == AuditData.StatusCode.COMPLETE ? "COMPLETE" : "ERROR");
+ }
- @Override
- public void audit(String msg, Throwable t) {
- logger.info(Markers.AUDIT, msg, t);
+ if (data.getResponseCode() != null) {
+ MDC.put(RESPONSE_CODE, data.getResponseCode());
+ }
+
+ if (data.getResponseDescription() != null) {
+ MDC.put(RESPONSE_DESCRIPTION, data.getResponseDescription());
+ }
+
+ if (data.getClientIpAddress() != null) {
+ MDC.put(CLIENT_IP_ADDRESS, data.getClientIpAddress());
+ }
+
+ try {
+ logger.info(Markers.AUDIT, "");
+ } finally {
+ MDC.remove(BEGIN_TIMESTAMP);
+ MDC.remove(END_TIMESTAMP);
+ MDC.remove(ELAPSED_TIME);
+ MDC.remove(STATUS_CODE);
+ MDC.remove(RESPONSE_CODE);
+ MDC.remove(RESPONSE_DESCRIPTION);
+ MDC.remove(CLIENT_IP_ADDRESS);
+ }
}
@Override
/*
- * Copyright © 2016-2017 European Support Limited
+ * Copyright © 2016-2018 European Support Limited
*
* 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.
package org.openecomp.sdc.logging.slf4j;
+import java.util.Objects;
+import java.util.concurrent.Callable;
import org.openecomp.sdc.logging.api.Logger;
import org.openecomp.sdc.logging.spi.LoggingServiceProvider;
import org.slf4j.MDC;
-import java.util.Objects;
-import java.util.concurrent.Callable;
-
/**
* @author evitaliy
* @since 13/09/2016.
*/
public class SLF4JLoggingServiceProvider implements LoggingServiceProvider {
+ public static final String PREFIX = "";
private static final String KEY_CANNOT_BE_NULL = "Key cannot be null";
+ private static final String REQUEST_ID = PREFIX + "RequestId";
+ private static final String SERVICE_NAME = PREFIX + "ServiceName";
+ private static final String PARTNER_NAME = PREFIX + "PartnerName";
+
+ private static final String[] ALL_FIELDS = { REQUEST_ID, SERVICE_NAME, PARTNER_NAME };
@Override
public Logger getLogger(String className) {
@Override
public Runnable copyToRunnable(Runnable runnable) {
Objects.requireNonNull(runnable, "Runnable cannot be null");
+ // TODO: Copy only the fields this service is responsible for
return new MDCRunnableWrapper(runnable);
}
@Override
public <V> Callable<V> copyToCallable(Callable<V> callable) {
Objects.requireNonNull(callable, "Runnable cannot be null");
+ // TODO: Copy only the fields this service is responsible for
return new MDCCallableWrapper<>(callable);
}
/*
- * Copyright © 2016-2017 European Support Limited
+ * Copyright © 2016-2018 European Support Limited
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* limitations under the License.
*/
-package org.openecomp.sdc.logging.api;
+package org.openecomp.sdc.logging;
+import org.openecomp.sdc.logging.api.AuditData;
+import org.openecomp.sdc.logging.api.Logger;
+import org.openecomp.sdc.logging.api.LoggerFactory;
import org.testng.annotations.Test;
-/**
- * This is only for manual testing - change {@link #ENABLED} to 'true'
- *
- * @author evitaliy
- * @since 13/09/2016.
- */
-public class LoggerTest {
-
+public class LogFileCreationTest {
private static final boolean ENABLED = false; // for manual testing change to 'true'
- private static final Logger LOGGER = LoggerFactory.getLogger(LoggerTest.class);
+ private static final Logger LOGGER = LoggerFactory.getLogger(LogFileCreationTest.class);
@Test(enabled = ENABLED)
public void testMetrics() {
@Test(enabled = ENABLED)
public void testAudit() {
- LOGGER.audit("This is audit");
+ SpyAuditData auditData = new SpyAuditData();
+ LOGGER.audit(auditData);
}
@Test(enabled = ENABLED)
public void testError() {
LOGGER.error("This is error");
}
+
+ private class SpyAuditData implements AuditData {
+ @Override
+ public long getStartTime() {
+
+ return 0;
+
+ }
+
+ @Override
+ public long getEndTime(){
+
+ return 0;
+ }
+
+ @Override
+ public StatusCode getStatusCode(){
+
+ return null;
+
+ }
+
+ @Override
+ public String getResponseCode(){
+
+ return null;
+
+ }
+
+ @Override
+ public String getResponseDescription(){
+
+ return null;
+
+ }
+
+ @Override
+ public String getClientIpAddress(){
+
+ return null;
+
+ }
+ }
}
import org.aspectj.lang.reflect.SourceLocation;
import org.aspectj.runtime.internal.AroundClosure;
import org.easymock.EasyMock;
+import org.openecomp.sdc.logging.api.AuditData;
import org.openecomp.sdc.logging.api.Logger;
import org.openecomp.sdc.logging.api.LoggerFactory;
import org.powermock.api.easymock.PowerMock;
}
@Override
- public void audit(String var1) {
- throw new RuntimeException("Not implemented");
- }
-
- @Override
- public void audit(String var1, Object var2) {
- throw new RuntimeException("Not implemented");
- }
-
- @Override
- public void audit(String var1, Object var2, Object var3) {
- throw new RuntimeException("Not implemented");
- }
-
- @Override
- public void audit(String var1, Object... var2) {
- throw new RuntimeException("Not implemented");
- }
-
- @Override
- public void audit(String var1, Throwable throwable) {
+ public void audit(AuditData var1) {
throw new RuntimeException("Not implemented");
}
Code Review / sdc.git / commitdiff