jaeger

Documentation

Overview

Package jaeger provides some convenience data structures for integration testing. Disable some linting, as this is just a test class where readability is preferred to performance nolint:gocritic

Index

• Constants
• type DiffResult
  • func Diff(expected, actual []Tag) DiffResult
  • func DiffAsRegexp(expected, actual []Tag) DiffResult
  • func (mr DiffResult) String() string
• type ErrType
• type Process
• type Reference
• type Span
  • func (s *Span) Diff(expected ...Tag) DiffResult
  • func (s *Span) DiffAsRegexp(expected ...Tag) DiffResult
• type Tag
  • func FindIn(tags []Tag, key string) (Tag, bool)
• type TagDiff
• type Trace
  • func (t *Trace) ChildrenOf(parentID string) []Span
  • func (t *Trace) FindByOperationName(operationName string) []Span
  • func (t *Trace) ParentOf(s *Span) (Span, bool)
• type TracesQuery
  • func (tq *TracesQuery) FindBySpan(tags ...Tag) []Trace

Constants

const (
	ErrTypeMissing = ErrType(iota)
	ErrTypeNotEqual
	ErrTypeNotMatching
)

Types

type DiffResult

type DiffResult []TagDiff

func Diff

func Diff(expected, actual []Tag) DiffResult

func DiffAsRegexp

func DiffAsRegexp(expected, actual []Tag) DiffResult

DiffAsRegexp works like Diff but it matches the expected tags values as regular expressions when type is "String"

func (DiffResult) String

func (mr DiffResult) String() string

type ErrType

type ErrType int

type Process

type Process struct {
	ServiceName string `json:"serviceName"`
	Tags        []Tag  `json:"tags"`
}

type Reference

type Reference struct {
	RefType string `json:"refType"`
	TraceID string `json:"traceID"`
	SpanID  string `json:"spanID"`
}

type Span

type Span struct {
	TraceID       string      `json:"traceID"`
	SpanID        string      `json:"spanID"`
	OperationName string      `json:"operationName"`
	References    []Reference `json:"references"`
	StartTime     int64       `json:"startTime"`
	Duration      int64       `json:"duration"`
	Tags          []Tag       `json:"tags"`
	ProcessID     string      `json:"processID"`
}

func (*Span) Diff

func (s *Span) Diff(expected ...Tag) DiffResult

func (*Span) DiffAsRegexp

func (s *Span) DiffAsRegexp(expected ...Tag) DiffResult

DiffAsRegexp works like Diff but it matches the expected tags values as regular expressions

type Tag

type Tag struct {
	Key   string      `json:"key"`
	Type  string      `json:"type"`
	Value interface{} `json:"value"`
}

func FindIn

func FindIn(tags []Tag, key string) (Tag, bool)

type TagDiff

type TagDiff struct {
	ErrType  ErrType
	Expected Tag
	Actual   Tag
}

type Trace

type Trace struct {
	TraceID   string             `json:"traceID"`
	Spans     []Span             `json:"spans"`
	Processes map[string]Process `json:"processes"`
}

func (*Trace) ChildrenOf

func (t *Trace) ChildrenOf(parentID string) []Span

func (*Trace) FindByOperationName

func (t *Trace) FindByOperationName(operationName string) []Span

func (*Trace) ParentOf

func (t *Trace) ParentOf(s *Span) (Span, bool)

type TracesQuery

type TracesQuery struct {
	Data []Trace `json:"data"`
}

func (*TracesQuery) FindBySpan

func (tq *TracesQuery) FindBySpan(tags ...Tag) []Trace