logstash-logback-encoder项目中logLevelValue字段的正确使用方式

在使用logstash-logback-encoder进行日志格式化输出时，开发者经常会遇到关于日志级别数值输出的配置问题。本文将详细介绍如何正确配置和使用logLevelValue字段，以及相关的技术细节。

问题背景

在logstash-logback-encoder项目中，开发者期望在JSON格式的日志输出中包含日志级别的数值表示（如DEBUG=1，INFO=2等）。文档中提到可以使用level_value字段名来获取这个数值，但直接使用%level_value转换词会导致解析错误。

错误配置分析

常见的错误配置方式是在pattern中直接使用%level_value转换词：

<pattern>
    {
    "log_level": "%level_value"
    }
</pattern>

这种配置会导致Logback报错："Failed to interpret '%level_value' conversion word"，因为Logback本身并不认识这个转换词。

正确配置方法

实际上，要输出日志级别的数值表示，应该使用<logLevelValue/>提供器：

<encoder class="net.logstash.logback.encoder.LoggingEventCompositeJsonEncoder">
    <providers>
        <logLevelValue>
            <fieldName>log_level</fieldName>
        </logLevelValue>
    </providers>
</encoder>

这种配置会输出类似如下的JSON：

{
    "log_level": 20000
}

数值映射关系

logstash-logback-encoder默认使用Logback内部的级别数值：

• TRACE = 5000
• DEBUG = 10000
• INFO = 20000
• WARN = 30000
• ERROR = 40000

自定义数值映射

如果开发者希望使用自定义的数值（如INFO=2），可以通过实现LogLevelValueProvider接口来创建自定义的数值映射。例如：

public class SimpleLogLevelValueProvider extends LogLevelValueProvider {
    @Override
    public int value(ILoggingEvent event) {
        switch (event.getLevel().toInt()) {
            case Level.TRACE_INT: return 1;
            case Level.DEBUG_INT: return 2;
            case Level.INFO_INT: return 3;
            case Level.WARN_INT: return 4;
            case Level.ERROR_INT: return 5;
            default: return 0;
        }
    }
}

然后在配置中引用这个自定义提供器：

<encoder class="net.logstash.logback.encoder.LoggingEventCompositeJsonEncoder">
    <providers>
        <custom class="com.example.SimpleLogLevelValueProvider">
            <fieldName>log_level</fieldName>
        </custom>
    </providers>
</encoder>

性能考虑

使用<logLevelValue/>提供器比在pattern中使用转换词更高效，因为：

1. 避免了模式解析的开销
2. 直接访问日志事件属性，减少中间处理
3. 更适合大规模日志处理场景

总结

正确使用logstash-logback-encoder的日志级别数值输出功能需要注意以下几点：

1. 不要直接在pattern中使用%level_value转换词
2. 使用专门的<logLevelValue/>提供器
3. 默认输出的是Logback内部的级别数值
4. 可以通过自定义提供器实现简化的数值映射
5. 考虑性能因素选择最优配置方式

通过以上方法，开发者可以灵活地在JSON日志中包含所需的日志级别数值信息，同时保持系统的高效运行。