# dubbo-zipkin

**Repository Path**: lan9liang/dubbo-zipkin

## Basic Information

- **Project Name**: dubbo-zipkin
- **Description**: Dubbo全链路追踪解决方案之Zipkin整合
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 2
- **Created**: 2021-01-26
- **Last Updated**: 2025-06-06

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

## Dubbo全链路追踪解决方案之Zipkin整合

_该案例是基于dubbo2.6.4+spring4完成的案例，理论支持dubbo2.7.0以下版本，2.7版本以上需要自己手写TracingFilter，并编写resource/META-INF/dubbo/org.apache.dubbo.rpc.Filter配置文件_
```properties
tracing=brave.dubbo.rpc.TracingFilter  #brave.dubbo.rpc为包路径
```

### 案例介绍
#### 安装ZipkinServer
```shell
$ curl -sSL https://zipkin.io/quickstart.sh | bash -s
```
#### 启动服务
zipkin支持mysql、H2、elasticsearch等作为存储
```shell
java -jar zipkin.jar # 直接运行
java -jar zipkin.jar --STORAGE_TYPE=elasticsearch --ES_HOSTS=http://localhost:9200 --ES_INDEX=zipkin # 指定数据存储
```
使用es存储时需要有es的运行环境


### 快速开始

#### 工程依赖
工程父pom中锁定依赖版本
```xml
<properties>
    <brave.version>5.4.2</brave.version>
    <zipkin-reporter.version>2.7.9</zipkin-reporter.version>
</properties>
<dependencyManagement>
    <dependencies>
        <!-- 引入 zipkin brave 的 BOM 文件 -->
        <dependency>
            <groupId>io.zipkin.brave</groupId>
            <artifactId>brave-bom</artifactId>
            <version>${brave.version}</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
        
        <!-- 引入 zipkin repoter 的 BOM 文件 -->
        <dependency>
            <groupId>io.zipkin.reporter2</groupId>
            <artifactId>zipkin-reporter-bom</artifactId>
            <version>${zipkin-reporter.version}</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
    </dependencies>
</dependencyManagement>

```
整合zipkin依赖项(公共模块)
```xml
<dependencies>
    <!-- 1. brave 对 dubbo 的集成 -->
    <dependency>
        <groupId>io.zipkin.brave</groupId>
        <artifactId>brave-instrumentation-dubbo-rpc</artifactId>
    </dependency>

    <!-- 2. brave 的 spring bean 支持 -->
    <dependency>
        <groupId>io.zipkin.brave</groupId>
        <artifactId>brave-spring-beans</artifactId>
    </dependency>

    <!-- 3. 在 SLF4J 的 MDC (Mapped Diagnostic Context) 中支持 traceId 和 spanId -->
    <dependency>
        <groupId>io.zipkin.brave</groupId>
        <artifactId>brave-context-slf4j</artifactId>
    </dependency>

    <!-- 4. 使用 okhttp3 作为 reporter -->
    <dependency>
        <groupId>io.zipkin.reporter2</groupId>
        <artifactId>zipkin-sender-okhttp3</artifactId>
    </dependency>
</dependencies>
```

dubbo依赖项
```xml
<dependencies>
    <!-- 1. Zookeeper 客户端依赖 -->
    <dependency>
        <groupId>org.apache.curator</groupId>
        <artifactId>curator-framework</artifactId>
        <version>2.12.0</version>
        <exclusions>
            <exclusion>
                <groupId>io.netty</groupId>
                <artifactId>netty</artifactId>
            </exclusion>
        </exclusions>
    </dependency>
    <!-- 2. Dubbo 依赖 -->
    <dependency>
        <groupId>com.alibaba</groupId>
        <artifactId>dubbo</artifactId>
        <version>2.6.2</version>
    </dependency>
</dependencies>
```

#### 服务代码

定义服务接口
```java
public interface ServiceApi {
    String getMessage();
}
```

服务提供方实现
```java
public class GetingService implements ServiceApi {
    public String getMessage() {
        return "hello dubbo...";
    }
}
```

服务提供方启动
```java
public class ProviderMain {

    public static void main(String[] args) throws IOException {
        ClassPathXmlApplicationContext context = new ClassPathXmlApplicationContext("classpath:application.xml");
        context.start();
        System.out.println("provider-service服务已启动...");
        System.in.read();
    }
}
```

#### 服务配置
服务提供方
```xml
<!-- 服务名 -->
<dubbo:application name="provider-service"/>
<!-- 注册中心 -->
<dubbo:registry address="127.0.0.1" protocol="zookeeper" check="false" port="2181"/>
<!-- 服务暴露协议及端口 -->
<dubbo:protocol name="dubbo" port="20880"/>
<!-- 指定暴露服务及拦截方式 -->
<dubbo:service interface="com.czhi.common.api.ServiceApi" ref="getingService" filter="tracing"/>
<!-- 服务实例 -->
<bean class="com.czhi.provider.service.GetingService" id="getingService"/>



<!-- 配置以http方式发送结果给zipkin服务端 -->
<bean id="sender" class="zipkin2.reporter.beans.OkHttpSenderFactoryBean">
    <property name="endpoint" value="http://10.10.10.221:9411/api/v2/spans"/>
</bean>
<!-- 发送的一些配置 -->
<bean id="tracing" class="brave.spring.beans.TracingFactoryBean">
    <property name="localServiceName" value="provider-service"/>
    <property name="spanReporter">
        <bean class="zipkin2.reporter.beans.AsyncReporterFactoryBean">
            <property name="sender" ref="sender"/>
            <!-- wait up to half a second for any in-flight spans on close -->
            <property name="closeTimeout" value="500"/>
        </bean>
    </property>
    <property name="currentTraceContext">
        <bean class="brave.spring.beans.CurrentTraceContextFactoryBean">
            <property name="scopeDecorators">
                <bean class="brave.context.slf4j.MDCScopeDecorator" factory-method="create"/>
            </property>
        </bean>
    </property>
</bean>
```

服务消费方
```xml
<dubbo:application name="consumer-service"/>
<dubbo:registry address="127.0.0.1" protocol="zookeeper" port="2181"/>
<dubbo:reference id="getingService" interface="com.czhi.common.api.ServiceApi" check="false" filter="tracing"/>


<!-- zipkin配置 -->
<bean id="sender" class="zipkin2.reporter.beans.OkHttpSenderFactoryBean">
    <property name="endpoint" value="http://10.10.10.221:9411/api/v2/spans"/>
</bean>

<bean id="tracing" class="brave.spring.beans.TracingFactoryBean">
    <property name="localServiceName" value="consumer-service"/>
    <property name="spanReporter">
        <bean class="zipkin2.reporter.beans.AsyncReporterFactoryBean">
            <property name="sender" ref="sender"/>
            <!-- wait up to half a second for any in-flight spans on close -->
            <property name="closeTimeout" value="500"/>
        </bean>
    </property>
    <property name="currentTraceContext">
        <bean class="brave.spring.beans.CurrentTraceContextFactoryBean">
            <property name="scopeDecorators">
                <bean class="brave.context.slf4j.MDCScopeDecorator" factory-method="create"/>
            </property>
        </bean>
    </property>
</bean>
```



## SpringBoot+Dubbo项目整合