Monitor.Tracing.Zipkin

Zipkin trace publisher.

Set up the trace collector

data Zipkin

A Zipkin trace publisher.

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

Creates a Zipkin publisher for the input Settings.

data Settings

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

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

data Endpoint

Information about a hosted service.

Constructors

Endpoint

Fields

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

Instances

Eq Endpoint

Defined in Monitor.Tracing.Zipkin

Methods

(==) :: Endpoint -> Endpoint -> Bool

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

Ord Endpoint

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

Defined in Monitor.Tracing.Zipkin

Methods

showsPrec :: Int -> Endpoint -> ShowS

show :: Endpoint -> String

showList :: [Endpoint] -> ShowS

ToJSON Endpoint

Defined in Monitor.Tracing.Zipkin

Methods

toJSON :: Endpoint -> Value

toEncoding :: Endpoint -> Encoding

toJSONList :: [Endpoint] -> Value

toEncodingList :: [Endpoint] -> Encoding

defaultEndpoint :: Endpoint

An empty endpoint.

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

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 ()

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

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

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

Record cross-process spans

data B3

Exportable trace information, used for cross-process traces.

Instances

Eq B3

Defined in Monitor.Tracing.Zipkin

Methods

(==) :: B3 -> B3 -> Bool

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

Show B3

Defined in Monitor.Tracing.Zipkin

Methods

showsPrec :: Int -> B3 -> ShowS

show :: B3 -> String

showList :: [B3] -> ShowS

ToJSON B3

Defined in Monitor.Tracing.Zipkin

Methods

toJSON :: B3 -> Value

toEncoding :: B3 -> Encoding

toJSONList :: [B3] -> Value

toEncodingList :: [B3] -> Encoding

FromJSON B3

Defined in Monitor.Tracing.Zipkin

Methods

parseJSON :: Value -> Parser B3

parseJSONList :: Value -> Parser [B3]

b3FromHeaders :: Map Text Text -> Maybe B3

Deserializes the B3 from headers.

b3ToHeaders :: B3 -> Map Text Text

Serializes the B3 to headers, suitable for HTTP requests.

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

Generates a child span with CLIENT kind. This function also provides the corresponding B3 so that it can be forwarded to the server.

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

Generates a child span with SERVER kind. The client's B3 should be provided as input.

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

Generates a child span with PRODUCER kind. This function also provides the corresponding B3 so that it can be forwarded to the consumer.

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

Generates a child span with CONSUMER kind. The producer's B3 should be provided as input.

Add metadata

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

Adds a tag to the active span.

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

Annotates the active span using the current time.

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

Annotates the active span at the given time.