System.Remote.Monitoring.CloudWatch

This module allows you to periodically push your ekg metrics to the Amazon CloudWatch backend. Inspired by the 'ekg-statsd' module.

To use, run forkCloudWatch with the CloudWatchEnv and metrics Store.

Documentation

data CloudWatchId

The ThreadID for the CloudWatch process.

cloudWatchThreadId :: CloudWatchId -> ThreadId

forkCloudWatch :: CloudWatchEnv -> Store -> IO CloudWatchId

Forks a thread to periodically publish metrics to Amazon's CloudWatch service for the given Store.

data CloudWatchEnv

The environment for the CloudWatch EKG metric pusher.

Constructors

CloudWatchEnv

Fields

• cweFlushInterval :: !Int

  The interval of time to flush, in milliseconds.

• cweAwsEnv :: !Env

  The AWS Environment that connects to the CloudWatch services.

• cweDimensions :: ![Dimension]

  The extra dimensions to pass for each metric. These can be used to configure process-level metric information, like ServerGroup, RegionName, Environment, etc.

• cweNamespace :: !Text

  The namespace that the service runs in.

• cweOnError :: !(forall e. Exception e => e -> IO ())

  The function used to handle exceptions coming from amazonka library.

defaultCloudWatchEnv :: Text -> Env -> CloudWatchEnv

The default CloudWatchEnv, requiring an Amazon environment and namespace. Equal to: CloudWatchEnv { cweFlushInterval = 1000 , cweAwsEnv = x , cweNamespace = namespace , cweDimensions = [] , cweOnError = defaultOnError }