All Downloads are FREE. Search and download functionalities are using the official Maven repository.
  • Log In
  • Register

    • ch.qos.logback.contrib.json.access.JsonLayout Maven / Gradle / Ivy

    Go to download

    Logback Contrib provides community-driven and supported extensions to the Logback logging framework. All contributions are made by contributors with CLA on file.

    The newest version!
    /**
 * Copyright (C) 2016, The logback-contrib developers. All rights reserved.
 *
 * This program and the accompanying materials are dual-licensed under
 * either the terms of the Eclipse Public License v1.0 as published by
 * the Eclipse Foundation
 *
 *   or (per the licensee's choosing)
 *
 * under the terms of the GNU Lesser General Public License version 2.1
 * as published by the Free Software Foundation.
 */
package ch.qos.logback.contrib.json.access;

import ch.qos.logback.access.spi.IAccessEvent;
import ch.qos.logback.contrib.json.JsonLayoutBase;

import java.util.LinkedHashMap;
import java.util.Map;
import java.util.concurrent.TimeUnit;

/**
 * A JsonLayout builds its {@link #toJsonMap(ch.qos.logback.access.spi.IAccessEvent) jsonMap} from a
 * source {@link ch.qos.logback.access.spi.IAccessEvent IAccessEvent} with the following keys/value pairs:
 * 
    
 * 
    
 *     
 *         
 *         
 *         
 *         
 *     
 *     
 *         
 *         
 *         
 *         
 *     
 *     
 *         
 *         
 *         
 *         
 *     
 *     
 *         
 *         
 *         
 *         
 *     
 *     
 *         
 *         
 *         
 *         
 *     
 *     
 *         
 *         
 *         
 *         
 *     
 *     
 *         
 *         
 *         
 *         
 *     
 *     
 *         
 *         
 *         
 *         
 *     
 *     
 *         
 *         
 *         
 *         
 *     
 *     
 *         
 *         
 *         
 *         
 *     
 *     
 *         
 *         
 *         
 *         
 *     
 *     
 *         
 *         
 *         
 *         
 *     
 *     
 *         
 *         
 *         
 *         
 *     
 *     
 *         
 *         
 *         
 *         
 *     
 *     
 *         
 *         
 *         
 *         
 *     
 *     
 *         
 *         
 *         
 *         
 *     
 *     
 *         
 *         
 *         
 *         
 *     
 *     
 *         
 *         
 *         
 *         
 *     
 * 
    KeyValueNotesEnabled by default?
    {@code timestamp}String value of IAccessEvent.{@link ch.qos.logback.access.spi.IAccessEvent#getTimeStamp() getTimeStamp()}By default, the value is not formatted; it is simply {@code String.valueOf(timestamp)}.  To format
 *         the string using a SimpleDateFormat, set the {@link #setTimestampFormat(String) timestampFormat}
 *         property with the corresponding SimpleDateFormat string, for example, {@code yyyy-MM-dd HH:mm:ss.SSS}true
    {@code remoteAddress}IAccessEvent.{@link ch.qos.logback.access.spi.IAccessEvent#getRemoteAddr() getRemoteAddr()}Internet Protocol (IP) address of the client or last proxy that sent the request.true
    {@code remoteUser}IAccessEvent.{@link ch.qos.logback.access.spi.IAccessEvent#getRemoteUser() getRemoteUser()}true
    {@code requestTime}String value of IAccessEvent.{@link ch.qos.logback.access.spi.IAccessEvent#getElapsedTime() getElapsedTime()}The time elapsed between receiving the request and logging it. By default, the value is formatted as {@code s.SSS}true
    {@code uri}IAccessEvent.{@link ch.qos.logback.access.spi.IAccessEvent#getRequestURI() getRequestURI()}true
    {@code status}String value of IAccessEvent.{@link ch.qos.logback.access.spi.IAccessEvent#getStatusCode getStatusCode()}true
    {@code method}IAccessEvent.{@link ch.qos.logback.access.spi.IAccessEvent#getMethod() getMethod()}true
    {@code protocol}IAccessEvent.{@link ch.qos.logback.access.spi.IAccessEvent#getProtocol() getProtocol()}true
    {@code contentLength}String value of IAccessEvent.{@link ch.qos.logback.access.spi.IAccessEvent#getContentLength() getContentLength()}true
    {@code url}IAccessEvent.{@link ch.qos.logback.access.spi.IAccessEvent#getRequestURL() getRequestURL()}false
    {@code remoteHost}IAccessEvent.{@link ch.qos.logback.access.spi.IAccessEvent#getRemoteHost() getRemoteHost()}Fully qualified name of the client or the last proxy that sent the request.true
    {@code serverName}IAccessEvent.{@link ch.qos.logback.access.spi.IAccessEvent#getServerName() getServerName()}Name of the server to which the request was sent.true
    {@code headers}IAccessEvent.{@link ch.qos.logback.access.spi.IAccessEvent#getRequestHeaderMap() getRequestHeaderMap()}This value is a {@code Map<String,String>}.true
    {@code params}IAccessEvent.{@link ch.qos.logback.access.spi.IAccessEvent#getRequestParameterMap() getRequestParameterMap()}This value is a {@code Map<String,String>}.true
    {@code port}String value of IAccessEvent.{@link ch.qos.logback.access.spi.IAccessEvent#getLocalPort() getLocalPort()}false
    {@code requestContent}IAccessEvent.{@link ch.qos.logback.access.spi.IAccessEvent#getRequestContent() getRequestContent()}false
    {@code responseContent}IAccessEvent.{@link ch.qos.logback.access.spi.IAccessEvent#getResponseContent() getResponseContent()}false
    
 *
 * @author Espen A. Fossen
 */
public class JsonLayout extends JsonLayoutBase {

    public static final String TIMESTAMP_ATTR_NAME = "timestamp";
    public static final String REMOTEADDR_ATTR_NAME = "remoteAddress";
    public static final String REMOTEUSER_ATTR_NAME = "remoteUser";
    public static final String REQUESTTIME_ATTR_NAME = "requestTime";
    public static final String REQUESTURI_ATTR_NAME = "uri";
    public static final String STATUSCODE_ATTR_NAME = "status";
    public static final String METHOD_ATTR_NAME = "method";
    public static final String PROTOCOL_ATTR_NAME = "protocol";
    public static final String CONTENTLENGTH_ATTR_NAME = "contentLength";
    public static final String REQUESTURL_ATTR_NAME = "url";
    public static final String REMOTEHOST_ATTR_NAME = "remoteHost";
    public static final String SERVERNAME_ATTR_NAME = "serverName";
    public static final String REQUESTHEADER_ATTR_NAME = "headers";
    public static final String REQUESTPARAMETER_ATTR_NAME = "params";
    public static final String LOCALPORT_ATTR_NAME = "port";
    public static final String REQUESTCONTENT_ATTR_NAME = "requestContent";
    public static final String RESPONSECONTENT_ATTR_NAME = "responseContent";

    protected boolean includeRemoteAddr;
    protected boolean includeRemoteUser;
    protected boolean includeRequestTime;
    protected boolean includeRequestURI;
    protected boolean includeStatusCode;
    protected boolean includeMethod;
    protected boolean includeProtocol;
    protected boolean includeContentLength;
    protected boolean includeRequestURL;
    protected boolean includeRemoteHost;
    protected boolean includeServerName;
    protected boolean includeRequestHeader;
    protected boolean includeRequestParameter;
    protected boolean includeLocalPort;
    protected boolean includeRequestContent;
    protected boolean includeResponseContent;


    public JsonLayout() {
        super();
        this.includeRemoteAddr = true;
        this.includeRemoteUser = true;
        this.includeRequestTime = true;
        this.includeRequestURI = true;
        this.includeStatusCode = true;
        this.includeMethod = true;
        this.includeProtocol = true;
        this.includeRequestURL = false;
        this.includeContentLength = false;
        this.includeRemoteHost = true;
        this.includeServerName = true;
        this.includeRequestHeader = true;
        this.includeRequestParameter = true;
        this.includeLocalPort = false;
        this.includeRequestContent = false;
        this.includeResponseContent = false;
    }

    @Override
    protected Map toJsonMap(IAccessEvent event) {
        Map map = new LinkedHashMap();

        addTimestamp(TIMESTAMP_ATTR_NAME, this.includeTimestamp, event.getTimeStamp(), map);
        add(REMOTEADDR_ATTR_NAME, this.includeRemoteAddr, event.getRemoteAddr(), map);
        add(REMOTEUSER_ATTR_NAME, this.includeRemoteUser, event.getRemoteUser(), map);
        addRequestTime(event.getElapsedTime(), map);
        addInt(STATUSCODE_ATTR_NAME, this.includeStatusCode, event.getStatusCode(), map);
        add(METHOD_ATTR_NAME, this.includeMethod, event.getMethod(), map);
        add(REQUESTURI_ATTR_NAME, this.includeRequestURI, event.getRequestURI(), map);
        add(PROTOCOL_ATTR_NAME, this.includeProtocol, event.getProtocol(), map);
        add(CONTENTLENGTH_ATTR_NAME, this.includeContentLength, Long.toString(event.getContentLength()), map);
        add(REQUESTURL_ATTR_NAME, this.includeRequestURL, event.getRequestURL(), map);
        add(REMOTEHOST_ATTR_NAME, this.includeRemoteHost, event.getRemoteHost(), map);
        add(SERVERNAME_ATTR_NAME, this.includeServerName, event.getServerName(), map);
        addMap(REQUESTHEADER_ATTR_NAME, this.includeRequestHeader, event.getRequestHeaderMap(), map);
        addMap(REQUESTPARAMETER_ATTR_NAME, this.includeRequestParameter, event.getRequestParameterMap(), map);
        addInt(LOCALPORT_ATTR_NAME, this.includeLocalPort, event.getLocalPort(), map);
        add(REQUESTCONTENT_ATTR_NAME, this.includeRequestContent,  event.getRequestContent(), map);
        add(RESPONSECONTENT_ATTR_NAME, this.includeResponseContent,  event.getResponseContent(), map);

        return map;
    }

    protected void addRequestTime(long requestTime, Map map) {
        if (this.includeRequestTime && requestTime > 0) {
            final long sec = TimeUnit.MILLISECONDS.toSeconds(requestTime);
            final long ms = TimeUnit.MILLISECONDS.toMillis(requestTime - TimeUnit.SECONDS.toMillis(sec));
            String time = String.format("%01d.%03d", sec, ms);
            if (time != null) {
                map.put(REQUESTTIME_ATTR_NAME, time);
            }
        }
    }

    protected void addInt(String key, boolean field, int intValue, Map map) {
        if (field) {
            String statusCode = String.valueOf(intValue);
            map.put(key, statusCode);
        }
    }

    public boolean isIncludeRemoteAddr() {
        return includeRemoteAddr;
    }

    public void setIncludeRemoteAddr(boolean includeRemoteAddr) {
        this.includeRemoteAddr = includeRemoteAddr;
    }

    public boolean isIncludeRemoteUser() {
        return includeRemoteUser;
    }

    public void setIncludeRemoteUser(boolean includeRemoteUser) {
        this.includeRemoteUser = includeRemoteUser;
    }

    public boolean isIncludeRequestTime() {
        return includeRequestTime;
    }

    public void setIncludeRequestTime(boolean includeRequestTime) {
        this.includeRequestTime = includeRequestTime;
    }

    public boolean isIncludeRequestURI() {
        return includeRequestURI;
    }

    public void setIncludeRequestURI(boolean includeRequestURI) {
        this.includeRequestURI = includeRequestURI;
    }

    public boolean isIncludeStatusCode() {
        return includeStatusCode;
    }

    public void setIncludeStatusCode(boolean includeStatusCode) {
        this.includeStatusCode = includeStatusCode;
    }

    public boolean isIncludeMethod() {
        return includeMethod;
    }

    public void setIncludeMethod(boolean includeMethod) {
        this.includeMethod = includeMethod;
    }

    public boolean isIncludeProtocol() {
        return includeProtocol;
    }

    public void setIncludeProtocol(boolean includeProtocol) {
        this.includeProtocol = includeProtocol;
    }

    public boolean isIncludeContentLength() {
        return includeContentLength;
    }

    public void setIncludeContentLength(boolean includeContentLength) {
        this.includeContentLength = includeContentLength;
    }

    public boolean isIncludeRequestURL() {
        return includeRequestURL;
    }

    public void setIncludeRequestURL(boolean includeRequestURL) {
        this.includeRequestURL = includeRequestURL;
    }

    public boolean isIncludeRemoteHost() {
        return includeRemoteHost;
    }

    public void setIncludeRemoteHost(boolean includeRemoteHost) {
        this.includeRemoteHost = includeRemoteHost;
    }

    public boolean isIncludeServerName() {
        return includeServerName;
    }

    public void setIncludeServerName(boolean includeServerName) {
        this.includeServerName = includeServerName;
    }

    public boolean isIncludeRequestHeader() {
        return includeRequestHeader;
    }

    public void setIncludeRequestHeader(boolean includeRequestHeader) {
        this.includeRequestHeader = includeRequestHeader;
    }

    public boolean isIncludeRequestParameter() {
        return includeRequestParameter;
    }

    public void setIncludeRequestParameter(boolean includeRequestParameter) {
        this.includeRequestParameter = includeRequestParameter;
    }

    public boolean isIncludeLocalPort() {
        return includeLocalPort;
    }

    public void setIncludeLocalPort(boolean includeLocalPort) {
        this.includeLocalPort = includeLocalPort;
    }

    public boolean isIncludeRequestContent() {
        return includeRequestContent;
    }

    public void setIncludeRequestContent(boolean includeRequestContent) {
        this.includeRequestContent = includeRequestContent;
    }

    public boolean isIncludeResponseContent() {
        return includeResponseContent;
    }

    public void setIncludeResponseContent(boolean includeResponseContent) {
        this.includeResponseContent = includeResponseContent;
    }
}




    © 2015 - 2025 Weber Informatics LLC | Privacy Policy