-
Notifications
You must be signed in to change notification settings - Fork 177
/
metrics.go
502 lines (372 loc) · 21 KB
/
metrics.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
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
package module
import (
"time"
"github.com/onflow/flow-go/model/cluster"
"github.com/onflow/flow-go/model/flow"
)
type EntriesFunc func() uint
// ResolverMetrics encapsulates the metrics collectors for dns resolver module of the networking layer.
type ResolverMetrics interface {
// DNSLookupDuration tracks the time spent to resolve a DNS address.
DNSLookupDuration(duration time.Duration)
// OnDNSCacheMiss tracks the total number of dns requests resolved through looking up the network.
OnDNSCacheMiss()
// DNSCacheResolution tracks the total number of dns requests resolved through the cache without
// looking up the network.
OnDNSCacheHit()
// OnDNSCacheInvalidated is called whenever dns cache is invalidated for an entry
OnDNSCacheInvalidated()
// OnDNSLookupRequestDropped tracks the number of dns lookup requests that are dropped due to a full queue
OnDNSLookupRequestDropped()
}
type NetworkMetrics interface {
ResolverMetrics
DHTMetrics
// NetworkMessageSent size in bytes and count of the network message sent
NetworkMessageSent(sizeBytes int, topic string, messageType string)
// NetworkMessageReceived size in bytes and count of the network message received
NetworkMessageReceived(sizeBytes int, topic string, messageType string)
// NetworkDuplicateMessagesDropped counts number of messages dropped due to duplicate detection
NetworkDuplicateMessagesDropped(topic string, messageType string)
// Message receive queue metrics
// MessageAdded increments the metric tracking the number of messages in the queue with the given priority
MessageAdded(priority int)
// MessageRemoved decrements the metric tracking the number of messages in the queue with the given priority
MessageRemoved(priority int)
// QueueDuration tracks the time spent by a message with the given priority in the queue
QueueDuration(duration time.Duration, priority int)
DirectMessageStarted(topic string)
DirectMessageFinished(topic string)
// MessageProcessingStarted tracks the start of a call to process a message from the given topic
MessageProcessingStarted(topic string)
// MessageProcessingFinished tracks the time a queue worker blocked by an engine for processing an incoming message on specified topic (i.e., channel).
MessageProcessingFinished(topic string, duration time.Duration)
// OutboundConnections updates the metric tracking the number of outbound connections of this node
OutboundConnections(connectionCount uint)
// InboundConnections updates the metric tracking the number of inbound connections of this node
InboundConnections(connectionCount uint)
}
type EngineMetrics interface {
MessageSent(engine string, message string)
MessageReceived(engine string, message string)
MessageHandled(engine string, messages string)
}
type ComplianceMetrics interface {
FinalizedHeight(height uint64)
CommittedEpochFinalView(view uint64)
SealedHeight(height uint64)
BlockFinalized(*flow.Block)
BlockSealed(*flow.Block)
BlockProposalDuration(duration time.Duration)
CurrentEpochCounter(counter uint64)
CurrentEpochPhase(phase flow.EpochPhase)
CurrentEpochFinalView(view uint64)
CurrentDKGPhase1FinalView(view uint64)
CurrentDKGPhase2FinalView(view uint64)
CurrentDKGPhase3FinalView(view uint64)
EpochEmergencyFallbackTriggered()
}
type CleanerMetrics interface {
RanGC(took time.Duration)
}
type CacheMetrics interface {
// CacheEntries report the total number of cached items
CacheEntries(resource string, entries uint)
// CacheHit report the number of times the queried item is found in the cache
CacheHit(resource string)
// CacheNotFound records the number of times the queried item was not found in either cache or database.
CacheNotFound(resource string)
// CacheMiss report the number of times the queried item is not found in the cache, but found in the database.
CacheMiss(resource string)
}
type MempoolMetrics interface {
MempoolEntries(resource string, entries uint)
Register(resource string, entriesFunc EntriesFunc) error
}
type HotstuffMetrics interface {
// HotStuffBusyDuration reports Metrics C6 HotStuff Busy Duration
HotStuffBusyDuration(duration time.Duration, event string)
// HotStuffIdleDuration reports Metrics C6 HotStuff Idle Duration
HotStuffIdleDuration(duration time.Duration)
// HotStuffWaitDuration reports Metrics C6 HotStuff Idle Duration
HotStuffWaitDuration(duration time.Duration, event string)
// SetCurView reports Metrics C8: Current View
SetCurView(view uint64)
// SetQCView reports Metrics C9: View of Newest Known QC
SetQCView(view uint64)
// CountSkipped reports the number of times we skipped ahead.
CountSkipped()
// CountTimeout reports the number of times we timed out.
CountTimeout()
// SetTimeout sets the current timeout duration
SetTimeout(duration time.Duration)
// CommitteeProcessingDuration measures the time which the HotStuff's core logic
// spends in the hotstuff.Committee component, i.e. the time determining consensus
// committee relations.
CommitteeProcessingDuration(duration time.Duration)
// SignerProcessingDuration measures the time which the HotStuff's core logic
// spends in the hotstuff.Signer component, i.e. the with crypto-related operations.
SignerProcessingDuration(duration time.Duration)
// ValidatorProcessingDuration measures the time which the HotStuff's core logic
// spends in the hotstuff.Validator component, i.e. the with verifying
// consensus messages.
ValidatorProcessingDuration(duration time.Duration)
// PayloadProductionDuration measures the time which the HotStuff's core logic
// spends in the module.Builder component, i.e. the with generating block payloads.
PayloadProductionDuration(duration time.Duration)
}
type CollectionMetrics interface {
// TransactionIngested is called when a new transaction is ingested by the
// node. It increments the total count of ingested transactions and starts
// a tx->col span for the transaction.
TransactionIngested(txID flow.Identifier)
// ClusterBlockProposed is called when a new collection is proposed by us or
// any other node in the cluster.
ClusterBlockProposed(block *cluster.Block)
// ClusterBlockFinalized is called when a collection is finalized.
ClusterBlockFinalized(block *cluster.Block)
}
type ConsensusMetrics interface {
// StartCollectionToFinalized reports Metrics C1: Collection Received by CCL→ Collection Included in Finalized Block
StartCollectionToFinalized(collectionID flow.Identifier)
// FinishCollectionToFinalized reports Metrics C1: Collection Received by CCL→ Collection Included in Finalized Block
FinishCollectionToFinalized(collectionID flow.Identifier)
// StartBlockToSeal reports Metrics C4: Block Received by CCL → Block Seal in finalized block
StartBlockToSeal(blockID flow.Identifier)
// FinishBlockToSeal reports Metrics C4: Block Received by CCL → Block Seal in finalized block
FinishBlockToSeal(blockID flow.Identifier)
// EmergencySeal increments the number of seals that were created in emergency mode
EmergencySeal()
// OnReceiptProcessingDuration records the number of seconds spent processing a receipt
OnReceiptProcessingDuration(duration time.Duration)
// OnApprovalProcessingDuration records the number of seconds spent processing an approval
OnApprovalProcessingDuration(duration time.Duration)
// CheckSealingDuration records absolute time for the full sealing check by the consensus match engine
CheckSealingDuration(duration time.Duration)
}
type VerificationMetrics interface {
// OnBlockConsumerJobDone is invoked by block consumer whenever it is notified a job is done by a worker. It
// sets the last processed block job index.
OnBlockConsumerJobDone(uint64)
// OnChunkConsumerJobDone is invoked by chunk consumer whenever it is notified a job is done by a worker. It
// sets the last processed chunk job index.
OnChunkConsumerJobDone(uint64)
// OnExecutionResultReceivedAtAssignerEngine is called whenever a new execution result arrives
// at Assigner engine. It increments total number of received execution results.
OnExecutionResultReceivedAtAssignerEngine()
// OnVerifiableChunkReceivedAtVerifierEngine increments a counter that keeps track of number of verifiable chunks received at
// verifier engine from fetcher engine.
OnVerifiableChunkReceivedAtVerifierEngine()
// OnFinalizedBlockArrivedAtAssigner sets a gauge that keeps track of number of the latest block height arrives
// at assigner engine. Note that it assumes blocks are coming to assigner engine in strictly increasing order of their height.
OnFinalizedBlockArrivedAtAssigner(height uint64)
// OnChunksAssignmentDoneAtAssigner increments a counter that keeps track of the total number of assigned chunks to
// the verification node.
OnChunksAssignmentDoneAtAssigner(chunks int)
// OnAssignedChunkProcessedAtAssigner increments a counter that keeps track of the total number of assigned chunks pushed by
// assigner engine to the fetcher engine.
OnAssignedChunkProcessedAtAssigner()
// OnAssignedChunkReceivedAtFetcher increments a counter that keeps track of number of assigned chunks arrive at fetcher engine.
OnAssignedChunkReceivedAtFetcher()
// OnChunkDataPackRequestSentByFetcher increments a counter that keeps track of number of chunk data pack requests that fetcher engine
// sends to requester engine.
OnChunkDataPackRequestSentByFetcher()
// OnChunkDataPackRequestReceivedByRequester increments a counter that keeps track of number of chunk data pack requests
// arrive at the requester engine from the fetcher engine.
OnChunkDataPackRequestReceivedByRequester()
// OnChunkDataPackRequestDispatchedInNetwork increments a counter that keeps track of number of chunk data pack requests that the
// requester engine dispatches in the network (to the execution nodes).
OnChunkDataPackRequestDispatchedInNetworkByRequester()
// OnChunkDataPackResponseReceivedFromNetwork increments a counter that keeps track of number of chunk data pack responses that the
// requester engine receives from execution nodes (through network).
OnChunkDataPackResponseReceivedFromNetworkByRequester()
// SetMaxChunkDataPackAttemptsForNextUnsealedHeightAtRequester is invoked when a cycle of requesting chunk data packs is done by requester engine.
// It updates the maximum number of attempts made by requester engine for requesting the chunk data packs of the next unsealed height.
// The maximum is taken over the history of all chunk data packs requested during that cycle that belong to the next unsealed height.
SetMaxChunkDataPackAttemptsForNextUnsealedHeightAtRequester(attempts uint64)
// OnChunkDataPackSentToFetcher increments a counter that keeps track of number of chunk data packs sent to the fetcher engine from
// requester engine.
OnChunkDataPackSentToFetcher()
// OnChunkDataPackArrivedAtFetcher increments a counter that keeps track of number of chunk data packs arrived at fetcher engine from
// requester engine.
OnChunkDataPackArrivedAtFetcher()
// OnVerifiableChunkSentToVerifier increments a counter that keeps track of number of verifiable chunks fetcher engine sent to verifier engine.
OnVerifiableChunkSentToVerifier()
// OnResultApprovalDispatchedInNetwork increments a counter that keeps track of number of result approvals dispatched in the network
// by verifier engine.
OnResultApprovalDispatchedInNetworkByVerifier()
}
// LedgerMetrics provides an interface to record Ledger Storage metrics.
// Ledger storage is non-linear (fork-aware) so certain metrics are averaged
// and computed before emitting for better visibility
type LedgerMetrics interface {
// ForestApproxMemorySize records approximate memory usage of forest (all in-memory trees)
ForestApproxMemorySize(bytes uint64)
// ForestNumberOfTrees current number of trees in a forest (in memory)
ForestNumberOfTrees(number uint64)
// LatestTrieRegCount records the number of unique register allocated (the latest created trie)
LatestTrieRegCount(number uint64)
// LatestTrieRegCountDiff records the difference between the number of unique register allocated of the latest created trie and parent trie
LatestTrieRegCountDiff(number int64)
// LatestTrieRegSize records the size of unique register allocated (the latest created trie)
LatestTrieRegSize(size uint64)
// LatestTrieRegSizeDiff records the difference between the size of unique register allocated of the latest created trie and parent trie
LatestTrieRegSizeDiff(size int64)
// LatestTrieMaxDepthTouched records the maximum depth touched of the lastest created trie
LatestTrieMaxDepthTouched(maxDepth uint16)
// UpdateCount increase a counter of performed updates
UpdateCount()
// ProofSize records a proof size
ProofSize(bytes uint32)
// UpdateValuesNumber accumulates number of updated values
UpdateValuesNumber(number uint64)
// UpdateValuesSize total size (in bytes) of updates values
UpdateValuesSize(byte uint64)
// UpdateDuration records absolute time for the update of a trie
UpdateDuration(duration time.Duration)
// UpdateDurationPerItem records update time for single value (total duration / number of updated values)
UpdateDurationPerItem(duration time.Duration)
// ReadValuesNumber accumulates number of read values
ReadValuesNumber(number uint64)
// ReadValuesSize total size (in bytes) of read values
ReadValuesSize(byte uint64)
// ReadDuration records absolute time for the read from a trie
ReadDuration(duration time.Duration)
// ReadDurationPerItem records read time for single value (total duration / number of read values)
ReadDurationPerItem(duration time.Duration)
}
type WALMetrics interface {
// DiskSize records the amount of disk space used by the storage (in bytes)
DiskSize(uint64)
}
type ExecutionDataServiceMetrics interface {
ExecutionDataAddStarted()
ExecutionDataAddFinished(duration time.Duration, success bool, blobTreeSize uint64)
ExecutionDataGetStarted()
ExecutionDataGetFinished(duration time.Duration, success bool, blobTreeSize uint64)
}
type ExecutionDataRequesterMetrics interface {
// ExecutionDataFetchStarted records an in-progress download
ExecutionDataFetchStarted()
// ExecutionDataFetchFinished records a completed download
ExecutionDataFetchFinished(duration time.Duration, success bool, height uint64)
// NotificationSent reports that ExecutionData received notifications were sent for a block height
NotificationSent(height uint64)
// FetchRetried reports that a download retry was processed
FetchRetried()
}
type RuntimeMetrics interface {
// TransactionParsed reports the time spent parsing a single transaction
RuntimeTransactionParsed(dur time.Duration)
// TransactionChecked reports the time spent checking a single transaction
RuntimeTransactionChecked(dur time.Duration)
// TransactionInterpreted reports the time spent interpreting a single transaction
RuntimeTransactionInterpreted(dur time.Duration)
// RuntimeSetNumberOfAccounts Sets the total number of accounts on the network
RuntimeSetNumberOfAccounts(count uint64)
}
type ProviderMetrics interface {
// ChunkDataPackRequested is executed every time a chunk data pack request is arrived at execution node.
// It increases the request counter by one.
ChunkDataPackRequested()
}
type AccessMetrics interface {
// TotalConnectionsInPool updates the number connections to collection/execution nodes stored in the pool, and the size of the pool
TotalConnectionsInPool(connectionCount uint, connectionPoolSize uint)
// ConnectionFromPoolRetrieved tracks the number of times a connection to a collection/execution node is retrieved from the connection pool
ConnectionFromPoolRetrieved()
}
type ExecutionMetrics interface {
LedgerMetrics
RuntimeMetrics
ProviderMetrics
WALMetrics
// StartBlockReceivedToExecuted starts a span to trace the duration of a block
// from being received for execution to execution being finished
StartBlockReceivedToExecuted(blockID flow.Identifier)
// FinishBlockReceivedToExecuted finishes a span to trace the duration of a block
// from being received for execution to execution being finished
FinishBlockReceivedToExecuted(blockID flow.Identifier)
// ExecutionStateReadsPerBlock reports number of state access/read operations per block
ExecutionStateReadsPerBlock(reads uint64)
// ExecutionStorageStateCommitment reports the storage size of a state commitment in bytes
ExecutionStorageStateCommitment(bytes int64)
// ExecutionLastExecutedBlockHeight reports last executed block height
ExecutionLastExecutedBlockHeight(height uint64)
// ExecutionBlockExecuted reports the total time and computation spent on executing a block
ExecutionBlockExecuted(dur time.Duration, compUsed uint64, txCounts int, colCounts int)
// ExecutionCollectionExecuted reports the total time and computation spent on executing a collection
ExecutionCollectionExecuted(dur time.Duration, compUsed uint64, txCounts int)
// ExecutionTransactionExecuted reports the total time, computation and memory spent on executing a single transaction
ExecutionTransactionExecuted(dur time.Duration, compUsed, memoryUsed, memoryEstimate uint64, eventCounts int, failed bool)
// ExecutionScriptExecuted reports the time and memory spent on executing an script
ExecutionScriptExecuted(dur time.Duration, compUsed, memoryUsed, memoryEstimate uint64)
// ExecutionCollectionRequestSent reports when a request for a collection is sent to a collection node
ExecutionCollectionRequestSent()
// Unused
ExecutionCollectionRequestRetried()
// ExecutionSync reports when the state syncing is triggered or stopped.
ExecutionSync(syncing bool)
ExecutionBlockDataUploadStarted()
ExecutionBlockDataUploadFinished(dur time.Duration)
}
type BackendScriptsMetrics interface {
// Record the round trip time while executing a script
ScriptExecuted(dur time.Duration, size int)
}
type TransactionMetrics interface {
BackendScriptsMetrics
// Record the round trip time while getting a transaction result
TransactionResultFetched(dur time.Duration, size int)
// TransactionReceived starts tracking of transaction execution/finalization/sealing
TransactionReceived(txID flow.Identifier, when time.Time)
// TransactionFinalized reports the time spent between the transaction being received and finalized. Reporting only
// works if the transaction was earlier added as received.
TransactionFinalized(txID flow.Identifier, when time.Time)
// TransactionExecuted reports the time spent between the transaction being received and executed. Reporting only
// works if the transaction was earlier added as received.
TransactionExecuted(txID flow.Identifier, when time.Time)
// TransactionExpired tracks number of expired transactions
TransactionExpired(txID flow.Identifier)
// TransactionSubmissionFailed should be called whenever we try to submit a transaction and it fails
TransactionSubmissionFailed()
}
type PingMetrics interface {
// NodeReachable tracks the round trip time in milliseconds taken to ping a node
// The nodeInfo provides additional information about the node such as the name of the node operator
NodeReachable(node *flow.Identity, nodeInfo string, rtt time.Duration)
// NodeInfo tracks the software version, sealed height and hotstuff view of a node
NodeInfo(node *flow.Identity, nodeInfo string, version string, sealedHeight uint64, hotstuffCurView uint64)
}
type HeroCacheMetrics interface {
// BucketAvailableSlots keeps track of number of available slots in buckets of cache.
BucketAvailableSlots(uint64, uint64)
// OnKeyPutSuccess is called whenever a new (key, entity) pair is successfully added to the cache.
OnKeyPutSuccess()
// OnKeyPutFailure is tracking the total number of unsuccessful writes caused by adding a duplicate key to the cache.
// A duplicate key is dropped by the cache when it is written to the cache.
// Note: in context of HeroCache, the key corresponds to the identifier of its entity. Hence, a duplicate key corresponds to
// a duplicate entity.
OnKeyPutFailure()
// OnKeyGetSuccess tracks total number of successful read queries.
// A read query is successful if the entity corresponding to its key is available in the cache.
// Note: in context of HeroCache, the key corresponds to the identifier of its entity.
OnKeyGetSuccess()
// OnKeyGetFailure tracks total number of unsuccessful read queries.
// A read query is unsuccessful if the entity corresponding to its key is not available in the cache.
// Note: in context of HeroCache, the key corresponds to the identifier of its entity.
OnKeyGetFailure()
// OnEntityEjectionDueToFullCapacity is called whenever adding a new (key, entity) to the cache results in ejection of another (key', entity') pair.
// This normally happens -- and is expected -- when the cache is full.
// Note: in context of HeroCache, the key corresponds to the identifier of its entity.
OnEntityEjectionDueToFullCapacity()
// OnEntityEjectionDueToEmergency is called whenever a bucket is found full and all of its keys are valid, i.e.,
// each key belongs to an existing (key, entity) pair.
// Hence, adding a new key to that bucket will replace the oldest valid key inside that bucket.
// Note: in context of HeroCache, the key corresponds to the identifier of its entity.
OnEntityEjectionDueToEmergency()
}
type DHTMetrics interface {
RoutingTablePeerAdded()
RoutingTablePeerRemoved()
}