com.raynigon.ecs.logging.access.logback.LogbackAccessValve Maven / Gradle / Ivy

package com.raynigon.ecs.logging.access.logback;

import ch.qos.logback.access.tomcat.TomcatServerAdapter;
import com.raynigon.ecs.logging.access.AccessLogProperties;
import com.raynigon.ecs.logging.access.context.IAccessLogContext;
import com.raynigon.ecs.logging.access.event.EcsAccessEvent;
import com.raynigon.ecs.logging.access.server.AccessValve;
import lombok.SneakyThrows;
import org.apache.catalina.Lifecycle;
import org.apache.catalina.Valve;
import org.apache.catalina.connector.Request;
import org.apache.catalina.connector.Response;
import org.apache.catalina.valves.ValveBase;
import org.slf4j.MDC;

import jakarta.servlet.ServletException;

import java.io.IOException;
import java.time.Duration;
import java.util.Objects;
import java.util.UUID;

import static com.raynigon.ecs.logging.LoggingConstants.*;

public class LogbackAccessValve extends ValveBase implements AccessValve, Lifecycle {

    private final AccessLogProperties config;
    private final IAccessLogContext context;
    private boolean requestAttributesEnabled = true;

    public LogbackAccessValve(AccessLogProperties config, String serviceName) {
        Objects.requireNonNull(config);
        this.config = config;
        context = new AccessLogContext(config);
        context.putProperty(SERVICE_NAME_PROPERTY, serviceName);
    }

    @Override
    public void log(Request request, Response response, long time) {
        if (config.getExcludeEndpoints().contains(request.getRequestURI())) {
            return;
        }
        TomcatServerAdapter adapter = new TomcatServerAdapter(request, response);
        EcsAccessEvent event = new EcsAccessEvent(request, response, adapter, context, Duration.ofMillis(time));
        context.appendEvent(event);
    }

    @Override
    public void setRequestAttributesEnabled(boolean requestAttributesEnabled) {
        this.requestAttributesEnabled = requestAttributesEnabled;
    }

    @Override
    public boolean getRequestAttributesEnabled() {
        return requestAttributesEnabled;
    }

    @Override
    public void invoke(Request request, Response response) throws IOException, ServletException {
        String correlationId = request.getHeader(TRANSACTION_ID_HEADER);
        if (correlationId == null)
            correlationId = UUID.randomUUID().toString();
        response.addHeader(TRANSACTION_ID_HEADER, correlationId);

        MDC.put(TRANSACTION_ID_PROPERTY, correlationId);
        String sessionId = request.getHeader(SESSION_ID_HEADER);
        if (sessionId != null)
            MDC.put(SESSION_ID_PROPERTY, sessionId);
        Valve next = getNext();
        if (next != null) {
            next.invoke(request, response);
        }
        if (sessionId != null)
            MDC.remove(SESSION_ID_PROPERTY);
        MDC.remove(TRANSACTION_ID_PROPERTY);
    }

    @Override
    @SneakyThrows
    protected synchronized void startInternal() {
        context.start();
        super.startInternal();
    }

    @Override
    @SneakyThrows
    protected synchronized void stopInternal() {
        context.stop();
        super.stopInternal();
    }
}