Copyright	(c) Ian Duncan 2013
Stability	experimental
Portability	non-portable
Safe Haskell	Safe-Inferred
Language	Haskell2010

Data.HealthCheck

Description

A simple interface through which simple status dashboards can be built.

import Data.HealthCheck
import Data.Metrics.Reporter.StdOut

healthCheck1 :: HealthCheck
healthCheck1 = healthCheck "benign_warm_fuzzy_thing" $
  return $ StatusReport Good Nothing

healthCheck2 :: HealthCheck
healthCheck2 = healthCheck "nuclear_missile_launcher" $
  return $ StatusReport Ugly $ Just "out of missiles"

main :: IO ()
main = printHealthChecks [ healthCheck1, healthCheck2 ]

Synopsis

data HealthCheck = HealthCheck {
- healthCheckStatusReport :: IO StatusReport
- healthCheckName :: Text
}
type HealthChecks = [HealthCheck]
healthCheck :: Text -> IO StatusReport -> HealthCheck
data Status
- = Good
- | Bad
- | Ugly
- | Unknown
data StatusReport = StatusReport {
- status :: Status
- statusMessage :: Maybe Text
}

Documentation

data HealthCheck Source #

A simple discrete health reporter

Constructors

HealthCheck
Fields healthCheckStatusReport :: IO StatusReport An action which determines the current status of the health check healthCheckName :: Text A unique identifier for the health check

type HealthChecks = [HealthCheck] Source #

Clean up type signatures for bundling sets of health checks for reporting

healthCheck :: Text -> IO StatusReport -> HealthCheck Source #

Create a health check.

data Status Source #

Provides a simple status reporting mechanism for checking application health at a glance.

Constructors

Good	Everything appears to be going well.
Bad	Something is broken.
Ugly	There is some sort of non-critical issue that deserves attention.
Unknown	There is no information, either good or bad, at the moment. An example of this might be something like a loss of network connectivity to a non-crucial service.

Instances

Instances details

Read Status Source #
Instance details Defined in Data.HealthCheck Methods readsPrec :: Int -> ReadS Status # readList :: ReadS [Status] # readPrec :: ReadPrec Status # readListPrec :: ReadPrec [Status] #
Show Status Source #
Instance details Defined in Data.HealthCheck Methods showsPrec :: Int -> Status -> ShowS # show :: Status -> String # showList :: [Status] -> ShowS #
Eq Status Source #
Instance details Defined in Data.HealthCheck Methods (==) :: Status -> Status -> Bool # (/=) :: Status -> Status -> Bool #
Ord Status Source #
Instance details Defined in Data.HealthCheck Methods compare :: Status -> Status -> Ordering # (<) :: Status -> Status -> Bool # (<=) :: Status -> Status -> Bool # (>) :: Status -> Status -> Bool # (>=) :: Status -> Status -> Bool # max :: Status -> Status -> Status # min :: Status -> Status -> Status #

data StatusReport Source #

A report on the current status of a subsystem.

Constructors

StatusReport
Fields status :: Status Current status statusMessage :: Maybe Text An optional message to display about the current status.

Instances

Instances details

Show StatusReport Source #
Instance details Defined in Data.HealthCheck Methods showsPrec :: Int -> StatusReport -> ShowS # show :: StatusReport -> String # showList :: [StatusReport] -> ShowS #