Skip to content

Enhance access logs #31

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
vlaurin merged 3 commits into from
Mar 18, 2025
Merged

Enhance access logs #31

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
66e2a39
Shorten access logs KVP keys
vlaurin Mar 18, 2025
5dafce4
Log access URI match
vlaurin Mar 18, 2025
da52f78
Clean up unused method
vlaurin Mar 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 34 additions & 20 deletions src/main/java/app/quickcase/sdk/spring/logging/AccessLogFilter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,16 +13,16 @@
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;
import lombok.extern.slf4j.Slf4j;
import org.slf4j.event.Level;
import org.slf4j.spi.LoggingEventBuilder;
import org.springframework.http.HttpMethod;
import org.springframework.web.servlet.HandlerMapping;

@Slf4j
public class AccessLogFilter implements Filter {
private static final String KEY_METHOD = "requestMethod";
private static final String KEY_URI = "requestUri";
private static final String KEY_STATUS = "responseCode";
private static final String KEY_METHOD = "method";
private static final String KEY_URI = "uri";
private static final String KEY_STATUS = "status";
private static final String KEY_DURATION = "duration";
private static final String KEY_MATCH = "match";

private final static Clock clock = Clock.systemDefaultZone();
private final AccessLogLevelStrategy logLevelStrategy;
Expand Down Expand Up @@ -58,30 +58,44 @@ public void doFilter(ServletRequest request,
final Duration duration = Duration.between(start, clock.instant());
final int status = httpResponse.getStatus();

log.atLevel(logLevelStrategy.onCompleted(method, requestURI, status))
.addKeyValue(KEY_METHOD, method)
.addKeyValue(KEY_URI, requestURI)
.addKeyValue(KEY_STATUS, status)
.addKeyValue(KEY_DURATION, duration.toMillis())
.log("Request processed ({}) in {}ms: {} {}", status, duration.toMillis(), method, requestURI);
var completedLogBuilder = log.atLevel(logLevelStrategy.onCompleted(method, requestURI, status))
.addKeyValue(KEY_METHOD, method)
.addKeyValue(KEY_URI, requestURI)
.addKeyValue(KEY_STATUS, status)
.addKeyValue(KEY_DURATION, duration.toMillis());

addPatternMatch(httpRequest, completedLogBuilder);

completedLogBuilder.log("Request processed ({}) in {}ms: {} {}", status, duration.toMillis(), method, requestURI);

} catch (Exception exception) {
final Duration duration = Duration.between(start, clock.instant());

log.atLevel(logLevelStrategy.onException(method, requestURI, exception))
.addKeyValue(KEY_METHOD, method)
.addKeyValue(KEY_URI, requestURI)
.addKeyValue(KEY_DURATION, duration.toMillis())
.log("Request failed in {}ms: {} {} ", duration.toMillis(), method, requestURI);
var errorLogBuilder = log.atLevel(logLevelStrategy.onException(method, requestURI, exception))
.addKeyValue(KEY_METHOD, method)
.addKeyValue(KEY_URI, requestURI)
.addKeyValue(KEY_DURATION, duration.toMillis());

addPatternMatch(httpRequest, errorLogBuilder);

errorLogBuilder.log("Request failed in {}ms: {} {} ", duration.toMillis(), method, requestURI);

throw exception;
}
}

private LoggingEventBuilder successLogBuilder (String httpMethod) {
if (HttpMethod.OPTIONS.matches(httpMethod)) {
return log.atDebug();
/**
* Extract and populate the matching URI pattern, if available, in the access log KVP.
* The matrix of variable for that matching pattern is ignored as it would duplicate the MDC in most cases.
*
* @param httpRequest Request from which to extract the matched pattern
* @param logBuilder Logging event builder to which the pattern KVP should be added
*/
private void addPatternMatch(HttpServletRequest httpRequest, LoggingEventBuilder logBuilder) {
var pattern = (String) httpRequest.getAttribute(HandlerMapping.BEST_MATCHING_PATTERN_ATTRIBUTE);

if (pattern != null) {
logBuilder.addKeyValue(KEY_MATCH, pattern);
}
return log.atInfo();
}
}