AI 助理
备案控制台
开发者社区 开发与运维 文章 正文

pinpoint插件开发之一：牛刀小试，调整gson插件

2022-04-29 514
版权
版权声明：
本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《 阿里云开发者社区用户服务协议》和 《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写 侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
简介： pinpoint自定义插件开发起步，先拿已有插件做微调，把基本套路摸清楚

欢迎访问我的GitHub

这里分类和汇总了欣宸的全部原创(含配套源码)： https://github.com/zq2599/blog_demos

本篇概览

  • 从本章开始我们一起来实战pinpoint插件开发，做一些实用的pinpoint插件，本着先易后难的原则，我们从修改现有插件开始吧；

准备工作

  1. 本次实战的操作环境是win10专业版，安装了Docker Community Edition Version 17.09.0-ce-win33(13620)；
  2. 编译环境，请参照《Docker下，极速体验编译pinpoint1.6.x分支》，我们会用这个容器编译构建修改过的插件，为了复制文件方便，我们启动容器使用以下命令：
docker run --name=ppcompile001 -p 19003:22 -idt -v c:/share:/usr/Downloads bolingcavalry/jdk7-mvn339-pinpoint16x-compile:0.0.1
  • 参数-v c:/share:/usr/Downloads表示将当前电脑的c:/share目录和容器的/usr/Downloads目录建立映射，这样我们就能把容器里的文件复制出来了（记得先在c盘根目录下创建share目录）；
  1. pinpoint的运行环境，请参照《Docker下，极速体验pinpoint1.6.3》，启动了三个容器，一个是pinpoint的web server，还有两个是运行着web应用的tomcat，运行环境运行成功后，我们可以在pinpoint的web server上看到web应用的服务调用链，为了复制文件方便，我们将docker-compose.yml文件中的每个容器也加上目录映射参数，整个docker-compose.yml内容如下：
version: '2'
services:
  pinpoint-server: 
    image: bolingcavalry/centos67-hbase126-pinpoint163-server:0.0.1
    container_name: pinpoint-server
    ports:
      - "19001:22"
      - "28080:28080"
    volumes:
      - c:/share:/usr/Downloads
    restart: always
  tomcat001: 
    image: bolingcavalry/centos67-pinpoint163-agent:0.0.1
    container_name: tomcat001
    links: 
      - pinpoint-server:pinpointhost
    ports:
      - "8081:8080"
    environment:
      TOMCAT_SERVER_ID: tomcat001
      PINPOINT_AGENT_ID: ppagent20171105001 
      PINPOINT_APPLICATION_NAME: app20171105001
    volumes:
      - c:/share:/usr/Downloads
    restart: always 
  tomcat002: 
    image: bolingcavalry/centos67-pinpoint163-agent:0.0.1
    container_name: tomcat002
    depends_on:
      - tomcat001
    links: 
      - pinpoint-server:pinpointhost
    ports:
      - "8082:8080"
    environment:
      TOMCAT_SERVER_ID: tomcat002
      PINPOINT_AGENT_ID: ppagent20171105002 
      PINPOINT_APPLICATION_NAME: app20171105002
    volumes:
      - c:/share:/usr/Downloads
    restart: always
  • 可以看到每个容器的配置中都有volumes参数，对容器和当前电脑的目录做了映射；

pinpoint对Gson类的监控

public String tracegson(HttpServletRequest request, Model model) {
        String name = get(request, "name");
        String age = get(request, "age");

        Student student = new Student();
        student.setName(name);
        student.setAge(Integer.valueOf(age));

        Gson gson = new Gson();

        String parseStr = gson.toJson(student, Student.class);

        logger.info("gson str [{}]", parseStr);

        return String.format("gson str : %s [%s]", parseStr, tag());
    }
  • 上面的代码中用到了Gson类的toJson方法，由于pinpoint1.6.3是带有Gson插件的，所以执行此方法后在pinpoint的调用链跟踪列表中可以看到对toJson方法的调用，如下图，至于如何部署和执行这段代码，请参照《Docker下，极速体验pinpoint1.6.3》：

这里写图片描述

  • 上图底部的红框中是对Gson的toJson方法的监控，可以看到这个节点已经不能展开了，难道gson插件不输出一些参数么？是本来就没有参数？还是参数没有显示？

分析源码

切到1.6.x分支，在plugin目录下可以看见gson插件的工程，如下图红框所示：
这里写图片描述

  • 先看看实现这个插件拦截了Gson的toJson方法后做了什么，做的事情都封装在ToJsonInterceptor.java中：
@Override
    public void before(Object target) {
        if (logger.isDebugEnabled()) {
            logger.beforeInterceptor(target, null);
        }

        final Trace trace = traceContext.currentTraceObject();
        if (trace == null) {
            return;
        }

        trace.traceBlockBegin();
    }
  • 上面的代码是Gson的toJson方法执行前做的事情：开启了一次追踪，我们再来看看Gson的toJson方法执行结束后做了什么：
 @Override
    public void after(Object target, Object result, Throwable throwable) {
        if (logger.isDebugEnabled()) {
            logger.afterInterceptor(target, null, result, throwable);
        }

        final Trace trace = traceContext.currentTraceObject();
        if (trace == null) {
            return;
        }

        try {
            SpanEventRecorder recorder = trace.currentSpanEventRecorder();
            recorder.recordServiceType(GsonPlugin.GSON_SERVICE_TYPE);
            recorder.recordApi(descriptor);
            recorder.recordException(throwable);

            if (result != null && result instanceof String) {
                recorder.recordAttribute(GsonPlugin.GSON_ANNOTATION_KEY_JSON_LENGTH, ((String) result).length());
            }
        } finally {
            trace.traceBlockEnd();
        }
    }
  • 注意这一句代码：
recorder.recordAttribute(GsonPlugin.GSON_ANNOTATION_KEY_JSON_LENGTH, ((String) result).length());
  • 这表示toJson方法的返回值如果非空并且是String对象的时候，pinpoint会记录一个参数GsonPlugin.GSON_ANNOTATION_KEY_JSON_LENGTH，这个参数的值是toJson方法返回的字符串的长度；
  • 已经记录了参数，但在pinpoint页面上却没有展示出来，我们去看看这个参数的定义吧：
public static final AnnotationKey GSON_ANNOTATION_KEY_JSON_LENGTH = AnnotationKeyFactory.of(9000, "gson.json.length");
  • GSON_ANNOTATION_KEY_JSON_LENGTH 是通过AnnotationKeyFactory.of方法创建的，我们跟踪这个方法，最终进入DefaultAnnotationKey的构造方法：
DefaultAnnotationKey(int code, String name, AnnotationKeyProperty... properties) {
        this.code = code;
        this.name = name;

        boolean viewInRecordSet = false;
        boolean errorApiMetadata = false;

        for (AnnotationKeyProperty property : properties) {
            switch (property) {
            case VIEW_IN_RECORD_SET:
                viewInRecordSet = true;
                break;
            case ERROR_API_METADATA:
                errorApiMetadata = true;
                break;
            }
        }

        this.viewInRecordSet = viewInRecordSet;
        this.errorApiMetadata = errorApiMetadata;
    }
  • 上述代码表示，如果我们不传入VIEW_IN_RECORD_SET，那么viewInRecordSet就一直为false，这就是导致gson.json.length参数在pinpoint中不显示的原因，要想让gson.json.length显示出来，只要在AnnotationKeyFactory.of方法的入参中加入VIEW_IN_RECORD_SET即可，接下来我们开始动手修改吧；

在编译环境修改源码

  • 在命令行执行以下命令登录到编译环境的容器中：
docker exec -it ppcompile001 /bin/bash
  • 修改这个文件：
/usr/local/work/pinpoint-1.6.x/plugins/gson/src/main/java/com/navercorp/pinpoint/plugin/gson/GsonPlugin.java
  • 找到下面这行代码：
public static final AnnotationKey GSON_ANNOTATION_KEY_JSON_LENGTH = AnnotationKeyFactory.of(9000, "gson.json.length");
  • 改成下面这样，AnnotationKeyFactory.of方法的入参从两个变成三个了：
public static final AnnotationKey GSON_ANNOTATION_KEY_JSON_LENGTH = AnnotationKeyFactory.of(9000, "gson.json.length", com.navercorp.pinpoint.common.trace.AnnotationKeyProperty.VIEW_IN_RECORD_SET);
  • 修改完毕后保存文件，进入pinpoint工程目录/usr/local/work/pinpoint-1.6.x，执行以下命令开始编译：
mvn install -Dmaven.test.skip=true -e
  • 编译完成后进入以下目录：
/usr/local/work/pinpoint-1.6.x/plugins/gson/target
  • 可以见到最新构建的gson插件，如下图黄框所示：

这里写图片描述

  • 把这个文件复制到/usr/Downloads目录，由于pinpoint运行环境的三个容器也建立了自己的/usr/Downloads和c:/share目录的映射，所以它们也能立即访问这个文件了；

替换pinpoint server的gson插件

  • 执行命令docker exec -it pinpoint-server /bin/bash进入pinpoint server容器；
  • 执行以下命令替换原有的gson插件：
rm -f /usr/local/work/tomcat-collector/apache-tomcat-8.0.36/webapps/ROOT/WEB-INF/lib/pinpoint-gson-plugin-1.6.3-SNAPSHOT.jar

cp /usr/Downloads/pinpoint-gson-plugin-1.6.3-SNAPSHOT.jar /usr/local/work/tomcat-collector/apache-tomcat-8.0.36/webapps/ROOT/WEB-INF/lib/

rm -f /usr/local/work/tomcat-web/apache-tomcat-8.0.36/webapps/ROOT/WEB-INF/lib/pinpoint-gson-plugin-1.6.3-SNAPSHOT.jar

cp /usr/Downloads/pinpoint-gson-plugin-1.6.3-SNAPSHOT.jar /usr/local/work/tomcat-web/apache-tomcat-8.0.36/webapps/ROOT/WEB-INF/lib/
  • 以上命令将pinpoint-collector和pinpoint-web两个容器的gson插件先删除，再把我们放在c:/share目录下最新的gson插件复制过去；
  • 重启collector和web两个应用，执行以下命令：
/usr/local/work/tomcat-collector/apache-tomcat-8.0.36/bin/shutdown.sh
/usr/local/work/tomcat-web/apache-tomcat-8.0.36/bin/shutdown.sh
/usr/local/work/tomcat-collector/apache-tomcat-8.0.36/bin/startup.sh
/usr/local/work/tomcat-web/apache-tomcat-8.0.36/bin/startup.sh

替换tomcat001容器的gson插件

  • 执行命令docker exec -it tomcat001 /bin/bash进入tomcat001容器；
  • 执行以下命令替换原有的gson插件：
rm -f /usr/local/work/pinpoint-agent-1.6.3/plugin/pinpoint-gson-plugin-1.6.3-SNAPSHOT.jar
cp /usr/Downloads/pinpoint-gson-plugin-1.6.3-SNAPSHOT.jar /usr/local/work/pinpoint-agent-1.6.3/plugin/
  • 以上命令将pinpoint agent目录下的gson插件先删除，再把我们放在c:/share目录下最新的gson插件复制过去；
  • 重启，由于tomcat是随着容器一起启动的，此处如果用shutdown.sh命令停止tomcat服务会导致容器退出，所以我们直接重启tomcat001容器吧；
  • 执行exit退出容器；
  • 在当前电脑的命令行执行docker restart tomcat001重启容器；

验证新的插件

  • 验证前，请确保web应用已经按照《Docker下，极速体验pinpoint1.6.3》中的方式部署到了tomcat001和tomcat002上面；
  • 浏览器访问：http://localhost:8081/pinpointtracedemo/tracegson?name=tom&age=11，这次访问会有一次Gson的toJson方法调用；
  • 通过访问pinpoint-server，看刚刚那次请求的追踪信息，如下图：

这里写图片描述
toJson这个节点现在可以展开了，红框中就是新的节点，内容是我们修改过的gson.json.length参数，值是23；

小结

至此，我们的第一次插件开发实战就结束了，小结本次插件开发过程：

  1. 修改插件源码；
  2. 编译构建成新的包；
  3. 新包替换pingpoint server上的collector和web应用中的旧包；
  4. 重启pinpoint server上的collector和web server；
  5. 新包替换pinpoint agent上的旧包；
  6. 重启agent上的业务的web server；
  • 以上只是修改了原有插件，接下来的实战中，我们一起创建一个全新的插件，实现我们需要的功能；

欢迎关注阿里云开发者社区博客：程序员欣宸

学习路上，你不孤单，欣宸原创一路相伴...
文章标签：
Shell
容器
应用服务中间件
监控
Docker
程序员
开发者
程序员欣宸
目录
相关文章
码哥字节
|
6月前
|
SQL Java 数据库连接
欲善事先利器——IDEA 插件篇
欲善事先利器——IDEA 插件篇
码哥字节
271 0
武子康
|
1月前
|
人工智能 Java 数据库连接
IDEA开发 常用代码规范插件 常用辅助类插件
IDEA开发 常用代码规范插件 常用辅助类插件
武子康
45 0
服务端技术栈
|
3月前
|
负载均衡 数据可视化 NoSQL
强烈推荐，好用的时序图开源插件PlantUML！
PlantUML这个开源时序图插件，它通过简单的语法和自动化的图形线条关联解决了传统画图软件中对齐困难、逻辑判断不易表示等问题，并提供了美观的图形和易于修改的特点，特别适合新入职场的开发者快速上手绘制高质量的时序图。
服务端技术栈
234 4
强烈推荐，好用的时序图开源插件PlantUML！
土木林森
|
3月前
|
Java Maven 开发者
"揭秘IDEA的神奇助手：Maven Helper插件，让你轻松驾驭复杂依赖，告别冲突噩梦！"
【8月更文挑战第20天】Maven Helper是一款提升Java开发者工作效率的IDEA插件，它能直观展示项目依赖关系并协助管理。主要功能包括依赖树视图、冲突检测与解决及依赖排除。安装简便，重启IDEA后即用。借助其“Dependencies”面板，开发者可以清晰了解依赖详情，快速定位并解决冲突问题，有效优化项目结构，提升开发效率。
土木林森
230 0
码哥字节
|
6月前
|
SQL Java 数据库连接
欲善事先利器—IDEA插件篇
欲善事先利器—IDEA插件篇
码哥字节
142 0
快乐阿超
代码统计插件statistic
代码统计插件statistic
快乐阿超
70 0
阿甘兄
|
数据库连接 数据库
MyBatisPlus代码生成工具（史上操作最简单版本）
MyBatisPlus代码生成工具（史上操作最简单版本）
阿甘兄
66 0
萌萌哒草头将军
|
API 开发者
🚀两个简单的自定义插件，探究Vite的插件机制
🚀两个简单的自定义插件，探究Vite的插件机制
萌萌哒草头将军
176 0
有一只柴犬
|
存储 程序员 开发工具
IDEA插件开发.02之“异味”代码收集插件
许久没更新IDEA插件开发系列了。最近刚好在汇总日常开发中常见的代码“异味”，共享文档复制黏贴略显麻烦，所以想着是否可以搞一个IDEA插件来帮忙收集常见代码，毕竟IDEA作为后端程序员必备的开发工具，显然会方便很多。
有一只柴犬
195 1
IDEA插件开发.02之“异味”代码收集插件
愿天堂没有BUG（公众号同名）
|
Java 测试技术 API
神器 SpringDoc 横空出世！最适合 SpringBoot 的API文档工具来了
之前在SpringBoot项目中一直使用的是SpringFox提供的Swagger库，上了下官网发现已经有接近两年没出新版本了！前几天升级了SpringBoot 2.6.x 版本，发现这个库的兼容性也越来越不好了，有的常用注解属性被废弃了居然都没提供替代！无意中发现了另一款Swagger库SpringDoc，试用了一下非常不错，推荐给大家！
愿天堂没有BUG（公众号同名）
1328 0

热门文章

最新文章

  • 1
    Java 生成 UUID
  • 2
    一文读懂 Serverless 的起源、发展和落地实践
  • 3
    Fiddler抓包：下载、安装及使用
  • 4
    用CodeViz绘制函数调用关系图(call graph)
  • 5
    阿里AI上岗双11服装车间，能识别头发丝直径十分之一的瑕疵
  • 6
    SpringBoot开发案例之整合Dubbo提供者(一)
  • 7
    Dubbo架构介绍
  • 8
    警惕垃圾邮件借加沙新闻进行钓鱼攻击
  • 9
    美国博客刊文发布NetApp StoreVault停产通知
  • 10
    IntelliJ IDEA 12 创建Web项目 教程 超详细版
  • 1
    通义灵码与云计算平台的融合：基础与概述
    37
  • 2
    《深度解析：死锁的“前世今生”与防范之道》
    32
  • 3
    《探秘程序崩溃：核心转储（Core Dump）分析全攻略》
    36
  • 4
    今日 AI 开源｜共 12 项｜开源的DIY健康追踪项目，基于低成本的智能戒指构建私人的健康监测应用
    40
  • 5
    Open Interpreter：AI 赋能终端！在终端中对话AI模型进行编程，通过运行代码来完成各种计算机操作任务
    32
  • 6
    「Mac畅玩鸿蒙与硬件15」鸿蒙UI组件篇5 - Slider 和 Progress 组件
    41
  • 7
    ai断点怎么做?
    16
  • 8
    AI Shell：在命令行里“对话” AI ，微软推出将 AI 助手引入命令行的 CLI 工具，打造对话式交互命令行
    21
  • 9
    ai怎么设计迷宫字体效果?
    15
  • 10
    「Mac畅玩鸿蒙与硬件14」鸿蒙UI组件篇4 - Toggle 和 Checkbox 组件
    30

    • 相关课程

    更多
  • Cloud Toolkit 开发部署效率提升神器
  • 最新大版本解读：Grafana 10 新特性 & 新能力
  • Springboot项目云开发快速迁移
  • 线上问题排查利器 Alibaba Arthas（上）
  • 线上问题排查利器 Alibaba Arthas（下）

    • 相关电子书

    更多
  • ReactNative实战优化之路
  • 函数计算最佳实践：快速开发一个分布式 Puppeteer 网页截图服务
  • ReactNative启动性能优化

    • 相关实验场景

    更多
  • 语言入门-1：环境构建
  • 基于 IntelliJ IDEA 插件部署微服务应用
    • 下一篇
    阿里云OSS设置跨域访问