APM【agent】设计文档

Dear 丶 2022-04-23 15:58 177阅读 0赞

## 背景 ##

当业务跨线程执行时，也需要传递 trace 信息到其他线程，才能将整个调用链串联起来。

## 设计思路 ##

基本的思路是，在父线程里读取出 trace 信息，将其作为参数传递给子线程，子线程在执行之前加载 trace 信息，执行完毕后清理 trace 信息并恢复为执行之前的状态。

### ThreadPool ###

我们实现了 Runnable 接口的包装类 TraceRunnable，调用其 get 方法即可完成对 Runnable 的包装，其原理可以看下面的代码：

代码块

Java
    public class TraceRunnable implements Runnable {
        // trace 信息
        private final Object span;
        private final Runnable runnable;
    
        public TraceRunnable(Runnable runnable) {
            this.span = Context.getServerContext();
            this.runnable = runnable;
        }
    
        @Override
        public void run() {
            Object backup = TraceContextHandler.backupAndSet(span);
            try {
                runnable.run();
            } finally {
                TraceContextHandler.restoreBackup(backup);
            }
    
        }
    
        /**
         * 创建trace封装的Runnable对象
         * @param runnable 需要被封装的Runnable
         * @return 封装后的TraceRunnable
         */
        public static TraceRunnable get(Runnable runnable) {
            if (runnable == null) {
                return null;
            }
            if (runnable instanceof TraceRunnable) {
                return (TraceRunnable) runnable;
            }
            return new TraceRunnable(runnable);
        }
    }

为了减少业务开发人员的工作量，使用 javaagent & instrument 技术，修改了 ThreadPoolExecutor 和 ScheduledThreadPoolExecutor 类的字节码。也就是说，只要在 JVM 参数里加上了 javaagent 的配置，不需要使用上面的 TraceRunnable 包装类，即可实现 trace 信息的自动传递。

### ForkJoinPool ###

在 Java7 里，引入了一种新的 Fork/Join 并行计算框架，和 ThreadPoolExecutor 一样，要想 trace 信息正常传递，也需要做一些特殊处理。

这里我们也提供了功能和 RecursiveTask 一样的类 TraceRecursiveTask，以及功能和 RecursiveAction 一致的 TraceRecursiveAction 类。注意：TraceRunnable 是一个包装类，而 TraceRecursiveTask 和 TraceRecursiveAction 并非包装类，是用来替代 RecursiveTask、RecursiveAction 的类。

其原理都是类似的，即在执行计算之前加载 trace 信息，完成计算后恢复现场。

代码块

Java
        protected final boolean exec() {
            Object backup = TraceContextHandler.backupAndSet(span);
            try {
                compute();
                return true;
            } finally {
                TraceContextHandler.restoreBackup(backup);
            }
        }

同样地，我们也利用字节码技术修改了 ForkJoinTask 类，实现不改代码即可传递 trace 的目的。

### Java8 Stream ###

由于并行 stream 的底层实现也是 ForkJoinPool，所以使用 javaagent 的方式来修改 ForkJoinTask，也就实现了并行 stream 里 trace 信息的传递。