Data.Pickle

Documentation

type Tags = Map Text Text

Tags for DogStatsD. Use empty text for rhs to send a keyed tag with no value. Example: M.fromList [("flag", "")]

data StatsDConfig

Configuration for the UDP connection used

Constructors

StatsDConfig

Fields

• statsdHost :: Text

  Host of statsd server

• statsdPort :: Text

  Port of statsd server

• statsdPrefix :: Text

  Prefix concatenated to all metrics names in our program

• statsdTags :: Tags

  mappend-ed tags for all stats we report

• statsdVerbose :: Bool

  Whether to print all metrics to stdout

type MetricData a = (Show a, Real a)

Something that can be sent as a metric.

defaultConfig :: StatsDConfig

Default config used for StatsD UDP connection ()

setupPickle :: StatsDConfig -> IO ()

Start up our statsd client. You probably want to do this first in main:

main = do

setupPickle defaultConfig ...

Subsequent calls to setupPickle will close the existing connection and create a new one with the updated settings. If multiple threads race to setup the connection, the last one to finish wins.

metric

Arguments

:: MetricData a

=> Text

metric kind in character form (g,c,ms,s)

-> Text

metric name

-> a

metric value

-> Maybe Tags

Tags for metric

-> Maybe Float

Sampling rate for applicable metrics.

-> IO ()

Send a metric. Parses the options together. This function makes a best-effort to send the metric; no metric-sending exceptions will be thrown. The metric won't be sent if setupPickle hasn't been called yet.

gauge :: MetricData a => Text -> a -> Maybe Tags -> IO ()

Send a gauge.

counter :: MetricData a => Text -> a -> Maybe Tags -> Maybe Float -> IO ()

Send a counter.

timer :: MetricData a => Text -> a -> Maybe Tags -> Maybe Float -> IO ()

Send a timer.

showT :: Show a => a -> Text

Internal utility to show something as Text