Network.Datadog.Monitor

Monitoring all of your infrastructure in one place wouldn’t be complete without the ability to know when critical changes are occurring. Datadog gives you the ability to create monitors that will actively check metrics, integration availability, network endpoints and more. Once a monitor is created, you will be notified when its conditions are met.

A simple way to get started with monitors:

main = do
  env <- createEnvironment =<< loadKeysFromEnv
  -- Check if the average bytes received in the last five minutes is >100 on host0
  let query = "avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100"
  let mspec = minimalMonitorSpec MetricAlert query
  monitor <- createMonitor env mspec
  print $ mId monitor

Documentation

data MonitorSpec

A representation of a monitor's configuration, from which a monitor could be rebuilt.

Constructors

MonitorSpec

Fields

• monitorSpecType' :: MonitorType
• monitorSpecQuery :: Text

  The query string the monitor uses to determine its state.

• monitorSpecName :: Maybe Text

  The human-readable name of the monitor.

• monitorSpecMessage :: Maybe Text

  The message sent with the notification when the monitor is triggered.

• monitorSpecOptions :: MonitorOptions

  Optional configuration parameters specifying advanced monitor beahviour.

Instances

Eq MonitorSpec

Methods

(==) :: MonitorSpec -> MonitorSpec -> Bool

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

HasSpec Monitor MonitorSpec

Methods

spec :: Lens' Monitor MonitorSpec

HasType' MonitorSpec MonitorType

Methods

type' :: Lens' MonitorSpec MonitorType

HasQuery MonitorSpec Text

Methods

query :: Lens' MonitorSpec Text

HasOptions MonitorSpec MonitorOptions

Methods

options :: Lens' MonitorSpec MonitorOptions

HasMessage MonitorSpec (Maybe Text)

Methods

message :: Lens' MonitorSpec (Maybe Text)

HasName MonitorSpec (Maybe Text)

Methods

name :: Lens' MonitorSpec (Maybe Text)

data MonitorType

Each monitor is of a specific type, which determines what sort of check the monitor performs.

Constructors

MetricAlert

Watches a (combination of) metric(s), alerting when it crosses some threshold.

ServiceCheck

Watches a service and alerts when the service enters a failing state.

EventAlert

Checks the event stream for events meeting certain criteria.

Instances

Eq MonitorType

Methods

(==) :: MonitorType -> MonitorType -> Bool

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

Show MonitorType

Methods

showsPrec :: Int -> MonitorType -> ShowS

show :: MonitorType -> String

showList :: [MonitorType] -> ShowS

AsMonitorType MonitorType

Methods

_MonitorType :: Prism' MonitorType MonitorType

_MetricAlert :: Prism' MonitorType ()

_ServiceCheck :: Prism' MonitorType ()

_EventAlert :: Prism' MonitorType ()

HasType' MonitorSpec MonitorType

Methods

type' :: Lens' MonitorSpec MonitorType

data MonitorOptions

Advanced configuration parameters for a monitor.

Constructors

MonitorOptions

Fields

• monitorOptionsSilenced :: HashMap Text (Maybe Integer)
• monitorOptionsNotifyNoData :: Bool
• monitorOptionsNoDataTimeframe :: Maybe Integer
• monitorOptionsTimeoutH :: Maybe Integer
• monitorOptionsRenotifyInterval :: Maybe Integer
• monitorOptionsEscalationMessage :: Text
• monitorOptionsNotifyAudit :: Bool

Instances

Eq MonitorOptions

Methods

(==) :: MonitorOptions -> MonitorOptions -> Bool

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

HasNotifyNoData MonitorOptions Bool

Methods

notifyNoData :: Lens' MonitorOptions Bool

HasNotifyAudit MonitorOptions Bool

Methods

notifyAudit :: Lens' MonitorOptions Bool

HasEscalationMessage MonitorOptions Text

Methods

escalationMessage :: Lens' MonitorOptions Text

HasOptions MonitorSpec MonitorOptions

Methods

options :: Lens' MonitorSpec MonitorOptions

HasTimeoutH MonitorOptions (Maybe Integer)

Methods

timeoutH :: Lens' MonitorOptions (Maybe Integer)

HasRenotifyInterval MonitorOptions (Maybe Integer)

Methods

renotifyInterval :: Lens' MonitorOptions (Maybe Integer)

HasNoDataTimeframe MonitorOptions (Maybe Integer)

Methods

noDataTimeframe :: Lens' MonitorOptions (Maybe Integer)

HasSilenced MonitorOptions (HashMap Text (Maybe Integer))

Methods

silenced :: Lens' MonitorOptions (HashMap Text (Maybe Integer))

getSilencedMonitorScopes :: MonitorOptions -> [(Text, Maybe UTCTime)]

Provide a list of the silenced scopes for this monitor and the time at which the silencer will expire (may be indefinite). The monitor "*" refers to the monitor at large (un-scoped).

silenceMonitorScope :: Text -> Maybe UTCTime -> MonitorOptions -> MonitorOptions

Silence a given scope until some time (or indefinitely), replacing the current silencer on the given scope if one already exists.

unsilenceMonitorScope :: Text -> MonitorOptions -> MonitorOptions

Remove the silencer from a given scope, if the scope is currently silenced.

unsilenceAllMonitorScope :: MonitorOptions -> MonitorOptions

Unsilence every scope in the monitor, including the global scope.

doesNotifyOnNoMonitorData :: MonitorOptions -> Maybe NominalDiffTime

Determine how long without data a monitor will go before notifying to such, providing Nothing if the monitor will never notify on lack of data.

notifyOnNoMonitorData :: NominalDiffTime -> MonitorOptions -> MonitorOptions

Have the monitor notify when it does not receive data for some given amount of time (rounded down to the nearest minute).

noNotifyOnNoMonitorData :: MonitorOptions -> MonitorOptions

Prevent the monitor from notifying when it is missing data.

getMonitorTimeout :: MonitorOptions -> Maybe NominalDiffTime

Determine after how long the monitor will stop alerting after it is triggered, providing Nothing if the monitor will never stop alerting.

setMonitorTimeout :: NominalDiffTime -> MonitorOptions -> MonitorOptions

Have the monitor stop alerting some time after it is triggered (rounded up to the nearest hour).

clearMonitorTimeout :: MonitorOptions -> MonitorOptions

Prevent the monitor from timing out after it is triggered.

doesRenotifyMonitor :: MonitorOptions -> Maybe (NominalDiffTime, Maybe Text)

Determine after how long after being triggered the monitor will re-notify, and what message it will include in the re-notification (if any), providing Nothing if the monitor will never re-notify.

renotifyMonitor :: NominalDiffTime -> Maybe Text -> MonitorOptions -> MonitorOptions

Have the monitor re-notify some amount of time after the most recent notification (rounded down to the nearest minute) and optionally what text it will include in the re-notification.

noRenotifyMonitor :: MonitorOptions -> MonitorOptions

Prevent the monitor from re-notifying after it triggers an un-resolved notification.

doesNotifyOnAudit :: MonitorOptions -> Bool

Determine if the monitor triggers a notification when it is modified.

notifyOnAudit :: MonitorOptions -> MonitorOptions

Have the monitor trigger a notification when it is modified.

noNotifyOnAudit :: MonitorOptions -> MonitorOptions

Prevent the monitor from triggering a notification when it is modified.

data Monitor

A Datadog monitor. These monitors actively check multiple different types of data within Datadog against user-provided conditions, triggering notifications when condition(s) are met.

Constructors

Monitor

Fields

• monitorId' :: MonitorId

  Datadog's internal reference to this specific monitor.

• monitorSpec :: MonitorSpec

  The specification from which this monitor can be re-created.

Instances

Eq Monitor

Methods

(==) :: Monitor -> Monitor -> Bool

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

HasSpec Monitor MonitorSpec

Methods

spec :: Lens' Monitor MonitorSpec

HasId' Monitor MonitorId

Methods

id' :: Lens' Monitor MonitorId

type MonitorId = Int

Datadog's internal reference to a specific monitor.

minimalMonitorSpec :: MonitorType -> Text -> MonitorSpec

Creates the most basic specification required by a monitor, containing the type of monitor and the query string used to detect the monitor's state.

This uses defaultMonitorOptions to set the options (see that function for disclaimer(s)).

createMonitor :: Environment -> MonitorSpec -> IO Monitor

Create a new monitor in Datadog matching a specification.

updateMonitor :: Environment -> MonitorId -> MonitorSpec -> IO Monitor

Sync a monitor with Datadog.

This must be called on any active monitors to apply the changes with Datadog itself; merely modifying a monitor locally is not enough to store the changes.

Beware: If a monitor has changed on the Datadog remote endpoint between the time it was copied locally and when this function is called, those changes already made remotely will be overwritten by this change.

deleteMonitor :: Environment -> MonitorId -> IO ()

Delete a monitor from Datadog.

Note that once a monitor is deleted, it cannot be used locally anymore, however you can always create a new monitor using the deleted monitor's specification.

loadMonitor :: Environment -> MonitorId -> IO Monitor

Load a monitor from Datadog by its ID.

loadMonitors

Arguments

:: Environment

-> [Tag]

Tags on which to filter the results

-> IO [Monitor]

Load monitors from Datadog.

This function takes a filter list argument, which should contain any tags the user wishes to filter on. If the filter list is left empty, no filters will be applied. The list of tags is ANDed together; if you specify more than one filter tag, only metrics which match all filter tags will be provided.

muteAllMonitors :: Environment -> IO ()

Prevent all monitors from notifying indefinitely.

unmuteAllMonitors :: Environment -> IO ()

Allow all monitors to notify.

class HasId' s a | s -> a where

Minimal complete definition

id'

Methods

id' :: Lens' s a

Instances

HasId' Monitor MonitorId

Methods

id' :: Lens' Monitor MonitorId

HasId' Event EventId

Methods

id' :: Lens' Event EventId

HasId' Downtime DowntimeId

Methods

id' :: Lens' Downtime DowntimeId

class HasSpec s a | s -> a where

Minimal complete definition

spec

Methods

spec :: Lens' s a

Instances

HasSpec Monitor MonitorSpec

Methods

spec :: Lens' Monitor MonitorSpec

HasSpec Downtime DowntimeSpec

Methods

spec :: Lens' Downtime DowntimeSpec

class HasType' s a | s -> a where

Minimal complete definition

type'

Methods

type' :: Lens' s a

Instances

HasType' MonitorSpec MonitorType

Methods

type' :: Lens' MonitorSpec MonitorType

class HasQuery s a | s -> a where

Minimal complete definition

query

Methods

query :: Lens' s a

Instances

HasQuery MonitorSpec Text

Methods

query :: Lens' MonitorSpec Text

class HasOptions s a | s -> a where

Minimal complete definition

options

Methods

options :: Lens' s a

Instances

HasOptions MonitorSpec MonitorOptions

Methods

options :: Lens' MonitorSpec MonitorOptions

class HasMessage s a | s -> a where

Minimal complete definition

message

Methods

message :: Lens' s a

Instances

HasMessage MonitorSpec (Maybe Text)

Methods

message :: Lens' MonitorSpec (Maybe Text)

HasMessage DowntimeSpec (Maybe Text)

Methods

message :: Lens' DowntimeSpec (Maybe Text)

HasMessage CheckResult (Maybe Text)

Methods

message :: Lens' CheckResult (Maybe Text)

class HasName s a | s -> a where

Minimal complete definition

name

Methods

name :: Lens' s a

Instances

HasName Metric Text

Methods

name :: Lens' Metric Text

HasName MonitorSpec (Maybe Text)

Methods

name :: Lens' MonitorSpec (Maybe Text)

class HasNotifyNoData s a | s -> a where

Minimal complete definition

notifyNoData

Methods

notifyNoData :: Lens' s a

Instances

HasNotifyNoData MonitorOptions Bool

Methods

notifyNoData :: Lens' MonitorOptions Bool

class HasTimeoutH s a | s -> a where

Minimal complete definition

timeoutH

Methods

timeoutH :: Lens' s a

Instances

HasTimeoutH MonitorOptions (Maybe Integer)

Methods

timeoutH :: Lens' MonitorOptions (Maybe Integer)

class HasRenotifyInterval s a | s -> a where

Minimal complete definition

renotifyInterval

Methods

renotifyInterval :: Lens' s a

Instances

HasRenotifyInterval MonitorOptions (Maybe Integer)

Methods

renotifyInterval :: Lens' MonitorOptions (Maybe Integer)

class HasNoDataTimeframe s a | s -> a where

Minimal complete definition

noDataTimeframe

Methods

noDataTimeframe :: Lens' s a

Instances

HasNoDataTimeframe MonitorOptions (Maybe Integer)

Methods

noDataTimeframe :: Lens' MonitorOptions (Maybe Integer)

class HasSilenced s a | s -> a where

Minimal complete definition

silenced

Methods

silenced :: Lens' s a

Instances

HasSilenced MonitorOptions (HashMap Text (Maybe Integer))

Methods

silenced :: Lens' MonitorOptions (HashMap Text (Maybe Integer))

class AsMonitorType r where

Methods

_MonitorType :: Prism' r MonitorType

_MetricAlert :: Prism' r ()

_ServiceCheck :: Prism' r ()

_EventAlert :: Prism' r ()

Instances

AsMonitorType MonitorType

Methods

_MonitorType :: Prism' MonitorType MonitorType

_MetricAlert :: Prism' MonitorType ()

_ServiceCheck :: Prism' MonitorType ()

_EventAlert :: Prism' MonitorType ()