Network.StatsD.Datadog

DogStatsD accepts custom application metrics points over UDP, and then periodically aggregates and forwards the metrics to Datadog, where they can be graphed on dashboards. The data is sent by using a client library such as this one that communicates with a DogStatsD server.

Client interface

data DogStatsSettings

Constructors

DogStatsSettings

Fields

• dogStatsSettingsHost :: HostName

  The hostname or IP of the DogStatsD server (default: 127.0.0.1)

• dogStatsSettingsPort :: !Int

  The port that the DogStatsD server is listening on (default: 8125)

• dogStatsSettingsBufferSize :: !Int

  Maximum buffer size. Stats are sent over UDP, so the maximum possible value is 65507 bytes per packet. In some scenarios, however, you may wish to send smaller packets. (default: 65507)

• dogStatsSettingsMaxDelay :: !Int

  Maximum amount of time (in microseconds) between having no stats to send locally and when new stats will be sent to the statsd server. (default: 1 second)

• dogStatsSettingsOnException :: SomeException -> Seq ByteString -> IO (Seq ByteString -> Seq ByteString)

  Handler to recover from exceptions thrown while sending stats to the server. Caution: Throwing an exception from this handler will shut down the worker that sends stats to the server, but is not able to prevent you from enqueuing stats via the client. Default: print the exception and throw away any accumulated stats.

Instances

HasPort DogStatsSettings Int

Defined in Network.StatsD.Datadog

Methods

port :: Lens' DogStatsSettings Int

HasMaxDelay DogStatsSettings Int

Defined in Network.StatsD.Datadog

Methods

maxDelay :: Lens' DogStatsSettings Int

HasHost DogStatsSettings HostName

Defined in Network.StatsD.Datadog

Methods

host :: Lens' DogStatsSettings HostName

HasBufferSize DogStatsSettings Int

Defined in Network.StatsD.Datadog

Methods

bufferSize :: Lens' DogStatsSettings Int

HasOnException DogStatsSettings (SomeException -> Seq ByteString -> IO (Seq ByteString -> Seq ByteString))

Defined in Network.StatsD.Datadog

Methods

onException :: Lens' DogStatsSettings (SomeException -> Seq ByteString -> IO (Seq ByteString -> Seq ByteString))

defaultSettings :: DogStatsSettings

withDogStatsD :: MonadUnliftIO m => DogStatsSettings -> (StatsClient -> m a) -> m a

Create a StatsClient and provide it to the provided function. The StatsClient will be finalized as soon as the inner block is exited, whether normally or via an exception.

mkStatsClient :: MonadIO m => DogStatsSettings -> m StatsClient

Create a stats client. Be sure to close it with finalizeStatsClient in order to send any pending stats and close the underlying handle when done using it. Alternatively, use withDogStatsD to finalize it automatically.

finalizeStatsClient :: MonadIO m => StatsClient -> m ()

Send all pending unsent events and close the connection to the specified statsd server.

send :: (MonadIO m, ToStatsD v) => StatsClient -> v -> m ()

Send a Metric, Event, or StatusCheck to the DogStatsD server.

Since UDP is used to send the events, there is no ack that sent values are successfully dealt with.

withDogStatsD defaultSettings $ \client -> do
  send client $ event "Wombat attack" "A host of mighty wombats has breached the gates"
  send client $ metric "wombat.force_count" Gauge (9001 :: Int)
  send client $ serviceCheck "Wombat Radar" ServiceOk

Data supported by DogStatsD

metric :: ToMetricValue a => MetricName -> MetricType -> a -> Metric

Smart Metric constructor. Use the lens functions to set the optional fields.

data Metric

Metric

The fields accessible through corresponding lenses are:

• name :: MetricName
• sampleRate :: Double
• type' :: MetricType
• value :: ToMetricValue a => a
• tags :: [Tag]

Instances

ToStatsD Metric

Defined in Network.StatsD.Datadog

Methods

toStatsD :: Metric -> Utf8Builder ()

HasType' Metric MetricType

Defined in Network.StatsD.Datadog

Methods

type' :: Lens' Metric MetricType

HasSampleRate Metric Double

Defined in Network.StatsD.Datadog

Methods

sampleRate :: Lens' Metric Double

HasName Metric MetricName

Defined in Network.StatsD.Datadog

Methods

name :: Lens' Metric MetricName

HasTags Metric [Tag]

Defined in Network.StatsD.Datadog

Methods

tags :: Lens' Metric [Tag]

newtype MetricName

Constructors

MetricName

Fields

• fromMetricName :: Text

Instances

HasName Metric MetricName

Defined in Network.StatsD.Datadog

Methods

name :: Lens' Metric MetricName

data MetricType

Constructors

Gauge

Gauges measure the value of a particular thing at a particular time, like the amount of fuel in a car’s gas tank or the number of users connected to a system.

Counter

Counters track how many times something happened per second, like the number of database requests or page views.

Timer

StatsD only supports histograms for timing, not generic values (like the size of uploaded files or the number of rows returned from a query). Timers are essentially a special case of histograms, so they are treated in the same manner by DogStatsD for backwards compatibility.

Histogram

Histograms track the statistical distribution of a set of values, like the duration of a number of database queries or the size of files uploaded by users. Each histogram will track the average, the minimum, the maximum, the median and the 95th percentile.

Set

Sets are used to count the number of unique elements in a group. If you want to track the number of unique visitor to your site, sets are a great way to do that.

Instances

HasType' Metric MetricType

Defined in Network.StatsD.Datadog

Methods

type' :: Lens' Metric MetricType

event :: Text -> Text -> Event

Smart Event constructor. Use the lens functions to set the optional fields.

data Event

Event

The fields accessible through corresponding lenses are:

• title :: Text
• text :: Text
• dateHappened :: Maybe UTCTime
• hostname :: Maybe Text
• aggregationKey :: Maybe Text
• priority :: Maybe Priority
• sourceTypeName :: Maybe Text
• alertType :: Maybe AlertType
• tags :: [Tag]

Instances

ToStatsD Event

Defined in Network.StatsD.Datadog

Methods

toStatsD :: Event -> Utf8Builder ()

HasTitle Event Text

Defined in Network.StatsD.Datadog

Methods

title :: Lens' Event Text

HasText Event Text

Defined in Network.StatsD.Datadog

Methods

text :: Lens' Event Text

HasTags Event [Tag]

Defined in Network.StatsD.Datadog

Methods

tags :: Lens' Event [Tag]

HasSourceTypeName Event (Maybe Text)

Defined in Network.StatsD.Datadog

Methods

sourceTypeName :: Lens' Event (Maybe Text)

HasPriority Event (Maybe Priority)

Defined in Network.StatsD.Datadog

Methods

priority :: Lens' Event (Maybe Priority)

HasHostname Event (Maybe Text)

Defined in Network.StatsD.Datadog

Methods

hostname :: Lens' Event (Maybe Text)

HasDateHappened Event (Maybe UTCTime)

Defined in Network.StatsD.Datadog

Methods

dateHappened :: Lens' Event (Maybe UTCTime)

HasAlertType Event (Maybe AlertType)

Defined in Network.StatsD.Datadog

Methods

alertType :: Lens' Event (Maybe AlertType)

HasAggregationKey Event (Maybe Text)

Defined in Network.StatsD.Datadog

Methods

aggregationKey :: Lens' Event (Maybe Text)

serviceCheck

Arguments

:: Text

name

-> ServiceCheckStatus

-> ServiceCheck

data ServiceCheck

ServiceCheck

The fields accessible through corresponding lenses are:

• name :: Text
• status :: ServiceCheckStatus
• message :: Maybe Text
• dateHappened :: Maybe UTCTime
• hostname :: Maybe Text
• tags :: [Tag]

Instances

ToStatsD ServiceCheck

Defined in Network.StatsD.Datadog

Methods

toStatsD :: ServiceCheck -> Utf8Builder ()

HasName ServiceCheck Text

Defined in Network.StatsD.Datadog

Methods

name :: Lens' ServiceCheck Text

HasStatus ServiceCheck ServiceCheckStatus

Defined in Network.StatsD.Datadog

Methods

status :: Lens' ServiceCheck ServiceCheckStatus

HasTags ServiceCheck [Tag]

Defined in Network.StatsD.Datadog

Methods

tags :: Lens' ServiceCheck [Tag]

HasHostname ServiceCheck (Maybe Text)

Defined in Network.StatsD.Datadog

Methods

hostname :: Lens' ServiceCheck (Maybe Text)

HasDateHappened ServiceCheck (Maybe UTCTime)

Defined in Network.StatsD.Datadog

Methods

dateHappened :: Lens' ServiceCheck (Maybe UTCTime)

HasMessage ServiceCheck (Maybe Text)

Defined in Network.StatsD.Datadog

Methods

message :: Lens' ServiceCheck (Maybe Text)

data ServiceCheckStatus

Constructors

ServiceOk

ServiceWarning

ServiceCritical

ServiceUnknown

Instances

Enum ServiceCheckStatus

Defined in Network.StatsD.Datadog

Methods

succ :: ServiceCheckStatus -> ServiceCheckStatus

pred :: ServiceCheckStatus -> ServiceCheckStatus

toEnum :: Int -> ServiceCheckStatus

fromEnum :: ServiceCheckStatus -> Int

enumFrom :: ServiceCheckStatus -> [ServiceCheckStatus]

enumFromThen :: ServiceCheckStatus -> ServiceCheckStatus -> [ServiceCheckStatus]

enumFromTo :: ServiceCheckStatus -> ServiceCheckStatus -> [ServiceCheckStatus]

enumFromThenTo :: ServiceCheckStatus -> ServiceCheckStatus -> ServiceCheckStatus -> [ServiceCheckStatus]

Eq ServiceCheckStatus

Defined in Network.StatsD.Datadog

Methods

(==) :: ServiceCheckStatus -> ServiceCheckStatus -> Bool

(/=) :: ServiceCheckStatus -> ServiceCheckStatus -> Bool

Ord ServiceCheckStatus

Defined in Network.StatsD.Datadog

Methods

compare :: ServiceCheckStatus -> ServiceCheckStatus -> Ordering

(<) :: ServiceCheckStatus -> ServiceCheckStatus -> Bool

(<=) :: ServiceCheckStatus -> ServiceCheckStatus -> Bool

(>) :: ServiceCheckStatus -> ServiceCheckStatus -> Bool

(>=) :: ServiceCheckStatus -> ServiceCheckStatus -> Bool

max :: ServiceCheckStatus -> ServiceCheckStatus -> ServiceCheckStatus

min :: ServiceCheckStatus -> ServiceCheckStatus -> ServiceCheckStatus

Read ServiceCheckStatus

Defined in Network.StatsD.Datadog

Methods

readsPrec :: Int -> ReadS ServiceCheckStatus

readList :: ReadS [ServiceCheckStatus]

readPrec :: ReadPrec ServiceCheckStatus

readListPrec :: ReadPrec [ServiceCheckStatus]

Show ServiceCheckStatus

Defined in Network.StatsD.Datadog

Methods

showsPrec :: Int -> ServiceCheckStatus -> ShowS

show :: ServiceCheckStatus -> String

showList :: [ServiceCheckStatus] -> ShowS

HasStatus ServiceCheck ServiceCheckStatus

Defined in Network.StatsD.Datadog

Methods

status :: Lens' ServiceCheck ServiceCheckStatus

class ToStatsD a

Convert an Event, Metric, or StatusCheck to their wire format.

Minimal complete definition

toStatsD

Instances

ToStatsD Metric

Defined in Network.StatsD.Datadog

Methods

toStatsD :: Metric -> Utf8Builder ()

ToStatsD Event

Defined in Network.StatsD.Datadog

Methods

toStatsD :: Event -> Utf8Builder ()

ToStatsD ServiceCheck

Defined in Network.StatsD.Datadog

Methods

toStatsD :: ServiceCheck -> Utf8Builder ()

Optional fields

data Tag

Tags are a Datadog specific extension to StatsD. They allow you to tag a metric with a dimension that’s meaningful to you and slice and dice along that dimension in your graphs. For example, if you wanted to measure the performance of two video rendering algorithms, you could tag the rendering time metric with the version of the algorithm you used.

Instances

Eq Tag

Defined in Network.StatsD.Datadog

Methods

(==) :: Tag -> Tag -> Bool

(/=) :: Tag -> Tag -> Bool

Show Tag

Defined in Network.StatsD.Datadog

Methods

showsPrec :: Int -> Tag -> ShowS

show :: Tag -> String

showList :: [Tag] -> ShowS

HasTags Metric [Tag]

Defined in Network.StatsD.Datadog

Methods

tags :: Lens' Metric [Tag]

HasTags Event [Tag]

Defined in Network.StatsD.Datadog

Methods

tags :: Lens' Event [Tag]

HasTags ServiceCheck [Tag]

Defined in Network.StatsD.Datadog

Methods

tags :: Lens' ServiceCheck [Tag]

tag :: Text -> Text -> Tag

Create a tag from a key-value pair. Useful for slicing and dicing events in Datadog.

Key and value text values are normalized by converting ":"s, "|"s, and "@"s to underscores ("_").

class ToMetricValue a where

Converts a supported numeric type to the format understood by DogStatsD. Currently limited by BufferBuilder encoding options.

Methods

encodeValue :: a -> Utf8Builder ()

Instances

ToMetricValue Double

Defined in Network.StatsD.Datadog

Methods

encodeValue :: Double -> Utf8Builder ()

ToMetricValue Int

Defined in Network.StatsD.Datadog

Methods

encodeValue :: Int -> Utf8Builder ()

value :: ToMetricValue a => Setter Metric Metric (Utf8Builder ()) a

Special setter to update the value of a Metric.

metric ("foo"" :: Text) Counter (1 :: Int) & value .~ (5 :: Double)

data Priority

Constructors

Low

Normal

Instances

HasPriority Event (Maybe Priority)

Defined in Network.StatsD.Datadog

Methods

priority :: Lens' Event (Maybe Priority)

data AlertType

Constructors

Error

Warning

Info

Success

Instances

HasAlertType Event (Maybe AlertType)

Defined in Network.StatsD.Datadog

Methods

alertType :: Lens' Event (Maybe AlertType)

class HasName s a | s -> a where

Methods

name :: Lens' s a

Instances

HasName Metric MetricName

Defined in Network.StatsD.Datadog

Methods

name :: Lens' Metric MetricName

HasName ServiceCheck Text

Defined in Network.StatsD.Datadog

Methods

name :: Lens' ServiceCheck Text

class HasSampleRate s a | s -> a where

Methods

sampleRate :: Lens' s a

Instances

HasSampleRate Metric Double

Defined in Network.StatsD.Datadog

Methods

sampleRate :: Lens' Metric Double

class HasType' s a | s -> a where

Methods

type' :: Lens' s a

Instances

HasType' Metric MetricType

Defined in Network.StatsD.Datadog

Methods

type' :: Lens' Metric MetricType

class HasTags s a | s -> a where

Methods

tags :: Lens' s a

Instances

HasTags Metric [Tag]

Defined in Network.StatsD.Datadog

Methods

tags :: Lens' Metric [Tag]

HasTags Event [Tag]

Defined in Network.StatsD.Datadog

Methods

tags :: Lens' Event [Tag]

HasTags ServiceCheck [Tag]

Defined in Network.StatsD.Datadog

Methods

tags :: Lens' ServiceCheck [Tag]

class HasTitle s a | s -> a where

Methods

title :: Lens' s a

Instances

HasTitle Event Text

Defined in Network.StatsD.Datadog

Methods

title :: Lens' Event Text

class HasText s a | s -> a where

Methods

text :: Lens' s a

Instances

HasText Event Text

Defined in Network.StatsD.Datadog

Methods

text :: Lens' Event Text

class HasDateHappened s a | s -> a where

Methods

dateHappened :: Lens' s a

Instances

HasDateHappened Event (Maybe UTCTime)

Defined in Network.StatsD.Datadog

Methods

dateHappened :: Lens' Event (Maybe UTCTime)

HasDateHappened ServiceCheck (Maybe UTCTime)

Defined in Network.StatsD.Datadog

Methods

dateHappened :: Lens' ServiceCheck (Maybe UTCTime)

class HasHostname s a | s -> a where

Methods

hostname :: Lens' s a

Instances

HasHostname Event (Maybe Text)

Defined in Network.StatsD.Datadog

Methods

hostname :: Lens' Event (Maybe Text)

HasHostname ServiceCheck (Maybe Text)

Defined in Network.StatsD.Datadog

Methods

hostname :: Lens' ServiceCheck (Maybe Text)

class HasAggregationKey s a | s -> a where

Methods

aggregationKey :: Lens' s a

Instances

HasAggregationKey Event (Maybe Text)

Defined in Network.StatsD.Datadog

Methods

aggregationKey :: Lens' Event (Maybe Text)

class HasPriority s a | s -> a where

Methods

priority :: Lens' s a

Instances

HasPriority Event (Maybe Priority)

Defined in Network.StatsD.Datadog

Methods

priority :: Lens' Event (Maybe Priority)

class HasSourceTypeName s a | s -> a where

Methods

sourceTypeName :: Lens' s a

Instances

HasSourceTypeName Event (Maybe Text)

Defined in Network.StatsD.Datadog

Methods

sourceTypeName :: Lens' Event (Maybe Text)

class HasAlertType s a | s -> a where

Methods

alertType :: Lens' s a

Instances

HasAlertType Event (Maybe AlertType)

Defined in Network.StatsD.Datadog

Methods

alertType :: Lens' Event (Maybe AlertType)

class HasHost s a | s -> a where

Methods

host :: Lens' s a

Instances

HasHost DogStatsSettings HostName

Defined in Network.StatsD.Datadog

Methods

host :: Lens' DogStatsSettings HostName

class HasPort s a | s -> a where

Methods

port :: Lens' s a

Instances

HasPort DogStatsSettings Int

Defined in Network.StatsD.Datadog

Methods

port :: Lens' DogStatsSettings Int

class HasBufferSize s a | s -> a where

Methods

bufferSize :: Lens' s a

Instances

HasBufferSize DogStatsSettings Int

Defined in Network.StatsD.Datadog

Methods

bufferSize :: Lens' DogStatsSettings Int

class HasMaxDelay s a | s -> a where

Methods

maxDelay :: Lens' s a

Instances

HasMaxDelay DogStatsSettings Int

Defined in Network.StatsD.Datadog

Methods

maxDelay :: Lens' DogStatsSettings Int

class HasOnException s a | s -> a where

Methods

onException :: Lens' s a

Instances

HasOnException DogStatsSettings (SomeException -> Seq ByteString -> IO (Seq ByteString -> Seq ByteString))

Defined in Network.StatsD.Datadog

Methods

onException :: Lens' DogStatsSettings (SomeException -> Seq ByteString -> IO (Seq ByteString -> Seq ByteString))

class HasStatus s a | s -> a where

Methods

status :: Lens' s a

Instances

HasStatus ServiceCheck ServiceCheckStatus

Defined in Network.StatsD.Datadog

Methods

status :: Lens' ServiceCheck ServiceCheckStatus

class HasMessage s a | s -> a where

Methods

message :: Lens' s a

Instances

HasMessage ServiceCheck (Maybe Text)

Defined in Network.StatsD.Datadog

Methods

message :: Lens' ServiceCheck (Maybe Text)

Dummy client

data StatsClient

Note that Dummy is not the only constructor, just the only publicly available one.

Constructors

Dummy

Just drops all stats.