skywalking从入门到精通(四)-自定义链路追踪

一、前言

在上述的示例中，我们都是通过 SkyWalking 提供的插件，实现对指定框架的链路追踪。那么，如果我们希望对项目中的业务方法，实现链路追踪，方便我们排查问题，需要怎么做呢？SkyWalking 提供了两种方式：

方式一，通过 SkyWalking @Trace 注解，可见《Application-toolkit-trace.md》文档。
方式二，通过 SkyWalking XML 配置，可见《Customize-enhance-trace.md》文档。

项目源代码地址: https://gitee.com/T-OPEN/skywalking-demo/tree/dev/
注意切换到dev分支进行调试。

二、自定义链路追踪

2.1 引入依赖jar

在需要进行自定义链路追踪的项目pom文件引入如下依赖，为了更好的兼容性，所以我们引入的apm-toolkit-trace 和我们前面java-agent都是使用 8.9.0版本：

   <dependency>
       <groupId>org.apache.skywalking</groupId>
       <artifactId>apm-toolkit-trace</artifactId>
       <version>8.9.0</version>
   </dependency>

2.2 代码中自定义链路追踪

实现自定义的链路追踪，我们有两种方式，第一种是方式上添加注解，第二种是代码中植入追踪代码

方法一：注解法

这种方案我认为比较适合方法体逻辑不复杂，我们只需要记录方法的出参，入参。需要注意的是 @Trace注解一定不能少，如果需要打印返回结果，一定要重写返回结果的toString方法，否者只会打印出来一个内存地址。

    @Trace
    @Tag(key = "orderId", value = "arg[0]") //固定写法必须写成 arg[0]
    @Tag(key = "userId", value = "arg[1]")
    @Tag(key = "result.orderId", value = "returnedObj.orderId") //固定写法 必须写成returnedObj.XXXX
    @Tag(key = "result.goods.goodsName", value = "returnedObj.goods.goodsName")
    public OrderEntity getOrderWithTagAnnotated(long orderId,long userId){
    
    
        OrderEntity orderEntity = new OrderEntity();
        orderEntity.setOrderId(orderId);
        orderEntity.setUserId(userId);
        orderEntity.setGoods(goodServiceFegin.getGoodsByGoodsId(6666L));
        return orderEntity;
    }

我们依次启动 ratel-skywalking-gateway，ratel-skywalking-order，ratel-skywalking-goods服务。然后访问：
http://localhost:9010/ratel-order/order/getOrderByOrderIdWithTagAnnotated?orderId=10001&userId=55555
回到skywalking-ui 的追踪模块，就可以看到我们刚才请求。
在这里插入图片描述
点击右边红框里的2个节点，就能看到我们自定义的链路追踪参数了。

方法二：编码的方式

这种方式适合方法逻辑比较多，在多个地方都需要记录一些参数或者关键信息，info，debug或者堆栈日志等。

    @GetMapping("/getOrderWithTagInContext")
    public OrderEntity getOrderWithTagInContext(){
    
    

        ActiveSpan.tag("my_tag", "my_value");
        ActiveSpan.error();
        ActiveSpan.error("Test-Error-Reason");

        ActiveSpan.error(new RuntimeException("Test-Error-Throwable"));
        ActiveSpan.info("Test-Info-Msg");
        ActiveSpan.debug("Test-debug-Msg");

        OrderEntity orderEntity = new OrderEntity();
        orderEntity.setOrderId(20230001);
        orderEntity.setUserId(100001);
        orderEntity.setGoods(goodServiceFegin.getGoods());
        return orderEntity;
    }

我们依次启动 ratel-skywalking-gateway，ratel-skywalking-order，ratel-skywalking-goods服务。然后访问：
http://localhost:9010/ratel-order/order/getOrderWithTagInContext
回到skywalking-ui 的追踪模块，就可以看到我们刚才请求。

在这里插入图片描述
可以看到我们这个有一条红色的日志，这是应为我们在代码里加入：

ActiveSpan.error();
ActiveSpan.error("Test-Error-Reason");
ActiveSpan.error(new RuntimeException("Test-Error-Throwable"));

可以看到我自定义的 error debug info 日志都被收集了上来。
在这里插入图片描述

在这里插入图片描述

三、OpenTracing 示例

在 opentracing-java 项目中，定义了 OpenTracing Java API。而 SkyWalking apm-toolkit-opentracing 项目，提供了对该 OpenTracing Java API 的实现。因此，我们可以使用它，实现比本文章「二、自定义追踪」小节，更加灵活的自定义追踪，同时可以做到和 SkyWalking 特性无关，毕竟咱使用的是 OpenTracing Java API。

下面，我们来搭建一个 OpenTracing Java API 的使用示例。

3.1 在pom文件中引入相关依赖:

        <dependency>
            <groupId>org.apache.skywalking</groupId>
            <artifactId>apm-toolkit-opentracing</artifactId>
            <version>8.9.0</version>
        </dependency>

3.2 在代码中增加自定义的链路追踪代码：

在最后一定要进行finish，否则也收集不到信息。

    @GetMapping("/getOrderWithOpentracing")
    public OrderEntity getOrderWithOpentracing(){
    
    
        Tracer tracer = new SkywalkingTracer();
        Tracer.SpanBuilder spanBuilder = tracer.buildSpan("/order-service/method-getOrderWithOpentracing");
        Span span = spanBuilder.withTag("tag1", false).withTag("tag2", "这是tag2").startManual();
        OrderEntity orderEntity = new OrderEntity();
        orderEntity.setOrderId(20230001);
        orderEntity.setUserId(100001);
        orderEntity.setGoods(goodServiceFegin.getGoods());
        span.finish();
        return orderEntity;
    }

我们依次启动 ratel-skywalking-gateway，ratel-skywalking-order，ratel-skywalking-goods服务。然后访问：
http://localhost:9010/ratel-order/order/getOrderWithOpentracing
回到skywalking-ui 的追踪模块，就可以看到我们刚才请求。
在这里插入图片描述