Safe Haskell	Safe-Inferred
Language	Haskell2010

OpenTracing.Span

Description

Data types and functions for manipulating spans

Synopsis

data SpanContext = SpanContext {
- ctxTraceID :: TraceID
- ctxSpanID :: Word64
- ctxParentSpanID :: Maybe Word64
- _ctxSampled :: Sampled
- _ctxBaggage :: HashMap Text Text
}
ctxSampled :: Lens' SpanContext Sampled
ctxBaggage :: Lens' SpanContext (HashMap Text Text)
data Span
newSpan :: (MonadIO m, Foldable t) => SpanContext -> Text -> SpanRefs -> t Tag -> m Span
class HasSpanFields a
data ActiveSpan
mkActive :: MonadIO m => Span -> m ActiveSpan
modifyActiveSpan :: MonadIO m => ActiveSpan -> (Span -> Span) -> m ()
readActiveSpan :: MonadIO m => ActiveSpan -> m Span
addTag :: MonadIO m => ActiveSpan -> Tag -> m ()
addLogRecord :: MonadIO m => ActiveSpan -> LogField -> m ()
addLogRecord' :: MonadIO m => ActiveSpan -> LogField -> [LogField] -> m ()
setBaggageItem :: MonadIO m => ActiveSpan -> Text -> Text -> m ()
getBaggageItem :: MonadIO m => ActiveSpan -> Text -> m (Maybe Text)
data FinishedSpan
spanFinish :: MonadIO m => Span -> m FinishedSpan
spanContext :: HasSpanFields a => Lens' a SpanContext
spanOperation :: HasSpanFields a => Lens' a Text
spanStart :: HasSpanFields a => Lens' a UTCTime
spanTags :: HasSpanFields a => Lens' a Tags
spanRefs :: HasRefs s a => Lens' s a
spanLogs :: HasSpanFields a => Lens' a [LogRecord]
spanDuration :: Lens' FinishedSpan NominalDiffTime
data SpanOpts
spanOpts :: Text -> SpanRefs -> SpanOpts
spanOptOperation :: Lens' SpanOpts Text
spanOptRefs :: Lens' SpanOpts SpanRefs
spanOptTags :: Lens' SpanOpts [Tag]
spanOptSampled :: Lens' SpanOpts (Maybe Sampled)
data Reference
- = ChildOf {
  - refCtx :: SpanContext
  }
- | FollowsFrom {
  - refCtx :: SpanContext
  }
findParent :: Foldable t => t Reference -> Maybe Reference
data SpanRefs
refActiveParents :: Lens' SpanRefs [ActiveSpan]
refPredecessors :: Lens' SpanRefs [FinishedSpan]
refPropagated :: Lens' SpanRefs [Reference]
childOf :: ActiveSpan -> SpanRefs
followsFrom :: FinishedSpan -> SpanRefs
freezeRefs :: SpanRefs -> IO [Reference]
data Sampled
- = NotSampled
- | Sampled
_IsSampled :: Iso' Bool Sampled
sampled :: HasSampled a => Lens' a Sampled
data Traced a = Traced {
- tracedResult :: a
- tracedSpan :: ~FinishedSpan
}

Documentation

data SpanContext Source #

A SpanContext is the data that uniquely identifies a span and the context in which it occurs. Spans occur in traces, which form complete pictures of a computation, potentially across multiple machines.

Since: 0.1.0.0

Constructors

SpanContext

Fields

ctxTraceID :: TraceID
A trace identifier. Trace ids are globally unique
ctxSpanID :: Word64
A span identifier. Span identifiers are unique to their trace.
ctxParentSpanID :: Maybe Word64
Spans without a parent are known as "root spans"
_ctxSampled :: Sampled
Whether or not this span is going to be reported.
_ctxBaggage :: HashMap Text Text
Baggage is arbitrary key:value pairs that cross process boundaries.

Instances

Instances details

ToJSON SpanContext Source #
Instance details Defined in OpenTracing.Span Methods toJSON :: SpanContext -> Value # toEncoding :: SpanContext -> Encoding # toJSONList :: [SpanContext] -> Value # toEncodingList :: [SpanContext] -> Encoding # omitField :: SpanContext -> Bool #

ctxSampled :: Lens' SpanContext Sampled Source #

ctxBaggage :: Lens' SpanContext (HashMap Text Text) Source #

data Span Source #

Span is a span that has been started (but not finished). See the OpenTracing spec for more info

Since: 0.1.0.0

Instances

Instances details

HasSpanFields Span Source #
Instance details Defined in OpenTracing.Span Methods spanContext :: Lens' Span SpanContext Source # spanOperation :: Lens' Span Text Source # spanStart :: Lens' Span UTCTime Source # spanTags :: Lens' Span Tags Source # spanLogs :: Lens' Span [LogRecord] Source #

newSpan :: (MonadIO m, Foldable t) => SpanContext -> Text -> SpanRefs -> t Tag -> m Span Source #

Create a new Span with the provided info. The created Span will have a start time equal to the system time when newSpan is called.

Since: 0.1.0.0

class HasSpanFields a Source #

Minimal complete definition

spanContext, spanOperation, spanStart, spanTags, spanLogs

Instances

Instances details

HasSpanFields FinishedSpan Source #
Instance details Defined in OpenTracing.Span Methods spanContext :: Lens' FinishedSpan SpanContext Source # spanOperation :: Lens' FinishedSpan Text Source # spanStart :: Lens' FinishedSpan UTCTime Source # spanTags :: Lens' FinishedSpan Tags Source # spanLogs :: Lens' FinishedSpan [LogRecord] Source #
HasSpanFields Span Source #
Instance details Defined in OpenTracing.Span Methods spanContext :: Lens' Span SpanContext Source # spanOperation :: Lens' Span Text Source # spanStart :: Lens' Span UTCTime Source # spanTags :: Lens' Span Tags Source # spanLogs :: Lens' Span [LogRecord] Source #

data ActiveSpan Source #

A mutable Span that is currently being recorded.

Since: 0.1.0.0

mkActive :: MonadIO m => Span -> m ActiveSpan Source #

Since: 0.1.0.0

modifyActiveSpan :: MonadIO m => ActiveSpan -> (Span -> Span) -> m () Source #

Since: 0.1.0.0

readActiveSpan :: MonadIO m => ActiveSpan -> m Span Source #

Since: 0.1.0.0

addTag :: MonadIO m => ActiveSpan -> Tag -> m () Source #

addLogRecord :: MonadIO m => ActiveSpan -> LogField -> m () Source #

Log structured data to an ActiveSpan. More info in the OpenTracing spec

Since: 0.1.0.0

addLogRecord' :: MonadIO m => ActiveSpan -> LogField -> [LogField] -> m () Source #

setBaggageItem :: MonadIO m => ActiveSpan -> Text -> Text -> m () Source #

getBaggageItem :: MonadIO m => ActiveSpan -> Text -> m (Maybe Text) Source #

data FinishedSpan Source #

A span that has finished executing.

Since: 0.1.0.0

Instances

Instances details

HasSpanFields FinishedSpan Source #
Instance details Defined in OpenTracing.Span Methods spanContext :: Lens' FinishedSpan SpanContext Source # spanOperation :: Lens' FinishedSpan Text Source # spanStart :: Lens' FinishedSpan UTCTime Source # spanTags :: Lens' FinishedSpan Tags Source # spanLogs :: Lens' FinishedSpan [LogRecord] Source #

spanFinish :: MonadIO m => Span -> m FinishedSpan Source #

Convert an unfinished Span into a FinishedSpan

Since: 0.1.0.0

spanContext :: HasSpanFields a => Lens' a SpanContext Source #

spanOperation :: HasSpanFields a => Lens' a Text Source #

spanStart :: HasSpanFields a => Lens' a UTCTime Source #

spanTags :: HasSpanFields a => Lens' a Tags Source #

spanRefs :: HasRefs s a => Lens' s a Source #

spanLogs :: HasSpanFields a => Lens' a [LogRecord] Source #

spanDuration :: Lens' FinishedSpan NominalDiffTime Source #

data SpanOpts Source #

SpanOpts is the metadata information about a span needed in order to start measuring a span. This is the information that application code will provide in order to indicate what a span is doing and how it related to other spans. More info in the OpenTracing spec

Since: 0.1.0.0

spanOpts :: Text -> SpanRefs -> SpanOpts Source #

Create a new SpanOpts with the minimal amount of required information.

Since: 0.1.0.0

spanOptOperation :: Lens' SpanOpts Text Source #

spanOptRefs :: Lens' SpanOpts SpanRefs Source #

spanOptTags :: Lens' SpanOpts [Tag] Source #

spanOptSampled :: Lens' SpanOpts (Maybe Sampled) Source #

data Reference Source #

A reference from one span to another. Spans can be related in two ways:

ChildOf indicates that the parent span is dependent on the child span in order to produce its own result.
FollowsFrom indicates that there is no dependence relation, perhaps the parent span spawned an asynchronous task.

More info in the OpenTracing spec

Since: 0.1.0.0

Constructors

ChildOf
Fields refCtx :: SpanContext
FollowsFrom
Fields refCtx :: SpanContext

findParent :: Foldable t => t Reference -> Maybe Reference Source #

data SpanRefs Source #

The different references that a span can hold to other spans.

Since: 0.1.0.0

Instances

Instances details

Monoid SpanRefs Source #
Instance details Defined in OpenTracing.Span Methods mempty :: SpanRefs # mappend :: SpanRefs -> SpanRefs -> SpanRefs # mconcat :: [SpanRefs] -> SpanRefs #
Semigroup SpanRefs Source #
Instance details Defined in OpenTracing.Span Methods (<>) :: SpanRefs -> SpanRefs -> SpanRefs # sconcat :: NonEmpty SpanRefs -> SpanRefs # stimes :: Integral b => b -> SpanRefs -> SpanRefs #

refActiveParents :: Lens' SpanRefs [ActiveSpan] Source #

refPredecessors :: Lens' SpanRefs [FinishedSpan] Source #

refPropagated :: Lens' SpanRefs [Reference] Source #

childOf :: ActiveSpan -> SpanRefs Source #

Create a SpanRefs containing the single refrence to a parent span.

Since: 0.1.0.0

followsFrom :: FinishedSpan -> SpanRefs Source #

Create a SpanRefs containing the single refrence to a predecessor span.

Since: 0.1.0.0

freezeRefs :: SpanRefs -> IO [Reference] Source #

Convert SpanRefs (which may include the mutable ActiveSpans) into an immutable list of References

Since: 0.1.0.0

data Sampled Source #

A datatype indicating whether a recorded span was sampled, i.e. whether or not it will be reported. Traces are often sampled in high volume environments to keep the amount of data generated manageable.

Since: 0.1.0.0

Constructors

NotSampled
Sampled

Instances

Instances details

ToJSON Sampled Source #
Instance details Defined in OpenTracing.Span Methods toJSON :: Sampled -> Value # toEncoding :: Sampled -> Encoding # toJSONList :: [Sampled] -> Value # toEncodingList :: [Sampled] -> Encoding # omitField :: Sampled -> Bool #
Bounded Sampled Source #
Instance details Defined in OpenTracing.Span Methods minBound :: Sampled # maxBound :: Sampled #
Enum Sampled Source #
Instance details Defined in OpenTracing.Span Methods succ :: Sampled -> Sampled # pred :: Sampled -> Sampled # toEnum :: Int -> Sampled # fromEnum :: Sampled -> Int # enumFrom :: Sampled -> [Sampled] # enumFromThen :: Sampled -> Sampled -> [Sampled] # enumFromTo :: Sampled -> Sampled -> [Sampled] # enumFromThenTo :: Sampled -> Sampled -> Sampled -> [Sampled] #
Read Sampled Source #
Instance details Defined in OpenTracing.Span Methods readsPrec :: Int -> ReadS Sampled # readList :: ReadS [Sampled] # readPrec :: ReadPrec Sampled # readListPrec :: ReadPrec [Sampled] #
Show Sampled Source #
Instance details Defined in OpenTracing.Span Methods showsPrec :: Int -> Sampled -> ShowS # show :: Sampled -> String # showList :: [Sampled] -> ShowS #
Eq Sampled Source #
Instance details Defined in OpenTracing.Span Methods (==) :: Sampled -> Sampled -> Bool # (/=) :: Sampled -> Sampled -> Bool #

_IsSampled :: Iso' Bool Sampled Source #

sampled :: HasSampled a => Lens' a Sampled Source #

data Traced a Source #

A wrapper for a value that was produced by a traced computation.

Since: 0.1.0.0

Constructors

Traced
Fields tracedResult :: a The raw value produced tracedSpan :: ~FinishedSpan The resulting span that was created