summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authormitchellwrosen <>2014-12-03 06:26:00 (GMT)
committerhdiff <hdiff@hdiff.luite.com>2014-12-03 06:26:00 (GMT)
commite98e3cb6ba45dbb79918d6c15423dd756f1f28bf (patch)
tree73b02ca2406d85f505a45fb98a61d4877d1f1235
version 0.10.1
-rw-r--r--LICENSE165
-rw-r--r--Setup.hs2
-rw-r--r--src/Statsd.hs145
-rw-r--r--statsd.cabal29
4 files changed, 341 insertions, 0 deletions
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..31afd6d
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,165 @@
+ GNU LESSER GENERAL PUBLIC LICENSE
+ Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+ This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+ 0. Additional Definitions.
+
+ As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+ "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+ An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+ A "Combined Work" is a work produced by combining or linking an
+Application with the Library. The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+ The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+ The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+ 1. Exception to Section 3 of the GNU GPL.
+
+ You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+ 2. Conveying Modified Versions.
+
+ If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+ a) under this License, provided that you make a good faith effort to
+ ensure that, in the event an Application does not supply the
+ function or data, the facility still operates, and performs
+ whatever part of its purpose remains meaningful, or
+
+ b) under the GNU GPL, with none of the additional permissions of
+ this License applicable to that copy.
+
+ 3. Object Code Incorporating Material from Library Header Files.
+
+ The object code form of an Application may incorporate material from
+a header file that is part of the Library. You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+ a) Give prominent notice with each copy of the object code that the
+ Library is used in it and that the Library and its use are
+ covered by this License.
+
+ b) Accompany the object code with a copy of the GNU GPL and this license
+ document.
+
+ 4. Combined Works.
+
+ You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+ a) Give prominent notice with each copy of the Combined Work that
+ the Library is used in it and that the Library and its use are
+ covered by this License.
+
+ b) Accompany the Combined Work with a copy of the GNU GPL and this license
+ document.
+
+ c) For a Combined Work that displays copyright notices during
+ execution, include the copyright notice for the Library among
+ these notices, as well as a reference directing the user to the
+ copies of the GNU GPL and this license document.
+
+ d) Do one of the following:
+
+ 0) Convey the Minimal Corresponding Source under the terms of this
+ License, and the Corresponding Application Code in a form
+ suitable for, and under terms that permit, the user to
+ recombine or relink the Application with a modified version of
+ the Linked Version to produce a modified Combined Work, in the
+ manner specified by section 6 of the GNU GPL for conveying
+ Corresponding Source.
+
+ 1) Use a suitable shared library mechanism for linking with the
+ Library. A suitable mechanism is one that (a) uses at run time
+ a copy of the Library already present on the user's computer
+ system, and (b) will operate properly with a modified version
+ of the Library that is interface-compatible with the Linked
+ Version.
+
+ e) Provide Installation Information, but only if you would otherwise
+ be required to provide such information under section 6 of the
+ GNU GPL, and only to the extent that such information is
+ necessary to install and execute a modified version of the
+ Combined Work produced by recombining or relinking the
+ Application with a modified version of the Linked Version. (If
+ you use option 4d0, the Installation Information must accompany
+ the Minimal Corresponding Source and Corresponding Application
+ Code. If you use option 4d1, you must provide the Installation
+ Information in the manner specified by section 6 of the GNU GPL
+ for conveying Corresponding Source.)
+
+ 5. Combined Libraries.
+
+ You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+ a) Accompany the combined library with a copy of the same work based
+ on the Library, uncombined with any other library facilities,
+ conveyed under the terms of this License.
+
+ b) Give prominent notice with the combined library that part of it
+ is a work based on the Library, and explaining where to find the
+ accompanying uncombined form of the same work.
+
+ 6. Revised Versions of the GNU Lesser General Public License.
+
+ The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+ Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+ If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.
diff --git a/Setup.hs b/Setup.hs
new file mode 100644
index 0000000..9a994af
--- /dev/null
+++ b/Setup.hs
@@ -0,0 +1,2 @@
+import Distribution.Simple
+main = defaultMain
diff --git a/src/Statsd.hs b/src/Statsd.hs
new file mode 100644
index 0000000..fd9aa72
--- /dev/null
+++ b/src/Statsd.hs
@@ -0,0 +1,145 @@
+module Statsd
+ (
+ -- * Types
+ StatsdT
+ , Statsd
+ , Bucket
+ , SamplePct
+
+ -- * StatsD API
+ , runStatsd
+ , statsdCounter
+ , statsdSampledCounter
+ , statsdTimer
+ , statsdGauge
+ , statsdGaugePlus
+ , statsdGaugeMinus
+ , statsdSet
+ ) where
+
+import Control.Exception
+import Control.Monad
+import Control.Monad.Reader
+import Control.Monad.Writer
+import Control.Monad.Trans.Control
+import Data.ByteString (ByteString)
+import qualified Data.ByteString.Char8 as BS
+import Network
+import Network.Socket
+import Network.Socket.ByteString (sendAll)
+import System.Random (randomRIO)
+
+-- | The StatsdT monad transformer. Pushing to StatsD occurs in this monad, and
+-- the computation is run with 'runStatsd'.
+newtype StatsdT m a = StatsdT (ReaderT Socket (WriterT [ByteString] 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.
+--
+-- > {-# 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{..}:_ <- getAddrInfo (Just hints) (Just host) (Just service)
+-- > runStatsd addrFamily addrSocketType addrProtocol addrAddress $ do
+-- > statsdCounter "foo" 1
+-- > statsdTimer "bar" 25
+runStatsd :: (MonadBaseControl IO m, MonadIO m)
+ => Family
+ -> SocketType
+ -> ProtocolNumber
+ -> SockAddr
+ -> StatsdT m a -> m a
+runStatsd family socket_type protocol_num sock_addr (StatsdT action) =
+ withSocket family socket_type protocol_num sock_addr $ \sock -> do
+ liftIO (putStrLn $ "sock = " ++ show sock)
+ (a, bss) <- runWriterT (runReaderT action sock)
+ let payload = BS.intercalate "\n" bss
+ liftIO (putStrLn $ "payload = " ++ show payload)
+ liftIO $ sendAll sock payload
+ return a
+
+-- | Push to a StatsD counter.
+--
+-- > statsdCounter "foo" 1 == "foo:1|c"
+statsdCounter :: MonadIO m => Bucket -> Int -> StatsdT m ()
+statsdCounter bucket n = StatsdT . lift . tell $ [encodeSimpleMetric bucket n "c"]
+
+-- | Push to a StatsD counter, sampled.
+--
+-- > statsdSampledCounter "foo" 1 0.5 == "foo:1|c|@0.5"
+statsdSampledCounter :: MonadIO m => Bucket -> Int -> SamplePct -> StatsdT m ()
+statsdSampledCounter bucket n pct = StatsdT $ do
+ r <- liftIO $ randomRIO (0.0, 1.0)
+ when (r <= pct) $
+ lift $ tell [encodeSimpleMetric bucket n "c" <> "|@" <> BS.pack (show pct)]
+
+-- | Push to a StatsD timer.
+--
+-- > statsdTimer "foo" 1 == "foo:1|ms"
+statsdTimer :: MonadIO m => Bucket -> Int -> StatsdT m ()
+statsdTimer bucket n = StatsdT . lift . tell $ [encodeSimpleMetric bucket n "ms"]
+
+-- | Push to a StatsD gauge.
+--
+-- > statsdGauge "foo" 1 == "foo:1|g"
+statsdGauge :: MonadIO m => Bucket -> Int -> StatsdT m ()
+statsdGauge bucket n = StatsdT . lift . tell $ [encodeSimpleMetric bucket n "g"]
+
+-- | Push a positive delta to a StatsD gauge.
+--
+-- > statsdGaugePlus "foo" 1 == "foo:+1|g"
+statsdGaugePlus :: MonadIO m => Bucket -> Int -> StatsdT m ()
+statsdGaugePlus bucket n = StatsdT . lift . tell $ [bucket <> ":+" <> BS.pack (show n) <> "|g"]
+
+-- | Push a negative delta to a StatsD gauge.
+--
+-- > statsdGaugePlus "foo" 1 == "foo:-1|g"
+statsdGaugeMinus :: MonadIO m => Bucket -> Int -> StatsdT m ()
+statsdGaugeMinus bucket n = StatsdT . lift . tell $ [bucket <> ":-" <> BS.pack (show n) <> "|g"]
+
+-- | Push to a StatsD set.
+--
+-- > statsdGaugePlus "foo" 1 == "foo:1|s"
+statsdSet :: MonadIO m => Bucket -> Int -> StatsdT m ()
+statsdSet bucket n = StatsdT . lift . tell $ [encodeSimpleMetric bucket n "s"]
+
+encodeSimpleMetric :: Bucket -> Int -> ByteString -> ByteString
+encodeSimpleMetric bucket n typ = bucket <> ":" <> BS.pack (show n) <> "|" <> typ
+
+withSocket :: MonadBaseControl IO m
+ => Family
+ -> SocketType
+ -> ProtocolNumber
+ -> SockAddr
+ -> (Socket -> m a)
+ -> m a
+withSocket family socket_type protocol_num sock_addr = liftBaseOp (bracket acquire close)
+ where
+ acquire :: IO Socket
+ acquire = do
+ sock <- socket family socket_type protocol_num
+ connect sock sock_addr
+ return sock
diff --git a/statsd.cabal b/statsd.cabal
new file mode 100644
index 0000000..4cdb047
--- /dev/null
+++ b/statsd.cabal
@@ -0,0 +1,29 @@
+name: statsd
+version: 0.1
+synopsis: StatsD API.
+description: This package provides a simple interface to <https://github.com/etsy/statsd/ StatsD>.
+homepage: https://github.com/mitchellwrosen/statsd-haskell
+license: LGPL-3
+license-file: LICENSE
+author: Mitchell Rosen
+maintainer: mitchellwrosen@gmail.com
+copyright: Copyright (C) 2014 Mitchell Rosen
+category: Network
+build-type: Simple
+cabal-version: >=1.10
+
+library
+ exposed-modules: Statsd
+
+ build-depends: base >= 4 && < 5
+ , bytestring >= 0.10 && < 1.0
+ , monad-control >= 0.3 && < 0.4
+ , mtl >= 2.0 && < 2.3
+ , network >= 2.3 && < 3.0
+ , random >= 1.0 && < 2.0
+ hs-source-dirs: src
+ default-language: Haskell2010
+ default-extensions: FlexibleContexts
+ , OverloadedStrings
+ , RankNTypes
+ ghc-options: -Wall