System.Remote.Monitoring.Bosun

This module lets you periodically flush metrics to a Bosun backend. Example usage:

main = do
  store <- newStore
  forkBosun defaultBosunOptions store

You probably want to include some of the predefined metrics defined in the ekg-core package, by calling e.g. the registerGcMetrics function defined in that package.

Documentation

data BosunOptions

Options to control how to connect to the Bosun server and how often to flush metrics.

Constructors

BosunOptions

Fields

bosunRoot :: !URI

The route URL to Bosun.

flushInterval :: !Int

The amount of time between sampling EKG metrics and pushing to Bosun.

tags :: !(HashMap Text Text)

Tags to apply to all metrics.

Instances

Eq BosunOptions

Show BosunOptions

defaultBosunOptions :: BosunOptions

Defaults:

• bosunRoot = "http:/127.0.0.1:8070"
• tags = [("host", hostname)]
• flushInterval = 10000

forkBosun :: BosunOptions -> Store -> IO ThreadId

Create a thread that periodically flushes the metrics in Store to Bosun.