OpenCensus 笔记

OpenCensus

OpenCensus 项目是 Google 开源的一个用来收集和追踪应用指标的第三方库。
OpenCensus 能够提供了一套统一的测量工具：跨服务捕获跟踪跨度（span）、应用级别指标以及来自其他应用的元数据（例如日志）。

OpenCensus 有如下一些主要特点：
标准通信协议和一致的 API ：用于处理 metric 和 trace
多语言库，包括Java，C++，Go，.Net，Python，PHP，Node.js，Erlang 和 Ruby
与 RPC 框架的集成，可以提供开箱即用的追踪和指标 ......

这种介绍类文章有很多，不必多言，本章将以 golang 版本的配套工具为例做一个最基础的 Demo
更多参见：https://opencensus.io/introduction

Note：

以下章节假设你已阅读并掌握 opencensus-go 的 README.md 中描述的几个基本概念，主要包括 tag、stats、exporters 等，我们将直入主题，以最快速度来完成一个最简单的 Demo;

Exporters

如你所知开发 Exporters 的团队有很多，还有一些是云服务，我们摘两个能够在本地快速搭建并使用的工具来做 Demo

Zipkin (Tracing)

网址：https://zipkin.io/pages/quickstart.html
通过 http://localhost:9411/api/v2/spans 收集
通过 http://127.0.0.1:9411 展示

打开网址下载 jar 包，启动 zipkin 用来收集和展示 Trace 信息

$> java -jar zipkin-server-2.12.9-exec.jar --logging.level.zipkin2=INFO

Prometheus : graphite_exporter (Stats)

网址：https://github.com/prometheus/graphite_exporter
通过 http://localhost:9109 上传度量值
通过 http://localhost:9108/metrics 查看度量值

编译&启动 : 直接 checkout 工程，编译并执行即可启动服务

$> go build -o graphite_exporter .
$> ./graphite_exporter

Demo

启动了上面两个服务就可以直接看例子了，例子中收集了 foo / bar / baz 三个函数的调用信息，并以 Trace 和 View 方式实现了上报

package main

import (
    "context"
    "fmt"
    "go.opencensus.io/stats"
    "go.opencensus.io/stats/view"
    "go.opencensus.io/tag"
    "log"
    "net/http"
    "time"

    "contrib.go.opencensus.io/exporter/graphite"
    "contrib.go.opencensus.io/exporter/zipkin"
    openzipkin "github.com/openzipkin/zipkin-go"
    zhttp "github.com/openzipkin/zipkin-go/reporter/http"
    "go.opencensus.io/trace"
)

var (
    FooMessage = stats.Int64("foo", "测试一下 foo", stats.UnitDimensionless)
    BarMessage = stats.Int64("bar", "测试一下 bar", stats.UnitDimensionless)
    BazMessage = stats.Int64("baz", "测试一下 baz", stats.UnitDimensionless)
)

func main() {
    localEndpoint, err := openzipkin.NewEndpoint("example-server", "[myip]:5454")
    if err != nil {
        log.Println(err)
    }

    reporter := zhttp.NewReporter("http://localhost:9411/api/v2/spans")
    defer reporter.Close()

    exporterTrace := zipkin.NewExporter(reporter, localEndpoint)
    trace.RegisterExporter(exporterTrace)
    trace.ApplyConfig(trace.Config{DefaultSampler: trace.AlwaysSample()})

    exporterView, err := graphite.NewExporter(graphite.Options{Namespace: "opencensus", Port: 9109})
    if err != nil {
        log.Fatal(err)
    }
    view.RegisterExporter(exporterView)

    if err = view.Register(
        &view.View{
            Name:        "foo_view",
            Description: "foo message",
            Measure:     FooMessage,
            TagKeys:     nil,
            Aggregation: view.Count(),
        },
        &view.View{
            Name:        "bar_view",
            Description: "bar message",
            Measure:     BarMessage,
            TagKeys:     nil,
            Aggregation: view.Count(),
        },
        &view.View{
            Name:        "baz_view",
            Description: "baz message",
            Measure:     BazMessage,
            TagKeys:     nil,
            Aggregation: view.Count(),
        },
    ); err != nil {
        log.Fatalf("Cannot register the view: %v", err)
    }

    view.SetReportingPeriod(1 * time.Second)

    ctx := context.Background()
    osk, _ := tag.NewKey("liangc-macos")
    uid, _ := tag.NewKey("uid-liangc")
    ctx, err = tag.New(ctx,
        tag.Insert(osk, "macOS-10.12.5"),
        tag.Upsert(uid, "cc14514"),
    )
    if err != nil {
        log.Fatal(err)
    }

    go foo(ctx)
    fmt.Println("ok.")

    addr := ":2004"
    log.Printf("Serving at %s", addr)
    log.Fatal(http.ListenAndServe(addr, nil))
}

func foo(ctx context.Context) {

    // Name the current span "/foo"
    stats.Record(ctx, FooMessage.M(1))
    ctx, span := trace.StartSpan(ctx, "/foo")
    defer span.End()
    go func() {
        for {
            // Foo calls bar and baz
            bar(ctx)
            baz(ctx)
        }
    }()
}

func bar(ctx context.Context) {
    stats.Record(ctx, BarMessage.M(1))
    ctx, span := trace.StartSpan(ctx, "/bar")
    defer span.End()

    // Do bar
    time.Sleep(1 * time.Second)
}

func baz(ctx context.Context) {
    stats.Record(ctx, BazMessage.M(1))
    ctx, span := trace.StartSpan(ctx, "/baz")
    defer span.End()

    // Do baz
    time.Sleep(2 * time.Second)
}

展示

Zipkin 展示 Trace 信息

image.png

图中 X 轴是时间线，可以看到截取了 32s 的调用数据，函数从 foo 开始，然后 bar 和 baz 交替执行，并附带了执行时间；

graphite_exporter 展示 Stats 信息