Safe Haskell	None
Language	Haskell2010

Network.Datadog.Check

Description

Checks allow users to post check statuses, for use with monitors.

Synopsis

data CheckStatus
- = CheckOk
- | CheckWarning
- | CheckCritical
- | CheckUnknown
data CheckResult = CheckResult {
- checkResultCheck :: Text
- checkResultHostName :: Text
- checkResultStatus :: CheckStatus
- checkResultTimestamp :: Maybe UTCTime
- checkResultMessage :: Maybe Text
- checkResultTags :: [Tag]
}
recordCheck :: Environment -> CheckResult -> IO ()
class HasStatus s a | s -> a where
- status :: Lens' s a
class HasHostName s a | s -> a where
- hostName :: Lens' s a
class HasCheck s a | s -> a where
- check :: Lens' s a
class HasTimestamp s a | s -> a where
- timestamp :: Lens' s a
class HasTags s a | s -> a where
- tags :: Lens' s a
class HasMessage s a | s -> a where
- message :: Lens' s a
class AsCheckStatus r where
- _CheckStatus :: Prism' r CheckStatus
- _CheckOk :: Prism' r ()
- _CheckWarning :: Prism' r ()
- _CheckCritical :: Prism' r ()
- _CheckUnknown :: Prism' r ()

Documentation

data CheckStatus Source #

The status of a service, based on a check that is run against it.

Constructors

CheckOk	Everything is as it should be.
CheckWarning	Something abnormal, but not critical, is amiss.
CheckCritical	Something dangerously critical is amiss.
CheckUnknown	The current status cannot be determined.

Instances

Instances details

Eq CheckStatus Source #
Instance details Defined in Network.Datadog.Types Methods (==) :: CheckStatus -> CheckStatus -> Bool # (/=) :: CheckStatus -> CheckStatus -> Bool #
ToJSON CheckStatus Source #
Instance details Defined in Network.Datadog.Internal Methods toJSON :: CheckStatus -> Value # toEncoding :: CheckStatus -> Encoding # toJSONList :: [CheckStatus] -> Value # toEncodingList :: [CheckStatus] -> Encoding #
FromJSON CheckStatus Source #
Instance details Defined in Network.Datadog.Internal Methods parseJSON :: Value -> Parser CheckStatus # parseJSONList :: Value -> Parser [CheckStatus] #
AsCheckStatus CheckStatus Source #
Instance details Defined in Network.Datadog.Lens Methods _CheckStatus :: Prism' CheckStatus CheckStatus Source # _CheckOk :: Prism' CheckStatus () Source # _CheckWarning :: Prism' CheckStatus () Source # _CheckCritical :: Prism' CheckStatus () Source # _CheckUnknown :: Prism' CheckStatus () Source #
HasStatus CheckResult CheckStatus Source #
Instance details Defined in Network.Datadog.Lens Methods status :: Lens' CheckResult CheckStatus Source #

data CheckResult Source #

The result of running a check on some service.

Constructors

CheckResult

Fields

checkResultCheck :: Text
Text describing the check
checkResultHostName :: Text
Name of the host which the check applies to
checkResultStatus :: CheckStatus
Status result of the check
checkResultTimestamp :: Maybe UTCTime
Time at which the check occurred (Nothing will wait until the check is sent to Datadog to compute the time)
checkResultMessage :: Maybe Text
Information related to why this specific check run supplied the status it did
checkResultTags :: [Tag]
Tags to associate with this check run

Instances

Instances details

Eq CheckResult Source #
Instance details Defined in Network.Datadog.Types Methods (==) :: CheckResult -> CheckResult -> Bool # (/=) :: CheckResult -> CheckResult -> Bool #
ToJSON CheckResult Source #
Instance details Defined in Network.Datadog.Internal Methods toJSON :: CheckResult -> Value # toEncoding :: CheckResult -> Encoding # toJSONList :: [CheckResult] -> Value # toEncodingList :: [CheckResult] -> Encoding #
FromJSON CheckResult Source #
Instance details Defined in Network.Datadog.Internal Methods parseJSON :: Value -> Parser CheckResult # parseJSONList :: Value -> Parser [CheckResult] #
HasStatus CheckResult CheckStatus Source #
Instance details Defined in Network.Datadog.Lens Methods status :: Lens' CheckResult CheckStatus Source #
HasHostName CheckResult Text Source #
Instance details Defined in Network.Datadog.Lens Methods hostName :: Lens' CheckResult Text Source #
HasCheck CheckResult Text Source #
Instance details Defined in Network.Datadog.Lens Methods check :: Lens' CheckResult Text Source #
HasTimestamp CheckResult (Maybe UTCTime) Source #
Instance details Defined in Network.Datadog.Lens Methods timestamp :: Lens' CheckResult (Maybe UTCTime) Source #
HasTags CheckResult [Tag] Source #
Instance details Defined in Network.Datadog.Lens Methods tags :: Lens' CheckResult [Tag] Source #
HasMessage CheckResult (Maybe Text) Source #
Instance details Defined in Network.Datadog.Lens Methods message :: Lens' CheckResult (Maybe Text) Source #

recordCheck :: Environment -> CheckResult -> IO () Source #

Record the result of a check in Datadog.

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

Methods

status :: Lens' s a Source #

Instances

Instances details

HasStatus CheckResult CheckStatus Source #
Instance details Defined in Network.Datadog.Lens Methods status :: Lens' CheckResult CheckStatus Source #

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

Methods

hostName :: Lens' s a Source #

Instances

Instances details

HasHostName CheckResult Text Source #
Instance details Defined in Network.Datadog.Lens Methods hostName :: Lens' CheckResult Text Source #

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

Methods

check :: Lens' s a Source #

Instances

Instances details

HasCheck CheckResult Text Source #
Instance details Defined in Network.Datadog.Lens Methods check :: Lens' CheckResult Text Source #

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

Methods

timestamp :: Lens' s a Source #

Instances

Instances details

HasTimestamp CheckResult (Maybe UTCTime) Source #
Instance details Defined in Network.Datadog.Lens Methods timestamp :: Lens' CheckResult (Maybe UTCTime) Source #

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

Methods

tags :: Lens' s a Source #

Instances

Instances details

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 HasMessage s a | s -> a where Source #

Methods

message :: Lens' s a Source #

Instances

Instances details

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

class AsCheckStatus r where Source #

Minimal complete definition

_CheckStatus

Methods

_CheckStatus :: Prism' r CheckStatus Source #

_CheckOk :: Prism' r () Source #

_CheckWarning :: Prism' r () Source #

_CheckCritical :: Prism' r () Source #

_CheckUnknown :: Prism' r () Source #

Instances

Instances details

AsCheckStatus CheckStatus Source #
Instance details Defined in Network.Datadog.Lens Methods _CheckStatus :: Prism' CheckStatus CheckStatus Source # _CheckOk :: Prism' CheckStatus () Source # _CheckWarning :: Prism' CheckStatus () Source # _CheckCritical :: Prism' CheckStatus () Source # _CheckUnknown :: Prism' CheckStatus () Source #