Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

use pool production tip to compute performance #1168

Merged
merged 5 commits into from
Dec 12, 2019
Merged

use pool production tip to compute performance #1168

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
f68691a
use pool production tip to compute performance
KtorZ Dec 12, 2019
2ee8945
use production tip for computing progress + make computeProgress a pu…
KtorZ Dec 12, 2019
4f11b8b
add unit test to verify progress calculation when failing to list pools
KtorZ Dec 12, 2019
a600b5d
fix prodTip calculation (maximumBy is partial)
KtorZ Dec 12, 2019
31123c5
fix newStakePoolLayer calls after addition of the cache directory
KtorZ Dec 12, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 29 additions & 30 deletions lib/core/src/Cardano/Pool/Metrics.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,8 @@ import Control.Monad.Trans.Except
( ExceptT (..), mapExceptT, runExceptT, throwE, withExceptT )
import Control.Tracer
( contramap )
import Data.Functor
( (<&>) )
import Data.Generics.Internal.VL.Lens
( view, (^.) )
import Data.List
Expand Down Expand Up @@ -139,7 +141,7 @@ data StakePool = StakePool
, stake :: Quantity "lovelace" Word64
, production :: Quantity "block" Word64
, apparentPerformance :: Double
} deriving (Generic)
} deriving (Show, Generic)

--------------------------------------------------------------------------------
-- Stake Pool Monitoring
Expand Down Expand Up @@ -251,6 +253,7 @@ data ErrListStakePools
= ErrMetricsIsUnsynced (Quantity "percent" Percentage)
| ErrListStakePoolsMetricsInconsistency ErrMetricsInconsistency
| ErrListStakePoolsErrNetworkTip ErrNetworkTip
deriving (Show)

newStakePoolLayer
:: Trace IO StakePoolLayerMsg
Expand All @@ -275,22 +278,28 @@ newStakePoolLayer tr db@DBLayer{..} nl metadataDir = StakePoolLayer
let nodeEpoch = nodeTip ^. #slotId . #epochNumber
let genesisEpoch = block0 ^. #header . #slotId . #epochNumber

(distr, prod) <- liftIO . atomically $ (,)
(distr, prod, prodTip) <- liftIO . atomically $ (,,)
<$> (Map.fromList <$> readStakeDistribution nodeEpoch)
<*> (count <$> readPoolProduction nodeEpoch)
<*> readPoolProduction nodeEpoch
<*> readPoolProductionTip

when (Map.null distr || Map.null prod) $ do
computeProgress nodeTip >>= throwE . ErrMetricsIsUnsynced
liftIO $ logTrace tr $ MsgComputedProgress prodTip nodeTip
throwE $ ErrMetricsIsUnsynced $ computeProgress prodTip nodeTip

if nodeEpoch == genesisEpoch
then do
seed <- liftIO $ atomically readSystemSeed
combineWith (sortArbitrarily seed) distr prod mempty
combineWith (sortArbitrarily seed) distr (count prod) mempty

else do
let tip = nodeTip ^. #slotId
perfs <- liftIO $ readPoolsPerformances db epochLength tip
combineWith (pure . sortByPerformance) distr prod perfs
let sl = prodTip ^. #slotId
perfs <- liftIO $ readPoolsPerformances db epochLength sl
combineWith (pure . sortByPerformance) distr (count prod) perfs

readPoolProductionTip = readPoolProductionCursor 1 <&> \case
[] -> header block0
h:_ -> h

-- For each pool, look up its metadata. If metadata could not be found for a
-- pool, the result will be 'Nothing'.
Expand Down Expand Up @@ -330,11 +339,6 @@ newStakePoolLayer tr db@DBLayer{..} nl metadataDir = StakePoolLayer
Left e ->
throwE $ ErrListStakePoolsMetricsInconsistency e

poolProductionTip :: IO (Maybe BlockHeader)
poolProductionTip = atomically $ readPoolProductionCursor 1 >>= \case
[x] -> return $ Just x
_ -> return Nothing

sortByPerformance :: [StakePool] -> [StakePool]
sortByPerformance = sortOn (Down . apparentPerformance)

Expand All @@ -352,20 +356,16 @@ newStakePoolLayer tr db@DBLayer{..} nl metadataDir = StakePoolLayer
StakePool{poolId,stake,production,apparentPerformance}

computeProgress
:: BlockHeader -- ^ The node tip, which respresents 100%.
-> ExceptT e IO (Quantity "percent" Percentage)
computeProgress nodeTip = liftIO $ do
mDbTip <- poolProductionTip
logTrace tr $ MsgComputedProgress mDbTip nodeTip
pure $ Quantity $ maybe minBound (`progress` nodeTip) mDbTip

progress :: BlockHeader -> BlockHeader -> Percentage
progress tip target =
let
s0 = getQuantity $ tip ^. #blockHeight
s1 = getQuantity $ target ^. #blockHeight
in toEnum $ round $ 100 * (toD s0) / (toD s1)
:: BlockHeader -- ^ ... / denominator
-> BlockHeader -- ^ numerator /...
-> Quantity "percent" Percentage
computeProgress prodTip nodeTip =
Quantity $ if s1 == 0
then minBound
else toEnum $ round $ 100 * (toD s0) / (toD s1)
where
s0 = getQuantity $ prodTip ^. #blockHeight
s1 = getQuantity $ nodeTip ^. #blockHeight
toD :: Integral i => i -> Double
toD = fromIntegral

Expand Down Expand Up @@ -586,7 +586,7 @@ data StakePoolLayerMsg
| MsgMetadataUsing PoolId PoolOwner StakePoolMetadata
| MsgMetadataMissing PoolId
| MsgMetadataMultiple PoolId [(PoolOwner, StakePoolMetadata)]
| MsgComputedProgress (Maybe BlockHeader) BlockHeader
| MsgComputedProgress BlockHeader BlockHeader
deriving (Show, Eq)

instance DefinePrivacyAnnotation StakePoolLayerMsg
Expand All @@ -605,14 +605,13 @@ instance ToText StakePoolLayerMsg where
MsgRegistry msg -> toText msg
MsgListStakePoolsBegin -> "Listing stake pools"
MsgMetadataUnavailable -> "Stake pool metadata is unavailable"
MsgComputedProgress (Just dbTip) nodeTip -> mconcat
MsgComputedProgress prodTip nodeTip -> mconcat
[ "The node tip is:\n"
, pretty nodeTip
, ",\nbut the last pool production stored in the db"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not exactly true anymore. prodTip is now the greatest slot stored in the DB, where epoch == nodeTip.epoch.

If the DB were to find itself at a greater slotId than the node this distinction would matter… But that shouldn't be possible.

edit: see other comment which is more concerning

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well, any epoch stored that would be greater than the nodeTip is irrelevant. That the symptoms of a rollback that hasn't yet happened on the database. In practice, the most recent production tip from the node's epoch is our current state.

, " is from:\n"
, pretty dbTip
, pretty prodTip
]
MsgComputedProgress Nothing _nodeTip -> ""
MsgMetadataUsing pid owner _ ->
"Using stake pool metadata from " <>
toText owner <> " for " <> toText pid
Expand Down
71 changes: 65 additions & 6 deletions lib/core/test/unit/Cardano/Pool/MetricsSpec.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,19 +19,24 @@ module Cardano.Pool.MetricsSpec

import Prelude

import Cardano.BM.Data.Tracer
( nullTracer )
import Cardano.Pool.DB
( DBLayer (..) )
import Cardano.Pool.DB.MVar
( newDBLayer )
import Cardano.Pool.Metadata
( StakePoolMetadata (..), sameStakePoolMetadata )
( StakePoolMetadata (..), envVarMetadataRegistry, sameStakePoolMetadata )
import Cardano.Pool.Metrics
( Block (..)
, ErrListStakePools (..)
, StakePoolLayer (..)
, StakePoolLayerMsg (..)
, associateMetadata
, calculatePerformance
, combineMetrics
, monitorStakePools
, newStakePoolLayer
)
import Cardano.Wallet.DummyTarget.Primitive.Types
( genesisParameters )
Expand Down Expand Up @@ -59,7 +64,7 @@ import Cardano.Wallet.Primitive.Types
, slotSucc
)
import Cardano.Wallet.Unsafe
( unsafeFromText )
( unsafeFromText, unsafeRunExceptT )
import Control.Concurrent.Async
( race_ )
import Control.Concurrent.MVar
Expand All @@ -69,7 +74,7 @@ import Control.Monad
import Control.Monad.Trans.Class
( lift )
import Control.Monad.Trans.Except
( ExceptT (..) )
( ExceptT (..), runExceptT )
import Control.Monad.Trans.State.Strict
( StateT, evalStateT, get, modify' )
import Data.Function
Expand All @@ -88,6 +93,8 @@ import Data.Text.Class
( toText )
import Data.Word
( Word32, Word64 )
import System.Environment
( setEnv )
import Test.Hspec
( Spec, describe, it, shouldBe, shouldContain, shouldSatisfy )
import Test.QuickCheck
Expand Down Expand Up @@ -143,6 +150,10 @@ spec = do
it "records all stake pool registrations in the database"
$ property prop_trackRegistrations

describe "listStakePools" $ do
it "can't list on empty database" test_emptyDatabaseNotSynced
it "report correct progress when not synced" test_notSyncedProgress

associateMetadataSpec

{-------------------------------------------------------------------------------
Expand Down Expand Up @@ -326,12 +337,59 @@ prop_trackRegistrations test = monadicIO $ do
pure header0
-- These params are basically unused and completely arbitrary.
, staticBlockchainParameters =
(block0, mockBlockchainParameters
{ getEpochStability = Quantity 2 })
( block0
, mockBlockchainParameters { getEpochStability = Quantity 2 }
)
}

data instance Cursor RegistrationsTest = Cursor BlockHeader

test_emptyDatabaseNotSynced :: IO ()
test_emptyDatabaseNotSynced = do
setEnv envVarMetadataRegistry "-"
db@DBLayer{..} <- newDBLayer
-- NOTE The directory below isn't use, the test should fail much before
let spl = newStakePoolLayer nullTracer db nl "/dev/null"
res <- runExceptT $ listStakePools spl
case res of
Left (ErrMetricsIsUnsynced (Quantity p)) -> p `shouldBe` toEnum 0
_ -> fail $ "got something else than expected: " <> show res
where
nl = mockNetworkLayer
{ networkTip =
pure header0
, staticBlockchainParameters =
( block0
-- v arbitrary but defined.
, mockBlockchainParameters { getEpochLength = EpochLength 10 }
)
}

test_notSyncedProgress :: IO ()
test_notSyncedProgress = do
setEnv envVarMetadataRegistry "-"
db@DBLayer{..} <- newDBLayer
atomically $ unsafeRunExceptT $
putPoolProduction prodTip (PoolId "Pool & The Gang")
-- NOTE The directory below isn't use, the test should fail much before
let spl = newStakePoolLayer nullTracer db nl "/dev/null"
res <- runExceptT $ listStakePools spl
case res of
Left (ErrMetricsIsUnsynced (Quantity p)) -> p `shouldBe` toEnum 33
_ -> fail $ "got something else than expected: " <> show res
where
nodeTip = header0 { blockHeight = Quantity 42 }
prodTip = header0 { blockHeight = Quantity 14 }
nl = mockNetworkLayer
{ networkTip =
pure nodeTip
, staticBlockchainParameters =
( block0
-- v arbitrary but defined.
, mockBlockchainParameters { getEpochLength = EpochLength 10 }
)
}

{-------------------------------------------------------------------------------
Mock Data
-------------------------------------------------------------------------------}
Expand All @@ -354,7 +412,8 @@ mockNetworkLayer = NetworkLayer
\_ -> error "mockNetworkLayer: postTx"
, staticBlockchainParameters =
( error "mockNetworkLayer: genesis block"
, mockBlockchainParameters )
, mockBlockchainParameters
)
, stakeDistribution =
error "mockNetworkLayer: stakeDistribution"
, getAccountBalance =
Expand Down