新聞中心
HTTP+DB+Redis+Logging
我們再來看一個相對完整一點的例子,包含幾個常用核心組件的鏈路跟蹤示例,示例代碼地址:https://github.com/GOgf/gf/tree/master/example/trace/http_with_db

客戶端
package main
import (
"github.com/gogf/gf/contrib/trace/jaeger/v2"
"github.com/gogf/gf/v2/database/gdb"
"github.com/gogf/gf/v2/frame/g"
"github.com/gogf/gf/v2/net/ghttp"
"github.com/gogf/gf/v2/net/gtrace"
"github.com/gogf/gf/v2/os/gctx"
)
const (
ServiceName = "http-client-with-db"
JaegerUdpEndpoint = "localhost:6831"
)
func main() {
var ctx = gctx.New()
tp, err := jaeger.Init(ServiceName, JaegerUdpEndpoint)
if err != nil {
g.Log().Fatal(ctx, err)
}
defer tp.Shutdown(ctx)
StartRequests()
}
func StartRequests() {
ctx, span := gtrace.NewSpan(gctx.New(), "StartRequests")
defer span.End()
var (
err error
client = g.Client()
)
// Add user info.
var insertRes = struct {
ghttp.DefaultHandlerResponse
Data struct{ Id int64 } `json:"data"`
}{}
err = client.PostVar(ctx, "http://127.0.0.1:8199/user/insert", g.Map{
"name": "john",
}).Scan(&insertRes)
if err != nil {
panic(err)
}
g.Log().Info(ctx, "insert result:", insertRes)
if insertRes.Data.Id == 0 {
g.Log().Error(ctx, "retrieve empty id string")
return
}
// Query user info.
var queryRes = struct {
ghttp.DefaultHandlerResponse
Data struct{ User gdb.Record } `json:"data"`
}{}
err = client.GetVar(ctx, "http://127.0.0.1:8199/user/query", g.Map{
"id": insertRes.Data.Id,
}).Scan(&queryRes)
if err != nil {
panic(err)
}
g.Log().Info(ctx, "query result:", queryRes)
// Delete user info.
var deleteRes = struct {
ghttp.DefaultHandlerResponse
}{}
err = client.PostVar(ctx, "http://127.0.0.1:8199/user/delete", g.Map{
"id": insertRes.Data.Id,
}).Scan(&deleteRes)
if err != nil {
panic(err)
}
g.Log().Info(ctx, "delete result:", deleteRes)
}客戶端代碼簡要說明:
首先,客戶端也是需要通過?jaeger.Init?方法初始化?Jaeger?。
在本示例中,我們通過HTTP客戶端向服務端發(fā)起了3次請求:
- ?
/user/insert? 用于新增一個用戶信息,成功后返回用戶的ID。 - ?
/user/query? 用于查詢用戶,使用前一個接口返回的用戶ID。 - ?
/user/delete? 用于刪除用戶,使用之前接口返回的用戶ID。
服務端
package main
import (
"context"
"fmt"
"time"
"github.com/gogf/gf/contrib/trace/jaeger/v2"
"github.com/gogf/gf/v2/database/gdb"
"github.com/gogf/gf/v2/frame/g"
"github.com/gogf/gf/v2/net/ghttp"
"github.com/gogf/gf/v2/os/gcache"
"github.com/gogf/gf/v2/os/gctx"
)
type cTrace struct{}
const (
ServiceName = "http-server-with-db"
JaegerUdpEndpoint = "localhost:6831"
)
func main() {
var ctx = gctx.New()
tp, err := jaeger.Init(ServiceName, JaegerUdpEndpoint)
if err != nil {
g.Log().Fatal(ctx, err)
}
defer tp.Shutdown(ctx)
// Set ORM cache adapter with redis.
g.DB().GetCache().SetAdapter(gcache.NewAdapterRedis(g.Redis()))
// Start HTTP server.
s := g.Server()
s.Use(ghttp.MiddlewareHandlerResponse)
s.Group("/", func(group *ghttp.RouterGroup) {
group.ALL("/user", new(cTrace))
})
s.SetPort(8199)
s.Run()
}
type InsertReq struct {
Name string `v:"required#Please input user name."`
}
type InsertRes struct {
Id int64
}
// Insert is a route handler for inserting user info into database.
func (c *cTrace) Insert(ctx context.Context, req *InsertReq) (res *InsertRes, err error) {
result, err := g.Model("user").Ctx(ctx).Insert(req)
if err != nil {
return nil, err
}
id, _ := result.LastInsertId()
res = &InsertRes{
Id: id,
}
return
}
type QueryReq struct {
Id int `v:"min:1#User id is required for querying"`
}
type QueryRes struct {
User gdb.Record
}
// Query is a route handler for querying user info. It firstly retrieves the info from redis,
// if there's nothing in the redis, it then does db select.
func (c *cTrace) Query(ctx context.Context, req *QueryReq) (res *QueryRes, err error) {
one, err := g.Model("user").Ctx(ctx).Cache(gdb.CacheOption{
Duration: 5 * time.Second,
Name: c.userCacheKey(req.Id),
Force: false,
}).WherePri(req.Id).One()
if err != nil {
return nil, err
}
res = &QueryRes{
User: one,
}
return
}
type DeleteReq struct {
Id int `v:"min:1#User id is required for deleting."`
}
type DeleteRes struct{}
// Delete is a route handler for deleting specified user info.
func (c *cTrace) Delete(ctx context.Context, req *DeleteReq) (res *DeleteRes, err error) {
_, err = g.Model("user").Ctx(ctx).Cache(gdb.CacheOption{
Duration: -1,
Name: c.userCacheKey(req.Id),
Force: false,
}).WherePri(req.Id).Delete()
if err != nil {
return nil, err
}
return
}
func (c *cTrace) userCacheKey(id int) string {
return fmt.Sprintf(`userInfo:%d`, id)
}服務端代碼簡要說明:
- 首先,客戶端也是需要通過?
jaeger.Init?方法初始化?Jaeger?。 - 在本示例中,我們使用到了數(shù)據(jù)庫和數(shù)據(jù)庫緩存功能,以便于同時演示?
ORM?和?Redis?的鏈路跟蹤記錄。 - 我們在程序啟動時通過以下方法設置當前數(shù)據(jù)庫緩存管理的適配器為?
redis?。
g.DB().GetCache().SetAdapter(gcache.NewAdapterRedis(g.Redis()))
- 在?
ORM?的操作中,需要通過?Ctx?方法將上下文變量傳遞到組件中,?orm?組件會自動識別當前上下文中是否包含?Tracing?鏈路信息,如果包含則自動啟用鏈路跟蹤特性。 - 在?
ORM?的操作中,這里使用?Cache?方法緩存查詢結(jié)果到?redis?中,并在刪除操作中也使用?Cache?方法清除?redis?中的緩存結(jié)果。
效果查看
啟動服務端:
啟動客戶端:
在?Jaeger?上查看鏈路信息:
可以看到,這次請求總共產(chǎn)生了14個?span?,其中客戶端有4個?span?,服務端有10個?span?,每一個?span?代表一個鏈路節(jié)點。不過,我們注意到,這里產(chǎn)生了3個?errors?。我們點擊詳情查看什么原因呢。
我們看到好像所有的?redis?操作都報錯了,隨便點擊一個?redis?的相關(guān)?span?,查看一下詳情呢:
原來是?redis?連接不上報錯了,這樣的話所有的?orm?緩存功能都失效了,但是可以看到并沒有影響接口邏輯,只是所有的查詢都走了數(shù)據(jù)庫。這個報錯是因為我本地忘了打開?redis server?,我趕緊啟動一下本地的?redis server?,再看看效果:
再把上面的客戶端運行一下,查看?jaeger?:
現(xiàn)在就沒有報錯了。
?HTTP Client&Server?、?Logging?組件在之前已經(jīng)介紹過,因此這里我們主要關(guān)注?orm?和?redis?組件的鏈路跟蹤信息。
ORM鏈路信息
Attributes/Tags
我們隨便點開一個?ORM?鏈路?Span?,看看?Attributes/Tags?信息:
可以看到這里的?span.kind?是?internal?,也就是之前介紹過的方法內(nèi)部?span?類型。這里很多?Tags?在之前已經(jīng)介紹過,因此這里主要介紹關(guān)于數(shù)據(jù)庫相關(guān)的?Tags?:
| Attribute/Tag | 說明 |
|---|---|
db.type | 數(shù)據(jù)庫連接類型。如mysql, mssql, pgsql等等。 |
db.link | 數(shù)據(jù)庫連接信息。其中密碼字段被自動隱藏。 |
db.group | 在配置文件中的數(shù)據(jù)庫分組名稱。 |
Events/Process
| Event/Log | 說明 |
|---|---|
db.execution.sql | 執(zhí)行的具體SQL語句。由于ORM底層是預處理,該語句為方便查看自動拼接而成,僅供參考。 |
db.execution.type | 執(zhí)行的SQL語句類型。常見為DB.ExecContext和DB.QueryContext,分別代表寫操作和讀操作。 |
db.execution.cost |
當前 |
Redis鏈路信息
Attributes/Tags
| Attribute/Tag | 說明 |
|---|---|
redis.host | Redis連接地址。 |
redis.port | Redis連接端口。 |
redis.db | Redis操作db。 |
Events/Process
| Event/Log | 說明 |
|---|---|
redis.execution.command | Redis執(zhí)行指令。 |
redis.execution.arguments | Redis執(zhí)行指令參數(shù)。 |
redis.execution.cost |
|
新聞標題:創(chuàng)新互聯(lián)GoFrame教程:GoFrameHTTP示例-數(shù)據(jù)操作
網(wǎng)頁路徑:http://www.fisionsoft.com.cn/article/dpisidc.html


咨詢
建站咨詢
