Safe Haskell	None
Language	Haskell2010

Datadog.Client

Description

An HTTP Client to post data to a datadog agent.

Many of our refinements are stricter than the actual requirements, to err on the side of caution, and because the actual requirements are very complex.

Synopsis

newtype Agent m = Agent {
- putTraces :: NonEmpty Trace -> m ()
}
type AgentT m = Agent (ExceptT ServantError m)
type DDText = NonEmpty && SizeLessThan 101
data HasAlpha
newtype MetaKey = MetaKey (Refined (DDText && Tag) Text)
newtype MetaValue = MetaValue (Refined DDText Text)
newtype ServiceName = ServiceName (Refined (DDText && Tag) Text)
data Span = Span {
- sName :: SpanName
- sParentId :: Maybe SpanId
- sStart :: UTCTime
- sDuration :: NominalDiffTime
- sMeta :: Maybe (Map MetaKey MetaValue)
}
newtype SpanId = SpanId (Refined NonZero Word64)
newtype SpanName = SpanName (Refined (DDText && HasAlpha) Text)
data Tag
data Trace = Trace {
- tService :: ServiceName
- tId :: TraceId
- tSpans :: Refined NonEmpty (Map SpanId Span)
}
newtype TraceId = TraceId (Refined NonZero Word64)
newServantAgent :: (MonadIO m, MonadError ServantError m) => ClientEnv -> Agent m

Documentation

newtype Agent m Source #

The Datadog Agent API, independent of any HTTP framework.

Constructors

Agent
Fields putTraces :: NonEmpty Trace -> m ()

Instances

FFunctor Agent Source #
Instance details Defined in Datadog.Client Methods ffmap :: (Functor m, Functor n) => (forall a. m a -> n a) -> Agent m -> Agent n #

type AgentT m = Agent (ExceptT ServantError m) Source #

Allows users to opt-out of having a MonadError in their Monad stack. They opt-in to error handling at the points when calling the Agent. Requires users to handle errors at the point of use.

See https://discourse.haskell.org/t/local-capabilities-with-mtl/231

type DDText = NonEmpty && SizeLessThan 101 Source #

data HasAlpha Source #

Instances

Predicate HasAlpha Text Source #
Instance details Defined in Datadog.Client Methods validate :: Monad m => HasAlpha -> Text -> RefineT m () #

newtype MetaKey Source #

Constructors

MetaKey (Refined (DDText && Tag) Text)

Instances

Eq MetaKey Source #
Instance details Defined in Datadog.Client Methods (==) :: MetaKey -> MetaKey -> Bool # (/=) :: MetaKey -> MetaKey -> Bool #
Ord MetaKey Source #
Instance details Defined in Datadog.Client Methods compare :: MetaKey -> MetaKey -> Ordering # (<) :: MetaKey -> MetaKey -> Bool # (<=) :: MetaKey -> MetaKey -> Bool # (>) :: MetaKey -> MetaKey -> Bool # (>=) :: MetaKey -> MetaKey -> Bool # max :: MetaKey -> MetaKey -> MetaKey # min :: MetaKey -> MetaKey -> MetaKey #
Show MetaKey Source #
Instance details Defined in Datadog.Client Methods showsPrec :: Int -> MetaKey -> ShowS # show :: MetaKey -> String # showList :: [MetaKey] -> ShowS #

newtype MetaValue Source #

Constructors

MetaValue (Refined DDText Text)

Instances

Eq MetaValue Source #
Instance details Defined in Datadog.Client Methods (==) :: MetaValue -> MetaValue -> Bool # (/=) :: MetaValue -> MetaValue -> Bool #
Show MetaValue Source #
Instance details Defined in Datadog.Client Methods showsPrec :: Int -> MetaValue -> ShowS # show :: MetaValue -> String # showList :: [MetaValue] -> ShowS #

newtype ServiceName Source #

Constructors

ServiceName (Refined (DDText && Tag) Text)

Instances

Eq ServiceName Source #
Instance details Defined in Datadog.Client Methods (==) :: ServiceName -> ServiceName -> Bool # (/=) :: ServiceName -> ServiceName -> Bool #
Show ServiceName Source #
Instance details Defined in Datadog.Client Methods showsPrec :: Int -> ServiceName -> ShowS # show :: ServiceName -> String # showList :: [ServiceName] -> ShowS #

data Span Source #

Constructors

Span
Fields sName :: SpanName sParentId :: Maybe SpanId sStart :: UTCTime sDuration :: NominalDiffTime sMeta :: Maybe (Map MetaKey MetaValue)

Instances

Eq Span Source #
Instance details Defined in Datadog.Client Methods (==) :: Span -> Span -> Bool # (/=) :: Span -> Span -> Bool #
Show Span Source #
Instance details Defined in Datadog.Client Methods showsPrec :: Int -> Span -> ShowS # show :: Span -> String # showList :: [Span] -> ShowS #

newtype SpanId Source #

Constructors

SpanId (Refined NonZero Word64)

Instances

Eq SpanId Source #
Instance details Defined in Datadog.Client Methods (==) :: SpanId -> SpanId -> Bool # (/=) :: SpanId -> SpanId -> Bool #
Show SpanId Source #
Instance details Defined in Datadog.Client Methods showsPrec :: Int -> SpanId -> ShowS # show :: SpanId -> String # showList :: [SpanId] -> ShowS #

newtype SpanName Source #

Constructors

SpanName (Refined (DDText && HasAlpha) Text)

Instances

Eq SpanName Source #
Instance details Defined in Datadog.Client Methods (==) :: SpanName -> SpanName -> Bool # (/=) :: SpanName -> SpanName -> Bool #
Show SpanName Source #
Instance details Defined in Datadog.Client Methods showsPrec :: Int -> SpanName -> ShowS # show :: SpanName -> String # showList :: [SpanName] -> ShowS #

data Tag Source #

Instances

Predicate Tag Text Source #
Instance details Defined in Datadog.Client Methods validate :: Monad m => Tag -> Text -> RefineT m () #

data Trace Source #

Constructors

Trace
Fields tService :: ServiceName tId :: TraceId tSpans :: Refined NonEmpty (Map SpanId Span)

Instances

Eq Trace Source #
Instance details Defined in Datadog.Client Methods (==) :: Trace -> Trace -> Bool # (/=) :: Trace -> Trace -> Bool #
Show Trace Source #
Instance details Defined in Datadog.Client Methods showsPrec :: Int -> Trace -> ShowS # show :: Trace -> String # showList :: [Trace] -> ShowS #

newtype TraceId Source #

Constructors

TraceId (Refined NonZero Word64)

Instances

Eq TraceId Source #
Instance details Defined in Datadog.Client Methods (==) :: TraceId -> TraceId -> Bool # (/=) :: TraceId -> TraceId -> Bool #
Show TraceId Source #
Instance details Defined in Datadog.Client Methods showsPrec :: Int -> TraceId -> ShowS # show :: TraceId -> String # showList :: [TraceId] -> ShowS #

newServantAgent :: (MonadIO m, MonadError ServantError m) => ClientEnv -> Agent m Source #

An Agent (or AgentT) implemented by Servant.