-
Notifications
You must be signed in to change notification settings - Fork 721
/
API.hs
402 lines (372 loc) · 17.1 KB
/
API.hs
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
{-# LANGUAGE DeriveAnyClass #-}
{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE ImportQualifiedPost #-}
{-# LANGUAGE LambdaCase #-}
{-# LANGUAGE RecordWildCards #-}
{-# OPTIONS_GHC -Wno-name-shadowing #-}
{- HLINT ignore "Use head" -}
module Cardano.Analysis.API (module Cardano.Analysis.API) where
import Prelude ((!!), error)
import Cardano.Prelude hiding (head)
import Data.Aeson (ToJSON(..), FromJSON(..))
import Data.List.Split (splitOn)
import Data.Text qualified as T
import Data.Text.Short (toText)
import Data.Time.Clock (NominalDiffTime)
import Data.Time (UTCTime)
import Text.Printf (PrintfArg, printf)
import Cardano.Slotting.Slot (EpochNo(..), SlotNo(..))
import Ouroboros.Network.Block (BlockNo(..))
import Cardano.Analysis.ChainFilter
import Cardano.Analysis.Profile
import Cardano.Analysis.Version
import Cardano.Logging.Resources.Types
import Cardano.Unlog.LogObject hiding (Text)
import Cardano.Unlog.Render
import Data.Distribution
--
-- * API types
--
-- | Results of block propagation analysis.
data BlockPropagation
= BlockPropagation
{ bpVersion :: !Version
, bpSlotRange :: !(SlotNo, SlotNo) -- ^ Analysis range, inclusive.
, bpForgerForges :: !(Distribution Float NominalDiffTime)
, bpForgerAdoptions :: !(Distribution Float NominalDiffTime)
, bpForgerAnnouncements :: !(Distribution Float NominalDiffTime)
, bpForgerSends :: !(Distribution Float NominalDiffTime)
, bpPeerNotices :: !(Distribution Float NominalDiffTime)
, bpPeerRequests :: !(Distribution Float NominalDiffTime)
, bpPeerFetches :: !(Distribution Float NominalDiffTime)
, bpPeerAdoptions :: !(Distribution Float NominalDiffTime)
, bpPeerAnnouncements :: !(Distribution Float NominalDiffTime)
, bpPeerSends :: !(Distribution Float NominalDiffTime)
, bpPropagation :: ![(Float, Distribution Float NominalDiffTime)]
, bpSizes :: !(Distribution Float Int)
, bpChainBlockEvents :: [BlockEvents]
}
deriving (Generic, FromJSON, ToJSON, Show)
-- | All events related to a block.
data BlockEvents
= BlockEvents
{ beBlock :: !Hash
, beBlockPrev :: !Hash
, beBlockNo :: !BlockNo
, beSlotNo :: !SlotNo
, beEpochNo :: !EpochNo
, beForge :: !BlockForge
, beObservations :: [BlockObservation]
, bePropagation :: !(Distribution Float NominalDiffTime)
-- ^ CDF of slot-start-to-adoptions on cluster
, beOtherBlocks :: [Hash]
, beErrors :: [BPError]
}
deriving (Generic, FromJSON, ToJSON, Show)
data BlockForge
= BlockForge
{ bfForger :: !Host
, bfSlotStart :: !SlotStart
, bfBlockGap :: !NominalDiffTime -- ^ Since previous forge event
, bfBlockSize :: !Int -- ^ Bytes
, bfForged :: !NominalDiffTime -- ^ Since slot start
, bfAdopted :: !NominalDiffTime -- ^ Since forging
, bfChainDelta :: !Int -- ^ ChainDelta during adoption
, bfAnnounced :: !NominalDiffTime -- ^ Since adoption
, bfSending :: !NominalDiffTime -- ^ Since announcement
}
deriving (Generic, FromJSON, ToJSON, Show)
data BlockObservation
= BlockObservation
{ boObserver :: !Host
, boSlotStart :: !SlotStart
, boNoticed :: !NominalDiffTime -- ^ Since slot start
, boRequested :: !NominalDiffTime -- ^ Since noticing
, boFetched :: !NominalDiffTime -- ^ Since requesting
, boAdopted :: !(Maybe NominalDiffTime) -- ^ Since fetching
, boChainDelta :: !Int -- ^ ChainDelta during adoption
, boAnnounced :: !(Maybe NominalDiffTime) -- ^ Since adoption
, boSending :: !(Maybe NominalDiffTime) -- ^ Since announcement
, boErrors :: [BPError]
}
deriving (Generic, FromJSON, ToJSON, Show)
data BPError
= BPError
{ eHost :: !Host
, eBlock :: !Hash
, eLO :: !(Maybe LogObject)
, eDesc :: !BPErrorKind
}
deriving (FromJSON, Generic, NFData, Show, ToJSON)
data Phase
= Notice
| Request
| Fetch
| Forge
| Acquire
| Adopt
| Announce
| Send
deriving (FromJSON, Eq, Generic, NFData, Ord, Show, ToJSON)
data BPErrorKind
= BPEBefore !Phase !Phase
| BPEUnexpectedForObserver !Phase
| BPEUnexpectedForForger !Phase
| BPEUnexpectedAsFirst !Phase
| BPEDuplicateForge
| BPEMissingPhase !Phase
| BPENegativePhase !Phase !NominalDiffTime
| BPEFork !Hash
deriving (FromJSON, Generic, NFData, Show, ToJSON)
data DataDomain
= DataDomain
{ ddRawSlotFirst :: !SlotNo
, ddRawSlotLast :: !SlotNo
, ddAnalysisSlotFirst :: !SlotNo
, ddAnalysisSlotLast :: !SlotNo
}
deriving (Generic, Show, ToJSON)
-- Perhaps: Plutus.V1.Ledger.Slot.SlotRange = Interval Slot
-- | The top-level representation of the machine timeline analysis results.
data MachTimeline
= MachTimeline
{ sVersion :: !Version
, sSlotRange :: (SlotNo, SlotNo) -- ^ Analysis range, inclusive.
, sMaxChecks :: !Word64
, sSlotMisses :: ![Word64]
, sSpanLensCPU85 :: ![Int]
, sSpanLensCPU85EBnd :: ![Int]
, sSpanLensCPU85Rwd :: ![Int]
-- distributions
, sMissDistrib :: !(Distribution Float Float)
, sLeadsDistrib :: !(Distribution Float Word64)
, sUtxoDistrib :: !(Distribution Float Word64)
, sDensityDistrib :: !(Distribution Float Float)
, sSpanCheckDistrib :: !(Distribution Float NominalDiffTime)
, sSpanLeadDistrib :: !(Distribution Float NominalDiffTime)
, sBlocklessDistrib :: !(Distribution Float Word64)
, sSpanLensCPU85Distrib
:: !(Distribution Float Int)
, sSpanLensCPU85EBndDistrib :: !(Distribution Float Int)
, sSpanLensCPU85RwdDistrib :: !(Distribution Float Int)
, sResourceDistribs :: !(Resources (Distribution Float Word64))
}
deriving (Generic, Show, ToJSON)
data SlotStats
= SlotStats
{ slSlot :: !SlotNo
, slEpoch :: !Word64
, slEpochSlot :: !Word64
, slStart :: !SlotStart
, slCountChecks :: !Word64
, slCountLeads :: !Word64
, slChainDBSnap :: !Word64
, slRejectedTx :: !Word64
, slBlockNo :: !Word64
, slBlockless :: !Word64
, slOrderViol :: !Word64
, slEarliest :: !UTCTime
, slSpanCheck :: !NominalDiffTime
, slSpanLead :: !NominalDiffTime
, slMempoolTxs :: !Word64
, slTxsMemSpan :: !(Maybe NominalDiffTime)
, slTxsCollected :: !Word64
, slTxsAccepted :: !Word64
, slTxsRejected :: !Word64
, slUtxoSize :: !Word64
, slDensity :: !Float
, slResources :: !(Resources (Maybe Word64))
}
deriving (Generic, Show, ToJSON)
--
-- * Key properties
--
testBlockEvents :: Profile -> BlockEvents -> ChainFilter -> Bool
testBlockEvents Profile{genesis=GenesisProfile{..}}
BlockEvents{beForge=BlockForge{..},..} = \case
CBlock flt -> case flt of
BUnitaryChainDelta -> bfChainDelta == 1
BFullnessGEq f ->
bfBlockSize > floor ((fromIntegral max_block_size :: Double) * f)
BFullnessLEq f ->
bfBlockSize < floor ((fromIntegral max_block_size :: Double) * f)
BSizeGEq x -> bfBlockSize >= fromIntegral x
BSizeLEq x -> bfBlockSize <= fromIntegral x
CSlot flt -> case flt of
SlotGEq s -> beSlotNo >= s
SlotLEq s -> beSlotNo <= s
EpochGEq e -> beEpochNo >= e
EpochLEq e -> beEpochNo <= e
_ -> True
isValidBlockEvent :: Profile -> [ChainFilter] -> BlockEvents -> Bool
isValidBlockEvent p criteria be =
all (testBlockEvents p be) criteria
isValidBlockObservation :: BlockObservation -> Bool
isValidBlockObservation BlockObservation{..} =
-- 1. All phases are present
null boErrors
&&
-- 2. All timings account for processing of a single block
boChainDelta == 1
testSlotStats :: Profile -> SlotStats -> SlotCond -> Bool
testSlotStats Profile{genesis=GenesisProfile{}}
SlotStats{..} = \case
SlotGEq s -> slSlot >= s
SlotLEq s -> slSlot <= s
EpochGEq s -> fromIntegral slEpoch >= s
EpochLEq s -> fromIntegral slEpoch <= s
SlotHasLeaders -> slCountLeads > 0
--
-- * Timeline rendering instances
--
instance RenderDistributions BlockPropagation where
rdFields _ =
-- Width LeftPad
[ Field 6 0 "forged" (f!!0) "Forge" $ DDeltaT bpForgerForges
, Field 6 0 "fAdopted" (f!!1) "Adopt" $ DDeltaT bpForgerAdoptions
, Field 6 0 "fAnnounced" (f!!2) "Announ" $ DDeltaT bpForgerAnnouncements
, Field 6 0 "fSendStart" (f!!3) "Sendin" $ DDeltaT bpForgerSends
, Field 5 0 "noticedVal" (p!!0) "Notic" $ DDeltaT bpPeerNotices
, Field 5 0 "requestedVal" (p!!1) "Reque" $ DDeltaT bpPeerRequests
, Field 5 0 "fetchedVal" (p!!2) "Fetch" $ DDeltaT bpPeerFetches
, Field 5 0 "pAdoptedVal" (p!!3) "Adopt" $ DDeltaT bpPeerAdoptions
, Field 5 0 "pAnnouncedVal" (p!!4) "Annou" $ DDeltaT bpPeerAnnouncements
, Field 5 0 "pSendStartVal" (p!!5) "Send" $ DDeltaT bpPeerSends
] ++
[ Field 5 0 "propagation" (r!!i)
(T.take 4 $ T.pack $ printf "%.04f" ps)
(DDeltaT ((\(ps', d) ->
if ps' == ps then d
else error $ printf "Percspec mismatch: [%d]: exp=%f act=%f" i ps ps')
. fromMaybe
(error $ printf "No percentile %d/%f in bpPropagation." i ps)
. flip atMay i . bpPropagation))
| (i, Perc ps) <- zip [0::Int ..] (adoptionPcts <> [Perc 1.0]) ] ++
[ Field 9 0 "sizes" "Size" "bytes" $ DInt bpSizes
]
where
f = nChunksEachOf 4 7 "Forger event Δt:"
p = nChunksEachOf 6 6 "Peer event Δt:"
r = nChunksEachOf aLen 6 "Slot-rel. Δt to adoption centile:"
aLen = length adoptionPcts + 1 -- +1 is for the implied 1.0 percentile
adoptionPcts :: [PercSpec Float]
adoptionPcts =
[ Perc 0.5, Perc 0.8, Perc 0.9, Perc 0.92, Perc 0.94, Perc 0.96, Perc 0.98 ]
instance RenderTimeline BlockEvents where
rtFields _ =
-- Width LeftPad
[ Field 5 0 "block" "block" "no." $ IWord64 (unBlockNo . beBlockNo)
, Field 5 0 "abs.slot" "abs." "slot#" $ IWord64 (unSlotNo . beSlotNo)
, Field 6 0 "hash" "block" "hash" $ IText (shortHash . beBlock)
, Field 6 0 "hashPrev" "prev" "hash" $ IText (shortHash . beBlockPrev)
, Field 7 0 "forger" "forger" "host" $ IText (toText . unHost . bfForger . beForge)
, Field 9 0 "blockSize" "size" "bytes" $ IInt (bfBlockSize . beForge)
, Field 7 0 "blockGap" "block" "gap" $ IDeltaT (bfBlockGap . beForge)
, Field 3 0 "forks" "for" "-ks" $ IInt (count bpeIsFork . beErrors)
, Field 6 0 "forged" (f!!0) "Forge" $ IDeltaT (bfForged . beForge)
, Field 6 0 "fAdopted" (f!!1) "Adopt" $ IDeltaT (bfAdopted . beForge)
, Field 6 0 "fAnnounced" (f!!2) "Announ" $ IDeltaT (bfAnnounced . beForge)
, Field 6 0 "fSendStart" (f!!3) "Sendin" $ IDeltaT (bfSending . beForge)
, Field 5 0 "valid.observ" "valid" "obsrv" $ IInt (length . valids)
, Field 5 0 "noticedVal" (p!!0) "Notic" $ IDeltaT (af boNoticed . valids)
, Field 5 0 "requestedVal" (p!!1) "Requd" $ IDeltaT (af boRequested . valids)
, Field 5 0 "fetchedVal" (p!!2) "Fetch" $ IDeltaT (af boFetched . valids)
, Field 5 0 "pAdoptedVal" (p!!3) "Adopt" $ IDeltaT (af' boAdopted . valids)
, Field 5 0 "pAnnouncedVal" (p!!4) "Annou" $ IDeltaT (af' boAnnounced . valids)
, Field 5 0 "pSendStartVal" (p!!5) "Send" $ IDeltaT (af' boSending . valids)
, Field 5 0 "pPropag0.5" (r!!0) "0.5" $ IDeltaT (percSpec 0.5 . bePropagation)
, Field 5 0 "pPropag0.96" (r!!1) "0.96" $ IDeltaT (percSpec 0.96 . bePropagation)
, Field 5 0 "pPropag1.0" (r!!2) "1.0" $ IDeltaT (percSpec 1.0 . bePropagation)
, Field 5 0 "errors" "all" "errs" $ IInt (length . beErrors)
, Field 3 0 "missAdopt" (m!!0) "ado" $ IInt (count (bpeIsMissing Adopt) . beErrors)
, Field 3 0 "missAnnou" (m!!1) "ann" $ IInt (count (bpeIsMissing Announce) . beErrors)
, Field 3 0 "missSend" (m!!2) "snd" $ IInt (count (bpeIsMissing Send) . beErrors)
, Field 3 0 "negAnnou" (n!!0) "ann" $ IInt (count (bpeIsNegative Announce) . beErrors)
, Field 3 0 "negSend" (n!!1) "snd" $ IInt (count (bpeIsNegative Send) . beErrors)
]
where
valids = filter isValidBlockObservation . beObservations
f = nChunksEachOf 4 7 "Forger event Δt:"
p = nChunksEachOf 6 6 "Peer event Δt averages:"
r = nChunksEachOf 3 6 "Propagation Δt:"
m = nChunksEachOf 3 4 "Missing"
n = nChunksEachOf 2 4 "Negative"
percSpec :: Float -> Distribution Float NominalDiffTime -> NominalDiffTime
percSpec ps d = dPercSpec (Perc ps) d
& fromMaybe (error $ printf "No percentile %f in distribution." ps)
af f = avg . fmap f
af' f = avg . mapMaybe f
avg :: [NominalDiffTime] -> NominalDiffTime
avg [] = 0
avg xs = (/ fromInteger (fromIntegral $ length xs)) $ sum xs
count :: (a -> Bool) -> [a] -> Int
count f = length . filter f
bpeIsFork :: BPError -> Bool
bpeIsFork BPError{eDesc=BPEFork{}} = True
bpeIsFork _ = False
bpeIsMissing, bpeIsNegative :: Phase -> BPError -> Bool
bpeIsMissing p BPError{eDesc=BPEMissingPhase p'} = p == p'
bpeIsMissing _ _ = False
bpeIsNegative p BPError{eDesc=BPENegativePhase p' _} = p == p'
bpeIsNegative _ _ = False
rtCommentary BlockEvents{..} = (" " <>) . show <$> beErrors
instance RenderTimeline SlotStats where
rtFields _ =
-- Width LeftPad
[ Field 5 0 "abs.slot" "abs." "slot#" $ IWord64 (unSlotNo . slSlot)
, Field 4 0 "slot" " epo" "slot" $ IWord64 slEpochSlot
, Field 2 0 "epoch" "ch " "#" $ IWord64 slEpoch
, Field 5 0 "block" "block" "no." $ IWord64 slBlockNo
, Field 5 0 "blockGap" "block" "gap" $ IWord64 slBlockless
, Field 3 0 "leadChecks" "lead" "chk" $ IWord64 slCountChecks
, Field 3 0 "leadShips" "ship" "win" $ IWord64 slCountLeads
, Field 4 0 "CDBSnap" "CDB" "snap" $ IWord64 slChainDBSnap
, Field 3 0 "rejTxs" "rej" "txs" $ IWord64 slRejectedTx
, Field 7 0 "checkSpan" "check" "span" $ IDeltaT slSpanCheck
, Field 5 0 "leadSpan" "lead" "span" $ IDeltaT slSpanLead
, Field 4 0 "mempoolTxSpan" (t 4!!0) "span" $ IText (maybe "" show.slTxsMemSpan)
, Field 4 0 "txsColl" (t 4!!1) "cold" $ IWord64 slTxsCollected
, Field 4 0 "txsAcc" (t 4!!2) "accd" $ IWord64 slTxsAccepted
, Field 4 0 "txsRej" (t 4!!3) "rejd" $ IWord64 slTxsRejected
, Field 5 1 "chDensity" "chain" "dens." $ IFloat slDensity
, Field 3 0 "CPU%" (c 3!!0) "all" $ IText (d 3.rCentiCpu.slResources)
, Field 3 0 "GC%" (c 3!!1) "GC" $ IText (d 3.fmap (min 999).rCentiGC.slResources)
, Field 3 0 "MUT%" (c 3!!2) "mut" $ IText (d 3.fmap (min 999).rCentiMut.slResources)
, Field 3 0 "majFlt" (g 3!!0) "maj" $ IText (d 3.rGcsMajor.slResources)
, Field 3 0 "minFlt" (g 3!!1) "min" $ IText (d 3.rGcsMinor.slResources)
, Field 6 0 "productiv" "Produc" "tivity" $ IText
(\SlotStats{..}->
f 4 $ calcProd <$> (min 6 . -- workaround for ghc-8.10.2
fromIntegral <$> rCentiMut slResources :: Maybe Float)
<*> (fromIntegral <$> rCentiCpu slResources))
, Field 5 0 "rssMB" (m 5!!0) "RSS" $ IText (d 5.rRSS .slResources)
, Field 5 0 "heapMB" (m 5!!1) "Heap" $ IText (d 5.rHeap .slResources)
, Field 5 0 "liveMB" (m 5!!2) "Live" $ IText (d 5.rLive .slResources)
, Field 5 0 "allocatedMB" "Allocd" "MB" $ IText (d 5.rAlloc.slResources)
, Field 6 0 "allocMut" "Alloc/" "mutSec" $ IText
(\SlotStats{..}->
d 5 $
(ceiling :: Float -> Int)
<$> ((/) <$> (fromIntegral . (100 *) <$> rAlloc slResources)
<*> (fromIntegral . max 1 . (1024 *) <$> rCentiMut slResources)))
, Field 7 0 "mempoolTxs" "Mempool" "txs" $ IWord64 slMempoolTxs
, Field 9 0 "utxoEntries" "UTxO" "entries" $ IWord64 slUtxoSize
, Field 10 0 "absSlotTime" "Absolute" "slot time" $ IText
(\SlotStats{..}->
T.pack $ " " `splitOn` show slStart !! 1)
]
where
t w = nChunksEachOf 4 (w + 1) "mempool tx"
c w = nChunksEachOf 3 (w + 1) "%CPU"
g w = nChunksEachOf 2 (w + 1) "GCs"
m w = nChunksEachOf 3 (w + 1) "Memory use, MB"
d, f :: PrintfArg a => Int -> Maybe a -> Text
d width = \case
Just x -> T.pack $ printf ("%"<>"" --(if exportMode then "0" else "")
<>show width<>"d") x
Nothing -> mconcat (replicate width "-")
f width = \case
Just x -> T.pack $ printf ("%0."<>show width<>"f") x
Nothing -> mconcat (replicate width "-")
calcProd :: Float -> Float -> Float
calcProd mut' cpu' = if cpu' == 0 then 1 else mut' / cpu'