Zipkin Go 项目使用教程

1. 项目的目录结构及介绍

Zipkin Go 项目的目录结构如下：

zipkin-go/
├── README.md
├── go.mod
├── go.sum
├── model/
├── propagation/
│   └── b3/
├── middleware/
│   ├── grpc/
│   └── http/
├── reporter/
│   ├── kafka/
│   ├── log/
│   └── recorder/
├── tracer/
└── ...

主要目录介绍：

• model/: 包含与 Zipkin V2 API 兼容的 Go 数据模型，支持自动 sanitize、解析和序列化。
• propagation/: 包含 SpanContext 传播逻辑，支持 Zipkin B3 Propagation 用于 HTTP 和 GRPC。
• middleware/: 包含官方支持的中间件处理程序和跟踪包装器，如 HTTP 和 GRPC 中间件。
• reporter/: 包含不同类型的报告器，如 Kafka、日志和记录器。
• tracer/: 包含主要的跟踪实现。

2. 项目的启动文件介绍

Zipkin Go 项目没有明确的“启动文件”，因为它是一个库，需要集成到你的 Go 应用程序中。通常，你需要在你的应用程序中初始化一个 Tracer 实例，并使用它来创建和记录 Span。

以下是一个简单的示例：

package main

import (
    "log"
    "net/http"
    "github.com/openzipkin/zipkin-go"
    "github.com/openzipkin/zipkin-go/reporter/log"
)

func main() {
    reporter := log.NewReporter()
    endpoint, _ := zipkin.NewEndpoint("my-service", "localhost:0")
    tracer, _ := zipkin.NewTracer(reporter, zipkin.WithLocalEndpoint(endpoint))

    http.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
        span := tracer.StartSpan("my-span")
        defer span.Finish()

        // 你的业务逻辑
    })

    log.Fatal(http.ListenAndServe(":8080", nil))
}

3. 项目的配置文件介绍

Zipkin Go 项目没有传统的配置文件，配置主要通过代码中的选项进行。以下是一些常见的配置选项：

初始化 Tracer

endpoint, _ := zipkin.NewEndpoint("my-service", "localhost:0")
tracer, _ := zipkin.NewTracer(
    reporter,
    zipkin.WithLocalEndpoint(endpoint),
    zipkin.WithSampler(zipkin.AlwaysSample),
)

配置报告器

reporter := log.NewReporter()
// 或者使用 Kafka 报告器
// reporter := kafka.NewReporter("localhost:9092")

配置中间件

http.Handle("/", zipkinhttp.NewHandler(
    http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
        // 你的业务逻辑
    }),
    "my-http-handler",
))

通过这些配置选项，你可以灵活地配置 Zipkin Go 以适应你的应用程序需求。