-
Notifications
You must be signed in to change notification settings - Fork 175
/
main.go
244 lines (210 loc) · 6.99 KB
/
main.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
237
238
239
240
241
242
243
244
package main
import (
"flag"
"math/rand"
"testing"
"time"
"github.com/prometheus/client_golang/prometheus"
"github.com/rs/zerolog"
"github.com/onflow/flow-go/engine/verification/match"
"github.com/onflow/flow-go/engine/verification/test"
"github.com/onflow/flow-go/model/messages"
vermodel "github.com/onflow/flow-go/model/verification"
"github.com/onflow/flow-go/module/buffer"
"github.com/onflow/flow-go/module/mempool/stdmap"
"github.com/onflow/flow-go/module/metrics"
"github.com/onflow/flow-go/module/metrics/example"
"github.com/onflow/flow-go/module/trace"
"github.com/onflow/flow-go/utils/unittest"
)
// main runs a local tracer server on the machine and starts monitoring some metrics for sake of verification, which
// increases result approvals counter and checked chunks counter 100 times each
func main() {
hp := flag.Bool("happypath", false, "run happy path")
flag.Parse()
if *hp {
happyPathExample()
} else {
demo()
}
}
// happyPathExample captures the metrics on running VerificationHappyPath with
// a single execution receipt of 10 chunks
func happyPathExample() {
example.WithMetricsServer(func(logger zerolog.Logger) {
tracer, err := trace.NewTracer(logger, "verification")
if err != nil {
panic(err)
}
// initiates and starts mempool collector
// since happy path goes very fast leap timer on collector set to 1 nanosecond.
mempoolCollector := metrics.NewMempoolCollector(1 * time.Nanosecond)
<-mempoolCollector.Ready()
// starts happy path
t := &testing.T{}
verificationCollector := metrics.NewVerificationCollector(tracer, prometheus.DefaultRegisterer)
test.VerificationHappyPath(t, 1, 10, verificationCollector, mempoolCollector)
<-mempoolCollector.Done()
})
}
// demo runs a local tracer server on the machine and starts monitoring some metrics for sake of verification, which
// increases result approvals counter and checked chunks counter 100 times each
func demo() {
example.WithMetricsServer(func(logger zerolog.Logger) {
tracer, err := trace.NewTracer(logger, "verification")
if err != nil {
panic(err)
}
vc := metrics.NewVerificationCollector(tracer, prometheus.DefaultRegisterer)
mc := metrics.NewMempoolCollector(5 * time.Second)
// starts periodic launch of mempoolCollector
<-mc.Ready()
// creates a receipt mempool and registers a metric on its size
receipts, err := stdmap.NewReceipts(100)
if err != nil {
panic(err)
}
err = mc.Register(metrics.ResourceReceipt, receipts.Size)
if err != nil {
panic(err)
}
// creates a pending receipts mempool and registers a metric on its size
pendingReceipts, err := stdmap.NewReceiptDataPacks(100)
if err != nil {
panic(err)
}
err = mc.Register(metrics.ResourcePendingReceipt, pendingReceipts.Size)
if err != nil {
panic(err)
}
// creates pending receipt ids by block mempool, and registers size method of backend for metrics
receiptIDsByBlock, err := stdmap.NewIdentifierMap(100)
if err != nil {
panic(err)
}
err = mc.Register(metrics.ResourcePendingReceiptIDsByBlock, receiptIDsByBlock.Size)
if err != nil {
panic(err)
}
// creates pending receipt ids by result mempool, and registers size method of backend for metrics
receiptIDsByResult, err := stdmap.NewIdentifierMap(100)
if err != nil {
panic(err)
}
err = mc.Register(metrics.ResourceReceiptIDsByResult, receiptIDsByResult.Size)
if err != nil {
panic(err)
}
// creates pending results mempool, and registers size method of backend for metrics
pendingResults := stdmap.NewResultDataPacks(100)
err = mc.Register(metrics.ResourcePendingResult, pendingResults.Size)
if err != nil {
panic(err)
}
// creates pending chunks mempool, and registers size method of backend for metrics
pendingChunks := match.NewChunks(100)
err = mc.Register(metrics.ResourcePendingChunk, pendingChunks.Size)
if err != nil {
panic(err)
}
// creates processed results ids mempool, and registers size method of backend for metrics
processedResultsIDs, err := stdmap.NewIdentifiers(100)
if err != nil {
panic(err)
}
err = mc.Register(metrics.ResourceProcessedResultID, processedResultsIDs.Size)
if err != nil {
panic(err)
}
// creates consensus cache for follower engine, and registers size method of backend for metrics
pendingBlocks := buffer.NewPendingBlocks()
err = mc.Register(metrics.ResourcePendingBlock, pendingBlocks.Size)
if err != nil {
panic(err)
}
// Over iterations each metric is gone through
// a probabilistic experiment with probability 0.5
// to collect or not.
// This is done to stretch metrics and scatter their pattern
// for a clear visualization.
for i := 0; i < 100; i++ {
// assigner
tryRandomCall(vc.OnExecutionReceiptReceived)
tryRandomCall(func() {
vc.OnChunksAssigned(rand.Int() % 10)
})
tryRandomCall(vc.OnChunkProcessed)
tryRandomCall(func() {
vc.OnAssignerProcessFinalizedBlock(uint64(i))
})
// finder
tryRandomCall(vc.OnExecutionReceiptReceived)
tryRandomCall(vc.OnExecutionResultSent)
// match
tryRandomCall(vc.OnExecutionResultReceived)
tryRandomCall(vc.OnChunkDataPackReceived)
tryRandomCall(vc.OnVerifiableChunkSent)
// verifier
tryRandomCall(vc.OnVerifiableChunkReceived)
// memory pools
receipt := unittest.ExecutionReceiptFixture()
tryRandomCall(func() {
receipts.Add(receipt)
})
tryRandomCall(func() {
pendingReceipts.Add(&vermodel.ReceiptDataPack{
Receipt: receipt,
OriginID: unittest.IdentifierFixture(),
})
})
tryRandomCall(func() {
err := receiptIDsByBlock.Append(receipt.ExecutionResult.BlockID, receipt.ID())
if err != nil {
panic(err)
}
})
tryRandomCall(func() {
err = receiptIDsByResult.Append(receipt.ExecutionResult.BlockID, receipt.ExecutionResult.ID())
if err != nil {
panic(err)
}
})
tryRandomCall(func() {
pendingResults.Add(&vermodel.ResultDataPack{
ExecutorID: receipt.ExecutorID,
ExecutionResult: &receipt.ExecutionResult,
})
})
tryRandomCall(func() {
pendingChunks.Add(&match.ChunkStatus{
Chunk: receipt.ExecutionResult.Chunks[0],
ExecutionResultID: receipt.ExecutionResult.ID(),
ExecutorID: receipt.ExecutorID,
LastAttempt: time.Time{},
Attempt: 0,
})
})
tryRandomCall(func() {
processedResultsIDs.Add(receipt.ExecutionResult.ID())
})
tryRandomCall(func() {
block := unittest.BlockFixture()
pendingBlocks.Add(unittest.IdentifierFixture(), &messages.BlockProposal{
Header: block.Header,
Payload: block.Payload,
})
})
// adds a synthetic 1 s delay for verification duration
time.Sleep(1 * time.Second)
tryRandomCall(vc.OnResultApproval)
}
})
}
// tryRandomCall executes function f with a probability of 1/2 that does not necessarily follow a uniform distribution.
//
// DISCLAIMER: this function should not be utilized for production code. Solely meant for testing and demo.
func tryRandomCall(f func()) {
if rand.Int()%2 == 0 {
f()
}
}