OpenCensus 筆記

OpenCensus

OpenCensus 項(xiàng)目是 Google 開(kāi)源的一個(gè)用來(lái)收集和追蹤應(yīng)用指標(biāo)的第三方庫(kù)乙各。
OpenCensus 能夠提供了一套統(tǒng)一的測(cè)量工具：跨服務(wù)捕獲跟蹤跨度（span）、應(yīng)用級(jí)別指標(biāo)以及來(lái)自其他應(yīng)用的元數(shù)據(jù)（例如日志）馒胆。

OpenCensus 有如下一些主要特點(diǎn)：
標(biāo)準(zhǔn)通信協(xié)議和一致的 API ：用于處理 metric 和 trace
多語(yǔ)言庫(kù)滞伟，包括Java媚值，C++宴树，Go，.Net额各，Python，PHP吧恃，Node.js虾啦，Erlang 和 Ruby
與 RPC 框架的集成，可以提供開(kāi)箱即用的追蹤和指標(biāo) ......

這種介紹類(lèi)文章有很多痕寓，不必多言傲醉，本章將以 golang 版本的配套工具為例做一個(gè)最基礎(chǔ)的 Demo
更多參見(jiàn)：https://opencensus.io/introduction

Note：

以下章節(jié)假設(shè)你已閱讀并掌握 opencensus-go 的 README.md 中描述的幾個(gè)基本概念，主要包括 tag呻率、stats硬毕、exporters 等，我們將直入主題礼仗，以最快速度來(lái)完成一個(gè)最簡(jiǎn)單的 Demo;

Exporters

如你所知開(kāi)發(fā) Exporters 的團(tuán)隊(duì)有很多吐咳，還有一些是云服務(wù)，我們摘兩個(gè)能夠在本地快速搭建并使用的工具來(lái)做 Demo

Zipkin (Tracing)

網(wǎng)址：https://zipkin.io/pages/quickstart.html
通過(guò) http://localhost:9411/api/v2/spans 收集
通過(guò) http://127.0.0.1:9411 展示

打開(kāi)網(wǎng)址下載 jar 包元践，啟動(dòng) zipkin 用來(lái)收集和展示 Trace 信息

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

Prometheus : graphite_exporter (Stats)

網(wǎng)址：https://github.com/prometheus/graphite_exporter
通過(guò) http://localhost:9109 上傳度量值
通過(guò) http://localhost:9108/metrics 查看度量值

編譯&啟動(dòng) : 直接 checkout 工程韭脊，編譯并執(zhí)行即可啟動(dòng)服務(wù)

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

Demo

啟動(dòng)了上面兩個(gè)服務(wù)就可以直接看例子了，例子中收集了 foo / bar / baz 三個(gè)函數(shù)的調(diào)用信息单旁，并以 Trace 和 View 方式實(shí)現(xiàn)了上報(bào)

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", "測(cè)試一下 foo", stats.UnitDimensionless)
    BarMessage = stats.Int64("bar", "測(cè)試一下 bar", stats.UnitDimensionless)
    BazMessage = stats.Int64("baz", "測(cè)試一下 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 軸是時(shí)間線沪羔，可以看到截取了 32s 的調(diào)用數(shù)據(jù)，函數(shù)從 foo 開(kāi)始象浑，然后 bar 和 baz 交替執(zhí)行蔫饰，并附帶了執(zhí)行時(shí)間琅豆；

graphite_exporter 展示 Stats 信息