Safe Haskell	None
Language	Haskell2010

Network.Datadog.Downtime

Description

Downtime prevents all alerting related to specific Datadog scopes.

Synopsis

data DowntimeSpec = DowntimeSpec {
- downtimeSpecStart :: Maybe UTCTime
- downtimeSpecEnd :: Maybe UTCTime
- downtimeSpecMessage :: Maybe Text
- downtimeSpecScope :: Tag
}
data Downtime
minimalDowntimeSpec :: Tag -> DowntimeSpec
scheduleDowntime :: Environment -> DowntimeSpec -> IO Downtime
updateDowntime :: Environment -> DowntimeId -> DowntimeSpec -> IO Downtime
cancelDowntime :: Environment -> DowntimeId -> IO ()
loadDowntime :: Environment -> DowntimeId -> IO Downtime
loadDowntimes :: Environment -> Bool -> IO [Downtime]
class HasScope s a | s -> a where
class HasSpec s a | s -> a where
class HasMessage s a | s -> a where
class HasStart s a | s -> a where
class HasEnd s a | s -> a where
class HasId' s a | s -> a where
type DowntimeId = Int

Documentation

data DowntimeSpec #

A description of when downtime should occur.

Constructors

DowntimeSpec

Fields

downtimeSpecStart :: Maybe UTCTime
When to start the downtime (or immediately)
downtimeSpecEnd :: Maybe UTCTime
When to stop the downtime (or indefinitely)
downtimeSpecMessage :: Maybe Text
A message to include with notifications for this downtime
downtimeSpecScope :: Tag
The scope to apply downtime to (if applying downtime to a host, use a tag of the form "host:hostname", NOT just "hostname")

Instances

Eq DowntimeSpec #
Instance details Defined in Network.Datadog.Types Methods (==) :: DowntimeSpec -> DowntimeSpec -> Bool # (/=) :: DowntimeSpec -> DowntimeSpec -> Bool #
ToJSON DowntimeSpec #
Instance details Defined in Network.Datadog.Internal Methods toJSON :: DowntimeSpec -> Value # toEncoding :: DowntimeSpec -> Encoding # toJSONList :: [DowntimeSpec] -> Value # toEncodingList :: [DowntimeSpec] -> Encoding #
FromJSON DowntimeSpec #
Instance details Defined in Network.Datadog.Internal Methods parseJSON :: Value -> Parser DowntimeSpec # parseJSONList :: Value -> Parser [DowntimeSpec] #
HasScope DowntimeSpec Tag #
Instance details Defined in Network.Datadog.Lens Methods scope :: Lens' DowntimeSpec Tag #
HasSpec Downtime DowntimeSpec #
Instance details Defined in Network.Datadog.Lens Methods spec :: Lens' Downtime DowntimeSpec #
HasMessage DowntimeSpec (Maybe Text) #
Instance details Defined in Network.Datadog.Lens Methods message :: Lens' DowntimeSpec (Maybe Text) #
HasStart DowntimeSpec (Maybe UTCTime) #
Instance details Defined in Network.Datadog.Lens Methods start :: Lens' DowntimeSpec (Maybe UTCTime) #
HasEnd DowntimeSpec (Maybe UTCTime) #
Instance details Defined in Network.Datadog.Lens Methods end :: Lens' DowntimeSpec (Maybe UTCTime) #

data Downtime #

A scheduled donwtime stored in Datadog.

Instances

Eq Downtime #
Instance details Defined in Network.Datadog.Types Methods (==) :: Downtime -> Downtime -> Bool # (/=) :: Downtime -> Downtime -> Bool #
ToJSON Downtime #
Instance details Defined in Network.Datadog.Internal Methods toJSON :: Downtime -> Value # toEncoding :: Downtime -> Encoding # toJSONList :: [Downtime] -> Value # toEncodingList :: [Downtime] -> Encoding #
FromJSON Downtime #
Instance details Defined in Network.Datadog.Internal Methods parseJSON :: Value -> Parser Downtime # parseJSONList :: Value -> Parser [Downtime] #
HasSpec Downtime DowntimeSpec #
Instance details Defined in Network.Datadog.Lens Methods spec :: Lens' Downtime DowntimeSpec #
HasId' Downtime DowntimeId #
Instance details Defined in Network.Datadog.Lens Methods id' :: Lens' Downtime DowntimeId #

minimalDowntimeSpec :: Tag -> DowntimeSpec #

Creates the most basic possible downtime specification, which just contains the scope to which the downtime applies.

scheduleDowntime :: Environment -> DowntimeSpec -> IO Downtime #

Schedule a new downtime in Datadog.

updateDowntime :: Environment -> DowntimeId -> DowntimeSpec -> IO Downtime #

Update the specification of a downtime in Datadog.

cancelDowntime :: Environment -> DowntimeId -> IO () #

Cancel scheduled downtime in Datadog.

loadDowntime :: Environment -> DowntimeId -> IO Downtime #

Load a scheduled downtime from Datadog by its ID.

loadDowntimes :: Environment -> Bool -> IO [Downtime] #

Load all scheduled downtimes, optionally filtering for only downtimes that are currently active.

class HasScope s a | s -> a where #

Minimal complete definition

scope

Methods

scope :: Lens' s a #

Instances

HasScope DowntimeSpec Tag #
Instance details Defined in Network.Datadog.Lens Methods scope :: Lens' DowntimeSpec Tag #

class HasSpec s a | s -> a where #

Minimal complete definition

spec

Methods

spec :: Lens' s a #

Instances

HasSpec Monitor MonitorSpec #
Instance details Defined in Network.Datadog.Lens Methods spec :: Lens' Monitor MonitorSpec #
HasSpec Downtime DowntimeSpec #
Instance details Defined in Network.Datadog.Lens Methods spec :: Lens' Downtime DowntimeSpec #

class HasMessage s a | s -> a where #

Minimal complete definition

message

Methods

message :: Lens' s a #

Instances

HasMessage MonitorSpec (Maybe Text) #
Instance details Defined in Network.Datadog.Lens Methods message :: Lens' MonitorSpec (Maybe Text) #
HasMessage DowntimeSpec (Maybe Text) #
Instance details Defined in Network.Datadog.Lens Methods message :: Lens' DowntimeSpec (Maybe Text) #
HasMessage CheckResult (Maybe Text) #
Instance details Defined in Network.Datadog.Lens Methods message :: Lens' CheckResult (Maybe Text) #

class HasStart s a | s -> a where #

Minimal complete definition

start

Methods

start :: Lens' s a #

Instances

HasStart DowntimeSpec (Maybe UTCTime) #
Instance details Defined in Network.Datadog.Lens Methods start :: Lens' DowntimeSpec (Maybe UTCTime) #

class HasEnd s a | s -> a where #

Minimal complete definition

end

Methods

end :: Lens' s a #

Instances

HasEnd DowntimeSpec (Maybe UTCTime) #
Instance details Defined in Network.Datadog.Lens Methods end :: Lens' DowntimeSpec (Maybe UTCTime) #

class HasId' s a | s -> a where #

Minimal complete definition

id'

Methods

id' :: Lens' s a #

Instances

HasId' Monitor MonitorId #
Instance details Defined in Network.Datadog.Lens Methods id' :: Lens' Monitor MonitorId #
HasId' Event EventId #
Instance details Defined in Network.Datadog.Lens Methods id' :: Lens' Event EventId #
HasId' Downtime DowntimeId #
Instance details Defined in Network.Datadog.Lens Methods id' :: Lens' Downtime DowntimeId #

type DowntimeId = Int #

Datadog's internal reference to a specific donwtime instance.