Network.Datadog.Check

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

Documentation

data CheckStatus

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

Eq CheckStatus

Defined in Network.Datadog.Types

Methods

(==) :: CheckStatus -> CheckStatus -> Bool

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

ToJSON CheckStatus

Defined in Network.Datadog.Internal

Methods

toJSON :: CheckStatus -> Value

toEncoding :: CheckStatus -> Encoding

toJSONList :: [CheckStatus] -> Value

toEncodingList :: [CheckStatus] -> Encoding

FromJSON CheckStatus

Defined in Network.Datadog.Internal

Methods

parseJSON :: Value -> Parser CheckStatus

parseJSONList :: Value -> Parser [CheckStatus]

AsCheckStatus CheckStatus

Defined in Network.Datadog.Lens

Methods

_CheckStatus :: Prism' CheckStatus CheckStatus

_CheckOk :: Prism' CheckStatus ()

_CheckWarning :: Prism' CheckStatus ()

_CheckCritical :: Prism' CheckStatus ()

_CheckUnknown :: Prism' CheckStatus ()

HasStatus CheckResult CheckStatus

Defined in Network.Datadog.Lens

Methods

status :: Lens' CheckResult CheckStatus

data CheckResult

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

Eq CheckResult

Defined in Network.Datadog.Types

Methods

(==) :: CheckResult -> CheckResult -> Bool

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

ToJSON CheckResult

Defined in Network.Datadog.Internal

Methods

toJSON :: CheckResult -> Value

toEncoding :: CheckResult -> Encoding

toJSONList :: [CheckResult] -> Value

toEncodingList :: [CheckResult] -> Encoding

FromJSON CheckResult

Defined in Network.Datadog.Internal

Methods

parseJSON :: Value -> Parser CheckResult

parseJSONList :: Value -> Parser [CheckResult]

HasStatus CheckResult CheckStatus

Defined in Network.Datadog.Lens

Methods

status :: Lens' CheckResult CheckStatus

HasHostName CheckResult Text

Defined in Network.Datadog.Lens

Methods

hostName :: Lens' CheckResult Text

HasCheck CheckResult Text

Defined in Network.Datadog.Lens

Methods

check :: Lens' CheckResult Text

HasTimestamp CheckResult (Maybe UTCTime)

Defined in Network.Datadog.Lens

Methods

timestamp :: Lens' CheckResult (Maybe UTCTime)

HasTags CheckResult [Tag]

Defined in Network.Datadog.Lens

Methods

tags :: Lens' CheckResult [Tag]

HasMessage CheckResult (Maybe Text)

Defined in Network.Datadog.Lens

Methods

message :: Lens' CheckResult (Maybe Text)

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

Record the result of a check in Datadog.

class HasStatus s a | s -> a where

Methods

status :: Lens' s a

Instances

HasStatus CheckResult CheckStatus

Defined in Network.Datadog.Lens

Methods

status :: Lens' CheckResult CheckStatus

class HasHostName s a | s -> a where

Methods

hostName :: Lens' s a

Instances

HasHostName CheckResult Text

Defined in Network.Datadog.Lens

Methods

hostName :: Lens' CheckResult Text

class HasCheck s a | s -> a where

Methods

check :: Lens' s a

Instances

HasCheck CheckResult Text

Defined in Network.Datadog.Lens

Methods

check :: Lens' CheckResult Text

class HasTimestamp s a | s -> a where

Methods

timestamp :: Lens' s a

Instances

HasTimestamp CheckResult (Maybe UTCTime)

Defined in Network.Datadog.Lens

Methods

timestamp :: Lens' CheckResult (Maybe UTCTime)

class HasTags s a | s -> a where

Methods

tags :: Lens' s a

Instances

HasTags Metric [Text]

Defined in Network.Datadog.Lens

Methods

tags :: Lens' Metric [Text]

HasTags EventSpec [Tag]

Defined in Network.Datadog.Lens

Methods

tags :: Lens' EventSpec [Tag]

HasTags CheckResult [Tag]

Defined in Network.Datadog.Lens

Methods

tags :: Lens' CheckResult [Tag]

class HasMessage s a | s -> a where

Methods

message :: Lens' s a

Instances

HasMessage MonitorSpec (Maybe Text)

Defined in Network.Datadog.Lens

Methods

message :: Lens' MonitorSpec (Maybe Text)

HasMessage DowntimeSpec (Maybe Text)

Defined in Network.Datadog.Lens

Methods

message :: Lens' DowntimeSpec (Maybe Text)

HasMessage CheckResult (Maybe Text)

Defined in Network.Datadog.Lens

Methods

message :: Lens' CheckResult (Maybe Text)

class AsCheckStatus r where

Minimal complete definition

_CheckStatus

Methods

_CheckStatus :: Prism' r CheckStatus

_CheckOk :: Prism' r ()

_CheckWarning :: Prism' r ()

_CheckCritical :: Prism' r ()

_CheckUnknown :: Prism' r ()

Instances

AsCheckStatus CheckStatus

Defined in Network.Datadog.Lens

Methods

_CheckStatus :: Prism' CheckStatus CheckStatus

_CheckOk :: Prism' CheckStatus ()

_CheckWarning :: Prism' CheckStatus ()

_CheckCritical :: Prism' CheckStatus ()

_CheckUnknown :: Prism' CheckStatus ()