Prod.Status

Documentation

type StatusApi a = "status" :> Get '[HTML, JSON] (Status a)

type RenderStatus a = Status a -> Html ()

Type to render a status page.

defaultStatusPage :: forall a. (a -> Html ()) -> RenderStatus a

metricsSection :: MetricsJSurl -> RenderStatus a

Section with metrics.

versionsSection :: [(String, Version)] -> RenderStatus a

statusPage :: ToHtml a => RenderStatus a

Like defaultStatusPage but uses a type-class-defined to pass the application-status rendering.

handleStatus :: Runtime -> IO a -> RenderStatus a -> Handler (Status a)

data Status a

Constructors

Status

Fields

• identification :: !Identification
• liveness :: !Liveness
• readiness :: !Readiness
• appStatus :: !a
• renderer :: RenderStatus a

Instances

MimeRender HTML (Status a)

Defined in Prod.Status

Methods

mimeRender :: Proxy HTML -> Status a -> ByteString

ToJSON a => ToJSON (Status a)

Defined in Prod.Status

Methods

toJSON :: Status a -> Value

toEncoding :: Status a -> Encoding

toJSONList :: [Status a] -> Value

toEncodingList :: [Status a] -> Encoding

omitField :: Status a -> Bool

newtype Identification

Constructors

Identification Text

Instances

ToJSON Identification

Defined in Prod.Status

Methods

toJSON :: Identification -> Value

toEncoding :: Identification -> Encoding

toJSONList :: [Identification] -> Value

toEncodingList :: [Identification] -> Encoding

omitField :: Identification -> Bool

this :: Identification