如何監控 Log4j2 異步日誌遇到寫入瓶頸

如何監控 Log4j2 異步日誌遇到寫入瓶頸

在之前的一篇文章中(一次鞭辟入裏的 Log4j2 異步日誌輸出阻塞問題的定位)，我們詳細分析了一個經典的 Log4j2 異步日誌阻塞問題的定位，主要原因還是日誌文件寫入慢了。並且比較深入的分析了 Log4j2 異步日誌的原理，最後給出了一些解決方案。

新的問題 - 如何更好的應對這種情況？

之前提出的解決方案僅僅是針對之前定位的問題的優化，但是隨着業務發展，日誌量肯定會更多，大量的日誌可能導致寫入日誌成爲新的性能瓶頸。對於這種情況，我們需要監控。

首先想到的是進程外部採集系統指標監控：現在服務都提倡上雲，並實現雲原生服務。對於雲服務，存儲日誌很可能使用 NFS（Network File System），例如 AWS 的 EFS。這種 NFS 一動都可以動態的控制 IO 最大承載，但是服務的增長是很難預估完美的，並且高併發業務流量基本都是一瞬間到達，僅通過 IO 定時採集很難評估到真正的流量尖峯（例如 IO 定時採集是 5s 一次，但是在某一秒內突然到達很多流量，導致進程內大多線程阻塞，這之後採集 IO 看到 IO 壓力貌似不大的樣子）。並且，由於線程的阻塞，導致可能我們看到的 CPU 佔用貌似也不高的樣子。所以，外部定時採集指標，很難真正定位到日誌流量問題。

然後我們考慮進程自己監控，暴露接口給外部監控定時檢查，例如 K8s 的 pod 健康檢查等等。在進程的日誌寫入壓力過大的時候，新擴容一個實例；啓動完成後，在註冊中心將這個日誌壓力大的進程的狀態設置爲暫時下線（例如 Eureka 置爲 OUT_OF_SERVICE，Nacos 置爲 PAUSED），讓流量轉發到其他實例。待日誌壓力小之後，再修改狀態爲 UP，繼續服務。

那麼如何實現這種監控呢？

監控 Log4j2 異步日誌的核心 - 監控 RingBuffer

根據之前我們分析 Log4j2 異步日誌的原理，我們知道其核心是 RingBuffer 這個數據結構作爲緩存。我們可以監控其剩餘大小的變化來判斷當前日誌壓力。那麼怎麼能拿到呢？

Log4j2 異步日誌與 RingBuffer 的關係

Log4j2 對於每一個 AsyncLogger 配置，都會創建一個獨立的 RingBuffer，例如下面的 Log4j2 配置：

<!--省略了除了 loggers 以外的其他配置-->
 <loggers>
    <!--default logger -->
    <Asyncroot level="info" includeLocation="true">
        <appender-ref ref="console"/>
    </Asyncroot>
    <AsyncLogger name="RocketmqClient" level="error" additivity="false" includeLocation="true">
        <appender-ref ref="console"/>
    </AsyncLogger>
    <AsyncLogger name="com.alibaba.druid.pool.DruidDataSourceStatLoggerImpl" level="error" additivity="false" includeLocation="true">
        <appender-ref ref="console"/>
    </AsyncLogger>
    <AsyncLogger name="org.mybatis" level="error" additivity="false" includeLocation="true">
        <appender-ref ref="console"/>
    </AsyncLogger>
</loggers>

這個配置包含 4 個 AsyncLogger，對於每個 AsyncLogger 都會創建一個 RingBuffer。Log4j2 也考慮到了監控 AsyncLogger 這種情況，所以將 AsyncLogger 的監控暴露成爲一個 MBean（JMX Managed Bean）。

相關源碼如下：

Server.java

private static void registerLoggerConfigs(final LoggerContext ctx, final MBeanServer mbs, final Executor executor)
        throws InstanceAlreadyExistsException, MBeanRegistrationException, NotCompliantMBeanException {

    //獲取 log4j2.xml 配置中的 loggers 標籤下的所有配置值
    final Map<String, LoggerConfig> map = ctx.getConfiguration().getLoggers();
    //遍歷每個 key，其實就是 logger 的 name
    for (final String name : map.keySet()) {
        final LoggerConfig cfg = map.get(name);
        final LoggerConfigAdmin mbean = new LoggerConfigAdmin(ctx, cfg);
        //對於每個 logger 註冊一個 LoggerConfigAdmin
        register(mbs, mbean, mbean.getObjectName());
        //如果是異步日誌配置，則註冊一個 RingBufferAdmin
        if (cfg instanceof AsyncLoggerConfig) {
            final AsyncLoggerConfig async = (AsyncLoggerConfig) cfg;
            final RingBufferAdmin rbmbean = async.createRingBufferAdmin(ctx.getName());
            register(mbs, rbmbean, rbmbean.getObjectName());
        }
    }
}

創建的 MBean 的類源碼：RingBufferAdmin.java

public class RingBufferAdmin implements RingBufferAdminMBean {
    private final RingBuffer<?> ringBuffer;
    private final ObjectName objectName;
    //... 省略其他我們不關心的代碼
    
    public static final String DOMAIN = "org.apache.logging.log4j2";
    String PATTERN_ASYNC_LOGGER_CONFIG = DOMAIN + ":type=%s,component=Loggers,name=%s,subtype=RingBuffer";
    
    //創建 RingBufferAdmin，名稱格式符合 Mbean 的名稱格式
    public static RingBufferAdmin forAsyncLoggerConfig(final RingBuffer<?> ringBuffer, 
            final String contextName, final String configName) {
        final String ctxName = Server.escape(contextName);
        //對於 RootLogger，這裏 cfgName 爲空字符串
        final String cfgName = Server.escape(configName);
        final String name = String.format(PATTERN_ASYNC_LOGGER_CONFIG, ctxName, cfgName);
        return new RingBufferAdmin(ringBuffer, name);
    }
    
    //獲取 RingBuffer 的大小
    @Override
    public long getBufferSize() {
        return ringBuffer == null ? 0 : ringBuffer.getBufferSize();
    }
    //獲取 RingBuffer 剩餘的大小
    @Override
    public long getRemainingCapacity() {
        return ringBuffer == null ? 0 : ringBuffer.remainingCapacity();
    }
    public ObjectName getObjectName() {
        return objectName;
    }
}

我們可以通過 JConsole 查看對應的 MBean：

其中 2f0e140b 爲 LoggerContext 的 name。

Spring Boot + Prometheus 監控 Log4j2 RingBuffer 大小

我們的微服務項目中使用了 spring boot，並且集成了 prometheus。我們可以通過將 Log4j2 RingBuffer 大小作爲指標暴露到 prometheus 中，通過如下代碼：

import io.micrometer.core.instrument.Gauge;
import io.micrometer.prometheus.PrometheusMeterRegistry;
import lombok.extern.log4j.Log4j2;
import org.apache.commons.lang3.StringUtils;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.core.LoggerContext;
import org.apache.logging.log4j.core.jmx.RingBufferAdminMBean;
import org.springframework.beans.factory.ObjectProvider;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.actuate.autoconfigure.metrics.export.ConditionalOnEnabledMetricsExport;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.event.ContextRefreshedEvent;
import org.springframework.context.event.EventListener;

import javax.annotation.PostConstruct;
import javax.management.ObjectName;
import java.lang.management.ManagementFactory;

@Log4j2
@Configuration(proxyBeanMethods = false)
//需要在引入了 prometheus 並且 actuator 暴露了 prometheus 端口的情況下才加載
@ConditionalOnEnabledMetricsExport("prometheus")
public class Log4j2Configuration {
    @Autowired
    private ObjectProvider<PrometheusMeterRegistry> meterRegistry;
    //只初始化一次
    private volatile boolean isInitialized = false;

    //需要在 ApplicationContext 刷新之後進行註冊
    //在加載 ApplicationContext 之前，日誌配置就已經初始化好了
    //但是 prometheus 的相關 Bean 加載比較複雜，並且隨着版本更迭改動比較多，所以就直接偷懶，在整個 ApplicationContext 刷新之後再註冊
    // ApplicationContext 可能 refresh 多次，例如調用 /actuator/refresh，還有就是多 ApplicationContext 的場景
    // 這裏爲了簡單，通過一個簡單的 isInitialized 判斷是否是第一次初始化，保證只初始化一次
    @EventListener(ContextRefreshedEvent.class)
    public synchronized void init() {
        if (!isInitialized) {
            //通過 LogManager 獲取 LoggerContext，從而獲取配置
            LoggerContext loggerContext = (LoggerContext) LogManager.getContext(false);
            org.apache.logging.log4j.core.config.Configuration configuration = loggerContext.getConfiguration();
            //獲取 LoggerContext 的名稱，因爲 Mbean 的名稱包含這個
            String ctxName = loggerContext.getName();
            configuration.getLoggers().keySet().forEach(k -> {
                try {
                    //針對 RootLogger，它的 cfgName 是空字符串，爲了顯示好看，我們在 prometheus 中將它命名爲 root
                    String cfgName = StringUtils.isBlank(k) ? "" : k;
                    String gaugeName = StringUtils.isBlank(k) ? "root" : k;
                    Gauge.builder(gaugeName + "_logger_ring_buffer_remaining_capacity", () ->
                    {
                        try {
                            return (Number) ManagementFactory.getPlatformMBeanServer()
                                    .getAttribute(new ObjectName(
                                            //按照 Log4j2 源碼中的命名方式組裝名稱
                                            String.format(RingBufferAdminMBean.PATTERN_ASYNC_LOGGER_CONFIG, ctxName, cfgName)
                                            //獲取剩餘大小，注意這個是嚴格區分大小寫的
                                    ), "RemainingCapacity");
                        } catch (Exception e) {
                            log.error("get {} ring buffer remaining size error", k, e);
                        }
                        return -1;
                    }).register(meterRegistry.getIfAvailable());
                } catch (Exception e) {
                    log.error("Log4j2Configuration-init error: {}", e.getMessage(), e);
                }
            });
            isInitialized = true;
        }
    }
}

增加這個代碼之後，請求 /actuator/prometheus 之後，可以看到對應的返回：

//省略其他的
# HELP root_logger_ring_buffer_remaining_capacity  
# TYPE root_logger_ring_buffer_remaining_capacity gauge
root_logger_ring_buffer_remaining_capacity 262144.0
# HELP org_mybatis_logger_ring_buffer_remaining_capacity  
# TYPE org_mybatis_logger_ring_buffer_remaining_capacity gauge
org_mybatis_logger_ring_buffer_remaining_capacity 262144.0
# HELP com_alibaba_druid_pool_DruidDataSourceStatLoggerImpl_logger_ring_buffer_remaining_capacity  
# TYPE com_alibaba_druid_pool_DruidDataSourceStatLoggerImpl_logger_ring_buffer_remaining_capacity gauge
com_alibaba_druid_pool_DruidDataSourceStatLoggerImpl_logger_ring_buffer_remaining_capacity 262144.0
# HELP RocketmqClient_logger_ring_buffer_remaining_capacity  
# TYPE RocketmqClient_logger_ring_buffer_remaining_capacity gauge
RocketmqClient_logger_ring_buffer_remaining_capacity 262144.0

這樣，當這個值爲 0 持續一段時間後（就代表 RingBuffer 滿了，日誌生成速度已經遠大於消費寫入 Appender 的速度了），我們就認爲這個應用日誌負載過高了。