Documentation
¶
Index ¶
- Constants
- Variables
- func AnnotateClient(newSpan NewSpanFunc, c Collector) endpoint.Middleware
- func AnnotateServer(newSpan NewSpanFunc, c Collector) endpoint.Middleware
- func ToContext(newSpan NewSpanFunc, logger log.Logger) func(ctx context.Context, r *http.Request) context.Context
- func ToRequest(newSpan NewSpanFunc) func(ctx context.Context, r *http.Request) context.Context
- type Collector
- type MultiCollector
- type NewSpanFunc
- type NopCollector
- type ScribeCollector
- type ScribeOption
- type Span
Constants ¶
const ( // ClientSend is the annotation value used to mark a client sending a // request to a server. ClientSend = "cs" // ServerReceive is the annotation value used to mark a server's receipt // of a request from a client. ServerReceive = "sr" // ServerSend is the annotation value used to mark a server's completion // of a request and response to a client. ServerSend = "ss" // ClientReceive is the annotation value used to mark a client's receipt // of a completed request from a server. ClientReceive = "cr" )
Variables ¶
var (
// SpanContextKey represents the Span in the request context.
SpanContextKey = "Zipkin-Span"
)
Functions ¶
func AnnotateClient ¶
func AnnotateClient(newSpan NewSpanFunc, c Collector) endpoint.Middleware
AnnotateClient returns a middleware that extracts a parent span from the context, produces a client (child) span from it, adds client-send and client-receive annotations at the boundaries, and submits the span to the collector. If no span is found in the context, a new span is generated and inserted.
func AnnotateServer ¶
func AnnotateServer(newSpan NewSpanFunc, c Collector) endpoint.Middleware
AnnotateServer returns a server.Middleware that extracts a span from the context, adds server-receive and server-send annotations at the boundaries, and submits the span to the collector. If no span is found in the context, a new span is generated and inserted.
func ToContext ¶
func ToContext(newSpan NewSpanFunc, logger log.Logger) func(ctx context.Context, r *http.Request) context.Context
ToContext returns a function that satisfies transport/http.BeforeFunc. It takes a Zipkin span from the incoming HTTP request, and saves it in the request context. It's designed to be wired into a server's HTTP transport Before stack. The logger is used to report errors.
func ToRequest ¶
ToRequest returns a function that satisfies transport/http.BeforeFunc. It takes a Zipkin span from the context, and injects it into the HTTP request. It's designed to be wired into a client's HTTP transport Before stack. It's expected that AnnotateClient has already ensured the span in the context is a child/client span.
Types ¶
type Collector ¶
Collector represents a Zipkin trace collector, which is probably a set of remote endpoints.
func NewScribeCollector ¶
func NewScribeCollector(addr string, timeout time.Duration, options ...ScribeOption) (Collector, error)
NewScribeCollector returns a new Scribe-backed Collector. addr should be a TCP endpoint of the form "host:port". timeout is passed to the Thrift dial function NewTSocketFromAddrTimeout. batchSize and batchInterval control the maximum size and interval of a batch of spans; as soon as either limit is reached, the batch is sent. The logger is used to log errors, such as batch send failures; users should provide an appropriate context, if desired.
type MultiCollector ¶
type MultiCollector []Collector
MultiCollector implements Collector by sending spans to all collectors.
func (MultiCollector) Collect ¶
func (c MultiCollector) Collect(s *Span) error
Collect implements Collector.
type NewSpanFunc ¶
NewSpanFunc takes trace, span, & parent span IDs to produce a Span object.
func MakeNewSpanFunc ¶
func MakeNewSpanFunc(hostport, serviceName, methodName string) NewSpanFunc
MakeNewSpanFunc returns a function that generates a new Zipkin span.
type NopCollector ¶
type NopCollector struct{}
NopCollector implements Collector but performs no work.
func (NopCollector) Collect ¶
func (NopCollector) Collect(*Span) error
Collect implements Collector.
type ScribeCollector ¶
type ScribeCollector struct {
// contains filtered or unexported fields
}
ScribeCollector implements Collector by forwarding spans to a Scribe service, in batches.
func (*ScribeCollector) Collect ¶
func (c *ScribeCollector) Collect(s *Span) error
Collect implements Collector.
type ScribeOption ¶
type ScribeOption func(s *ScribeCollector)
ScribeOption sets a parameter for the StdlibAdapter.
func ScribeBatchInterval ¶
func ScribeBatchInterval(d time.Duration) ScribeOption
ScribeBatchInterval sets the maximum duration we will buffer traces before emitting them to the collector. The default batch interval is 1 second.
func ScribeBatchSize ¶
func ScribeBatchSize(n int) ScribeOption
ScribeBatchSize sets the maximum batch size, after which a collect will be triggered. The default batch size is 100 traces.
func ScribeLogger ¶
func ScribeLogger(logger log.Logger) ScribeOption
ScribeLogger sets the logger used to report errors in the collection process. By default, a no-op logger is used, i.e. no errors are logged anywhere. It's important to set this option in a production service.
func ScribeSampleRate ¶
func ScribeSampleRate(f float64) ScribeOption
ScribeSampleRate sets the sample rate used to determine if a trace will be sent to the collector. By default, the sample rate is 1.0, i.e. all traces are sent.
type Span ¶
type Span struct {
// contains filtered or unexported fields
}
A Span is a named collection of annotations. It represents meaningful information about a single method call, i.e. a single request against a service. Clients should annotate the span, and submit it when the request that generated it is complete.
func NewSpan ¶
NewSpan returns a new Span, which can be annotated and collected by a collector. Spans are passed through the request context to each middleware under the SpanContextKey.
func (*Span) AnnotateDuration ¶
AnnotateDuration annotates the span with the given value and duration.
func (*Span) Encode ¶
func (s *Span) Encode() *zipkincore.Span
Encode creates a Thrift Span from the gokit Span.
func (*Span) ParentSpanID ¶
ParentSpanID returns the ID of the span which invoked this span. It may be zero.
Source Files
Directories