SkyWalking Java Agent 日志组件分析

LogResolver 接口目前提供了2个实现类：PatternLogResolver 、JsonLogResolver 分别返回 PatternLogger 和 JsonLogger。

ILog 接口的实现类

===========

• NoopLogger 枚举

NoopLogger 直接继承了 ILog，NoopLogger 只是实现了 ILog 接口，所有方法都是空实现，NoopLogger 存在的意义是为了防止 NullPointerException，因为调用者可以通过 LogManager 的 setLogResolver 方法设置不同的日志解析器 LogResolver，如果为null，则返回 ILog 接口的默认实现 NoopLogger。

• AbstractLogger 抽象类

• PatternLogger

• JsonLogger

AbstractLogger

==============

AbstractLogger 抽象类是为了简化 ILog 接口的具体实现，主要功能：

1. 它持有logger类名 targetClass；

2. 负责日志级别检查；

3. 解析用户输入的 message，将{}替换为对应的参数值；

4. 提供格式化日志内容的抽象方法，需要具体子类实现，目前支持 pattern 和 json 两种，默认为pattern。

输出的日志格式

%level %timestamp %thread %class : %msg %throwable

每一项代表的意义如下：

%level 日志级别.

%timestamp 时间戳 yyyy-MM-dd HH:mm:ss:SSS 格式.

%thread 线程名.

%msg 用户指定的日志信息.

%class 类名.

%throwable 异常信息.

%agent_name agent名称.

对于日志格式中的每一项， SkyWalking Java Agent 分别提供了对应的转换器解析，比如 ThreadConverter、LevelConverter 等。

/**

• An abstract class to simplify the real implementation of the loggers.

• It hold the class name of the logger, and is responsible for log level check,

• message interpolation, etc.

*/

public abstract class AbstractLogger implements ILog {

public static final Map<String, Class<? extends Converter>> DEFAULT_CONVERTER_MAP = new HashMap<>();

protected List converters = new ArrayList<>();

static {

DEFAULT_CONVERTER_MAP.put(“thread”, ThreadConverter.class);

DEFAULT_CONVERTER_MAP.put(“level”, LevelConverter.class);

DEFAULT_CONVERTER_MAP.put(“agent_name”, AgentNameConverter.class);

DEFAULT_CONVERTER_MAP.put(“timestamp”, DateConverter.class);

DEFAULT_CONVERTER_MAP.put(“msg”, MessageConverter.class);

DEFAULT_CONVERTER_MAP.put(“throwable”, ThrowableConverter.class);

DEFAULT_CONVERTER_MAP.put(“class”, ClassConverter.class);

}

// 省略部分代码…

}

比如 ThreadConverter 类用于解析 %thread 输出当前线程的 name。

/**

• Just return the Thread.currentThread().getName()

*/

public class ThreadConverter implements Converter {

@Override

public String convert(LogEvent logEvent) {

return Thread.currentThread().getName();

}

@Override

public String getKey() {

return “thread”;

}

}

日志格式化 format

============

AbstractLogger 类实现了 ILog 接口，实现了打印日志方法，最终都调用了下面这个通用的方法

protected void logger(LogLevel level, String message, Throwable e) {

WriterFactory.getLogWriter().write(this.format(level, message, e));

}

其中 logger 方法内部调用了 format 方法，format 是一个抽象方法，留给子类去实现日志输出的格式，返回字符串的字符串将输出到文件或标准输出。

/**

• The abstract method left for real loggers.

• Any implementation MUST return string, which will be directly transferred to log destination,

• i.e. log files OR stdout

• @param level log level

• @param message log message, which has been interpolated with user-defined parameters.

• @param e throwable if exists

• @return string representation of the log, for example, raw json string for {@link JsonLogger}

*/

protected abstract String format(LogLevel level, String message, Throwable e);

抽象类对接口中的方法做了实现，每个实现中都调用了一个抽象方法，这个抽象方法让子类来实现具体的业务逻辑。

下面是 AbstractLogger 抽象类其中一个实现类 PatternLogger 类对 format 方法的实现，调用转换器相应的 Converter ，将日志拼接成字符串。

@Override

protected String format(LogLevel level, String message, Throwable t) {

LogEvent logEvent = new LogEvent(level, message, t, targetClass);

StringBuilder stringBuilder = new StringBuilder();

for (Converter converter : this.converters) {

stringBuilder.append(converter.convert(logEvent));

}

return stringBuilder.toString();

}

public void setPattern(String pattern) {

if (StringUtil.isEmpty(pattern)) {

pattern = DEFAULT_PATTERN;

}

this.pattern = pattern;

this.converters = new Parser(pattern, DEFAULT_CONVERTER_MAP).parse();

}

PatternLogger 将日志格式 pattern 转换成对应的转换器 Converter 是在 PatternLogger.setPattern 方法实现的，内部调用了 Parser.parse 方法，具体实现参见 Parser 类源码。

WriterFactory

=============

日志已经拼装完毕，接下来就该将日志内容输出到指定的位置，WriterFactory 工厂类就是负责创建 IWriter 接口的实现类，用于将日志信息写入到目的地。

public interface IWriter {

void write(String message);

}

IWriter 接口有2种实现 FileWriter 和 SystemOutWriter

• FileWriter：使用一个阻塞队列 ArrayBlockingQueue 作为缓冲，线程池 ScheduledExecutorService 异步从队列中取出日志信息，使用 FileOutputStream 将日志信息写入日志文件中，典型的生产者-消费者模式；

• SystemOutWriter：将日志信息输出到控制台；

FileWriter 工作原理

===============

下面我们看下 FileWriter 是如何将日志写入日志文件的

• FileWriter 负责将日志信息写入 ArrayBlockingQueue 队列中

• ScheduledExecutorService 定时任务 a）每秒从 ArrayBlockingQueue 取出所有日志信息，写入到文件中； b）判断文件大小是否超过最大值Config.Logging.MAX_FILE_SIZE； c）如果超过最大值将当前文件重命名。

/**

• Write log to the queue. W/ performance trade off.

• @param message to log

*/

@Override

public void write(String message) {

logBuffer.offer(message);

}

日志组件涉及到的设计模式：

• 工厂模式