Safe Haskell	None
Language	Haskell2010

Network.Datadog.Event

Description

Events in Datadog represent notable occurrences.

Synopsis

data EventPriority
- = NormalPriority
- | LowPriority
data AlertType
- = Error
- | Warning
- | Info
- | Success
data SourceType
- = Nagios
- | Hudson
- | Jenkins
- | User
- | MyApps
- | Feed
- | Chef
- | Puppet
- | Git
- | BitBucket
- | Fabric
- | Capistrano
data EventSpec = EventSpec {
- eventSpecTitle :: Text
- eventSpecText :: Text
- eventSpecDateHappened :: UTCTime
- eventSpecPriority :: EventPriority
- eventSpecHost :: Maybe Text
- eventSpecTags :: [Tag]
- eventSpecAlertType :: AlertType
- eventSpecSourceType :: Maybe SourceType
}
data Event
type EventId = Int
minimalEventSpec :: Text -> Text -> UTCTime -> EventPriority -> EventSpec
createEvent :: Environment -> EventSpec -> IO Event
loadEvent :: Environment -> EventId -> IO Event
loadEvents :: Environment -> (UTCTime, UTCTime) -> Maybe EventPriority -> [Text] -> IO [Event]
class AsEventPriority r where
- _EventPriority :: Prism' r EventPriority
- _NormalPriority :: Prism' r ()
- _LowPriority :: Prism' r ()
class AsAlertType r where
- _AlertType :: Prism' r AlertType
- _Error :: Prism' r ()
- _Warning :: Prism' r ()
- _Info :: Prism' r ()
- _Success :: Prism' r ()
class AsSourceType r where
- _SourceType :: Prism' r SourceType
- _Nagios :: Prism' r ()
- _Hudson :: Prism' r ()
- _Jenkins :: Prism' r ()
- _User :: Prism' r ()
- _MyApps :: Prism' r ()
- _Feed :: Prism' r ()
- _Chef :: Prism' r ()
- _Puppet :: Prism' r ()
- _Git :: Prism' r ()
- _BitBucket :: Prism' r ()
- _Fabric :: Prism' r ()
- _Capistrano :: Prism' r ()
class HasTitle s a | s -> a where
- title :: Lens' s a
class HasText s a | s -> a where
- text :: Lens' s a
class HasPriority s a | s -> a where
- priority :: Lens' s a
class HasDateHappened s a | s -> a where
- dateHappened :: Lens' s a
class HasAlertType s a | s -> a where
- alertType :: Lens' s a
class HasDetails s a | s -> a where
- details :: Lens' s a
class HasTags s a | s -> a where
- tags :: Lens' s a
class HasSourceType s a | s -> a where
- sourceType :: Lens' s a
class HasHost s a | s -> a where
- host :: Lens' s a
class HasId' s a | s -> a where
- id' :: Lens' s a

Documentation

data EventPriority Source #

A set of priorities used to denote the importance of an event.

Constructors

NormalPriority
LowPriority

Instances

Eq EventPriority Source #
Instance details Defined in Network.Datadog.Types Methods (==) :: EventPriority -> EventPriority -> Bool # (/=) :: EventPriority -> EventPriority -> Bool #
Show EventPriority Source #
Instance details Defined in Network.Datadog.Types Methods showsPrec :: Int -> EventPriority -> ShowS # show :: EventPriority -> String # showList :: [EventPriority] -> ShowS #
ToJSON EventPriority Source #
Instance details Defined in Network.Datadog.Internal Methods toJSON :: EventPriority -> Value # toEncoding :: EventPriority -> Encoding # toJSONList :: [EventPriority] -> Value # toEncodingList :: [EventPriority] -> Encoding #
FromJSON EventPriority Source #
Instance details Defined in Network.Datadog.Internal Methods parseJSON :: Value -> Parser EventPriority # parseJSONList :: Value -> Parser [EventPriority] #
AsEventPriority EventPriority Source #
Instance details Defined in Network.Datadog.Lens Methods _EventPriority :: Prism' EventPriority EventPriority Source # _NormalPriority :: Prism' EventPriority () Source # _LowPriority :: Prism' EventPriority () Source #
HasPriority EventSpec EventPriority Source #
Instance details Defined in Network.Datadog.Lens Methods priority :: Lens' EventSpec EventPriority Source #

data AlertType Source #

The failure levels for an alert.

Constructors

Error
Warning
Info
Success

Instances

Eq AlertType Source #
Instance details Defined in Network.Datadog.Types Methods (==) :: AlertType -> AlertType -> Bool # (/=) :: AlertType -> AlertType -> Bool #
Show AlertType Source #
Instance details Defined in Network.Datadog.Types Methods showsPrec :: Int -> AlertType -> ShowS # show :: AlertType -> String # showList :: [AlertType] -> ShowS #
ToJSON AlertType Source #
Instance details Defined in Network.Datadog.Internal Methods toJSON :: AlertType -> Value # toEncoding :: AlertType -> Encoding # toJSONList :: [AlertType] -> Value # toEncodingList :: [AlertType] -> Encoding #
FromJSON AlertType Source #
Instance details Defined in Network.Datadog.Internal Methods parseJSON :: Value -> Parser AlertType # parseJSONList :: Value -> Parser [AlertType] #
AsAlertType AlertType Source #
Instance details Defined in Network.Datadog.Lens Methods _AlertType :: Prism' AlertType AlertType Source # _Error :: Prism' AlertType () Source # _Warning :: Prism' AlertType () Source # _Info :: Prism' AlertType () Source # _Success :: Prism' AlertType () Source #
HasAlertType EventSpec AlertType Source #
Instance details Defined in Network.Datadog.Lens Methods alertType :: Lens' EventSpec AlertType Source #

data SourceType Source #

A source from which an event may originate, recognized by Datadog.

Constructors

Nagios
Hudson
Jenkins
User
MyApps
Feed
Chef
Puppet
Git
BitBucket
Fabric
Capistrano

Instances

Eq SourceType Source #
Instance details Defined in Network.Datadog.Types Methods (==) :: SourceType -> SourceType -> Bool # (/=) :: SourceType -> SourceType -> Bool #
Show SourceType Source #
Instance details Defined in Network.Datadog.Types Methods showsPrec :: Int -> SourceType -> ShowS # show :: SourceType -> String # showList :: [SourceType] -> ShowS #
ToJSON SourceType Source #
Instance details Defined in Network.Datadog.Internal Methods toJSON :: SourceType -> Value # toEncoding :: SourceType -> Encoding # toJSONList :: [SourceType] -> Value # toEncodingList :: [SourceType] -> Encoding #
FromJSON SourceType Source #
Instance details Defined in Network.Datadog.Internal Methods parseJSON :: Value -> Parser SourceType # parseJSONList :: Value -> Parser [SourceType] #
AsSourceType SourceType Source #
Instance details Defined in Network.Datadog.Lens Methods _SourceType :: Prism' SourceType SourceType Source # _Nagios :: Prism' SourceType () Source # _Hudson :: Prism' SourceType () Source # _Jenkins :: Prism' SourceType () Source # _User :: Prism' SourceType () Source # _MyApps :: Prism' SourceType () Source # _Feed :: Prism' SourceType () Source # _Chef :: Prism' SourceType () Source # _Puppet :: Prism' SourceType () Source # _Git :: Prism' SourceType () Source # _BitBucket :: Prism' SourceType () Source # _Fabric :: Prism' SourceType () Source # _Capistrano :: Prism' SourceType () Source #
HasSourceType EventSpec (Maybe SourceType) Source #
Instance details Defined in Network.Datadog.Lens Methods sourceType :: Lens' EventSpec (Maybe SourceType) Source #

data EventSpec Source #

Details that describe an event.

Constructors

EventSpec
Fields eventSpecTitle :: Text eventSpecText :: Text The description/body of the event eventSpecDateHappened :: UTCTime The time at which the event occurred eventSpecPriority :: EventPriority eventSpecHost :: Maybe Text The hostname associated with the event eventSpecTags :: [Tag] eventSpecAlertType :: AlertType eventSpecSourceType :: Maybe SourceType The trigger of the event (if identifiable)

Instances

Eq EventSpec Source #
Instance details Defined in Network.Datadog.Types Methods (==) :: EventSpec -> EventSpec -> Bool # (/=) :: EventSpec -> EventSpec -> Bool #
Show EventSpec Source #
Instance details Defined in Network.Datadog.Types Methods showsPrec :: Int -> EventSpec -> ShowS # show :: EventSpec -> String # showList :: [EventSpec] -> ShowS #
ToJSON EventSpec Source #
Instance details Defined in Network.Datadog.Internal Methods toJSON :: EventSpec -> Value # toEncoding :: EventSpec -> Encoding # toJSONList :: [EventSpec] -> Value # toEncodingList :: [EventSpec] -> Encoding #
FromJSON EventSpec Source #
Instance details Defined in Network.Datadog.Internal Methods parseJSON :: Value -> Parser EventSpec # parseJSONList :: Value -> Parser [EventSpec] #
HasTitle EventSpec Text Source #
Instance details Defined in Network.Datadog.Lens Methods title :: Lens' EventSpec Text Source #
HasText EventSpec Text Source #
Instance details Defined in Network.Datadog.Lens Methods text :: Lens' EventSpec Text Source #
HasPriority EventSpec EventPriority Source #
Instance details Defined in Network.Datadog.Lens Methods priority :: Lens' EventSpec EventPriority Source #
HasDateHappened EventSpec UTCTime Source #
Instance details Defined in Network.Datadog.Lens Methods dateHappened :: Lens' EventSpec UTCTime Source #
HasAlertType EventSpec AlertType Source #
Instance details Defined in Network.Datadog.Lens Methods alertType :: Lens' EventSpec AlertType Source #
HasDetails Event EventSpec Source #
Instance details Defined in Network.Datadog.Lens Methods details :: Lens' Event EventSpec Source #
HasTags EventSpec [Tag] Source #
Instance details Defined in Network.Datadog.Lens Methods tags :: Lens' EventSpec [Tag] Source #
HasSourceType EventSpec (Maybe SourceType) Source #
Instance details Defined in Network.Datadog.Lens Methods sourceType :: Lens' EventSpec (Maybe SourceType) Source #
HasHost EventSpec (Maybe Text) Source #
Instance details Defined in Network.Datadog.Lens Methods host :: Lens' EventSpec (Maybe Text) Source #

data Event Source #

An event stored within Datadog. An event represents some sort of occurrence that was recorded in Datadog.

Instances

Eq Event Source #
Instance details Defined in Network.Datadog.Types Methods (==) :: Event -> Event -> Bool # (/=) :: Event -> Event -> Bool #
Show Event Source #
Instance details Defined in Network.Datadog.Types Methods showsPrec :: Int -> Event -> ShowS # show :: Event -> String # showList :: [Event] -> ShowS #
ToJSON Event Source #
Instance details Defined in Network.Datadog.Internal Methods toJSON :: Event -> Value # toEncoding :: Event -> Encoding # toJSONList :: [Event] -> Value # toEncodingList :: [Event] -> Encoding #
FromJSON Event Source #
Instance details Defined in Network.Datadog.Internal Methods parseJSON :: Value -> Parser Event # parseJSONList :: Value -> Parser [Event] #
HasId' Event EventId Source #
Instance details Defined in Network.Datadog.Lens Methods id' :: Lens' Event EventId Source #
HasDetails Event EventSpec Source #
Instance details Defined in Network.Datadog.Lens Methods details :: Lens' Event EventSpec Source #

type EventId = Int Source #

Datadog's internal reference to a specific event.

minimalEventSpec :: Text -> Text -> UTCTime -> EventPriority -> EventSpec Source #

Creates the most basic description required for an event, containing the event title, descriptive text, time of occurrence, and priority of the event. This event will be of type Info.

createEvent :: Environment -> EventSpec -> IO Event Source #

Store a new event in Datadog.

loadEvent :: Environment -> EventId -> IO Event Source #

Load an event from Datadog by its ID.

loadEvents Source #

Arguments

:: Environment
-> (UTCTime, UTCTime)	The range within which to query for events
-> Maybe EventPriority	Optionally filter results by a specific priority level
-> [Text]	A list of tags to filter by
-> IO [Event]

Query Datadog for events within a specific time range.

class AsEventPriority r where Source #

Minimal complete definition

_EventPriority

Methods

_EventPriority :: Prism' r EventPriority Source #

_NormalPriority :: Prism' r () Source #

_LowPriority :: Prism' r () Source #

Instances

AsEventPriority EventPriority Source #
Instance details Defined in Network.Datadog.Lens Methods _EventPriority :: Prism' EventPriority EventPriority Source # _NormalPriority :: Prism' EventPriority () Source # _LowPriority :: Prism' EventPriority () Source #

class AsAlertType r where Source #

Minimal complete definition

_AlertType

Methods

_AlertType :: Prism' r AlertType Source #

_Error :: Prism' r () Source #

_Warning :: Prism' r () Source #

_Info :: Prism' r () Source #

_Success :: Prism' r () Source #

Instances

AsAlertType AlertType Source #
Instance details Defined in Network.Datadog.Lens Methods _AlertType :: Prism' AlertType AlertType Source # _Error :: Prism' AlertType () Source # _Warning :: Prism' AlertType () Source # _Info :: Prism' AlertType () Source # _Success :: Prism' AlertType () Source #

class AsSourceType r where Source #

Minimal complete definition

_SourceType

Methods

_SourceType :: Prism' r SourceType Source #

_Nagios :: Prism' r () Source #

_Hudson :: Prism' r () Source #

_Jenkins :: Prism' r () Source #

_User :: Prism' r () Source #

_MyApps :: Prism' r () Source #

_Feed :: Prism' r () Source #

_Chef :: Prism' r () Source #

_Puppet :: Prism' r () Source #

_Git :: Prism' r () Source #

_BitBucket :: Prism' r () Source #

_Fabric :: Prism' r () Source #

_Capistrano :: Prism' r () Source #

Instances

AsSourceType SourceType Source #

Instance details

Defined in Network.Datadog.Lens

Methods

_SourceType :: Prism' SourceType SourceType Source #

_Nagios :: Prism' SourceType () Source #

_Hudson :: Prism' SourceType () Source #

_Jenkins :: Prism' SourceType () Source #

_User :: Prism' SourceType () Source #

_MyApps :: Prism' SourceType () Source #

_Feed :: Prism' SourceType () Source #

_Chef :: Prism' SourceType () Source #

_Puppet :: Prism' SourceType () Source #

_Git :: Prism' SourceType () Source #

_BitBucket :: Prism' SourceType () Source #

_Fabric :: Prism' SourceType () Source #

_Capistrano :: Prism' SourceType () Source #

class HasTitle s a | s -> a where Source #

Methods

title :: Lens' s a Source #

Instances

HasTitle EventSpec Text Source #
Instance details Defined in Network.Datadog.Lens Methods title :: Lens' EventSpec Text Source #

class HasText s a | s -> a where Source #

Methods

text :: Lens' s a Source #

Instances

HasText EventSpec Text Source #
Instance details Defined in Network.Datadog.Lens Methods text :: Lens' EventSpec Text Source #

class HasPriority s a | s -> a where Source #

Methods

priority :: Lens' s a Source #

Instances

HasPriority EventSpec EventPriority Source #
Instance details Defined in Network.Datadog.Lens Methods priority :: Lens' EventSpec EventPriority Source #

class HasDateHappened s a | s -> a where Source #

Methods

dateHappened :: Lens' s a Source #

Instances

HasDateHappened EventSpec UTCTime Source #
Instance details Defined in Network.Datadog.Lens Methods dateHappened :: Lens' EventSpec UTCTime Source #

class HasAlertType s a | s -> a where Source #

Methods

alertType :: Lens' s a Source #

Instances

HasAlertType EventSpec AlertType Source #
Instance details Defined in Network.Datadog.Lens Methods alertType :: Lens' EventSpec AlertType Source #

class HasDetails s a | s -> a where Source #

Methods

details :: Lens' s a Source #

Instances

HasDetails Event EventSpec Source #
Instance details Defined in Network.Datadog.Lens Methods details :: Lens' Event EventSpec Source #

class HasTags s a | s -> a where Source #

Methods

tags :: Lens' s a Source #

Instances

HasTags Metric [Text] Source #
Instance details Defined in Network.Datadog.Lens Methods tags :: Lens' Metric [Text] Source #
HasTags EventSpec [Tag] Source #
Instance details Defined in Network.Datadog.Lens Methods tags :: Lens' EventSpec [Tag] Source #
HasTags CheckResult [Tag] Source #
Instance details Defined in Network.Datadog.Lens Methods tags :: Lens' CheckResult [Tag] Source #

class HasSourceType s a | s -> a where Source #

Methods

sourceType :: Lens' s a Source #

Instances

HasSourceType EventSpec (Maybe SourceType) Source #
Instance details Defined in Network.Datadog.Lens Methods sourceType :: Lens' EventSpec (Maybe SourceType) Source #

class HasHost s a | s -> a where Source #

Methods

host :: Lens' s a Source #

Instances

HasHost Metric (Maybe Text) Source #
Instance details Defined in Network.Datadog.Lens Methods host :: Lens' Metric (Maybe Text) Source #
HasHost EventSpec (Maybe Text) Source #
Instance details Defined in Network.Datadog.Lens Methods host :: Lens' EventSpec (Maybe Text) Source #

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

Methods

id' :: Lens' s a Source #

Instances

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