Safe Haskell	None
Language	Haskell2010

Monitor.Tracing.Zipkin

Contents

Set up the trace collector
Record in-process spans
Record cross-process spans
Add metadata

Description

Zipkin trace publisher.

Synopsis

data Zipkin
new :: MonadIO m => Settings -> m Zipkin
data Settings = Settings {
- settingsHostname :: !HostName
- settingsPort :: !PortNumber
- settingsEndpoint :: !(Maybe Endpoint)
- settingsManager :: !(Maybe Manager)
- settingsPublishPeriod :: !NominalDiffTime
}
defaultSettings :: Settings
data Endpoint = Endpoint {
- endpointService :: !(Maybe Text)
- endpointPort :: !(Maybe Int)
- endpointIPv4 :: !(Maybe IPv4)
- endpointIPv6 :: !(Maybe IPv6)
}
defaultEndpoint :: Endpoint
run :: Zipkin -> TraceT m a -> m a
publish :: MonadIO m => Zipkin -> m ()
with :: MonadUnliftIO m => Settings -> (Zipkin -> m a) -> m a
rootSpan :: MonadTrace m => Sampling -> Name -> m a -> m a
data Sampling
- = Accept
- | Debug
- | Deny
localSpan :: MonadTrace m => Name -> m a -> m a
data B3
clientSpan :: MonadTrace m => Maybe Endpoint -> Name -> (Maybe B3 -> m a) -> m a
serverSpan :: MonadTrace m => Maybe Endpoint -> B3 -> m a -> m a
producerSpan :: MonadTrace m => Maybe Endpoint -> Name -> (Maybe B3 -> m a) -> m a
consumerSpan :: MonadTrace m => Maybe Endpoint -> B3 -> m a -> m a
tag :: MonadTrace m => Text -> Text -> m ()
annotate :: MonadTrace m => Text -> m ()
annotateAt :: MonadTrace m => POSIXTime -> Text -> m ()

Set up the trace collector

data Zipkin Source #

A Zipkin trace publisher.

new :: MonadIO m => Settings -> m Zipkin Source #

Creates a Zipkin publisher for the input Settings.

data Settings Source #

Zipkin creating settings.

Constructors

Settings

Fields

settingsHostname :: !HostName
The Zipkin server's hostname.
settingsPort :: !PortNumber
The port the Zipkin server is listening on.
settingsEndpoint :: !(Maybe Endpoint)
Local endpoint used for all published spans.
settingsManager :: !(Maybe Manager)
An optional HTTP manager to use for publishing spans on the Zipkin server.
settingsPublishPeriod :: !NominalDiffTime
If set to a positive value, traces will be flushed in the background every such period.

defaultSettings :: Settings Source #

Creates Settings pointing to a Zikpin server at host "localhost" and port 9411, without background flushing.

data Endpoint Source #

Information about a hosted service.

Constructors

Endpoint
Fields endpointService :: !(Maybe Text) endpointPort :: !(Maybe Int) endpointIPv4 :: !(Maybe IPv4) endpointIPv6 :: !(Maybe IPv6)

Instances

Eq Endpoint Source #
Instance details Defined in Monitor.Tracing.Zipkin Methods (==) :: Endpoint -> Endpoint -> Bool # (/=) :: Endpoint -> Endpoint -> Bool #
Ord Endpoint Source #
Instance details Defined in Monitor.Tracing.Zipkin Methods compare :: Endpoint -> Endpoint -> Ordering # (<) :: Endpoint -> Endpoint -> Bool # (<=) :: Endpoint -> Endpoint -> Bool # (>) :: Endpoint -> Endpoint -> Bool # (>=) :: Endpoint -> Endpoint -> Bool # max :: Endpoint -> Endpoint -> Endpoint # min :: Endpoint -> Endpoint -> Endpoint #
Show Endpoint Source #
Instance details Defined in Monitor.Tracing.Zipkin Methods showsPrec :: Int -> Endpoint -> ShowS # show :: Endpoint -> String # showList :: [Endpoint] -> ShowS #
ToJSON Endpoint Source #
Instance details Defined in Monitor.Tracing.Zipkin Methods toJSON :: Endpoint -> Value # toEncoding :: Endpoint -> Encoding # toJSONList :: [Endpoint] -> Value # toEncodingList :: [Endpoint] -> Encoding #

defaultEndpoint :: Endpoint Source #

An empty endpoint.

run :: Zipkin -> TraceT m a -> m a Source #

Runs a TraceT action, sampling spans appropriately. Note that this method does not publish spans on its own; to do so, either call publish manually or specify a positive settingsPublishPeriod to publish in the background.

publish :: MonadIO m => Zipkin -> m () Source #

Flushes all complete spans to the Zipkin server. This method is thread-safe.

with :: MonadUnliftIO m => Settings -> (Zipkin -> m a) -> m a Source #

Convenience method to start a Zipkin, run an action, and publish all spans before returning.

Record in-process spans

rootSpan :: MonadTrace m => Sampling -> Name -> m a -> m a Source #

Starts a new trace.

data Sampling Source #

The sampling applied to a trace.

Note that non-sampled traces still yield active spans. However these spans are not published to Zipkin.

Constructors

Accept	Sample it.
Debug	Sample it and mark it as debug.
Deny	Do not sample it.

Instances

Enum Sampling Source #
Instance details Defined in Monitor.Tracing.Zipkin Methods succ :: Sampling -> Sampling # pred :: Sampling -> Sampling # toEnum :: Int -> Sampling # fromEnum :: Sampling -> Int # enumFrom :: Sampling -> [Sampling] # enumFromThen :: Sampling -> Sampling -> [Sampling] # enumFromTo :: Sampling -> Sampling -> [Sampling] # enumFromThenTo :: Sampling -> Sampling -> Sampling -> [Sampling] #
Eq Sampling Source #
Instance details Defined in Monitor.Tracing.Zipkin Methods (==) :: Sampling -> Sampling -> Bool # (/=) :: Sampling -> Sampling -> Bool #
Ord Sampling Source #
Instance details Defined in Monitor.Tracing.Zipkin Methods compare :: Sampling -> Sampling -> Ordering # (<) :: Sampling -> Sampling -> Bool # (<=) :: Sampling -> Sampling -> Bool # (>) :: Sampling -> Sampling -> Bool # (>=) :: Sampling -> Sampling -> Bool # max :: Sampling -> Sampling -> Sampling # min :: Sampling -> Sampling -> Sampling #
Show Sampling Source #
Instance details Defined in Monitor.Tracing.Zipkin Methods showsPrec :: Int -> Sampling -> ShowS # show :: Sampling -> String # showList :: [Sampling] -> ShowS #

localSpan :: MonadTrace m => Name -> m a -> m a Source #

Continues an existing trace if present, otherwise does nothing.

Record cross-process spans

data B3 Source #

Exportable trace information, used for cross-process traces.

Instances

Eq B3 Source #
Instance details Defined in Monitor.Tracing.Zipkin Methods (==) :: B3 -> B3 -> Bool # (/=) :: B3 -> B3 -> Bool #
Show B3 Source #
Instance details Defined in Monitor.Tracing.Zipkin Methods showsPrec :: Int -> B3 -> ShowS # show :: B3 -> String # showList :: [B3] -> ShowS #
ToJSON B3 Source #
Instance details Defined in Monitor.Tracing.Zipkin Methods toJSON :: B3 -> Value # toEncoding :: B3 -> Encoding # toJSONList :: [B3] -> Value # toEncodingList :: [B3] -> Encoding #
FromJSON B3 Source #
Instance details Defined in Monitor.Tracing.Zipkin Methods parseJSON :: Value -> Parser B3 # parseJSONList :: Value -> Parser [B3] #

clientSpan :: MonadTrace m => Maybe Endpoint -> Name -> (Maybe B3 -> m a) -> m a Source #

serverSpan :: MonadTrace m => Maybe Endpoint -> B3 -> m a -> m a Source #

producerSpan :: MonadTrace m => Maybe Endpoint -> Name -> (Maybe B3 -> m a) -> m a Source #

consumerSpan :: MonadTrace m => Maybe Endpoint -> B3 -> m a -> m a Source #

Add metadata

tag :: MonadTrace m => Text -> Text -> m () Source #

Adds a tag to the active span.

annotate :: MonadTrace m => Text -> m () Source #

Annotates the active span using the current time.

annotateAt :: MonadTrace m => POSIXTime -> Text -> m () Source #

Annotates the active span at the given time.