-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | StatsD API.
--   
@package statsd
@version 0.1

module Statsd

-- | The StatsdT monad transformer. Pushing to StatsD occurs in this monad,
--   and the computation is run with <a>runStatsd</a>.
data StatsdT m a

-- | A simple type alias for pushing to StatsD in IO.
type Statsd a = StatsdT IO a

-- | A StatsD bucket.
type Bucket = ByteString

-- | Counter sample percent. Must be between 0.0 and 1.0, inclusive.
type SamplePct = Double

-- | Run a StatsdT computation, which pushes metrics to StatsD.
--   
--   <pre>
--   {-# LANGUAGE OverloadedStrings #-}
--   {-# LANGUAGE RecordWildCards   #-}
--   
--   module Main where
--   
--   import Network
--   import Network.Socket
--   import Statsd
--   
--   main :: IO ()
--   main = do
--       let hints   = defaultHints
--                       { addrFamily     = AF_INET
--                       , addrSocketType = Datagram
--                       }
--           host    = "localhost"
--           service = "8125"
--   
--       AddrInfo{..}:_ &lt;- getAddrInfo (Just hints) (Just host) (Just service)
--       runStatsd addrFamily addrSocketType addrProtocol addrAddress $ do
--           statsdCounter "foo" 1
--           statsdTimer "bar" 25
--   </pre>
runStatsd :: (MonadBaseControl IO m, MonadIO m) => Family -> SocketType -> ProtocolNumber -> SockAddr -> StatsdT m a -> m a

-- | Push to a StatsD counter.
--   
--   <pre>
--   statsdCounter "foo" 1 == "foo:1|c"
--   </pre>
statsdCounter :: MonadIO m => Bucket -> Int -> StatsdT m ()

-- | Push to a StatsD counter, sampled.
--   
--   <pre>
--   statsdSampledCounter "foo" 1 0.5 == "foo:1|c|@0.5"
--   </pre>
statsdSampledCounter :: MonadIO m => Bucket -> Int -> SamplePct -> StatsdT m ()

-- | Push to a StatsD timer.
--   
--   <pre>
--   statsdTimer "foo" 1 == "foo:1|ms"
--   </pre>
statsdTimer :: MonadIO m => Bucket -> Int -> StatsdT m ()

-- | Push to a StatsD gauge.
--   
--   <pre>
--   statsdGauge "foo" 1 == "foo:1|g"
--   </pre>
statsdGauge :: MonadIO m => Bucket -> Int -> StatsdT m ()

-- | Push a positive delta to a StatsD gauge.
--   
--   <pre>
--   statsdGaugePlus "foo" 1 == "foo:+1|g"
--   </pre>
statsdGaugePlus :: MonadIO m => Bucket -> Int -> StatsdT m ()

-- | Push a negative delta to a StatsD gauge.
--   
--   <pre>
--   statsdGaugePlus "foo" 1 == "foo:-1|g"
--   </pre>
statsdGaugeMinus :: MonadIO m => Bucket -> Int -> StatsdT m ()

-- | Push to a StatsD set.
--   
--   <pre>
--   statsdGaugePlus "foo" 1 == "foo:1|s"
--   </pre>
statsdSet :: MonadIO m => Bucket -> Int -> StatsdT m ()