Safe Haskell	Safe-Inferred
Language	Haskell2010

Cardano.Node.Startup

Synopsis

data StartupTrace blk
- = StartupInfo [SocketOrSocketInfo SockAddr SockAddr] (Maybe (SocketOrSocketInfo LocalSocket LocalAddress)) (Map NodeToNodeVersion (BlockNodeToNodeVersion blk)) (Map NodeToClientVersion (BlockNodeToClientVersion blk))
- | StartupP2PInfo DiffusionMode
- | StartupTime UTCTime
- | StartupNetworkMagic NetworkMagic
- | StartupSocketConfigError SocketConfigError
- | StartupDBValidation
- | BlockForgingUpdate EnabledBlockForging
- | BlockForgingUpdateError ProtocolInstantiationError
- | BlockForgingBlockTypeMismatch SomeBlockType SomeBlockType
- | NetworkConfigUpdate
- | NetworkConfigUpdateUnsupported
- | NetworkConfigUpdateError Text
- | NetworkConfigLegacy
- | NetworkConfig [(HotValency, WarmValency, Map RelayAccessPoint PeerAdvertise)] (Map RelayAccessPoint PeerAdvertise) UseLedgerAfter
- | P2PWarning
- | PeerSharingWarning
- | WarningDevelopmentNodeToNodeVersions [NodeToNodeVersion]
- | WarningDevelopmentNodeToClientVersions [NodeToClientVersion]
- | BICommon BasicInfoCommon
- | BIShelley BasicInfoShelleyBased
- | BIByron BasicInfoByron
- | BINetwork BasicInfoNetwork
data EnabledBlockForging
data BasicInfoCommon = BasicInfoCommon {
- biConfigPath :: FilePath
- biNetworkMagic :: NetworkMagic
- biProtocol :: Text
- biVersion :: Text
- biCommit :: Text
- biNodeStartTime :: UTCTime
}
data BasicInfoShelleyBased = BasicInfoShelleyBased {
- bisEra :: Text
- bisSystemStartTime :: UTCTime
- bisSlotLength :: NominalDiffTime
- bisEpochLength :: Word64
- bisSlotsPerKESPeriod :: Word64
}
data BasicInfoByron = BasicInfoByron {
- bibSystemStartTime :: UTCTime
- bibSlotLength :: NominalDiffTime
- bibEpochLength :: Word64
}
data BasicInfoNetwork = BasicInfoNetwork {
- niAddresses :: [SocketOrSocketInfo SockAddr SockAddr]
- niDiffusionMode :: DiffusionMode
- niDnsProducers :: [DnsSubscriptionTarget]
- niIpProducers :: IPSubscriptionTarget
}
data NodeInfo = NodeInfo {
- niName :: Text
- niProtocol :: Text
- niVersion :: Text
- niCommit :: Text
- niStartTime :: UTCTime
- niSystemStartTime :: UTCTime
}
prepareNodeInfo :: NodeConfiguration -> SomeConsensusProtocol -> TraceConfig -> UTCTime -> IO NodeInfo
data NodeStartupInfo = NodeStartupInfo {
- suiEra :: Text
- suiSlotLength :: NominalDiffTime
- suiEpochLength :: Word64
- suiSlotsPerKESPeriod :: Word64
}

Documentation

data StartupTrace blk Source #

Constructors

StartupInfo	Log startup information.
Fields [SocketOrSocketInfo SockAddr SockAddr] node-to-node addresses (Maybe (SocketOrSocketInfo LocalSocket LocalAddress)) node-to-client socket path (Map NodeToNodeVersion (BlockNodeToNodeVersion blk)) supported node-to-node versions (Map NodeToClientVersion (BlockNodeToClientVersion blk)) supported node-to-client versions
StartupP2PInfo DiffusionMode	Log peer-to-peer diffusion mode
StartupTime UTCTime
StartupNetworkMagic NetworkMagic
StartupSocketConfigError SocketConfigError
StartupDBValidation
BlockForgingUpdate EnabledBlockForging	Log that the block forging is being updated
BlockForgingUpdateError ProtocolInstantiationError	Protocol instantiation error when updating block forging
BlockForgingBlockTypeMismatch	Mismatched block type
Fields SomeBlockType expected SomeBlockType provided
NetworkConfigUpdate	Log that the network configuration is being updated.
NetworkConfigUpdateUnsupported	Re-configuration of network config is not supported.
NetworkConfigUpdateError Text	Log network configuration update error.
NetworkConfigLegacy	Legacy topology file format is used.
NetworkConfig [(HotValency, WarmValency, Map RelayAccessPoint PeerAdvertise)] (Map RelayAccessPoint PeerAdvertise) UseLedgerAfter	Log peer-to-peer network configuration, either on startup or when its updated.
P2PWarning	Warn when `EnableP2P` is set.
PeerSharingWarning	Warn when `EnableP2P` is set.
WarningDevelopmentNodeToNodeVersions [NodeToNodeVersion]	Warn when `ExperimentalProtocolsEnabled` is set and affects node-to-node protocol.
WarningDevelopmentNodeToClientVersions [NodeToClientVersion]	Warn when `ExperimentalProtocolsEnabled` is set and affects node-to-client protocol.
BICommon BasicInfoCommon
BIShelley BasicInfoShelleyBased
BIByron BasicInfoByron
BINetwork BasicInfoNetwork

Instances

Instances details

(Show (BlockNodeToNodeVersion blk), Show (BlockNodeToClientVersion blk), ToJSON (BlockNodeToNodeVersion blk), ToJSON (BlockNodeToClientVersion blk)) => Transformable Text IO (StartupTrace blk) Source #
Instance details Defined in Cardano.Tracing.Startup Methods trTransformer :: TracingVerbosity -> Trace IO Text -> Tracer IO (StartupTrace blk) #
HasPrivacyAnnotation (StartupTrace blk) Source #
Instance details Defined in Cardano.Tracing.Startup Methods getPrivacyAnnotation :: StartupTrace blk -> PrivacyAnnotation #
HasSeverityAnnotation (StartupTrace blk) Source #
Instance details Defined in Cardano.Tracing.Startup Methods getSeverityAnnotation :: StartupTrace blk -> Severity #
HasTextFormatter (StartupTrace blk) Source #
Instance details Defined in Cardano.Tracing.Startup Methods formatText :: StartupTrace blk -> Object -> Text #
(Show (BlockNodeToNodeVersion blk), Show (BlockNodeToClientVersion blk), ToJSON (BlockNodeToNodeVersion blk), ToJSON (BlockNodeToClientVersion blk)) => ToObject (StartupTrace blk) Source #
Instance details Defined in Cardano.Tracing.Startup Methods toObject :: TracingVerbosity -> StartupTrace blk -> Object # textTransformer :: StartupTrace blk -> Object -> Text #
(Show (BlockNodeToNodeVersion blk), Show (BlockNodeToClientVersion blk), ToJSON (BlockNodeToNodeVersion blk), ToJSON (BlockNodeToClientVersion blk)) => LogFormatting (StartupTrace blk)
Instance details Defined in Cardano.Node.Tracing.Tracers.Startup Methods forMachine :: DetailLevel -> StartupTrace blk -> Object forHuman :: StartupTrace blk -> Text asMetrics :: StartupTrace blk -> [Metric]
MetaTrace (StartupTrace blk)
Instance details Defined in Cardano.Node.Tracing.Tracers.Startup Methods namespaceFor :: StartupTrace blk -> Namespace (StartupTrace blk) severityFor :: Namespace (StartupTrace blk) -> Maybe (StartupTrace blk) -> Maybe SeverityS privacyFor :: Namespace (StartupTrace blk) -> Maybe (StartupTrace blk) -> Maybe Privacy detailsFor :: Namespace (StartupTrace blk) -> Maybe (StartupTrace blk) -> Maybe DetailLevel documentFor :: Namespace (StartupTrace blk) -> Maybe Text metricsDocFor :: Namespace (StartupTrace blk) -> [(Text, Text)] allNamespaces :: [Namespace (StartupTrace blk)]

data EnabledBlockForging Source #

Constructors

EnabledBlockForging
DisabledBlockForging
NotEffective	one needs to send `SIGHUP` after consensus initialised itself (especially after replying all blocks).

Instances

Instances details

Show EnabledBlockForging Source #
Instance details Defined in Cardano.Node.Startup Methods showsPrec :: Int -> EnabledBlockForging -> ShowS Source # show :: EnabledBlockForging -> String Source # showList :: [EnabledBlockForging] -> ShowS Source #
Eq EnabledBlockForging Source #
Instance details Defined in Cardano.Node.Startup Methods (==) :: EnabledBlockForging -> EnabledBlockForging -> Bool Source # (/=) :: EnabledBlockForging -> EnabledBlockForging -> Bool Source #

data BasicInfoCommon Source #

Constructors

BasicInfoCommon
Fields biConfigPath :: FilePath biNetworkMagic :: NetworkMagic biProtocol :: Text biVersion :: Text biCommit :: Text biNodeStartTime :: UTCTime

data BasicInfoShelleyBased Source #

Constructors

BasicInfoShelleyBased
Fields bisEra :: Text bisSystemStartTime :: UTCTime bisSlotLength :: NominalDiffTime bisEpochLength :: Word64 bisSlotsPerKESPeriod :: Word64

data BasicInfoByron Source #

Constructors

BasicInfoByron
Fields bibSystemStartTime :: UTCTime bibSlotLength :: NominalDiffTime bibEpochLength :: Word64

data BasicInfoNetwork Source #

Constructors

BasicInfoNetwork
Fields niAddresses :: [SocketOrSocketInfo SockAddr SockAddr] niDiffusionMode :: DiffusionMode niDnsProducers :: [DnsSubscriptionTarget] niIpProducers :: IPSubscriptionTarget

data NodeInfo Source #

Constructors

NodeInfo
Fields niName :: Text niProtocol :: Text niVersion :: Text niCommit :: Text niStartTime :: UTCTime niSystemStartTime :: UTCTime

Instances

Instances details

FromJSON NodeInfo Source #
Instance details Defined in Cardano.Node.Startup Methods parseJSON :: Value -> Parser NodeInfo parseJSONList :: Value -> Parser [NodeInfo] omittedField :: Maybe NodeInfo
ToJSON NodeInfo Source #
Instance details Defined in Cardano.Node.Startup Methods toJSON :: NodeInfo -> Value # toEncoding :: NodeInfo -> Encoding toJSONList :: [NodeInfo] -> Value toEncodingList :: [NodeInfo] -> Encoding omitField :: NodeInfo -> Bool
Generic NodeInfo Source #
Instance details Defined in Cardano.Node.Startup Associated Types type Rep NodeInfo :: Type -> Type Source # Methods from :: NodeInfo -> Rep NodeInfo x Source # to :: Rep NodeInfo x -> NodeInfo Source #
Show NodeInfo Source #
Instance details Defined in Cardano.Node.Startup Methods showsPrec :: Int -> NodeInfo -> ShowS Source # show :: NodeInfo -> String Source # showList :: [NodeInfo] -> ShowS Source #
NFData NodeInfo Source #
Instance details Defined in Cardano.Node.Startup Methods rnf :: NodeInfo -> () Source #
Eq NodeInfo Source #
Instance details Defined in Cardano.Node.Startup Methods (==) :: NodeInfo -> NodeInfo -> Bool Source # (/=) :: NodeInfo -> NodeInfo -> Bool Source #
MetaTrace NodeInfo Source #
Instance details Defined in Cardano.Node.Startup Methods namespaceFor :: NodeInfo -> Namespace NodeInfo severityFor :: Namespace NodeInfo -> Maybe NodeInfo -> Maybe SeverityS privacyFor :: Namespace NodeInfo -> Maybe NodeInfo -> Maybe Privacy detailsFor :: Namespace NodeInfo -> Maybe NodeInfo -> Maybe DetailLevel documentFor :: Namespace NodeInfo -> Maybe Text metricsDocFor :: Namespace NodeInfo -> [(Text, Text)] allNamespaces :: [Namespace NodeInfo]
type Rep NodeInfo Source #
Instance details Defined in Cardano.Node.Startup type Rep NodeInfo = D1 ('MetaData "NodeInfo" "Cardano.Node.Startup" "cardano-node-8.7.2-J48sTm7zM1ILYN8ovLbDl2" 'False) (C1 ('MetaCons "NodeInfo" 'PrefixI 'True) ((S1 ('MetaSel ('Just "niName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :: (S1 ('MetaSel ('Just "niProtocol") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :: S1 ('MetaSel ('Just "niVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text))) :: (S1 ('MetaSel ('Just "niCommit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :: (S1 ('MetaSel ('Just "niStartTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UTCTime) :*: S1 ('MetaSel ('Just "niSystemStartTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UTCTime)))))

prepareNodeInfo :: NodeConfiguration -> SomeConsensusProtocol -> TraceConfig -> UTCTime -> IO NodeInfo Source #

Prepare basic info about the node. This info will be sent to 'cardano-tracer'.

data NodeStartupInfo Source #

This information is taken from BasicInfoShelleyBased. It is required for 'cardano-tracer' service (particularly, for RTView).

Constructors

NodeStartupInfo
Fields suiEra :: Text suiSlotLength :: NominalDiffTime suiEpochLength :: Word64 suiSlotsPerKESPeriod :: Word64

Instances

Instances details

FromJSON NodeStartupInfo Source #
Instance details Defined in Cardano.Node.Startup Methods parseJSON :: Value -> Parser NodeStartupInfo parseJSONList :: Value -> Parser [NodeStartupInfo] omittedField :: Maybe NodeStartupInfo
ToJSON NodeStartupInfo Source #
Instance details Defined in Cardano.Node.Startup Methods toJSON :: NodeStartupInfo -> Value # toEncoding :: NodeStartupInfo -> Encoding toJSONList :: [NodeStartupInfo] -> Value toEncodingList :: [NodeStartupInfo] -> Encoding omitField :: NodeStartupInfo -> Bool
Generic NodeStartupInfo Source #
Instance details Defined in Cardano.Node.Startup Associated Types type Rep NodeStartupInfo :: Type -> Type Source # Methods from :: NodeStartupInfo -> Rep NodeStartupInfo x Source # to :: Rep NodeStartupInfo x -> NodeStartupInfo Source #
Show NodeStartupInfo Source #
Instance details Defined in Cardano.Node.Startup Methods showsPrec :: Int -> NodeStartupInfo -> ShowS Source # show :: NodeStartupInfo -> String Source # showList :: [NodeStartupInfo] -> ShowS Source #
NFData NodeStartupInfo Source #
Instance details Defined in Cardano.Node.Startup Methods rnf :: NodeStartupInfo -> () Source #
Eq NodeStartupInfo Source #
Instance details Defined in Cardano.Node.Startup Methods (==) :: NodeStartupInfo -> NodeStartupInfo -> Bool Source # (/=) :: NodeStartupInfo -> NodeStartupInfo -> Bool Source #
MetaTrace NodeStartupInfo Source #
Instance details Defined in Cardano.Node.Startup Methods namespaceFor :: NodeStartupInfo -> Namespace NodeStartupInfo severityFor :: Namespace NodeStartupInfo -> Maybe NodeStartupInfo -> Maybe SeverityS privacyFor :: Namespace NodeStartupInfo -> Maybe NodeStartupInfo -> Maybe Privacy detailsFor :: Namespace NodeStartupInfo -> Maybe NodeStartupInfo -> Maybe DetailLevel documentFor :: Namespace NodeStartupInfo -> Maybe Text metricsDocFor :: Namespace NodeStartupInfo -> [(Text, Text)] allNamespaces :: [Namespace NodeStartupInfo]
type Rep NodeStartupInfo Source #
Instance details Defined in Cardano.Node.Startup type Rep NodeStartupInfo = D1 ('MetaData "NodeStartupInfo" "Cardano.Node.Startup" "cardano-node-8.7.2-J48sTm7zM1ILYN8ovLbDl2" 'False) (C1 ('MetaCons "NodeStartupInfo" 'PrefixI 'True) ((S1 ('MetaSel ('Just "suiEra") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :: S1 ('MetaSel ('Just "suiSlotLength") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 NominalDiffTime)) :: (S1 ('MetaSel ('Just "suiEpochLength") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word64) :*: S1 ('MetaSel ('Just "suiSlotsPerKESPeriod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word64))))