forked from alpe/cosmos-tracing
-
Notifications
You must be signed in to change notification settings - Fork 0
/
sdk_tracer.go
236 lines (209 loc) · 6.76 KB
/
sdk_tracer.go
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
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
package tracing
import (
"fmt"
"strconv"
wasmtypes "github.com/CosmWasm/wasmd/x/wasm/types"
abci "github.com/cometbft/cometbft/abci/types"
"github.com/cometbft/cometbft/crypto/tmhash"
cmttypes "github.com/cometbft/cometbft/libs/bytes"
"github.com/cosmos/cosmos-sdk/baseapp"
"github.com/cosmos/cosmos-sdk/codec"
sdk "github.com/cosmos/cosmos-sdk/types"
govv1beta1 "github.com/cosmos/cosmos-sdk/x/gov/types/v1beta1"
"github.com/gogo/protobuf/proto"
"github.com/opentracing/opentracing-go"
)
const (
tagModule = "module"
tagErrored = "errored"
tagSDKMsgType = "sdk_message_type"
tagSDKGRPCService = "sdk_grpc_service"
tagBlockHeight = "height"
tagTXHash = "tx"
tagSimulation = "simulation"
tagQueryPath = "query_path"
tagValsetUpdate = "valset_update"
logRawStoreIO = "raw_store_io"
logValsetDiff = "valset_diff"
logRawLoggerOut = "logger_out"
logGasUsage = "gas_usage"
)
// BeginBlockTracer is a decorator to the begin block callback that adds tracing functionality
// Deprecated use TraceModuleManager instead to get more fine grained module data
func BeginBlockTracer(other sdk.BeginBlocker) sdk.BeginBlocker {
if !tracerEnabled {
return other
}
return func(rootCtx sdk.Context, req abci.RequestBeginBlock) (rsp abci.ResponseBeginBlock) {
DoWithTracing(rootCtx, "old-abci_begin_block", all, func(workCtx sdk.Context, span opentracing.Span) error {
rsp = other(workCtx, req)
return nil
})
return
}
}
// EndBlockTracer is a decorator to the end block callback that adds tracing functionality
// Deprecated use TraceModuleManager instead to get more fine grained module data
func EndBlockTracer(other sdk.EndBlocker) sdk.EndBlocker {
if !tracerEnabled {
return other
}
return func(rootCtx sdk.Context, req abci.RequestEndBlock) (rsp abci.ResponseEndBlock) {
DoWithTracing(rootCtx, "old-abci_end_block", all, func(workCtx sdk.Context, span opentracing.Span) error {
rsp = other(workCtx, req)
return nil
})
return
}
}
// NewTraceAnteHandler decorates the ante handler with tracing functionality
func NewTraceAnteHandler(other sdk.AnteHandler, cdc codec.Codec) sdk.AnteHandler {
if !tracerEnabled {
return other
}
return func(rootCtx sdk.Context, tx sdk.Tx, simulate bool) (nextCtx sdk.Context, err error) {
if !isTraceable(rootCtx, simulate) {
return other(rootCtx, tx, simulate)
}
ctx := WithSimulation(rootCtx, simulate)
DoWithTracing(ctx, "ante_handler", writesOnly, func(workCtx sdk.Context, span opentracing.Span) error {
msgs := make([]string, len(tx.GetMsgs()))
senders := make([]string, 0, len(tx.GetMsgs()))
for i, msg := range tx.GetMsgs() {
msgs[i] = fmt.Sprintf("%T", msg)
pm, ok := msg.(proto.Message)
if !ok {
continue
}
jsonMsg, err := cdc.MarshalJSON(pm)
if err != nil {
jsonMsg = []byte(err.Error())
}
span.LogFields(safeLogField(logRawSDKMsg, cutLength(string(jsonMsg), MaxSDKMsgTraced)))
senders = append(senders, addrsToString(msg.GetSigners())...)
}
span.SetTag(tagTXHash, cmttypes.HexBytes(tmhash.Sum(rootCtx.TxBytes())).String())
span.SetTag(tagSDKMsgType, deduplicateStrings(msgs))
span.SetTag(tagSender, deduplicateStrings(senders))
span.SetTag(tagSimulation, strconv.FormatBool(simulate))
nextCtx, err = other(workCtx, tx, simulate)
return err
})
return
}
}
func addrsToString(addrs []sdk.AccAddress) []string {
r := make([]string, len(addrs))
for i, a := range addrs {
r[i] = a.String()
}
return r
}
func deduplicateStrings(msgs []string) []string {
r := make([]string, 0, len(msgs))
idx := make(map[string]struct{}, len(msgs))
for _, v := range msgs {
if _, exists := idx[v]; exists {
continue
}
r = append(r, v)
idx[v] = struct{}{}
}
return r
}
var _ govv1beta1.Router = TraceGovRouter{}
// TraceGovRouter is a decorator to the sdk gov router that adds call tracing functionality
type TraceGovRouter struct {
other govv1beta1.Router
}
func NewTraceGovRouter(other govv1beta1.Router) govv1beta1.Router {
if !tracerEnabled {
return other
}
return &TraceGovRouter{other: other}
}
func (t TraceGovRouter) AddRoute(r string, h govv1beta1.Handler) (rtr govv1beta1.Router) {
return NewTraceGovRouter(t.other.AddRoute(r, h))
}
func (t TraceGovRouter) HasRoute(r string) bool {
return t.other.HasRoute(r)
}
func (t TraceGovRouter) Seal() {
t.other.Seal()
}
func (t TraceGovRouter) GetRoute(path string) (h govv1beta1.Handler) {
realHandler := t.other.GetRoute(path)
if realHandler == nil {
return nil
}
return func(rootCtx sdk.Context, content govv1beta1.Content) (err error) {
if !IsTraceable(rootCtx) {
return realHandler(rootCtx, content)
}
DoWithTracing(rootCtx, "gov_router", all, func(workCtx sdk.Context, span opentracing.Span) error {
span.SetTag(tagModule, content.ProposalRoute()).
SetTag(tagSDKMsgType, fmt.Sprintf("%T", content))
err = realHandler(workCtx, content)
return err
})
return
}
}
// MessageRouter ADR 031 request type routing
type MessageRouter interface {
Handler(msg sdk.Msg) baseapp.MsgServiceHandler
}
var _ MessageRouter = TraceMessageRouter{}
type TraceMessageRouter struct {
other MessageRouter
}
func NewTraceMessageRouter(other MessageRouter) MessageRouter {
if !tracerEnabled {
return other
}
return &TraceMessageRouter{other: other}
}
type routeable interface {
Route() string
}
func (t TraceMessageRouter) Handler(msg sdk.Msg) baseapp.MsgServiceHandler {
realHandler := t.other.Handler(msg)
return func(rootCtx sdk.Context, msg sdk.Msg) (result *sdk.Result, err error) {
if !IsTraceable(rootCtx) {
return realHandler(rootCtx, msg)
}
DoWithTracing(rootCtx, "new_msg_router", all, func(workCtx sdk.Context, span opentracing.Span) error {
moduleName := "-"
if m, ok := msg.(routeable); ok {
moduleName = m.Route()
}
span.SetTag(tagModule, moduleName).
SetTag(tagSDKMsgType, fmt.Sprintf("%T", msg)).
SetTag(tagSender, deduplicateStrings(addrsToString(msg.GetSigners())))
tryLogWasmMsg(span, msg)
result, err = realHandler(workCtx, msg)
if err != nil {
return err
}
addTagsFromWasmEvents(span, result.GetEvents())
logResultData(span, result.Data)
return nil
})
return
}
}
func logResultData(span opentracing.Span, data []byte) {
span.LogFields(safeLogField("raw_wasm_message_result", toJson(data)))
}
func tryLogWasmMsg(span opentracing.Span, msg sdk.Msg) {
switch m := msg.(type) {
case *wasmtypes.MsgInstantiateContract:
span.LogFields(safeLogField(logDecodedWasmMsg, string(m.Msg)))
case *wasmtypes.MsgInstantiateContract2:
span.LogFields(safeLogField(logDecodedWasmMsg, string(m.Msg)))
case *wasmtypes.MsgExecuteContract:
span.LogFields(safeLogField(logDecodedWasmMsg, string(m.Msg)))
case *wasmtypes.MsgMigrateContract:
span.LogFields(safeLogField(logDecodedWasmMsg, string(m.Msg)))
}
}