dubbo使用Apache Skywalking做分布式跟踪

Apache Skywalking简介

Apache Skywalking专门为微服务架构和云原生架构系统而设计并且支持分布式链路追踪的APM系统。Apache Skywalking(Incubator)通过加载探针的方式收集应用调用链路信息，并对采集的调用链路信息进行分析，生成应用间关系和服务间关系以及服务指标。Apache Skywalking 目前支持多种语言，其中包括Java，.Net Core，Node.js和Go语言。

目前Skywalking已经支持从6个可视化维度剖析分布式系统的运行情况。总览视图是应用和组件的全局视图，其中包括组件和应用数量，应用的告警波动，慢服务列表以及应用吞吐量；拓扑图从应用依赖关系出发，展现整个应用的拓扑关系；应用视图则是从单个应用的角度，展现应用的上下游关系，TopN的服务和服务器，JVM的相关信息以及对应的主机信息。服务视图关注单个服务入口的运行情况以及此服务的上下游依赖关系，依赖度，帮助用户针对单个服务的优化和监控；调用链展现了调用的单次请求经过的所有埋点以及每个埋点的执行时长；告警视图根据配置阈值针对应用、服务器、服务进行实时告警。

Dubbo与Apache Skywalking

编写Dubbo示例程序

API工程

服务接口：

package org.apache.skywalking.demo.interfaces;

public interface HelloService {
	String sayHello(String name);
}

Dubbo服务提供工程：

package org.apache.skywalking.demo.provider;

@Service(version = "${demo.service.version}",
	application = "${dubbo.application.id}",
	protocol = "${dubbo.protocol.id}",
	registry = "${dubbo.registry.id}", timeout = 60000)
public class HelloServiceImpl implements HelloService {

	public String sayHello(String name) {
		LockSupport.parkNanos(TimeUnit.SECONDS.toNanos(1));
		return "Hello, " + name;
	}

}

Consumer工程：

package org.apache.skywalking.demo.consumer;

@RestController
public class ConsumerController {

	private static int COUNT = 0;

	@Reference(version = "${demo.service.version}",
		application = "${dubbo.application.id}",
		url = "dubbo://localhost:20880", timeout = 60000)
	private HelloService helloService;

	@GetMapping("/sayHello/{name}")
	public String sayHello(@PathVariable(name = "name") String name) {
		if ((COUNT++) % 3 == 0){
			throw new RuntimeException();
		}
		LockSupport.parkNanos(TimeUnit.SECONDS.toNanos(2));
		return helloService.sayHello(name);
	}
}

部署Apache Skywalking

Apache Skywalking共提供两种部署模式：单节点模式和集群模式，以下为单节点模式部署步骤，集群模式部署详情参考文档。

部署步骤

1. 下载 Apache Skywalking Collector
2. 解压并启动Skywalking Collector。运行bin/startup.bat命令即可启动Skywalking Collector,这里会同时启动
   bat 为 windows 环境使用，sh 为 linux 环境使用，我们可以分别启动 oapService 和 webappService，也可以通过 startup 一次性全部启动，从 startup 中的命令可以知道其实就是分别启动 oapService 和 webappService。
   注：这里使用默认的H2作为日志存储

启动示例程序

在启动示例程序之前，执行编译打包的命令:

mvn  clean package

启动服务提供端:

java -jar -javaagent:./agent/skywalking-agent.jar -DSW_AGENT_NAME=dubbo-provider -Dskywalking.collector.servers=localhost:10800 dubbo-provider/target/dubbo-provider.jar

启动服务消费端

java -jar -javaagent:./agent/skywalking-agent.jar -DSW_AGENT_NAME=dubbo-consumer -Dskywalking.collector.servers=localhost:10800 dubbo-consumer/target/dubbo-consumer.jar 

注意：这里的skywalking-agent.jar是Skywalking压缩包中的agent目录下的如下图：

这里不要将jar包copy出去，可以将agent整个目录copy出去

使用SkyWalking手动追踪API

使用介绍

使用 maven 和 gradle 依赖相应的工具包，该工具包通过mavne有可能无法下载，可手动下载jar导入到maven

   <dependency>
      <groupId>org.apache.skywalkinggroupId>
      <artifactId>apm-toolkit-traceartifactId>
      <version>${skywalking.version}version>
   dependency>

随时使用 TraceContext.traceId() API，在应用程序的任何地方获取traceId.

@Service(interfaceClass = DemoService.class)
@Slf4j
public class DemoServiceImpl implements DemoService {
    @Override
    public String hello() {
        String traceId = TraceContext.traceId();
        log.info("获取的TraceId:{}",traceId);
        int i = 100 / 0;
        return "Hello Dubbo====>"+traceId;
    }
}

对任何需要追踪的方法，使用 @Trace 标注，则此方法会被加入到追踪链中。

在被追踪的方法中自定义 tag.

ActiveSpan.tag(“my_tag”, “my_value”);

    /**
     * 对任何需要追踪的方法，使用 @Trace 标注，则此方法会被加入到追踪链中。
     * 在被追踪的方法中自定义 tag.
     */
    @RequestMapping("/login")
    @Trace
    @Slf4j
    public String login(@RequestParam("userName") String userName, @RequestParam("passwrod") String passwrod){
        logger.info("login to system1, user: " + userName);
        //TraceContext.traceId() API，在应用程序的任何地方获取traceId.
        log.info("{}======{}========{}",userName,passwrod , TraceContext.traceId());
        ActiveSpan.tag("login_tag", "login to system, user: " + userName);
        return userService.login(userName,passwrod);
    }

增加logback日志组件集成

使用 maven 和 gradle 依赖相应的工具包

<dependency>
         <groupId>org.apache.skywalkinggroupId>
         <artifactId>apm-toolkit-logback-1.xartifactId>
         <version>{project.release.version}version>
     dependency>

在logback.xml中的pattern 配置[%tid]

    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder class="ch.qos.logback.core.encoder.LayoutWrappingEncoder">
            <layout class="org.apache.skywalking.apm.toolkit.log.logback.v1.x.TraceIdPatternLogbackLayout">
                <Pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%tid] [%thread] %-5level %logger{36} -%msg%nPattern>
            layout>
        encoder>
    appender>

当你使用-javaagent参数激活sky-walking的探针, 如果当前上下文中存在traceid，log4j2将在输出traceId。如果探针没有被激活，将输出TID: N/A.