Web.Moonshine

Documentation

data Moonshine a

The moonshine monad.

Instances

Monad Moonshine

Functor Moonshine

Applicative Moonshine

MonadIO Moonshine

runMoonshine :: Moonshine a -> IO a

Execute an insance of the Moonshine monad. This starts up a server and never returns.

route :: [(ByteString, Moonshine ())] -> Moonshine ()

Like route, but that automatically sets up metrics for the specified routes.

makeTimer :: Text -> Moonshine Timer

Make a new timer with the given name.

timerAdd :: (Real time, MonadIO io) => Timer -> time -> io ()

Add a time to a timer.

data Timer

The Timer type.

timed

Arguments

:: Text

The name of the timer.

-> Moonshine a

The action to be wrapped.

-> Moonshine a

Wrap a Moonshine in a timer, so that timing data for invocations will be logged to the metrics handler.

liftSnap :: Snap () -> Moonshine ()

Lifts a snap action into a moonshine action.

liftIO :: MonadIO m => forall a. IO a -> m a

Lift a computation from the IO monad.

setBanner :: String -> IO ()

Sets the banner that moonshine should display on startup.

timedIO :: MonadIO io => Timer -> io a -> io a

Time how long it takes to perform some kind of IO. This function is compatible with any MonadIO.

makeGauge :: Text -> Moonshine Gauge

Create a new gauge with the given name.

gaugeInc :: MonadIO io => Gauge -> io ()

Add one to a gauge value.

gaugeDec :: MonadIO io => Gauge -> io ()

Subtract one from a gauge value.

gaugeSet :: MonadIO io => Gauge -> Int64 -> io ()

Set the gauge the a specific value one from a gauge value.

gaugeAdd :: MonadIO io => Gauge -> Int64 -> io ()

Add a value to a gauge.

gaugeSubtract :: MonadIO io => Gauge -> Int64 -> io ()

Subtrace a value from a gauge.

data Gauge

The Gauge type.