UnderTow Access.log格式

仲涵亮
2023-12-01

最近从tomcat切换到UnderTow,来优化下频繁YoungGC的问题。发现accesslog格式不太一样,并且官方文档上面的并不全面,所以就看看源码来总结下,这样以后就算有更新,也可以通过这些类来知道最新的格式。

核心配置在io.undertow.attribute这个包下面

例如时间配置,就是对应的DateTimeAttribute这个类:

public class DateTimeAttribute implements ExchangeAttribute {

    public static final String DATE_TIME_SHORT = "%t";
    public static final String DATE_TIME = "%{DATE_TIME}";
    public static final String CUSTOM_TIME = "%{time,";

    public static final ExchangeAttribute INSTANCE = new DateTimeAttribute();

    private final String dateFormat;
    private final ThreadLocal<SimpleDateFormat> cachedFormat;

    private DateTimeAttribute() {
        this.dateFormat = null;
        this.cachedFormat = null;
    }

    public DateTimeAttribute(final String dateFormat) {
        this(dateFormat, null);
    }

    public DateTimeAttribute(final String dateFormat, final String timezone) {
        this.dateFormat = dateFormat;
        this.cachedFormat = new ThreadLocal<SimpleDateFormat>() {
            @Override
            protected SimpleDateFormat initialValue() {
                final SimpleDateFormat format = new SimpleDateFormat(dateFormat);
                if(timezone != null) {
                    format.setTimeZone(TimeZone.getTimeZone(timezone));
                }
                return format;
            }
        };
    }
    @Override
    public String readAttribute(final HttpServerExchange exchange) {
        if(dateFormat == null) {
            return DateUtils.toCommonLogFormat(new Date());
        } else {
            final SimpleDateFormat dateFormat = this.cachedFormat.get();
            return dateFormat.format(new Date());
        }
    }

    @Override
    public void writeAttribute(final HttpServerExchange exchange, final String newValue) throws ReadOnlyAttributeException {
        throw new ReadOnlyAttributeException("Date time", newValue);
    }

    public static final class Builder implements ExchangeAttributeBuilder {

        @Override
        public String name() {
            return "Date Time";
        }

        @Override
        public ExchangeAttribute build(final String token) {
            if (token.equals(DATE_TIME) || token.equals(DATE_TIME_SHORT)) {
                return DateTimeAttribute.INSTANCE;
            }
            if(token.startsWith(CUSTOM_TIME) && token.endsWith("}")) {
                return new DateTimeAttribute(token.substring(CUSTOM_TIME.length(), token.length() - 1));
            }
            return null;
        }

        @Override
        public int priority() {
            return 0;
        }
    }
}

通过看这个源代码,我们可以知道配置时间不知可以通过%t,%{DATE_TIME}来改变accesslog中的日期位置,还可以修改日期格式,通过%{time,格式}的方式

以下是一个示例accesslog格式,可供参考:

server.undertow.accesslog.pattern=[%{time,yyyy-MM-dd HH:mm:ss.S z}] %m %U "%q" %s %D %b %{i,X-B3-TraceId},%{i,X-B3-SpanId} %{i,X-Real-IP} %{i,Referer} "%{i,User-Agent}" %{i,Platform} %l %u %I %v %a

 类似资料: