Btrace 是一个安全，可以动态跟踪 java 程序的一种工具。
他的操作不会对原有 java 进程产生影响，不用关闭正在运行的 java 进程，也不会修改 java 进程中的逻辑和数据。
BTrace通过动态（字节码）检测类运行Java程序。BTrace插入跟踪行动运行Java程序的类和hotswaps跟踪程序类。
因此，也就成为我们线上跟踪生产代码的有力工具!
二.如何使用BTRACE
三.实例通过注解来完成跟踪类型的支持
l 方法调用
l 方法返回
l 捕捉方法异常
l 行号
l 字段get/set
l 方法调用/返回（在指定的方法中）
l 异常抛出前后
l 同步进入/退出
l 定时器
BTrace脚本
为了保证trace语句只读, BTrace对trace脚本有一些限制(比如不能改变被trace代码中的状态)，跟踪类中必须要有一个静态方法，主要是通过调用BTraceUtils类来完成一些动作，并且这些动作是安全的，是BTrace规定的一个子集，详见如下描述：
l BTrace禁止new类、数组,、抛异常、捕获异常
l 禁止调用除com.sun.btrace.BTraceUtil类的其他实例方法以及静态方法
l BTrace1.2前不能有实例字段和方法，只能有无返回值的静态方法，所有字段也都必须是静态的。
l 禁止定义外部、内部、匿名, 本地类
l 禁止有同步块和同步方法
l 禁止有循环(for, while, do..while)
l 禁止实现接口, 不能扩展类，直接超类必须是java.lang.Object
l 禁止使用assert语句, 不能使用class字面值
l 禁止使用class字节码
方法上的注解
l @ OnMethod 用来指定trace的目标类和方法以及具体位置, 被注解的方法在匹配的方法执行到指定的位置会被调用。"clazz"属性用来指定目标类名, 可以指定全限定类名, 比如"java.awt.Component", 也可以是正则表达式(表达式必须写在"//"中, 比如"/java\\.awt\\..+/")。"method"属性用来指定被trace的方法. 表达式可以参考自带的例子(NewComponent.java 和 Classload.java, 关于方法的注解可以参考MultiClass.java). 有时候被trace的类和方法可能也使用了注解. 用法参考自带例子WebServiceTracker.java. 针对注解也是可以使用正则表达式, 比如像这个"@/com\\.acme\\..+/ "，也可以通过指定超类来匹配多个类, 比如"+java.lang.Runnable"可以匹配所有实现了java.lang.Runnable接口的类. 具体参考自带例子SubtypeTracer.java。
l @OnTimer定时触发Trace，时间可以指定，单位为毫秒，具体参考自带例子 Histogram.java。
l @OnError 当trace代码抛异常或者错误时，该注解的方法会被执行. 如果同一个trace脚本中其他方法抛异常, 该注解方法也会被执行。
l @OnExit 当trace方法调用内置exit(int)方法(用来结束整个trace程序)时, 该注解的方法会被执行. 参考自带例子ProbeExit.java。
l @OnEvent 用来截获"外部"btrace client触发的事件, 比如按Ctrl-C 中断btrace执行时，并且选择2，或者输入事件名称，将执行使用了该注解的方法, 该注解的value值为具体事件名称。具体参考例子HistoOnEvent.java
l @OnLowMemory 当内存超过某个设定值将触发该注解的方法, 具体参考MemAlerter.java
l @OnProbe 使用外部文件XML来定义trace方法以及具体的位置，具体参考示例SocketTracker1.java和java.net.socket.xml。
参数上的注解
l @Self 用来指定被trace方法的this，可参考例子AWTEventTracer.java 和 AllCalls1.java
l @Return 用来指定被trace方法的返回值，可参考例子Classload.java
l @ProbeClassName (since 1.1) 用来指定被trace的类名, 可参考例子AllMethods.java
l @ProbeMethodName (since 1.1) 用来指定被trace的方法名, 可参考例子WebServiceTracker.java。
l @TargetInstance (since 1.1) 用来指定被trace方法内部被调用到的实例, 可参考例子AllCalls2.java
l @TargetMethodOrField (since 1.1) 用来指定被trace方法内部被调用的方法名, 可参考例子AllCalls1.java 和 AllCalls2.java。
非注解的方法参数
未使用注解的方法参数一般都是用来做方法签名匹配用的, 他们一般和被trace方法中参数出现的顺序一致. 不过他们也可以与注解方法交错使用, 如果一个参数类型声明为*AnyType[]*, 则表明它按顺序"通吃"方法所有参数. 未注解方法需要与*Location*结合使用:
l Kind.ENTRY-被trace方法参数
l Kind.RETURN- 被trace方法返回值
l Kind.THROW - 抛异常
l Kind.ARRAY_SET, Kind.ARRAY_GET - 数组索引
l Kind.CATCH - 捕获异常
l Kind.FIELD_SET - 属性值
l Kind.LINE - 行号
l Kind.NEW - 类名
l Kind.ERROR - 抛异常
属性上的注解
l @Export 该注解的静态属性主要用来与jvmstat计数器做关联. 使用该注解之后, btrace程序就可以向jvmstat客户端(可以用来统计jvm堆中的内存使用量)暴露trace程序的执行次数, 具体可参考例子ThreadCounter.java
l @Property 使用了该注解的trace脚本将作为MBean的一个属性, 一旦使用该注解, trace脚本就会创建一个MBean并向MBean服务器注册, 这样JMX客户端比如VisualVM, jconsole就可以看到这些BTrace MBean. 如果这些被注解的属性与被trace程序的属性关联, 那么就可以通过VisualVM 和jconsole来查看这些属性了. 具体可参考例子ThreadCounterBean.java 和 HistogramBean.java。
l @TLS 用来将一个脚本变量与一个ThreadLocal变量关联. 因为ThreadLocal变量是跟线程相关的, 一般用来检查在同一个线程调用中是否执行到了被trace的方法. 具体可参考例子OnThrow.java 和 WebServiceTracker.java
类上的注解
l @com.sun.btrace.annotations.DTrace 用来指定btrace脚本与内置在其脚本中的D语言脚本关联, 具体参考例子DTraceInline.java.
l @com.sun.btrace.annotations.DTraceRef 用来指定btrace脚本与另一个D语言脚本文件关联. 具体参考例子DTraceRefDemo.java.
l @com.sun.btrace.annotations.BTrace 用来指定该java类为一个btrace脚本文件.
附件中sample很多例子
package com.leo.btrace;
import com.sun.btrace.annotations.*;
import static com.sun.btrace.BTraceUtils.*;
@BTrace
public class TracingScript {
@TLS
private static long startTime = 0;
@OnMethod(
clazz = "com.dfire.soa.provider.order.service.impl.GetOrderService",
method = "fromOrder2TotalPayInfo"
)
public static void startMethod() {
startTime = timeMillis();
}
@OnMethod(
clazz="com.dfire.soa.provider.order.service.impl.GetOrderService",
method="fromOrder2TotalPayInfo",
location=@Location(Kind.RETURN)
)
public static void traceExecute(){
println(strcat("time:", str(timeMillis() - startTime)));
println("===========================================");
}
}
当有调用com.dfire.soa.provider.order.service.impl.GetOrderService的fromOrder2TotalPayInfo时，就会打印时间了。
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
