1. 1. 修改 server/main.go
  2. 2. 服务端事件查看
  3. 3. 请求日志信息查看

GRPC - Trace

grpc默认提供了客户端和服务端的trace日志,可惜没有提供自定义接口,当前只能查看基本的事件日志和请求日志,对于基本的请求状态查看也是很有帮助的,客户端与服务端基本一致,这里以服务端开启trace为例。

修改 server/main.go

新增了 startTrace 方法

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
package main

import (
"net"
"fmt"
"net/http"

pb "liusha.me/example/proto"

"golang.org/x/net/context"
"google.golang.org/grpc"
"golang.org/x/net/trace"
"google.golang.org/grpc/codes" // grpc 响应状态码
"google.golang.org/grpc/credentials" // grpc认证包
"google.golang.org/grpc/grpclog"
"google.golang.org/grpc/metadata" // grpc metadata包
)

const (
// Address gRPC服务地址
Address = "127.0.0.1:50052"
)

// 定义helloService并实现约定的接口
type helloService struct{}

// HelloService ...
var HelloService = helloService{}

func (h helloService) SayHello(ctx context.Context, in *pb.HelloRequest) (*pb.HelloReply, error) {
resp := new(pb.HelloReply)
resp.Message = "Hello " + in.Name + "."

return resp, nil
}

// auth 验证Token
func auth(ctx context.Context) error {
md, ok := metadata.FromContext(ctx)
if !ok {
return fmt.Errorf("Err%d: 无Token认证信息", codes.Unauthenticated)
}

var (
appid string
appkey string
)

if val, ok := md["appid"]; ok {
appid = val[0]
}

if val, ok := md["appkey"]; ok {
appkey = val[0]
}

if appid != "101010" || appkey != "i am key" {
return fmt.Errorf("Err%d: Token认证信息无效: appid=%s, appkey=%s", codes.Unauthenticated, appid, appkey)
}

return nil
}

func main() {
listen, err := net.Listen("tcp", Address)
if err != nil {
grpclog.Fatalf("Failed to listen: %v", err)
}

var opts []grpc.ServerOption

// TLS认证
creds, err := credentials.NewServerTLSFromFile("./keys/server.pem", "./keys/server.key")
if err != nil {
fmt.Errorf("Failed to generate credentials %v", err)
}

opts = append(opts, grpc.Creds(creds))

// 注册interceptor
var interceptor grpc.UnaryServerInterceptor
interceptor = func(ctx context.Context, req interface{}, info *grpc.UnaryServerInfo, handler grpc.UnaryHandler) (resp interface{}, err error) {
err = auth(ctx)
if err != nil {
return
}
// 继续处理请求
return handler(ctx, req)
}
opts = append(opts, grpc.UnaryInterceptor(interceptor))

// 实例化grpc Server
s := grpc.NewServer(opts...)

// 开启trace
go startTrace()

// 注册HelloService
pb.RegisterHelloServer(s, HelloService)

fmt.Println("Listen on " + Address + " with TLS + Token + Interceptor")

s.Serve(listen)
}

func startTrace() {
trace.AuthRequest = func(req *http.Request) (any, sensitive bool) {
return true, true
}
go http.ListenAndServe(":50051", nil)
fmt.Println("Trace listen on 50051")
}

运行:

1
2
3
4
go run hello/server/main.go

Listen on 127.0.0.1:50052 with TLS + Token + Interceptor
Trace listen on 50051

客户端运行

1
2
3
go run hello/client/main.go

Hello gRPC.

服务端事件查看

访问:localhost:50051/debug/events ,结果如图:

grpc-trace

可以看到服务端注册的服务和服务正常启动的事件信息,默认trace中只有这一个事件

请求日志信息查看

访问:localhost:50051/debug/requests ,结果如图:

grpc-trace

这里可以显示最近的请求状态,包括请求的服务、参数、耗时、响应,对于简单的状态查看还是很方便的,默认值显示最近10条记录,不可以修改。