Tapper v0.1.1 API Reference
Modules
Client API for Tapper
Tapper main application; configures and starts application supervisor
Support functions for configuration parsing
Encode protocol spans to JSON suitable for sending to Zipkin Server API
Endpoint description struct; used everywhere an endpoint is required
The ID used with the API; tracks nested spans
Defines the intermediate data structures used between the Tracer, and Reporters,
containing only de-normalised fields relevant to the data transfer to trace collectors
(e.g. Zipkin server), de-coupling from internal Tracer server state. In particular,
protocol spans have a duration
, rather than an end_timestamp
Annotation, with endpoint and timestamp
Binary annotation with type, key, value, and endpoint
Endpoint, with service name
A span, with hierarchy, start time, duration and annotations
Reporter modules should implement this behaviour
Reporter that just logs JSON
Reporter that sends spans to Zipkin Server API
Generate, format or parse a span id
Timestamp
Generate, parse or format a top-level trace id
Low-level client API, interfaces between a Tapper client and a Tapper.Tracer.Server
Helpers for creating annotations
The (minimal) low-level API for the Tapper.Tracer
; clients will normally use the Tapper
module
The Trace server
Supervises Tapper.Tracer.Server
instances
Clean up a trace after a time-out
Tracer internal state, and functions to convert this to protocol spans (Tapper.Protocol)
Converts Trace to Protocol spans