Network.Carbon.Plaintext

Interacting with Carbon

Connections

data Connection

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 connected at least once.

Constructors

Connection

Fields

• connectionSocket :: !Socket

  The connection socket to Carbon.

Instances

Eq Connection

Methods

(==) :: Connection -> Connection -> Bool

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

Show Connection

Methods

showsPrec :: Int -> Connection -> ShowS

show :: Connection -> String

showList :: [Connection] -> ShowS

connect :: SockAddr -> IO Connection

Connect to Carbon.

disconnect :: Connection -> IO ()

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 ()

Send a collection of metrics to Carbon.

sendMetric :: Connection -> Text -> Double -> UTCTime -> IO ()

Send a single metric.

data Metric

A single data point. A metric has a path that names it, a value, and the time the metric was sampled.

Constructors

Metric

Fields

• metricPath :: !Text
• metricValue :: !Double
• metricTimeStamp :: !UTCTime

Instances

Eq Metric

Methods

(==) :: Metric -> Metric -> Bool

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

Show Metric

Methods

showsPrec :: Int -> Metric -> ShowS

show :: Metric -> String

showList :: [Metric] -> ShowS

Protocol details

encodeMetric :: Metric -> Builder

Encode a Metric for transmission over the plain text protocol.