Documentation
¶
Overview ¶
Package mocktracer provides a mock implementation of the tracer used in testing. It allows querying spans generated at runtime, without having them actually be sent to an agent. It provides a simple way to test that instrumentation is running correctly in your application.
Simply call "Start" at the beginning of your tests to start and obtain an instance of the mock tracer.
Example ¶
package main
import (
"github.com/DataDog/dd-trace-go/v2/ddtrace/mocktracer"
)
func main() {
// Start the mock tracer.
mt := mocktracer.Start()
defer mt.Stop()
// ...run some code with generates spans.
// Query the mock tracer for finished spans.
spans := mt.FinishedSpans()
if len(spans) != 1 {
// should only have 1 span
panic("expected 1 span")
}
// Run assertions...
}
Index ¶
- func UnwrapSlice(ss []*Span) []*tracer.Span
- type DSMBacklog
- type Span
- func (s *Span) AddLink(spanContext *tracer.SpanContext, attributes map[string]string)
- func (s *Span) AddSpanLink(link tracer.SpanLink)
- func (s *Span) Context() *tracer.SpanContext
- func (s *Span) Duration() time.Duration
- func (s *Span) FinishTime() time.Time
- func (s *Span) Integration() string
- func (s *Span) Links() []tracer.SpanLink
- func (s *Span) OperationName() string
- func (s *Span) ParentID() uint64
- func (s *Span) SetTag(k string, v interface{})
- func (s *Span) SetUser(id string, opts ...tracer.UserMonitoringOption)
- func (s *Span) SpanID() uint64
- func (s *Span) StartTime() time.Time
- func (s *Span) String() string
- func (s *Span) Tag(k string) interface{}
- func (s *Span) Tags() map[string]interface{}
- func (s *Span) TraceID() uint64
- func (s *Span) Unwrap() *tracer.Span
- type Tracer
Examples ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func UnwrapSlice ¶
Types ¶
type DSMBacklog ¶
type DSMBacklog = datastreams.Backlog
DSMBacklog is an alias to datastreams.Backlog
type Span ¶
type Span struct {
// contains filtered or unexported fields
}
func (*Span) AddLink ¶
func (s *Span) AddLink(spanContext *tracer.SpanContext, attributes map[string]string)
func (*Span) AddSpanLink ¶
func (*Span) Context ¶
func (s *Span) Context() *tracer.SpanContext
Context returns the SpanContext of this Span.
func (*Span) FinishTime ¶
func (*Span) Integration ¶
Integration returns the component from which the mockspan was created.
func (*Span) OperationName ¶
func (*Span) SetUser ¶
func (s *Span) SetUser(id string, opts ...tracer.UserMonitoringOption)
SetUser associates user information to the current trace which the provided span belongs to. The options can be used to tune which user bit of information gets monitored. This mockup only sets the user information as span tags of the root span of the current trace.
type Tracer ¶
type Tracer interface {
tracer.Tracer
// OpenSpans returns the set of started spans that have not been finished yet.
OpenSpans() []*Span
FinishSpan(*tracer.Span)
// FinishedSpans returns the set of finished spans.
FinishedSpans() []*Span
SentDSMBacklogs() []DSMBacklog
// Reset resets the spans and services recorded in the tracer. This is
// especially useful when running tests in a loop, where a clean start
// is desired for FinishedSpans calls.
Reset()
// Stop deactivates the mock tracer and allows a normal tracer to take over.
// It should always be called when testing has finished.
Stop()
}
Tracer exposes an interface for querying the currently running mock tracer.
Source Files