非入侵的全鏈路監(jiān)控系統(tǒng)，代碼實(shí)現(xiàn)案例分享
作者：小傅哥
在我們的監(jiān)控程序中，需要對(duì)各種模塊進(jìn)行監(jiān)控；servlet、rpc、http、jdbc、redis、logic等，那么我們?cè)谠O(shè)計(jì)監(jiān)控程序時(shí)就需要對(duì)監(jiān)控的程序進(jìn)行模塊化開(kāi)發(fā)，可以在需要的時(shí)候進(jìn)行組裝配置即可，以方便我們監(jiān)控程序的擴(kuò)展和可控制性。
案例簡(jiǎn)述
在我們的監(jiān)控程序中，需要對(duì)各種模塊進(jìn)行監(jiān)控；servlet、rpc、http、jdbc、redis、logic等，那么我們?cè)谠O(shè)計(jì)監(jiān)控程序時(shí)就需要對(duì)監(jiān)控的程序進(jìn)行模塊化開(kāi)發(fā)，可以在需要的時(shí)候進(jìn)行組裝配置即可，以方便我們監(jiān)控程序的擴(kuò)展和可控制性。這一章節(jié)我們把監(jiān)控模塊剝離，采用工廠模式進(jìn)行調(diào)用｛目前是靜態(tài)工廠在我們實(shí)際使用中可以把工廠做成動(dòng)態(tài)配置化｝。
環(huán)境準(zhǔn)備
- IntelliJ IDEA Community Edition
- jdk1.8.0_45 64位
配置信息（路徑相關(guān)修改為自己的）
- 配置位置：Run/Debug Configurations -> VM options
- 配置內(nèi)容：-javaagent:E:\itstack\GIT\itstack.org\itstack-demo-agent\itstack-demo-agent-06\target\itstack-demo-agent-06-1.0.0-SNAPSHOT.jar=testargs
代碼示例
itstack-demo-agent-06
├── pom.xml
└── src
├── main
│ ├── java
│ │ └── org.itstack.demo.agent
│ │ ├── plugin
│ │ │ ├── impl
│ │ │ │ ├── jvm
│ │ │ │ │ ├── JvmAdvice.java
│ │ │ │ │ ├── JvmPlugin.java
│ │ │ │ │ └── JvmStack.java
│ │ │ │ └── link
│ │ │ │ ├── LinkAdvice.java
│ │ │ │ └── LinkPlugin.java
│ │ │ ├── InterceptPoint.java
│ │ │ ├── IPlugin.java
│ │ │ └── PluginFactory.java
│ │ │
│ │ ├── track
│ │ │ ├── Span.java
│ │ │ ├── TrackContext.java
│ │ │ └── TrackManager.java
│ │ └── MyAgent.java
│ └── resources
│ └── META-INF
│ └── MANIFEST.MF
└── test
└── java
└── org.itstack.demo.test
└── ApiTest.java
JvmAdvice.java
/**
* 公眾號(hào)：bugstack蟲(chóng)洞棧 ｛獲取學(xué)習(xí)源碼｝
* create by fuzhengwei on 2019
*/
public class JvmAdvice {
@Advice.OnMethodExit()
public static void exit() {
JvmStack.printMemoryInfo();
JvmStack.printGCInfo();
}
}
JvmPlugin.java
/**
* 公眾號(hào)：bugstack蟲(chóng)洞棧 ｛獲取學(xué)習(xí)源碼｝
* create by fuzhengwei on 2019
*/
public class JvmPlugin implements IPlugin {
@Override
public String name() {
return "jvm";
}
@Override
public InterceptPoint[] buildInterceptPoint() {
return new InterceptPoint[]{
new InterceptPoint() {
@Override
public ElementMatcher<TypeDescription> buildTypesMatcher() {
return ElementMatchers.nameStartsWith("org.itstack.demo.test");
}
@Override
public ElementMatcher<MethodDescription> buildMethodsMatcher() {
return ElementMatchers.isMethod()
.and(ElementMatchers.any())
.and(ElementMatchers.not(ElementMatchers.nameStartsWith("main")));
}
}
};
}
@Override
public Class adviceClass() {
return JvmAdvice.class;
}
}
LinkAdvice.java
/**
* 公眾號(hào)：bugstack蟲(chóng)洞棧 ｛獲取學(xué)習(xí)源碼｝
* create by fuzhengwei on 2019
*/
public class LinkAdvice {
@Advice.OnMethodEnter()
public static void enter(@Advice.Origin("#t") String className, @Advice.Origin("#m") String methodName) {
Span currentSpan = TrackManager.getCurrentSpan();
if (null == currentSpan) {
String linkId = UUID.randomUUID().toString();
TrackContext.setLinkId(linkId);
}
TrackManager.createEntrySpan();
}
@Advice.OnMethodExit()
public static void exit(@Advice.Origin("#t") String className, @Advice.Origin("#m") String methodName) {
Span exitSpan = TrackManager.getExitSpan();
if (null == exitSpan) return;
System.out.println("鏈路追蹤(MQ)：" + exitSpan.getLinkId() + " " + className + "." + methodName + " 耗時(shí)：" + (System.currentTimeMillis() - exitSpan.getEnterTime().getTime()) + "ms");
}
}
LinkPlugin.java
/**
* 公眾號(hào)：bugstack蟲(chóng)洞棧 ｛獲取學(xué)習(xí)源碼｝
* create by fuzhengwei on 2019
*/
public class LinkPlugin implements IPlugin {
@Override
public String name() {
return "link";
}
@Override
public InterceptPoint[] buildInterceptPoint() {
return new InterceptPoint[]{
new InterceptPoint() {
@Override
public ElementMatcher<TypeDescription> buildTypesMatcher() {
return ElementMatchers.nameStartsWith("org.itstack.demo.test");
}
@Override
public ElementMatcher<MethodDescription> buildMethodsMatcher() {
return ElementMatchers.isMethod()
.and(ElementMatchers.any())
.and(ElementMatchers.not(ElementMatchers.nameStartsWith("main")));
}
}
};
}
@Override
public Class adviceClass() {
return LinkAdvice.class;
}
}
InterceptPoint.java
/**
* 攔截點(diǎn)
* 公眾號(hào)：bugstack蟲(chóng)洞棧 ｛獲取學(xué)習(xí)源碼｝
* create by fuzhengwei on 2019
*/
public interface InterceptPoint {
//類(lèi)匹配規(guī)則
ElementMatcher<TypeDescription> buildTypesMatcher();
//方法匹配規(guī)則
ElementMatcher<MethodDescription> buildMethodsMatcher();
}
IPlugin.java
/**
* 監(jiān)控組件
* 公眾號(hào)：bugstack蟲(chóng)洞棧 ｛獲取學(xué)習(xí)源碼｝
* create by fuzhengwei on 2019
*/
public interface IPlugin {
//名稱(chēng)
String name();
//監(jiān)控點(diǎn)
InterceptPoint[] buildInterceptPoint();
//攔截器類(lèi)
Class adviceClass();
}
PluginFactory.java
/**
* 公眾號(hào)：bugstack蟲(chóng)洞棧 ｛獲取學(xué)習(xí)源碼｝
* create by fuzhengwei on 2019
*/
public class PluginFactory {
public static List<IPlugin> pluginGroup = new ArrayList<>();
static {
//鏈路監(jiān)控
pluginGroup.add(new LinkPlugin());
//Jvm監(jiān)控
pluginGroup.add(new JvmPlugin());
}
}
TrackManager.java
/**
* 追蹤管控
* 公眾號(hào)：bugstack蟲(chóng)洞棧 ｛獲取學(xué)習(xí)源碼｝
* create by fuzhengwei on 2019
*/
public class TrackManager {
private static final ThreadLocal<Stack<Span>> track = new ThreadLocal<>();
private static Span createSpan() {
Stack<Span> stack = track.get();
if (stack == null) {
stack = new Stack<>();
track.set(stack);
}
String linkId;
if (stack.isEmpty()) {
linkId = TrackContext.getLinkId();
if (linkId == null) {
linkId = "nvl";
TrackContext.setLinkId(linkId);
}
} else {
Span span = stack.peek();
linkId = span.getLinkId();
TrackContext.setLinkId(linkId);
}
return new Span(linkId);
}
public static Span createEntrySpan() {
Span span = createSpan();
Stack<Span> stack = track.get();
stack.push(span);
return span;
}
public static Span getExitSpan() {
Stack<Span> stack = track.get();
if (stack == null || stack.isEmpty()) {
TrackContext.clear();
return null;
}
return stack.pop();
}
public static Span getCurrentSpan() {
Stack<Span> stack = track.get();
if (stack == null || stack.isEmpty()) {
return null;
}
return stack.peek();
}
}
MyAgent.java
/**
* 公眾號(hào)：bugstack蟲(chóng)洞棧 ｛獲取學(xué)習(xí)源碼｝
* create by fuzhengwei on 2019
*/
public class MyAgent {
//JVM 首先嘗試在代理類(lèi)上調(diào)用以下方法
public static void premain(String agentArgs, Instrumentation inst) {
System.out.println("基于javaagent鏈路追蹤｛源碼微信公眾號(hào)：bugstack蟲(chóng)洞棧｝");
System.out.println("==========================================================\r\n");
AgentBuilder agentBuilder = new AgentBuilder.Default();
List<IPlugin> pluginGroup = PluginFactory.pluginGroup;
for (IPlugin plugin : pluginGroup) {
InterceptPoint[] interceptPoints = plugin.buildInterceptPoint();
for (InterceptPoint point : interceptPoints) {
AgentBuilder.Transformer transformer = (builder, typeDescription, classLoader, javaModule) -> {
builder = builder.visit(Advice.to(plugin.adviceClass()).on(point.buildMethodsMatcher()));
return builder;
};
agentBuilder = agentBuilder.type(point.buildTypesMatcher()).transform(transformer).asDecorator();
}
}
//監(jiān)聽(tīng)
AgentBuilder.Listener listener = new AgentBuilder.Listener() {
@Override
public void onDiscovery(String s, ClassLoader classLoader, JavaModule javaModule, boolean b) {
}
@Override
public void onTransformation(TypeDescription typeDescription, ClassLoader classLoader, JavaModule javaModule, boolean b, DynamicType dynamicType) {
System.out.println("onTransformation：" + typeDescription);
}
@Override
public void onIgnored(TypeDescription typeDescription, ClassLoader classLoader, JavaModule javaModule, boolean b) {
}
@Override
public void onError(String s, ClassLoader classLoader, JavaModule javaModule, boolean b, Throwable throwable) {
}
@Override
public void onComplete(String s, ClassLoader classLoader, JavaModule javaModule, boolean b) {
}
};
agentBuilder.with(listener).installOn(inst);
}
}
MANIFEST.MF
Manifest-Version: 1.0
Premain-Class: org.itstack.demo.agent.MyAgent
Can-Redefine-Classes: true
ApiTest.java
**
* 鏈路追蹤
* VM options：
* -javaagent:E:\itstack\GIT\itstack.org\itstack-demo-agent\itstack-demo-agent-06\target\itstack-demo-agent-06-1.0.0-SNAPSHOT.jar=testargs
*
* 按需打開(kāi)需要測(cè)試的模塊
* 鏈路監(jiān)控
* pluginGroup.add(new LinkPlugin());
* Jvm監(jiān)控
* pluginGroup.add(new JvmPlugin());
*
* 博客：http://itstack.org
* 論壇：http://bugstack.cn
* 公眾號(hào)：bugstack蟲(chóng)洞棧 ｛獲取學(xué)習(xí)源碼｝
* create by fuzhengwei on 2019
*
*/
public class ApiTest {
public static void main(String[] args) {
//線程一
new Thread(() -> new ApiTest().http_lt1("哪咤")).start();
//線程二
new Thread(() -> {
new ApiTest().http_lt2("悟空");
}).start();
}
public void http_lt1(String name) {
try {
Thread.sleep((long) (Math.random() * 500));
} catch (InterruptedException e) {
e.printStackTrace();
}
System.out.println("測(cè)試結(jié)果：hi1 " + name);
http_lt2(name);
}
public void http_lt2(String name) {
try {
Thread.sleep((long) (Math.random() * 500));
} catch (InterruptedException e) {
e.printStackTrace();
}
System.out.println("測(cè)試結(jié)果：hi2 " + name);
http_lt3(name);
}
public void http_lt3(String name) {
try {
Thread.sleep((long) (Math.random() * 500));
} catch (InterruptedException e) {
e.printStackTrace();
}
System.out.println("測(cè)試結(jié)果：hi3 " + name);
}
}
測(cè)試結(jié)果
基于javaagent鏈路追蹤｛源碼微信公眾號(hào)：bugstack蟲(chóng)洞棧｝
==========================================================
onTransformation：class org.itstack.demo.test.ApiTest
測(cè)試結(jié)果：hi2 悟空
測(cè)試結(jié)果：hi1 哪咤
測(cè)試結(jié)果：hi3 悟空
鏈路追蹤(MQ)：608a1cbf-ef1f-4195-bdc7-c3729a114f8d org.itstack.demo.test.ApiTest.http_lt3 耗時(shí)：111ms
測(cè)試結(jié)果：hi2 哪咤
init: 192MB max: 2708MB used: 43MB committed: 184MB use rate: 23%
init: 2MB max: 0MB used: 13MB committed: 14MB use rate: 95%
name: PS Scavenge count:0 took:0 pool name:[PS Eden Space, PS Survivor Space]
name: PS MarkSweep count:0 took:0 pool name:[PS Eden Space, PS Survivor Space, PS Old Gen]
-------------------------------------------------------------------------------------------------
鏈路追蹤(MQ)：608a1cbf-ef1f-4195-bdc7-c3729a114f8d org.itstack.demo.test.ApiTest.http_lt2 耗時(shí)：338ms
init: 192MB max: 2708MB used: 43MB committed: 184MB use rate: 23%
init: 2MB max: 0MB used: 13MB committed: 14MB use rate: 95%
name: PS Scavenge count:0 took:0 pool name:[PS Eden Space, PS Survivor Space]
name: PS MarkSweep count:0 took:0 pool name:[PS Eden Space, PS Survivor Space, PS Old Gen]
-------------------------------------------------------------------------------------------------
測(cè)試結(jié)果：hi3 哪咤
鏈路追蹤(MQ)：2f28ed75-650a-4f0f-bd69-fe0709a8985e org.itstack.demo.test.ApiTest.http_lt3 耗時(shí)：221ms
init: 192MB max: 2708MB used: 43MB committed: 184MB use rate: 23%
init: 2MB max: 0MB used: 13MB committed: 14MB use rate: 95%
name: PS Scavenge count:0 took:0 pool name:[PS Eden Space, PS Survivor Space]
name: PS MarkSweep count:0 took:0 pool name:[PS Eden Space, PS Survivor Space, PS Old Gen]
-------------------------------------------------------------------------------------------------
鏈路追蹤(MQ)：2f28ed75-650a-4f0f-bd69-fe0709a8985e org.itstack.demo.test.ApiTest.http_lt2 耗時(shí)：316ms
init: 192MB max: 2708MB used: 43MB committed: 184MB use rate: 23%
init: 2MB max: 0MB used: 13MB committed: 14MB use rate: 95%
name: PS Scavenge count:0 took:0 pool name:[PS Eden Space, PS Survivor Space]
name: PS MarkSweep count:0 took:0 pool name:[PS Eden Space, PS Survivor Space, PS Old Gen]
-------------------------------------------------------------------------------------------------
鏈路追蹤(MQ)：2f28ed75-650a-4f0f-bd69-fe0709a8985e org.itstack.demo.test.ApiTest.http_lt1 耗時(shí)：547ms
init: 192MB max: 2708MB used: 43MB committed: 184MB use rate: 23%
init: 2MB max: 0MB used: 13MB committed: 14MB use rate: 95%
name: PS Scavenge count:0 took:0 pool name:[PS Eden Space, PS Survivor Space]
name: PS MarkSweep count:0 took:0 pool name:[PS Eden Space, PS Survivor Space, PS Old Gen]
-------------------------------------------------------------------------------------------------
Process finished with exit code 0
責(zé)任編輯：武曉燕
來(lái)源：
今日頭條
