package org.openecomp.sdc.logging.servlet;
import javax.servlet.http.HttpServletRequest;
-import org.openecomp.sdc.logging.api.Logger;
/**
- * Tracker for all the elements of ONAP logging and tracing at an entry point to an application - context and audit.
- * The order of invocations is important, assuming the context must be kept as long as audit hasn't been finished.
+ * Tracker for all the elements of ONAP logging and tracing at an entry point to an application.
+ * The order of invocations is important, and on {@link #preRequest(HttpServletRequest)} it respects the order of
+ * trackers passed to the constructor. On {@link #postRequest(RequestProcessingResult)}, the invocation will be in the
+ * <b>reverse</b> order.
*
* @author evitaliy
* @since 01 Aug 2018
*/
public class CombinedTracker implements Tracker {
- private final ContextTracker context;
- private final AuditTracker audit;
+ private final Tracker[] trackers;
- public CombinedTracker(Logger logger, HttpHeader partnerNameHeader, HttpHeader requestIdHeader) {
- this.context = new ContextTracker(partnerNameHeader, requestIdHeader);
- this.audit = new AuditTracker(logger);
- }
-
- public CombinedTracker(Class<?> resourceType, HttpHeader partnerNameHeader, HttpHeader requestIdHeader) {
- this.context = new ContextTracker(partnerNameHeader, requestIdHeader);
- this.audit = new AuditTracker(resourceType);
+ public CombinedTracker(Tracker... trackers) {
+ this.trackers = new Tracker[trackers.length];
+ System.arraycopy(trackers, 0, this.trackers, 0, trackers.length);
}
@Override
public void preRequest(HttpServletRequest request) {
- this.context.preRequest(request);
- this.audit.preRequest(request);
+
+ for (Tracker t : trackers) {
+ t.preRequest(request);
+ }
}
@Override
public void postRequest(RequestProcessingResult result) {
- this.audit.postRequest(result);
- this.context.postRequest(result);
+
+ for (int i = trackers.length - 1; i > -1; i--) {
+ trackers[i].postRequest(result);
+ }
}
}
*
* @param headerNames cannot be null or empty
*/
- public HttpHeader(String[] headerNames) {
+ public HttpHeader(String... headerNames) {
if (Objects.requireNonNull(headerNames, NAMES_CANNOT_BE_NULL).length < 1) {
throw new IllegalArgumentException(AT_LEAST_ONE_NAME_REQUIRED);
import javax.ws.rs.ext.Provider;
import org.openecomp.sdc.logging.api.Logger;
import org.openecomp.sdc.logging.api.LoggerFactory;
+import org.openecomp.sdc.logging.servlet.AuditTracker;
import org.openecomp.sdc.logging.servlet.CombinedTracker;
+import org.openecomp.sdc.logging.servlet.ContextTracker;
import org.openecomp.sdc.logging.servlet.HttpHeader;
import org.openecomp.sdc.logging.servlet.Tracker;
private HttpServletRequest httpRequest;
- private HttpHeader requestIdHeader = new HttpHeader(new String[] {DEFAULT_REQUEST_ID_HEADER});
- private HttpHeader partnerNameHeader = new HttpHeader(new String[] {DEFAULT_PARTNER_NAME_HEADER});
+ private HttpHeader requestIdHeader = new HttpHeader(DEFAULT_REQUEST_ID_HEADER);
+ private HttpHeader partnerNameHeader = new HttpHeader(DEFAULT_PARTNER_NAME_HEADER);
private ResourceInfo resource;
@Override
public void filter(ContainerRequestContext requestContext) {
Class<?> resourceClass = resource.getResourceMethod().getDeclaringClass();
- Tracker tracker = new CombinedTracker(resourceClass, partnerNameHeader, requestIdHeader);
+ Tracker tracker = new CombinedTracker(
+ new ContextTracker(partnerNameHeader, requestIdHeader),
+ new AuditTracker(resourceClass));
requestContext.setProperty(LOGGING_TRACKER_KEY, tracker);
tracker.preRequest(httpRequest);
}
--- /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.servlet;
+
+import static org.mockito.ArgumentMatchers.any;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.times;
+import static org.mockito.Mockito.verify;
+
+import javax.servlet.http.HttpServletRequest;
+import org.junit.Test;
+
+/**
+ * Test the construction and invocation of combined tracker.
+ *
+ * @author evitaliy
+ * @since 01 Aug 2018
+ */
+public class CombinedTrackerTest {
+
+ @Test(expected = NullPointerException.class)
+ public void throwExceptionWhenTrackersNull() {
+ new CombinedTracker((Tracker[]) null);
+ }
+
+ @Test
+ public void trackersCalledWhenPreRequest() {
+ Tracker firstTracker = mock(Tracker.class);
+ Tracker secondTracker = mock(Tracker.class);
+ CombinedTracker tracker = new CombinedTracker(firstTracker, secondTracker);
+ tracker.preRequest(mock(HttpServletRequest.class));
+ verify(firstTracker, times(1)).preRequest(any(HttpServletRequest.class));
+ verify(secondTracker, times(1)).preRequest(any(HttpServletRequest.class));
+ }
+
+ @Test
+ public void trackersCalledWhenPostRequest() {
+ Tracker firstTracker = mock(Tracker.class);
+ Tracker secondTracker = mock(Tracker.class);
+ CombinedTracker tracker = new CombinedTracker(firstTracker, secondTracker);
+ tracker.postRequest(mock(RequestProcessingResult.class));
+ verify(firstTracker, times(1)).postRequest(any(RequestProcessingResult.class));
+ verify(secondTracker, times(1)).postRequest(any(RequestProcessingResult.class));
+ }
+}
\ No newline at end of file
public class ContextTrackerTest {
private static final String X_REQUEST_ID = "X-REQUEST-ID";
- private static final HttpHeader REQUEST_ID_HEADER = new HttpHeader(new String[] {X_REQUEST_ID});
+ private static final HttpHeader REQUEST_ID_HEADER = new HttpHeader(X_REQUEST_ID);
private static final String X_PARTNER_NAME = "X-PARTNER-NAME";
- private static final HttpHeader PARTNER_NAME_HEADER = new HttpHeader(new String[] {X_PARTNER_NAME});
+ private static final HttpHeader PARTNER_NAME_HEADER = new HttpHeader(X_PARTNER_NAME);
@Test(expected = NullPointerException.class)
public void throwExceptionWhenPartnerNamesNull() {
@Test(expected = IllegalArgumentException.class)
public void throwExceptionWhenInputArrayEmpty() {
- new HttpHeader(new String[0]);
+ new HttpHeader();
}
@Test(expected = IllegalArgumentException.class)
@Test
public void valueNotReturnedWhenNameInArrayNotRequested() {
- HttpHeader header = new HttpHeader(new String[] {"A"});
+ HttpHeader header = new HttpHeader("A");
assertFalse(header.getAny(NULL_WHEN_NAME_NOT_B).isPresent());
}
@Test
public void valueReturnedWhenSinglePossibleHeaderInArrayMatches() {
- HttpHeader header = new HttpHeader(new String[] {"B"});
+ HttpHeader header = new HttpHeader("B");
assertTrue(header.getAny(NULL_WHEN_NAME_NOT_B).isPresent());
}
@Test
public void valueReturnedWhenLastHeaderInArrayMatches() throws Throwable {
- HttpHeader header = new HttpHeader(new String[] {"A", "B"});
+ HttpHeader header = new HttpHeader("A", "B");
header.getAny(NULL_WHEN_NAME_NOT_B).orElseThrow(VALUE_EXPECTED);
}
@Test
public void valueReturnedWhenFirstHeaderInArrayMatches() throws Throwable {
- HttpHeader header = new HttpHeader(new String[] {"B", "A"});
+ HttpHeader header = new HttpHeader("B", "A");
header.getAny(NULL_WHEN_NAME_NOT_B).orElseThrow(VALUE_EXPECTED);
}
@Test
public void valueReturnedWhenMiddleHeaderInArrayMatches() throws Throwable {
- HttpHeader header = new HttpHeader(new String[] {"A", "B", "C"});
+ HttpHeader header = new HttpHeader("A", "B", "C");
header.getAny(NULL_WHEN_NAME_NOT_B).orElseThrow(VALUE_EXPECTED);
}
import ch.qos.logback.core.AppenderBase;
import ch.qos.logback.core.joran.spi.DefaultClass;
import ch.qos.logback.core.sift.Discriminator;
-import org.slf4j.LoggerFactory;
-
import java.util.Iterator;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;
+import org.slf4j.LoggerFactory;
/**
* <p>Allows to use EELF logging configuration almost as is, by using a custom routing function, but pre-configured
// "magic" appender to indicate a missing appender
private static final Appender<ILoggingEvent> NO_APPENDER = new DispatchingAppender();
- private Map<String, Appender<ILoggingEvent>> appenders = new ConcurrentHashMap<>();
+ private final Map<String, Appender<ILoggingEvent>> appenders = new ConcurrentHashMap<>();
private Discriminator<ILoggingEvent> discriminator;
private String appenderNamePattern;
package org.openecomp.sdc.logging.slf4j;
-import org.openecomp.sdc.logging.context.HostAddressCache;
-import org.openecomp.sdc.logging.context.InstanceId;
-
import java.net.InetAddress;
import java.util.EnumMap;
import java.util.Map;
import java.util.Optional;
+import org.openecomp.sdc.logging.context.HostAddressCache;
+import org.openecomp.sdc.logging.context.InstanceId;
/**
* Maps global logging context to corresponding MDC fields.
package org.openecomp.sdc.logging.slf4j;
-import org.slf4j.MDC;
-
import java.util.EnumMap;
import java.util.Map;
+import org.slf4j.MDC;
/**
* Because we don't know which information should be carried over from MDC, and which shouldn't, copy just the keys that
*/
public class Markers {
+ public static final Marker AUDIT = MarkerFactory.getMarker("AUDIT");
+ public static final Marker METRICS = MarkerFactory.getMarker("METRICS");
+
private Markers() {
// prevent instantiation
}
-
- public static final Marker AUDIT = MarkerFactory.getMarker("AUDIT");
- public static final Marker METRICS = MarkerFactory.getMarker("METRICS");
}
package org.openecomp.sdc.logging.slf4j;
-import org.openecomp.sdc.logging.api.ContextData;
-
import java.util.EnumMap;
import java.util.Map;
+import org.openecomp.sdc.logging.api.ContextData;
/**
* Maps request data sent to the context service to corresponding MDC fields.
package org.openecomp.sdc.logging.slf4j;
+import java.text.SimpleDateFormat;
import org.openecomp.sdc.logging.api.AuditData;
import org.openecomp.sdc.logging.api.Logger;
import org.openecomp.sdc.logging.api.MetricsData;
import org.slf4j.LoggerFactory;
import org.slf4j.MDC;
-import java.text.SimpleDateFormat;
-
/**
* Delegates log calls to SLF4J API and MDC.
*
package org.openecomp.sdc.logging.slf4j;
+import java.util.Objects;
+import java.util.concurrent.Callable;
import org.openecomp.sdc.logging.api.ContextData;
import org.openecomp.sdc.logging.api.Logger;
import org.openecomp.sdc.logging.spi.LoggingServiceProvider;
-import java.util.Objects;
-import java.util.concurrent.Callable;
-
/**
* Uses SLF4J as backend for logging service.
*
// build a dynamic proxy to avoid implementing the long list of Logger methods
// when we actually need just Logger.info() with the audit marker
ClassLoader classLoader = Thread.currentThread().getContextClassLoader();
- return SpyLogger.class.cast(
- Proxy.newProxyInstance(classLoader, new Class<?>[]{SpyLogger.class}, new SpyingInvocationHandler()));
+ return (SpyLogger) Proxy.newProxyInstance(classLoader, new Class<?>[] {SpyLogger.class},
+ new SpyingInvocationHandler());
}
private static class SpyingInvocationHandler implements InvocationHandler {
import static org.openecomp.sdc.logging.api.StatusCode.COMPLETE;
import static org.openecomp.sdc.logging.api.StatusCode.ERROR;
+import static org.springframework.http.HttpStatus.Series.REDIRECTION;
+import static org.springframework.http.HttpStatus.Series.SUCCESSFUL;
import java.util.Objects;
import javax.servlet.http.HttpServletRequest;
import org.openecomp.sdc.logging.api.Logger;
import org.openecomp.sdc.logging.api.LoggerFactory;
import org.openecomp.sdc.logging.api.StatusCode;
+import org.openecomp.sdc.logging.servlet.AuditTracker;
import org.openecomp.sdc.logging.servlet.CombinedTracker;
+import org.openecomp.sdc.logging.servlet.ContextTracker;
import org.openecomp.sdc.logging.servlet.HttpHeader;
import org.openecomp.sdc.logging.servlet.RequestProcessingResult;
import org.openecomp.sdc.logging.servlet.Tracker;
import org.springframework.http.HttpStatus;
+import org.springframework.stereotype.Component;
import org.springframework.web.method.HandlerMethod;
import org.springframework.web.servlet.handler.HandlerInterceptorAdapter;
/**
- * <p>IMPORTANT: For this interceptor to work, all exceptions must be properly handled before being returned to a
+ * <p><b>IMPORTANT</b>: For this interceptor to work, all exceptions must be properly handled before being returned to a
* client. Any unexpected, automatically handled exception bypasses the interceptor and will not be logged.</p>
* <p>The interceptor must be either registered in Spring configuration XML as a bean, or programmatically as described
* in <a href="https://docs.spring.io/spring/docs/current/spring-framework-reference/web.html#mvc-config-interceptors">
* @author evitaliy
* @since 02 Aug 2018
*/
+@Component
public class LoggingInterceptor extends HandlerInterceptorAdapter {
static final String LOGGING_TRACKER_KEY = "onap.logging.tracker";
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) {
Class<?> resourceClass = getResourceType(handler);
- Tracker tracker = new CombinedTracker(resourceClass, partnerNameHeader, requestIdHeader);
+ Tracker tracker = new CombinedTracker(
+ new ContextTracker(partnerNameHeader, requestIdHeader),
+ new AuditTracker(resourceClass));
request.setAttribute(LOGGING_TRACKER_KEY, tracker);
tracker.preRequest(request);
return true;
static class ServletResponseResult implements RequestProcessingResult {
- private final HttpStatus status;
+ private final StatusInfo statusInfo;
ServletResponseResult(int status) {
- this.status = HttpStatus.valueOf(status);
+ this.statusInfo = init(status);
+ }
+
+ private StatusInfo init(int status) {
+
+ try {
+ return new StatusInfo(HttpStatus.valueOf(status));
+ } catch (IllegalArgumentException e) {
+ return new StatusInfo(status, "Non-standard HTTP status", HttpStatus.Series.valueOf(status));
+ }
}
@Override
public int getStatus() {
- return status.value();
+ return statusInfo.getStatus();
}
@Override
public StatusCode getStatusCode() {
- return status.is2xxSuccessful() || status.is3xxRedirection() ? COMPLETE : ERROR;
+ return statusInfo.getStatusCode();
}
@Override
public String getStatusPhrase() {
- return status.getReasonPhrase();
+ return statusInfo.getReasonPhrase();
+ }
+ }
+
+ private static class StatusInfo {
+
+ private final int status;
+ private final String reasonPhrase;
+ private final HttpStatus.Series series;
+
+ private StatusInfo(HttpStatus httpStatus) {
+ this(httpStatus.value(), httpStatus.getReasonPhrase(), httpStatus.series());
+ }
+
+ private StatusInfo(int status, String reasonPhrase, HttpStatus.Series series) {
+ this.status = status;
+ this.reasonPhrase = reasonPhrase;
+ this.series = series;
+ }
+
+ private int getStatus() {
+ return status;
+ }
+
+ private String getReasonPhrase() {
+ return reasonPhrase;
+ }
+
+ private StatusCode getStatusCode() {
+ return series.equals(SUCCESSFUL) || series.equals(REDIRECTION) ? COMPLETE : ERROR;
}
}
}
\ No newline at end of file
assertEquals(status, result.getStatus());
assertEquals(COMPLETE, result.getStatusCode());
}
+
+ @Test
+ public void errorStatusWhenNonStandardInformationalCode() {
+ final int status = 133;
+ LoggingInterceptor.ServletResponseResult result = new LoggingInterceptor.ServletResponseResult(status);
+ assertEquals(status, result.getStatus());
+ assertEquals(ERROR, result.getStatusCode());
+ }
+
+ @Test
+ public void errorStatusWhenNonStandardClientErrorCode() {
+ final int status = 485;
+ LoggingInterceptor.ServletResponseResult result = new LoggingInterceptor.ServletResponseResult(status);
+ assertEquals(status, result.getStatus());
+ assertEquals(ERROR, result.getStatusCode());
+ }
+
+ @Test
+ public void errorStatusWhenNonStandardServerErrorCode() {
+ final int status = 547;
+ LoggingInterceptor.ServletResponseResult result = new LoggingInterceptor.ServletResponseResult(status);
+ assertEquals(status, result.getStatus());
+ assertEquals(ERROR, result.getStatusCode());
+ }
+
+ @Test
+ public void completeStatusWhenNonStandardSuccessCode() {
+ final int status = 277;
+ LoggingInterceptor.ServletResponseResult result = new LoggingInterceptor.ServletResponseResult(status);
+ assertEquals(status, result.getStatus());
+ assertEquals(COMPLETE, result.getStatusCode());
+ }
+
+ @Test
+ public void completeStatusWhenNonStandardRedirectionCode() {
+ final int status = 364;
+ LoggingInterceptor.ServletResponseResult result = new LoggingInterceptor.ServletResponseResult(status);
+ assertEquals(status, result.getStatus());
+ assertEquals(COMPLETE, result.getStatusCode());
+ }
}
\ No newline at end of file
Code Review / sdc.git / commitdiff