ouroboros-consensus:tracing
Safe HaskellNone
LanguageHaskell2010

Ouroboros.Consensus.Tracing.KESInfo

Description

Tracing of the KES key state of a block forging credential.

HasKESInfo and GetKESInfo project the per-block-type ForgeStateUpdateError/ForgeStateInfo onto the block-type-agnostic KESInfo, which is what actually gets traced. They live next to the LogFormatting instances that consume them so that a consumer of this sublibrary gets both from a single import.

Documentation

class HasKESInfo blk where Source #

Minimal complete definition

Nothing

Methods

getKESInfo ∷ Proxy blk → ForgeStateUpdateError blk → Maybe KESInfo Source #

Instances

Instances details
HasKESInfo ByronBlock Source # 
Instance details

Defined in Ouroboros.Consensus.Tracing.KESInfo

Methods

getKESInfo ∷ Proxy ByronBlock → ForgeStateUpdateError ByronBlock → Maybe KESInfo Source #

All HasKESInfo xs ⇒ HasKESInfo (HardForkBlock xs) Source # 
Instance details

Defined in Ouroboros.Consensus.Tracing.KESInfo

Methods

getKESInfo ∷ Proxy (HardForkBlock xs) → ForgeStateUpdateError (HardForkBlock xs) → Maybe KESInfo Source #

HasKESInfo (ShelleyBlock protocol era) Source # 
Instance details

Defined in Ouroboros.Consensus.Tracing.KESInfo

Methods

getKESInfo ∷ Proxy (ShelleyBlock protocol era) → ForgeStateUpdateError (ShelleyBlock protocol era) → Maybe KESInfo Source #

class GetKESInfo blk where Source #

Minimal complete definition

Nothing

Methods

getKESInfoFromStateInfo ∷ Proxy blk → ForgeStateInfo blk → Maybe KESInfo Source #

Instances

Instances details
GetKESInfo ByronBlock Source # 
Instance details

Defined in Ouroboros.Consensus.Tracing.KESInfo

Methods

getKESInfoFromStateInfo ∷ Proxy ByronBlock → ForgeStateInfo ByronBlock → Maybe KESInfo Source #

All GetKESInfo xs ⇒ GetKESInfo (HardForkBlock xs) Source # 
Instance details

Defined in Ouroboros.Consensus.Tracing.KESInfo

Methods

getKESInfoFromStateInfo ∷ Proxy (HardForkBlock xs) → ForgeStateInfo (HardForkBlock xs) → Maybe KESInfo Source #

GetKESInfo (ShelleyBlock protocol era) Source # 
Instance details

Defined in Ouroboros.Consensus.Tracing.KESInfo

Methods

getKESInfoFromStateInfo ∷ Proxy (ShelleyBlock protocol era) → ForgeStateInfo (ShelleyBlock protocol era) → Maybe KESInfo Source #

traceAsKESInfo ∷ ∀ (m ∷ Type → Type) blk. (GetKESInfo blk, MonadIO m) ⇒ Proxy blk → Trace m (TraceLabelCreds KESInfo) → Trace m (TraceLabelCreds (ForgeStateInfo blk)) Source #

Orphan instances

ToJSON KESPeriod Source # 
Instance details

Methods

toJSON ∷ KESPeriod → Value Source #

toEncoding ∷ KESPeriod → Encoding Source #

toJSONList ∷ [KESPeriod] → Value Source #

toEncodingList ∷ [KESPeriod] → Encoding Source #

omitField ∷ KESPeriod → Bool Source #

LogFormatting KESEvolutionError Source # 
Instance details

Methods

forMachine ∷ DetailLevel → KESEvolutionError → Object Source #

forHuman ∷ KESEvolutionError → Text Source #

asMetrics ∷ KESEvolutionError → [Metric] Source #

LogFormatting KESInfo Source # 
Instance details

Methods

forMachine ∷ DetailLevel → KESInfo → Object Source #

forHuman ∷ KESInfo → Text Source #

asMetrics ∷ KESInfo → [Metric] Source #

MetaTrace KESInfo Source # 
Instance details

Methods

namespaceFor ∷ KESInfo → Namespace KESInfo Source #

severityFor ∷ Namespace KESInfo → Maybe KESInfo → Maybe SeverityS Source #

privacyFor ∷ Namespace KESInfo → Maybe KESInfo → Maybe Privacy Source #

detailsFor ∷ Namespace KESInfo → Maybe KESInfo → Maybe DetailLevel Source #

documentFor ∷ Namespace KESInfo → Maybe Text Source #

metricsDocFor ∷ Namespace KESInfo → [(Text, Text)] Source #

allNamespaces ∷ [Namespace KESInfo] Source #