add trace doc

pull/302/head
felixhao 5 years ago
parent a83992e6dd
commit 971dec97be
  1. BIN
      doc/img/zipkin.jpg
  2. 0
      doc/wiki-cn/dapper.md
  3. 2
      doc/wiki-cn/summary.md
  4. 42
      doc/wiki-cn/trace.md

Binary file not shown.

After

Width:  |  Height:  |  Size: 64 KiB

@ -17,7 +17,7 @@
* [config](config.md) * [config](config.md)
* [paladin](config-paladin.md) * [paladin](config-paladin.md)
* [ecode](ecode.md) * [ecode](ecode.md)
* [dapper trace](dapper.md) * [trace](dapper.md)
* [log](logger.md) * [log](logger.md)
* [log-agent](log-agent.md) * [log-agent](log-agent.md)
* [database](database.md) * [database](database.md)

@ -0,0 +1,42 @@
# 背景
当代的互联网的服务,通常都是用复杂的、大规模分布式集群来实现的。互联网应用构建在不同的软件模块集上,这些软件模块,有可能是由不同的团队开发、可能使用不同的编程语言来实现、有可能布在了几千台服务器,横跨多个不同的数据中心。因此,就需要一些可以帮助理解系统行为、用于分析性能问题的工具。
# 概览
* kratos内部的trace基于opentracing语义
* 使用protobuf协议描述trace结构
* 全链路支持(gRPC/HTTP/MySQL/Redis/Memcached等)
## 参考文档
[opentracing](https://github.com/opentracing-contrib/opentracing-specification-zh/blob/master/specification.md)
[dapper](https://bigbully.github.io/Dapper-translation/)
# 使用
kratos本身不提供整套`trace`数据方案,但在`net/trace/report.go`内声明了`repoter`接口,可以简单的集成现有开源系统,比如:`zipkin`和`jaeger`。
### zipkin使用
可以看[zipkin](https://github.com/bilibili/kratos/tree/master/pkg/net/trace/zipkin)的协议上报实现,具体使用方式如下:
1. 前提是需要有一套自己搭建的`zipkin`集群
2. 在业务代码的`main`函数内进行初始化,代码如下:
```go
// 忽略其他代码
import "github.com/bilibili/kratos/pkg/net/trace/zipkin"
// 忽略其他代码
func main(){
// 忽略其他代码
zipkin.Init(&zipkin.Config{
Endpoint: "http://localhost:9411/api/v2/spans",
})
// 忽略其他代码
}
```
# 效果图
![zipkin](/doc/img/zipkin.jpg)
Loading…
Cancel
Save