Documentation
¶
Overview ¶
Package tracing implements utility functions for interacting with a global tracing system. Currently this system uses the opentracing APIs. However, eventually we will need to migrate to the new opentelemetry APIs, and therefore in order to reduce disruption this package abstracts interaction with these packages.
Index ¶
- func FinishSpans(msg *message.Batch)
- func InitSpan(operationName string, part *message.Part) *message.Part
- func InitSpanFromParent(operationName string, parent *Span, part *message.Part) *message.Part
- func InitSpans(operationName string, msg *message.Batch)
- func InitSpansFromParent(operationName string, parent *Span, msg *message.Batch)
- func InitSpansFromParentTextMap(operationName string, textMapGeneric map[string]interface{}, ...) error
- func IterateWithChildSpans(operationName string, msg *message.Batch, ...) error
- func WithSiblingSpans(operationName string, msg *message.Batch) *message.Batch
- type Span
- func CreateChildSpan(operationName string, part *message.Part) *Span
- func CreateChildSpans(operationName string, msg *message.Batch) []*Span
- func GetSpan(p *message.Part) *Span
- func PartsWithChildSpans(operationName string, parts []*message.Part) ([]*message.Part, []*Span)
- func WithChildSpans(operationName string, msg *message.Batch) (*message.Batch, []*Span)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func FinishSpans ¶
FinishSpans calls Finish on all message parts containing a span.
func InitSpan ¶
InitSpan sets up an OpenTracing span on a message part if one does not already exist.
func InitSpanFromParent ¶
InitSpanFromParent sets up an OpenTracing span as children of a parent span on a message part if one does not already exist.
func InitSpans ¶
InitSpans sets up OpenTracing spans on each message part if one does not already exist.
func InitSpansFromParent ¶
InitSpansFromParent sets up OpenTracing spans as children of a parent span on each message part if one does not already exist.
func InitSpansFromParentTextMap ¶
func InitSpansFromParentTextMap(operationName string, textMapGeneric map[string]interface{}, msg *message.Batch) error
InitSpansFromParentTextMap obtains a span parent reference from a text map and creates child spans for each message.
func IterateWithChildSpans ¶
func IterateWithChildSpans(operationName string, msg *message.Batch, iter func(int, *Span, *message.Part) error) error
IterateWithChildSpans iterates all the parts of a message and, for each part, creates a new span from an existing span attached to the part and calls a func with that span before finishing the child span.
Types ¶
type Span ¶
type Span struct {
// contains filtered or unexported fields
}
Span abstracts the span type of our global tracing system in order to allow it to be replaced in future.
func CreateChildSpan ¶
CreateChildSpan takes a message part, extracts an existing span if there is one and returns child span.
func CreateChildSpans ¶
CreateChildSpans takes a message, extracts spans per message part and returns a slice of child spans. The length of the returned slice is guaranteed to match the message size.
func GetSpan ¶
GetSpan returns a span attached to a message part. Returns nil if the part doesn't have a span attached.
func PartsWithChildSpans ¶
PartsWithChildSpans takes a slice of message parts, extracts spans per part, creates new child spans, and returns a new slice of parts with those spans embedded. The original parts are unchanged.
func WithChildSpans ¶
WithChildSpans takes a message, extracts spans per message part, creates new child spans, and returns a new message with those spans embedded. The original message is unchanged.
Source Files