Safe Haskell | None |
---|
- data Connection = Connection {}
- connect :: SockAddr -> IO Connection
- disconnect :: Connection -> IO ()
- sendMetrics :: Connection -> Vector Metric -> IO ()
- sendMetric :: Connection -> Text -> Double -> UTCTime -> IO ()
- data Metric = Metric {
- metricPath :: !Text
- metricValue :: !Double
- metricTimeStamp :: !UTCTime
- encodeMetric :: Metric -> Builder
Interacting with Carbon
Connections
data Connection Source
Low-level representation of a Carbon connection. It's suggested that you
construct this via connect
. It is henceforth assumed that
getPeerName
will return something useful, which usually means
connectionSocket
should have been connect
ed at least once.
Connection | |
|
connect :: SockAddr -> IO ConnectionSource
Connect to Carbon.
disconnect :: Connection -> IO ()Source
Disconnect from Carbon. Note that it's still valid to sendMetrics
to this
Connection
, and it will result in a reconnection.
Metrics
sendMetrics :: Connection -> Vector Metric -> IO ()Source
Send a collection of metrics to Carbon.
sendMetric :: Connection -> Text -> Double -> UTCTime -> IO ()Source
Send a single metric.
A single data point. A metric has a path that names it, a value, and the time the metric was sampled.
Metric | |
|
Protocol details
encodeMetric :: Metric -> BuilderSource
Encode a Metric
for transmission over the plain text protocol.