Safe Haskell	None
Language	Haskell2010

Tracing.Core

Synopsis

data Span = Span {
- operationName :: !OpName
- context :: !SpanContext
- timestamp :: !POSIXTime
- duration :: !NominalDiffTime
- relations :: ![SpanRelation]
- tags :: !(Map Text SpanTag)
- baggage :: !(Map Text Text)
- debug :: !Bool
- serviceName :: !Text
}
data SpanRelation
- = ChildOf !SpanContext
- | FollowsFrom !SpanContext
data SpanRelationTag
- = Child
- | Follows
data SpanContext = SpanContext {
- traceId :: !TraceId
- spanId :: !SpanId
}
data SpanTag
- = TagString !Text
- | TagBool !Bool
- | TagInt !Int64
- | TagDouble !Double
newtype OpName = OpName Text
newtype SpanId = SpanId Int64
newtype TraceId = TraceId Int64
data Tracer = Tracer {
- spanBuffer :: IORef [Span]
- svcName :: Text
}
data TracingInstructions = TracingInstructions {
- traceId :: !TraceId
- spanId :: !SpanId
- parentSpanId :: !(Maybe SpanId)
- debug :: !Bool
- sample :: !Bool
}
class Monad m => MonadTracer m where
class ToSpanTag a where
data Tag = ToSpanTag a => Tag Text a
recordSpan :: (MonadIO m, MonadBaseControl IO m, MonadTracer m) => Maybe SpanRelationTag -> [Tag] -> OpName -> m a -> m a
debugPrintSpan :: Span -> Text

Documentation

data Span #

A timed section of code with a logical name and SpanContext. Individual spans will be reconstructed by an OpenTracing backend into a single trace.

Constructors

Span
Fields operationName :: !OpName context :: !SpanContext timestamp :: !POSIXTime duration :: !NominalDiffTime relations :: ![SpanRelation] tags :: !(Map Text SpanTag) baggage :: !(Map Text Text) debug :: !Bool serviceName :: !Text

Instances

Show Span #
Instance details Defined in Tracing.Core Methods showsPrec :: Int -> Span -> ShowS # show :: Span -> String # showList :: [Span] -> ShowS #

data SpanRelation #

Spans may be top level, a child, or logically follow from a given span.

Constructors

ChildOf !SpanContext
FollowsFrom !SpanContext

Instances

Eq SpanRelation #
Instance details Defined in Tracing.Core Methods (==) :: SpanRelation -> SpanRelation -> Bool # (/=) :: SpanRelation -> SpanRelation -> Bool #
Show SpanRelation #
Instance details Defined in Tracing.Core Methods showsPrec :: Int -> SpanRelation -> ShowS # show :: SpanRelation -> String # showList :: [SpanRelation] -> ShowS #

data SpanRelationTag #

Indicates the type of relation this span represents

Constructors

Child
Follows

data SpanContext #

Uniquely identifies a given Span & points to its encompasing trace

Constructors

SpanContext
Fields traceId :: !TraceId spanId :: !SpanId

Instances

Eq SpanContext #
Instance details Defined in Tracing.Core Methods (==) :: SpanContext -> SpanContext -> Bool # (/=) :: SpanContext -> SpanContext -> Bool #
Show SpanContext #
Instance details Defined in Tracing.Core Methods showsPrec :: Int -> SpanContext -> ShowS # show :: SpanContext -> String # showList :: [SpanContext] -> ShowS #

data SpanTag #

Used to embed additional information into a Span for consumption & viewing in a tracing backend

Constructors

TagString !Text
TagBool !Bool
TagInt !Int64
TagDouble !Double

Instances

Eq SpanTag #
Instance details Defined in Tracing.Core Methods (==) :: SpanTag -> SpanTag -> Bool # (/=) :: SpanTag -> SpanTag -> Bool #
Show SpanTag #
Instance details Defined in Tracing.Core Methods showsPrec :: Int -> SpanTag -> ShowS # show :: SpanTag -> String # showList :: [SpanTag] -> ShowS #
ToSpanTag SpanTag #
Instance details Defined in Tracing.Core Methods toSpanTag :: SpanTag -> SpanTag #

newtype OpName #

Human-readable name for the span

Constructors

OpName Text

Instances

Eq OpName #
Instance details Defined in Tracing.Core Methods (==) :: OpName -> OpName -> Bool # (/=) :: OpName -> OpName -> Bool #
Ord OpName #
Instance details Defined in Tracing.Core Methods compare :: OpName -> OpName -> Ordering # (<) :: OpName -> OpName -> Bool # (<=) :: OpName -> OpName -> Bool # (>) :: OpName -> OpName -> Bool # (>=) :: OpName -> OpName -> Bool # max :: OpName -> OpName -> OpName # min :: OpName -> OpName -> OpName #
Show OpName #
Instance details Defined in Tracing.Core Methods showsPrec :: Int -> OpName -> ShowS # show :: OpName -> String # showList :: [OpName] -> ShowS #
IsString OpName #
Instance details Defined in Tracing.Core Methods fromString :: String -> OpName #

newtype SpanId #

An opaque & unique identifier for a trace segment, called a Span

Constructors

SpanId Int64

Instances

Eq SpanId #
Instance details Defined in Tracing.Core Methods (==) :: SpanId -> SpanId -> Bool # (/=) :: SpanId -> SpanId -> Bool #
Ord SpanId #
Instance details Defined in Tracing.Core Methods compare :: SpanId -> SpanId -> Ordering # (<) :: SpanId -> SpanId -> Bool # (<=) :: SpanId -> SpanId -> Bool # (>) :: SpanId -> SpanId -> Bool # (>=) :: SpanId -> SpanId -> Bool # max :: SpanId -> SpanId -> SpanId # min :: SpanId -> SpanId -> SpanId #
Show SpanId #
Instance details Defined in Tracing.Core Methods showsPrec :: Int -> SpanId -> ShowS # show :: SpanId -> String # showList :: [SpanId] -> ShowS #
FromHttpApiData SpanId #
Instance details Defined in Tracing.Core Methods parseUrlPiece :: Text -> Either Text SpanId # parseHeader :: ByteString -> Either Text SpanId # parseQueryParam :: Text -> Either Text SpanId #

newtype TraceId #

An opaque & unique identifier for a logical operation. Traces are composed of many Spans

Constructors

TraceId Int64

Instances

Eq TraceId #
Instance details Defined in Tracing.Core Methods (==) :: TraceId -> TraceId -> Bool # (/=) :: TraceId -> TraceId -> Bool #
Ord TraceId #
Instance details Defined in Tracing.Core Methods compare :: TraceId -> TraceId -> Ordering # (<) :: TraceId -> TraceId -> Bool # (<=) :: TraceId -> TraceId -> Bool # (>) :: TraceId -> TraceId -> Bool # (>=) :: TraceId -> TraceId -> Bool # max :: TraceId -> TraceId -> TraceId # min :: TraceId -> TraceId -> TraceId #
Show TraceId #
Instance details Defined in Tracing.Core Methods showsPrec :: Int -> TraceId -> ShowS # show :: TraceId -> String # showList :: [TraceId] -> ShowS #
FromHttpApiData TraceId #
Instance details Defined in Tracing.Core Methods parseUrlPiece :: Text -> Either Text TraceId # parseHeader :: ByteString -> Either Text TraceId # parseQueryParam :: Text -> Either Text TraceId #

data Tracer #

Global context required for tracing. The $sel:spanBuffer:Tracer should be manually drained by library users.

Constructors

Tracer
Fields spanBuffer :: IORef [Span] svcName :: Text

data TracingInstructions #

Instructions that are specific to a single trace

Constructors

TracingInstructions
Fields traceId :: !TraceId spanId :: !SpanId parentSpanId :: !(Maybe SpanId) debug :: !Bool sample :: !Bool

Instances

Eq TracingInstructions #
Instance details Defined in Tracing.Core Methods (==) :: TracingInstructions -> TracingInstructions -> Bool # (/=) :: TracingInstructions -> TracingInstructions -> Bool #
Show TracingInstructions #
Instance details Defined in Tracing.Core Methods showsPrec :: Int -> TracingInstructions -> ShowS # show :: TracingInstructions -> String # showList :: [TracingInstructions] -> ShowS #
FromHttpApiData TracingInstructions #
Instance details Defined in Servant.Tracing Methods parseUrlPiece :: Text -> Either Text TracingInstructions # parseHeader :: ByteString -> Either Text TracingInstructions # parseQueryParam :: Text -> Either Text TracingInstructions #

class Monad m => MonadTracer m where #

Indicates that the current monad can provide a Tracer and related context. It assumes some form of environment. While this exposes some mutable state, all of it is hidden away behind the recordSpan api.

Minimal complete definition

getTracer, currentTrace, currentSpan, isDebug

Methods

getTracer #

Arguments

:: m Tracer

Tracer is global to the process

currentTrace #

Arguments

:: m TraceId

Set during the initial request from the outside world, this is propagated across all nodes in the call

currentSpan #

Arguments

:: m (IORef SpanId)

Set via recordSpan

isDebug #

Arguments

:: m Bool

Set during the initial request from the outside world, this is propagated across all nodes in the call

class ToSpanTag a where #

The type in question may be converted into a SpanTag

Minimal complete definition

toSpanTag

Methods

toSpanTag :: a -> SpanTag #

Instances

ToJSON a => ToSpanTag a #
Instance details Defined in Tracing.Core Methods toSpanTag :: a -> SpanTag #
ToSpanTag SpanTag #
Instance details Defined in Tracing.Core Methods toSpanTag :: SpanTag -> SpanTag #

data Tag #

Allows for easily representing multiple types in a tag list

Constructors

ToSpanTag a => Tag Text a

recordSpan :: (MonadIO m, MonadBaseControl IO m, MonadTracer m) => Maybe SpanRelationTag -> [Tag] -> OpName -> m a -> m a #

Wraps a computation & writes it to the Tracer's IORef. To start a new top-level span, and therefore a new trace, call this function with *spanType* == Nothing. Otherwise, this will create a child span.

Doesn't support parallel computations yet

debugPrintSpan :: Span -> Text #

Dump the details of a span. Used for debugging or logging