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 信息
圖中 X
軸是時間線,可以看到截取了 32s
的調用數據,函數從 foo
開始,然後 bar
和 baz
交替執行,並附帶了執行時間;
graphite_exporter 展示 Stats 信息
可以看到 bar_view
和 baz_view
分別被調用了 17
次,foo_view
作爲入口函數只調用了一次