Prod.Health

Documentation

type HealthApi = GetLivenessApi :<|> (GetReadinessApi :<|> DrainApi)

type GetReadinessApi = Summary "Health readiness probe." :> ("health" :> ("ready" :> Get '[JSON] Readiness))

handleHealth :: Runtime -> Server HealthApi

data Liveness

Constructors

Alive

Instances

ToJSON Liveness

Defined in Prod.Health

Methods

toJSON :: Liveness -> Value

toEncoding :: Liveness -> Encoding

toJSONList :: [Liveness] -> Value

toEncodingList :: [Liveness] -> Encoding

omitField :: Liveness -> Bool

newtype Reason

Constructors

Reason Text

Instances

FromJSON Reason

Defined in Prod.Health

Methods

parseJSON :: Value -> Parser Reason

parseJSONList :: Value -> Parser [Reason]

omittedField :: Maybe Reason

ToJSON Reason

Defined in Prod.Health

Methods

toJSON :: Reason -> Value

toEncoding :: Reason -> Encoding

toJSONList :: [Reason] -> Value

toEncodingList :: [Reason] -> Encoding

omitField :: Reason -> Bool

Show Reason

Defined in Prod.Health

Methods

showsPrec :: Int -> Reason -> ShowS

show :: Reason -> String

showList :: [Reason] -> ShowS

Eq Reason

Defined in Prod.Health

Methods

(==) :: Reason -> Reason -> Bool

(/=) :: Reason -> Reason -> Bool

Ord Reason

Defined in Prod.Health

Methods

compare :: Reason -> Reason -> Ordering

(<) :: Reason -> Reason -> Bool

(<=) :: Reason -> Reason -> Bool

(>) :: Reason -> Reason -> Bool

(>=) :: Reason -> Reason -> Bool

max :: Reason -> Reason -> Reason

min :: Reason -> Reason -> Reason

data Readiness

Constructors

Ready

Ill (Set Reason)

Instances

FromJSON Readiness

Defined in Prod.Health

Methods

parseJSON :: Value -> Parser Readiness

parseJSONList :: Value -> Parser [Readiness]

omittedField :: Maybe Readiness

ToJSON Readiness

Defined in Prod.Health

Methods

toJSON :: Readiness -> Value

toEncoding :: Readiness -> Encoding

toJSONList :: [Readiness] -> Value

toEncodingList :: [Readiness] -> Encoding

omitField :: Readiness -> Bool

Generic Readiness

Defined in Prod.Health

Associated Types

type Rep Readiness :: Type -> Type

Methods

from :: Readiness -> Rep Readiness x

to :: Rep Readiness x -> Readiness

Show Readiness

Defined in Prod.Health

Methods

showsPrec :: Int -> Readiness -> ShowS

show :: Readiness -> String

showList :: [Readiness] -> ShowS

Eq Readiness

Defined in Prod.Health

Methods

(==) :: Readiness -> Readiness -> Bool

(/=) :: Readiness -> Readiness -> Bool

Ord Readiness

Defined in Prod.Health

Methods

compare :: Readiness -> Readiness -> Ordering

(<) :: Readiness -> Readiness -> Bool

(<=) :: Readiness -> Readiness -> Bool

(>) :: Readiness -> Readiness -> Bool

(>=) :: Readiness -> Readiness -> Bool

max :: Readiness -> Readiness -> Readiness

min :: Readiness -> Readiness -> Readiness

type Rep Readiness

Defined in Prod.Health

type Rep Readiness = D1 ('MetaData "Readiness" "Prod.Health" "prodapi-0.1.0.0-JQUOoBQvqFbCBOZ6p0aEZ7" 'False) (C1 ('MetaCons "Ready" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Ill" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Set Reason))))

completeReadiness :: Runtime -> IO Readiness

data Runtime

Constructors

Runtime

Fields

• liveness :: IO Liveness
• readiness :: IO Readiness
• conditions :: IORef (Set Reason)
• tracer :: Tracer IO Track

alwaysReadyRuntime :: Tracer IO Track -> IO Runtime

withLiveness :: IO Liveness -> Runtime -> Runtime

withReadiness :: IO Readiness -> Runtime -> Runtime

data Track

Constructors

Afflict CallStack Reason

Cure CallStack Reason

Instances

Show Track

Defined in Prod.Health

Methods

showsPrec :: Int -> Track -> ShowS

show :: Track -> String

showList :: [Track] -> ShowS