io.dropwizard.bundles.jsonlog.JsonRequestLogFactory Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of dropwizard-json-log-bundle Show documentation
Dropwizard bundle that allows your application to log messages in JSON.
There is a newer version: 1.3.5-1
Show newest version
package io.dropwizard.bundles.jsonlog;

import ch.qos.logback.access.spi.IAccessEvent;
import ch.qos.logback.classic.Logger;
import ch.qos.logback.classic.LoggerContext;
import ch.qos.logback.core.Appender;
import ch.qos.logback.core.ConsoleAppender;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonTypeName;
import io.dropwizard.logging.AbstractAppenderFactory;
import io.dropwizard.logging.async.AsyncAppenderFactory;
import io.dropwizard.logging.filter.LevelFilterFactory;
import io.dropwizard.logging.layout.LayoutFactory;
import io.dropwizard.request.logging.LogbackAccessRequestLog;
import io.dropwizard.request.logging.RequestLogFactory;
import io.dropwizard.request.logging.async.AsyncAccessEventAppenderFactory;
import java.util.Optional;
import javax.validation.Valid;
import javax.validation.constraints.NotNull;
import net.logstash.logback.encoder.LogstashAccessEncoder;
import net.logstash.logback.fieldnames.LogstashAccessFieldNames;
import org.eclipse.jetty.server.RequestLog;
import org.hibernate.validator.constraints.NotBlank;
import org.slf4j.LoggerFactory;

/**
 * Creates a Logback access request logger which will log access requests as JSON messages.
 */
@SuppressWarnings("WeakerAccess")
@JsonTypeName("json-logback-access")
public class JsonRequestLogFactory
    extends AbstractAppenderFactory
    implements RequestLogFactory {

  @Valid
  @NotNull
  private Fields fields = new Fields();

  @JsonProperty
  public Fields getFields() {
    return fields;
  }

  @JsonProperty
  public void setFields(Fields fields) {
    this.fields = fields;
  }

  @Override
  public boolean isEnabled() {
    return true;
  }

  @Override
  public RequestLog build(String name) {
    final LogbackAccessRequestLog requestLog = new LogbackAccessRequestLog();
    requestLog.addAppender(wrapAsync(createAppender(), new AsyncAccessEventAppenderFactory()));
    return requestLog;
  }

  @Override
  public Appender build(
      LoggerContext context, String applicationName,
      LayoutFactory layoutFactory,
      LevelFilterFactory filterFactory,
      AsyncAppenderFactory appenderFactory) {
    throw new UnsupportedOperationException();
  }

  protected LogstashAccessEncoder createEncoder() {
    final LogstashAccessEncoder encoder = new LogstashAccessEncoder();

    final LogstashAccessFieldNames fieldNames = new LogstashAccessFieldNames();
    fieldNames.setFieldsContentLength(fields.getContentLength().orElse(null));
    fieldNames.setFieldsElapsedTime(fields.getElapsedTime().orElse(null));
    fieldNames.setFieldsMethod(fields.getMethod().orElse(null));
    fieldNames.setFieldsProtocol(fields.getProtocol().orElse(null));
    fieldNames.setFieldsRemoteHost(fields.getRemoteHost().orElse(null));
    fieldNames.setFieldsRequestedUri(fields.getRequestedUri().orElse(null));
    fieldNames.setFieldsStatusCode(fields.getStatusCode().orElse(null));
    fieldNames.setFieldsHostname(fields.getHostname().orElse(null));
    fieldNames.setFieldsRequestedUrl(fields.getRequestedUrl().orElse(null));
    fieldNames.setFieldsRemoteUser(fields.getRemoteUser().orElse(null));
    fieldNames.setMessage(fields.getMessage());
    encoder.setFieldNames(fieldNames);

    encoder.start();
    return encoder;
  }

  protected ConsoleAppender createAppender() {
    final Logger logger = (Logger) LoggerFactory.getLogger("http.request");
    logger.setAdditive(false);

    final ConsoleAppender appender = new ConsoleAppender<>();
    appender.setName("console-appender");
    appender.setContext(logger.getLoggerContext());
    appender.setEncoder(createEncoder());
    appender.start();

    return appender;
  }

  @SuppressWarnings("unused")
  public static class Fields {
    private String contentLength = "bytes";
    private String elapsedTime = "duration";
    private String method = "verb";
    private String protocol = "protocol";
    private String remoteHost = "source_host";
    private String remoteUser = "remote_user";
    private String requestedUri = "request";
    private String statusCode = "response";
    private String hostname = null;
    private String requestedUrl = null;
    @NotBlank
    private String message = "message";

    @JsonProperty
    public void setContentLength(String contentLength) {
      this.contentLength = contentLength;
    }

    @JsonProperty
    public void setElapsedTime(String elapsedTime) {
      this.elapsedTime = elapsedTime;
    }

    @JsonProperty
    public void setMethod(String method) {
      this.method = method;
    }

    @JsonProperty
    public void setProtocol(String protocol) {
      this.protocol = protocol;
    }

    @JsonProperty
    public void setRemoteHost(String remoteHost) {
      this.remoteHost = remoteHost;
    }

    @JsonProperty
    public void setRemoteUser(String remoteUser) {
      this.remoteUser = remoteUser;
    }

    @JsonProperty
    public void setRequestedUri(String requestedUri) {
      this.requestedUri = requestedUri;
    }

    @JsonProperty
    public void setStatusCode(String statusCode) {
      this.statusCode = statusCode;
    }

    @JsonProperty
    public Optional getContentLength() {
      return Optional.ofNullable(contentLength);
    }

    @JsonProperty
    public Optional getElapsedTime() {
      return Optional.ofNullable(elapsedTime);
    }

    @JsonProperty
    public Optional getMethod() {
      return Optional.ofNullable(method);
    }

    @JsonProperty
    public Optional getProtocol() {
      return Optional.ofNullable(protocol);
    }

    @JsonProperty
    public Optional getRemoteHost() {
      return Optional.ofNullable(remoteHost);
    }

    @JsonProperty
    public Optional getRemoteUser() {
      return Optional.ofNullable(remoteUser);
    }

    @JsonProperty
    public Optional getRequestedUri() {
      return Optional.ofNullable(requestedUri);
    }

    @JsonProperty
    public Optional getStatusCode() {
      return Optional.ofNullable(statusCode);
    }

    @JsonProperty
    public Optional getHostname() {
      return Optional.ofNullable(hostname);
    }

    @JsonProperty
    public Optional getRequestedUrl() {
      return Optional.ofNullable(requestedUrl);
    }

    @JsonProperty
    public String getMessage() {
      return message;
    }
  }
}