云原生监控系列—源码级剖析SkyWalking（架构及Agent初始化）

1 整体架构

SkyWalking是一个开源的APM系统，包括云原生架构下分布式系统的监视、跟踪、诊断功能。架构图如下（图片来自SkyWalking官网）：

SkyWalking大致分为数据采集层、数据处理层、数据存储层和web应用层。

数据采集层

SkyWalking为不同的编程语言环境下的服务提供了相应的自动打点代理，比如Java Agent，只需要在启动命令上加上Agent的目录即可实现数据采集。Agent会给需要打点的方法生成一个代理，在代理中收集打点数据。SkyWalking还支持Service Mesh以及能适配Zipkin和Jaeger的数据格式（有一定限制）。

数据处理层

接收数据采集层推送的数据，并进行聚合、分析。

数据存储层

支持H2、MySQL、elasticsearch等存储系统

web应用层

对数据处理层处理好的数据进行可视化，便于用户访问。

2 Agent初始化

2.1 Agent启动类

SkyWalking会在main函数执行前，通过修改类的字节码文件来添加打点程序，所以需要在MANIFEST.MF文件中指定Premain-Class，jvm会在执行main函数前执行该类。配置如下图：

也可以在maven中指定

premain方法中有两个参数

agentArgs是添加在启动命令中的参数，比如

java -javaagent:path\apache-skywalking-apm-es7-8.1.0\apache-skywalking-apm-bin-es7\agent\skywalking-agent.jar=key=value -jar app

命令中的key=value会传给agentArgs。

instrumentation是jvm提供用于直接操作字节码文件的接口。

2.2 加载配置

配置文件在apache-skywalking-apm-es7-8.1.0\apache-skywalking-apm-bin-es7\agent\config目录下。

2.3 加载插件

SkyWalking为不同的组件提供了对应的插件，简单理解就是拦截器，通过这些拦截器来实现数据采集。插件在agent\plugins目录下，optional-plugins和optional-reporter-plugins目录下的插件是可选插件，如果需要直接复制的plugins下即可。

插件的路径配置在skywalking-plugin.def文件里，如下图：

public List<AbstractClassEnhancePluginDefine> loadPlugins() throws AgentPackageNotFoundException {
        //初始化类加载器
        AgentClassLoader.initDefaultLoader();

        PluginResourcesResolver resolver = new PluginResourcesResolver();
        //获取所有插件的路径
        List<URL> resources = resolver.getResources();

        if (resources == null || resources.size() == 0) {
            LOGGER.info("no plugin files (skywalking-plugin.def) found, continue to start application.");
            return new ArrayList<AbstractClassEnhancePluginDefine>();
        }

        //遍历路径加载插件定义
        for (URL pluginUrl : resources) {
            try {
                PluginCfg.INSTANCE.load(pluginUrl.openStream());
            } catch (Throwable t) {
                LOGGER.error(t, "plugin file [{}] init failure.", pluginUrl);
            }
        }

        List<PluginDefine> pluginClassList = PluginCfg.INSTANCE.getPluginClassList();

        List<AbstractClassEnhancePluginDefine> plugins = new ArrayList<AbstractClassEnhancePluginDefine>();
        //遍历插件定义，通过AgentClassLoader创建插件实例
        for (PluginDefine pluginDefine : pluginClassList) {
            try {
                LOGGER.debug("loading plugin class {}.", pluginDefine.getDefineClass());
                AbstractClassEnhancePluginDefine plugin = (AbstractClassEnhancePluginDefine) Class.forName(pluginDefine.getDefineClass(), true, AgentClassLoader
                    .getDefault()).newInstance();
                plugins.add(plugin);
            } catch (Throwable t) {
                LOGGER.error(t, "load plugin [{}] failure.", pluginDefine.getDefineClass());
            }
        }

        plugins.addAll(DynamicPluginLoader.INSTANCE.load(AgentClassLoader.getDefault()));

        return plugins;

    }

public PluginFinder(List<AbstractClassEnhancePluginDefine> plugins) {
        for (AbstractClassEnhancePluginDefine plugin : plugins) {
            ClassMatch match = plugin.enhanceClass();

            if (match == null) {
                continue;
            }

            //匹配指定类名的插件
            if (match instanceof NameMatch) {
                NameMatch nameMatch = (NameMatch) match;
                LinkedList<AbstractClassEnhancePluginDefine> pluginDefines = nameMatchDefine.get(nameMatch.getClassName());
                if (pluginDefines == null) {
                    pluginDefines = new LinkedList<AbstractClassEnhancePluginDefine>();
                    nameMatchDefine.put(nameMatch.getClassName(), pluginDefines);
                }
                pluginDefines.add(plugin);
            }
            //匹配签名的插件，比如有些组件提供了回调接口需要业务系统去实现这个接口，如果想要代理实现这个接口的类就需要通过接口签名的方式
            else {
                signatureMatchDefine.add(plugin);
            }

            //匹配Bootstrap类的插件，比如java.util.concurrent.Callable
            if (plugin.isBootstrapInstrumentation()) {
                bootstrapClassMatchDefine.add(plugin);
            }
        }
    }

匹配指定类名举例

匹配签名举例

匹配Bootstrap类举例

2.4 添加transform

transform通过操作字节码将目标类转换成SkyWalking提供的代理类。

private static class Transformer implements AgentBuilder.Transformer {
        private PluginFinder pluginFinder;

        Transformer(PluginFinder pluginFinder) {
            this.pluginFinder = pluginFinder;
        }

        @Override
        public DynamicType.Builder<?> transform(final DynamicType.Builder<?> builder,
                                                final TypeDescription typeDescription,
                                                final ClassLoader classLoader,
                                                final JavaModule module) {
            //根据目标类获取对应的插件
            List<AbstractClassEnhancePluginDefine> pluginDefines = pluginFinder.find(typeDescription);
            if (pluginDefines.size() > 0) {
                DynamicType.Builder<?> newBuilder = builder;
                EnhanceContext context = new EnhanceContext();
                for (AbstractClassEnhancePluginDefine define : pluginDefines) {
                    //定义增强目标类，这里只是定义，不会为目标类创建增强后的实例
                    DynamicType.Builder<?> possibleNewBuilder = define.define(
                            typeDescription, newBuilder, classLoader, context);
                    if (possibleNewBuilder != null) {
                        newBuilder = possibleNewBuilder;
                    }
                }
                if (context.isEnhanced()) {
                    LOGGER.debug("Finish the prepare stage for {}.", typeDescription.getName());
                }

                return newBuilder;
            }

            LOGGER.debug("Matched class {}, but ignore by finding mechanism.", typeDescription.getTypeName());
            return builder;
        }
    }

比如下图给方法增加InstMethodsInter拦截器，在调用目标方法前会先进入到InstMethodsInter的intercept方法。

2.5 指定RedefinitionStrategy

premain是在main方法之前执行，也就是说业务系统里的类都还没有加载到虚拟机里，agent是直接修改的字节码文件，在后续加载类的时候加载的是修改后的字节码文件。如果在类已经加载到jvm后再想修改类，此时就需要指定RedefinitionStrategy。总共有三种策略：

• DISABLED：不转换；
• REDEFINITION：直接替换类的定义，而不是修改类的字节码文件。但是这种方式有一定的限制，只能改变方法体，常量池和属性， 不能添加，删除及重命名字段和方法，不能更改方法的签名和继承；
• RETRANSFORMATION：重新转换类的文件字节码。
  SkyWalking用的是RETRANSFORMATION策略。