twirptrace

Documentation

Index

• Constants
• func NewOpenTracingHooks(tracer otrace.Tracer, opts ...TraceOption) *twirp.ServerHooks
• func WithTraceContext(base http.Handler, tracer otrace.Tracer) http.Handler
• type HTTPClient
• type TraceHTTPClient
  • func NewTraceHTTPClient(client HTTPClient) *TraceHTTPClient
  • func (c *TraceHTTPClient) Do(r *http.Request) (*http.Response, error)
• type TraceOption
  • func IncludeClientErrors(includeClientErrors bool) TraceOption
  • func WithContextTags(fn func(ctx context.Context) (context.Context, []TraceTag)) TraceOption
  • func WithTags(tags ...TraceTag) TraceOption
• type TraceOptions
• type TraceServerHooks
  • func (t *TraceServerHooks) TwirpHooks() *twirp.ServerHooks
• type TraceTag

Constants

const (
	RequestReceivedEvent = "request.received"
)

Functions

func NewOpenTracingHooks

func NewOpenTracingHooks(tracer otrace.Tracer, opts ...TraceOption) *twirp.ServerHooks

NewOpenTracingHooks provides a twirp.ServerHooks struct which records OpenTracing spans.

func WithTraceContext

func WithTraceContext(base http.Handler, tracer otrace.Tracer) http.Handler

WithTraceContext wraps the handler and extracts the span context from request headers to attach to the context for connecting client and server calls.

Types

type HTTPClient

type HTTPClient interface {
	Do(req *http.Request) (*http.Response, error)
}

HTTPClient as an interface that models *http.Client.

type TraceHTTPClient

type TraceHTTPClient struct {
	// contains filtered or unexported fields
}

TraceHTTPClient wraps a provided http.Client and tracer for instrumenting requests.

func NewTraceHTTPClient

func NewTraceHTTPClient(client HTTPClient) *TraceHTTPClient

func (*TraceHTTPClient) Do

func (c *TraceHTTPClient) Do(r *http.Request) (*http.Response, error)

Do injects the tracing headers into the tracer and updates the headers before making the actual request.

type TraceOption

type TraceOption func(opts *TraceOptions)

func IncludeClientErrors

func IncludeClientErrors(includeClientErrors bool) TraceOption

IncludeClientErrors, if set, will report client errors (4xx) as errors in the server span. If not set, only 5xx status will be reported as erroneous.

func WithContextTags

func WithContextTags(fn func(ctx context.Context) (context.Context, []TraceTag)) TraceOption

WithContextTags defines a function that returns set of trace tags. This is useful to extract values from the request ctx and return a set of tags that are set on the span. The function is used during the `RequestReceived` server hook.

func WithTags

func WithTags(tags ...TraceTag) TraceOption

WithTags defines tags to be added to each outoing span by default. If there is a pre-existing tag set for `key`, it is overwritten.

type TraceOptions

type TraceOptions struct {
	// contains filtered or unexported fields
}

type TraceServerHooks

type TraceServerHooks struct {
	Tracer otrace.Tracer
	// contains filtered or unexported fields
}

func (*TraceServerHooks) TwirpHooks

func (t *TraceServerHooks) TwirpHooks() *twirp.ServerHooks

type TraceTag

type TraceTag struct {
	// Key defines the span's tag key.
	Key string

	// Value defines the span's tag value. Values can be numeric types, strings, or
	// bools.
	Value interface{}
}

TraceTag represents a single span tag.