神器 JMH & Arthas 性能監(jiān)控
簡(jiǎn)單介紹兩款Java測(cè)試和性能監(jiān)控神器
最近的工作日并不算太平，各種大大小小的case和解case，發(fā)現(xiàn)已經(jīng)有好久好久沒有靜下心來專心寫點(diǎn)東西了。不過倒還是堅(jiān)持利用業(yè)余時(shí)間學(xué)習(xí)了不少微課上的東西，發(fā)現(xiàn)大佬們總結(jié)的東西還是不一樣，相比于大學(xué)時(shí)的那些枯燥的課本，大佬們總結(jié)出來的內(nèi)容更活，更加容易理解。自己后面也會(huì)把大佬們的東西好好消化吸收，變成自己的東西用文字性的東西表達(dá)出來。
今天想總結(jié)的東西是最近工作中使用到的測(cè)試工具JMH以及Java運(yùn)行時(shí)監(jiān)控工具Arthas。他們?cè)谖业膶?shí)際工作中也算是幫了大忙。所以在這里拋磚引玉一下這些工具的使用方法。同時(shí)也加深一下自己對(duì)這些工具的熟悉程度。對(duì)這兩個(gè)工具，我都會(huì)首先簡(jiǎn)單介紹一下這些工具的大致使用場(chǎng)景，然后會(huì)使用一個(gè)在工作中真正遇到的性能問題排查為例詳細(xì)講解這兩個(gè)工具的實(shí)際用法。話不多說，直奔主題。
問題描述
為了能夠讓我后面的實(shí)例能夠貫穿這兩個(gè)工具的使用，我首先簡(jiǎn)單描述下我們?cè)陂_發(fā)中遇到的實(shí)際的性能問題。然后再引出這兩個(gè)性能工具的實(shí)際使用，看我們?nèi)绾问褂眠@兩個(gè)工具成功定位到性能瓶頸的。
問題如下：為了能夠支持丟失率，我們將原先log4j2 的Async+自定義Appender的方式進(jìn)行了修正，把異步的邏輯放到了自己改版后的Appender中。但我們發(fā)現(xiàn)修改后日志性能要比之前Async+自定義Appender的方式下降不少。這里由于隱私原因我并沒有用實(shí)際公司中的實(shí)例，這里我用了一種其他同樣能夠體現(xiàn)問題的方式。我們暫時(shí)先不給出具體的配置文件，先給出性能測(cè)試代碼和結(jié)果
代碼
package com.bryantchang.appendertest;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
public class AppenderTest {
private static final String LOGGER_NAME_DEFAULT = "defaultLogger";
private static final String LOGGER_NAME_INCLUDE = "includeLocationLogger";
private static final Logger LOGGER = LoggerFactory.getLogger(LOGGER_NAME_INCLUDE);
public static final long BATCH = 10000;
public static void main(String[] args) throws InterruptedException {
while(true) {
long start, end;
start = System.currentTimeMillis();
for (int i = 0; i < BATCH; i++) {
LOGGER.info("msg is {}", i);
}
end = System.currentTimeMillis();
System.out.println("duration of " + LOGGER_NAME_INCLUDE + " is " + (end - start) + "ms");
Thread.sleep(1000);
}
}
}
代碼邏輯及其簡(jiǎn)單，就是調(diào)用logger.info每次打印10000條日志，然后記錄耗時(shí)。兩者的對(duì)比如下
對(duì)比結(jié)果
從這兩張圖片中我們能夠看到同樣的邏輯，兩個(gè)程序的耗時(shí)差距相差了數(shù)十倍，但看圖片，貌似僅僅是logger的名稱不一樣。對(duì)上面的實(shí)驗(yàn)結(jié)果進(jìn)行分析，我們可能會(huì)有兩個(gè)疑問
上面的代碼測(cè)試是否標(biāo)準(zhǔn)，規(guī)范
如果真的是性能問題，那么這兩個(gè)代碼到底在哪個(gè)方法上有了這么大的差距導(dǎo)致了最終的性能差異
下面這兩個(gè)工具就分別來回答這兩個(gè)問題
JMH簡(jiǎn)介
第一個(gè)問題就是，測(cè)試的方法是否標(biāo)準(zhǔn)。我們?cè)诰帉懘a時(shí)用的是死循環(huán)+前后“掐秒表”的方式。假如我們要再加個(gè)多線程的測(cè)試，我們還需要搞一個(gè)線程池，除了代碼本身的邏輯還要關(guān)心測(cè)試的邏輯。我們會(huì)想，有沒有一款工具能夠?qū)⑽覀儚臏y(cè)試邏輯中徹底解放出來，只需要關(guān)心我們需要測(cè)試的代碼邏輯。JMH就是這樣一款Java的測(cè)試框架。下面是JMH的官方定義
JMH 是一個(gè)面向 Java 語言或者其他 Java 虛擬機(jī)語言的性能基準(zhǔn)測(cè)試框架
這里面我們需要注意的是，JMH所測(cè)試的方法約簡(jiǎn)單越好，依賴越少越好，最適合的場(chǎng)景就是，測(cè)試兩個(gè)集合put，get性能，例如ArrayList與LinkedList的對(duì)比等，這里我們需要測(cè)試的是批量打一批日志所需要的時(shí)間，也基本符合使用JMH的測(cè)試場(chǎng)景。下面是測(cè)試代碼，bench框架代碼以及主函數(shù)。
待測(cè)試方法
public class LogBenchMarkWorker {
private LogBenchMarkWorker() {}
private static class LogBenchMarkWorkerInstance {
private static final LogBenchMarkWorker instance = new LogBenchMarkWorker();
}
public static LogBenchMarkWorker getInstance() {
return LogBenchMarkWorkerInstance.instance;
}
private static final String LOGGER_DEFAULT_NAME = "defaultLogger";
private static final String LOGGER_INCLUDE_LOCATION = "includeLocationLogger";
private static final Logger LOGGER = LoggerFactory.getLogger(LOGGER_DEFAULT_NAME);
private static long BATCH_SIZE = 10000;
public void logBatch() {
for (int i = 0; i < BATCH_SIZE; i++) {
LOGGER.info("msg is {}", i);
}
}
}
可以看到待測(cè)試方法非常簡(jiǎn)單，就是單批次一次性打印10000條日志的操作，所以并沒有需要額外說明的部分。下面我們?cè)賮砜碽enchmark部分。
public class LogBenchMarkMain {
@Benchmark
@BenchmarkMode(Mode.AverageTime)
@Fork(value = 1)
@Threads(1)
public void testLog1() {
LogBenchMarkWorker.getInstance().logBatch();
}
@Benchmark
@BenchmarkMode(Mode.AverageTime)
@Fork(value = 1)
@Threads(4)
public void testLog4() {
LogBenchMarkWorker.getInstance().logBatch();
}
@Benchmark
@BenchmarkMode(Mode.AverageTime)
@Fork(value = 1)
@Threads(8)
public void testLog8() {
LogBenchMarkWorker.getInstance().logBatch();
}
@Benchmark
@BenchmarkMode(Mode.AverageTime)
@Fork(value = 1)
@Threads(16)
public void testLog16() {
LogBenchMarkWorker.getInstance().logBatch();
}
在這段代碼中，我們就會(huì)發(fā)現(xiàn)有了一些JMH中特有的東西，我下面進(jìn)行簡(jiǎn)要介紹。
Benchmark注解：標(biāo)識(shí)在某個(gè)具體方法上，表示這個(gè)方法將是一個(gè)被測(cè)試的最小方法，在JMH中成為一個(gè)OPS
BenmarkMode:測(cè)試類型，JMH提供了幾種不同的Mode
Throughput:整體吞吐量
AverageTime:調(diào)用的平均時(shí)間，每次OPS執(zhí)行的時(shí)間
SampleTime:取樣，給出不同比例的ops時(shí)間，例如99%的ops時(shí)間，99.99%的ops時(shí)間
fork：fork的次數(shù)，如果設(shè)置為2，JMH會(huì)fork出兩個(gè)進(jìn)程來測(cè)試
Threads：很容易理解，這個(gè)參數(shù)表示這個(gè)方法同時(shí)被多少個(gè)線程執(zhí)行
在上面的代碼中，我定義了4個(gè)待測(cè)試的方法，方法的Fork，BenchmarkMode均為測(cè)試單次OPS的平均時(shí)間，但4個(gè)方法的線程數(shù)不同。
除了這幾個(gè)參數(shù)，還有幾個(gè)參數(shù)，我會(huì)在main函數(shù)里面來講，main代碼如下所示
public class Main {
public static void main(String[] args) throws RunnerException {
Options options = new OptionsBuilder()
.include(LogBenchMarkMain.class.getSimpleName())
.warmupIterations(5)
.measurementIterations(5)
.output("logs/BenchmarkCommon.log")
.build();
new Runner(options).run();
}
}
我們可以看到，在main函數(shù)中，我們就是要設(shè)置JMH的基礎(chǔ)配置，這里面的幾個(gè)配置參數(shù)含義如下：
include:benchmark所在類的名字，可以使用正則表達(dá)
warmupIteration:預(yù)熱的迭代次數(shù)，這里為什么要預(yù)熱的原因是由于JIT的存在，隨著代碼的運(yùn)行，會(huì)動(dòng)態(tài)對(duì)代碼的運(yùn)行進(jìn)行優(yōu)化。因此在測(cè)試過程中需要先預(yù)熱幾輪，讓代碼運(yùn)行穩(wěn)定后再實(shí)際進(jìn)行測(cè)試
measurementIterations:實(shí)際測(cè)試輪次
output:測(cè)試報(bào)告輸出位置
我分別用兩種logger運(yùn)行一下測(cè)試，查看性能測(cè)試報(bào)告對(duì)比
使用普通logger
LogBenchMarkMain.testLog1 avgt 5 0.006 ± 0.001 s/op
LogBenchMarkMain.testLog16 avgt 5 0.062 ± 0.026 s/op
LogBenchMarkMain.testLog4 avgt 5 0.006 ± 0.002 s/op
LogBenchMarkMain.testLog8 avgt 5 0.040 ± 0.004 s/op
使用了INCLUDE_LOCATION的logger
LogBenchMarkMain.testLog1 avgt 5 0.379 ± 0.007 s/op
LogBenchMarkMain.testLog16 avgt 5 1.784 ± 0.670 s/op
LogBenchMarkMain.testLog4 avgt 5 0.378 ± 0.003 s/op
LogBenchMarkMain.testLog8 avgt 5 0.776 ± 0.070 s/op
這里我們看到，性能差距立現(xiàn)。使用INCLUDE_LOCATION的性能要明顯低于使用普通logger的性能。這是我們一定很好奇，并且問一句“到底慢在哪”！！
Arthas 我的代碼在運(yùn)行時(shí)到底做了什么
Arthas是阿里開源的一款java調(diào)試神器，與greys類似，不過有著比greys更加強(qiáng)大的功能，例如，可以直接繪制java方法調(diào)用的火焰圖等。這兩個(gè)工具的原理都是使用了Java強(qiáng)大的字節(jié)碼技術(shù)。畢竟我也不是JVM大佬，所以具體的實(shí)現(xiàn)細(xì)節(jié)沒法展開，我們要做的就是站在巨人的肩膀上，接受并用熟練的使用好這些好用的性能監(jiān)控工具。
實(shí)際操作
talk is cheap, show me your code,既然是工具，我們直接進(jìn)行實(shí)際操作。我們?cè)诒緳C(jī)運(yùn)行我們一開始的程序，然后講解arthas的使用方法。
我們首先通過jps找到程序的進(jìn)程號(hào)，然后直接通過arthas給到的as.sh對(duì)我們運(yùn)行的程序進(jìn)行字節(jié)碼增強(qiáng)，然后啟動(dòng)arthas，命令如下
./as.sh pid
這個(gè)就是arthas的啟動(dòng)界面了，我們使用help命令查看工具所支持的功能
可以看到，arthas支持查看當(dāng)前jvm的狀態(tài)，查看當(dāng)前的線程狀態(tài)，監(jiān)控某些方法的調(diào)用時(shí)間，trace，profile生成火焰圖等，功能一應(yīng)俱全
我們這里也只將幾個(gè)比較常用的命令，其他的命令如果大家感興趣可以詳見官網(wǎng)arthas官網(wǎng)。這篇文章主要介紹下面幾個(gè)功能
反編譯代碼
監(jiān)控某個(gè)方法的調(diào)用
查看某個(gè)方法的調(diào)用和返回值
trace某個(gè)方法
監(jiān)控方法調(diào)用
這個(gè)主要的命令為monitor，根據(jù)官網(wǎng)的介紹，常用的使用方法為
monitor -c duration className methodName
其中duration代表每隔幾秒展示一次統(tǒng)計(jì)結(jié)果，即單次的統(tǒng)計(jì)周期，className就是類的全限定名，methodname就是方法的名字，這里面我們查看的方法是Logger類的info方法，我們分別對(duì)使用兩種不同logger的info方法。這里面的類是org.slf4j.Logger，方法時(shí)info，我們的監(jiān)控語句為
monitor -c 5 org.slf4j.Logger info
監(jiān)控結(jié)果如下
使用普通appender
使用include appender
我們可以看到，使用include appeder的打印日志方法要比普通的appender高出了3倍，這就不禁讓我們有了疑問，究竟這兩個(gè)方法各個(gè)步驟耗時(shí)如何呢。下面我們就介紹第二條命令，trace方法。
trace命令 & jad命令
這兩個(gè)程序的log4j2配置文件如下
<configuration status="warn" monitorInterval="30">
<appenders>
<Console name="console" target="SYSTEM_OUT">
<ThresholdFilter level="warn" onMatch="ACCEPT" onMismatch="DENY"/>
<PatternLayout pattern="[%d{HH:mm:ss.SSS}] [%-5p] %l - %m%n"/>
Console>
<Async name="AsyncDefault" blocking="false" includeLocation="false">
<AppenderRef ref="fileAppender"/>
Async>
<Async name="AsyncIncludeLocation" blocking="false" includeLocation="true">
<AppenderRef ref="fileAppender"/>
Async>
<File name="fileAppender" fileName="log/test.log" append="false">
<PatternLayout pattern="[%d{HH:mm:ss.SSS}] [%-5p] %l - %m%n"/>
File>
<File name="ERROR" fileName="logs/error.log">
<ThresholdFilter level="error" onMatch="ACCEPT" onMismatch="DENY"/>
<PatternLayout pattern="[%d{yyyy.MM.dd 'at' HH:mm:ss z}] [%-5p] %l - %m%n"/>
File>
<RollingFile name="rollingFile" fileName="logs/app.log"
filePattern="logs/$${date:yyyy-MM}/web-%d{yyyy-MM-dd}.log.gz">
<PatternLayout pattern="[%d{yyyy-MM-dd HH:mm:ss}] [%-5p] %l - %m%n"/>
<Policies>
<TimeBasedTriggeringPolicy modulate="true" interval="1"/>
Policies>
<DefaultRolloverStrategy>
<Delete basePath="logs" maxDepth="2">
<IfFileName glob="*/*.log.gz" />
<IfLastModified age="7d" />
Delete>
DefaultRolloverStrategy>
RollingFile>
appenders>
<loggers>
<logger name="defaultLogger" additivity="false">
<appender-ref ref="AsyncDefault">appender-ref>
logger>
<logger name="includeLocationLogger" additivity="false">
<appender-ref ref="AsyncIncludeLocation">appender-ref>
logger>
<root level="INFO">
root>
loggers>
configuration>
我們都是用了一個(gè)AsyncAppender套用了一個(gè)FileAppender。查看fileAppender，發(fā)現(xiàn)二者相同完全沒區(qū)別，只有asyncAppender中的一個(gè)選項(xiàng)有區(qū)別，這就是includeLocation，一個(gè)是false，另一個(gè)是true。至于這個(gè)參數(shù)的含義，我們暫時(shí)不討論，我們現(xiàn)在知道問題可能出在AsyncAppender里面，但是我們?cè)撊绾悟?yàn)證呢。trace命令就有了大用場(chǎng)。
trace命令的基本用法與monitor類似，其中主要的一個(gè)參數(shù)是-n則是代表trace多少次的意思
trace -n trace_times className methodName
我在之前Log4j2的相關(guān)博客里面講到過，任何一個(gè)appender，最核心的方法就是他的append方法。所以我們分別trace兩個(gè)程序的append方法。
trace -n 5 org.apache.logging.log4j.core.appender.AsyncAppender append
trace結(jié)果如下
使用普通appender
使用include appender
我們立刻可以發(fā)現(xiàn)，兩個(gè)trace的熱點(diǎn)方法不一樣，在使用include的appender中，耗時(shí)最長(zhǎng)的方法時(shí)org.apache.logging.log4j.core.impl.Log4jLogEvent類中的createMemento方法，那么怎么才能知道這個(gè)方法到底做了啥呢，那就請(qǐng)出我們下一個(gè)常用命令jad，這個(gè)命令能夠反編譯出對(duì)應(yīng)方法的代碼。這里我們jad一下上面說的那個(gè)createMemento方法，命令很簡(jiǎn)單
jad org.apache.logging.log4j.core.impl.Log4jLogEvent createMemento
結(jié)果如下
我們發(fā)現(xiàn)，這個(gè)方法中有個(gè)includeLocation參數(shù)，這個(gè)和我們的看到的兩個(gè)appender的唯一不同的配置相吻合，我們此時(shí)應(yīng)該有這個(gè)猜想，會(huì)不會(huì)就是這個(gè)參數(shù)導(dǎo)致的呢？為了驗(yàn)證這個(gè)猜想，我們引出下一個(gè)命令,watch
watch命令
watch命令能夠觀察到某個(gè)特定方法的入?yún)ⅲ祷刂档刃畔ⅲ覀兪褂眠@個(gè)命令查看一下這個(gè)createMemento方法的入?yún)ⅲ绻麅蓚€(gè)程序的入?yún)⒉煌腔究梢詳喽ㄊ沁@個(gè)原因引起命令如下
watch org.apache.logging.log4j.core.impl.Log4jLogEvent createMemento "params" -x 2 -n 5 -b -f
這里面的參數(shù)含義如下
-x 參數(shù)展開層次
-n 執(zhí)行次數(shù)
-b 查看方法調(diào)用前狀態(tài)
-f 方法調(diào)用后
其中的param代表查看方法的調(diào)用參數(shù)列表，還有其他的監(jiān)控項(xiàng)詳見官網(wǎng)官網(wǎng)
最終watch結(jié)果如下
使用普通logger
使用include
果不其然，這兩個(gè)參數(shù)果然是一個(gè)true一個(gè)false，我們簡(jiǎn)單看下這個(gè)參數(shù)是如何傳進(jìn)來的，我們jad一下AsyncAppender的append方法
我們發(fā)現(xiàn)這個(gè)includeLocation正是appender的一個(gè)屬性，也就是我們xml中配置的那個(gè)屬性。查看官網(wǎng)的相關(guān)分析，我們看到這個(gè)參數(shù)會(huì)使log的性能下降5–10倍
不過為了一探究竟，我還是靜態(tài)跟了一下這段代碼
這個(gè)includeLocation會(huì)在event的createMemento中被用到，在序列化生成對(duì)象時(shí)會(huì)創(chuàng)建一個(gè)LogEventProxy，代碼如下
public LogEventProxy(final LogEvent event, final boolean includeLocation) {
this.loggerFQCN = event.getLoggerFqcn();
this.marker = event.getMarker();
this.level = event.getLevel();
this.loggerName = event.getLoggerName();
final Message msg = event.getMessage();
this.message = msg instanceof ReusableMessage
? memento((ReusableMessage) msg)
: msg;
this.timeMillis = event.getTimeMillis();
this.thrown = event.getThrown();
this.thrownProxy = event.getThrownProxy();
this.contextData = memento(event.getContextData());
this.contextStack = event.getContextStack();
this.source = includeLocation ? event.getSource() : null;
this.threadId = event.getThreadId();
this.threadName = event.getThreadName();
this.threadPriority = event.getThreadPriority();
this.isLocationRequired = includeLocation;
this.isEndOfBatch = event.isEndOfBatch();
this.nanoTime = event.getNanoTime();
}
如果includeLocation為true，那么就會(huì)調(diào)用getSource函數(shù)，跟進(jìn)去查看，代碼如下
public StackTraceElement getSource() {
if (source != null) {
return source;
}
if (loggerFqcn == null || !includeLocation) {
return null;
}
source = Log4jLogEvent.calcLocation(loggerFqcn);
return source;
}
public static StackTraceElement calcLocation(final String fqcnOfLogger) {
if (fqcnOfLogger == null) {
return null;
}
// LOG4J2-1029 new Throwable().getStackTrace is faster than Thread.currentThread().getStackTrace().
final StackTraceElement[] stackTrace = new Throwable().getStackTrace();
StackTraceElement last = null;
for (int i = stackTrace.length - 1; i > 0; i--) {
final String className = stackTrace[i].getClassName();
if (fqcnOfLogger.equals(className)) {
return last;
}
last = stackTrace[i];
}
return null;
}
我們看到他會(huì)從整個(gè)的調(diào)用棧中去尋找調(diào)用這個(gè)方法的代碼行，其性能可想而知。我們用arthas監(jiān)控一下，驗(yàn)證一下。
首先我們trace crateMemento方法
trace -n 5 org.apache.logging.log4j.core.impl.Log4jLogEvent createMemento
發(fā)現(xiàn)熱點(diǎn)方法時(shí)org.apache.logging.log4j.core.impl.Log4jLogEvent的serialize()，繼續(xù)trace下去
trace -n 5 org.apache.logging.log4j.core.impl.Log4jLogEvent serialize
看到熱點(diǎn)是org.apache.logging.log4j.core.impl.Log4jLogEvent:LogEventProxy的構(gòu)造方法，繼續(xù)trace
trace -n 5 org.apache.logging.log4j.core.impl.Log4jLogEvent$LogEventProxy
發(fā)現(xiàn)是getSource方法，繼續(xù)
trace -n 5 trace -n 5 org.apache.logging.log4j.core.LogEvent getSource
熱點(diǎn)終于定位到了，是org.apache.logging.log4j.core.impl.Log4jLogEvent的calcLocation函數(shù)，和我們靜態(tài)跟蹤的代碼一樣。
至此我們通過結(jié)合JMH和arthas共同定位出了一個(gè)線上的性能問題。不過我介紹的只是冰山一角，更多常用的命令還希望大家通過官網(wǎng)自己了解和實(shí)踐，有了幾次親身實(shí)踐之后，這個(gè)工具也就玩熟了。
轉(zhuǎn)自：https://bryantchang.github.io/2019/12/08/java-profile-tools/