sampler

type Consumer ¶

type Consumer interface {
	Consume(s *Sample, custom interface{})
	Close()
}

Consumer receives a resulting Sample

type Producer ¶

type Producer interface {
	Produce(ctx context.Context, sampleID uint64) (interface{}, error)
}

Producer is responsible for producing a single sample the function should return an error if it fails, custom can be used to send domain specific data to the collector.

type ProducerConsumer ¶

type ProducerConsumer interface {
	Producer
	Consumer
}

type ProducerFunc ¶

type ProducerFunc func(context.Context, uint64) (customData interface{}, err error)

func (f ProducerFunc) Produce(ctx context.Context, sampleID uint64) (interface{}, error)

type Runner ¶

type Runner interface {
	Run(stop context.Context) (done context.Context)
}

Runner will run the sampler asynchronously, it returns a context immediately that the caller can wait on. the done context is cancelled when:

• all the goroutines have completed
• all samples have been collected

func NewWithProducerConsumer(interval time.Duration, pc ProducerConsumer) Runner

type Sample ¶

type Sample struct {
	// ID represents the number that uniquely identifies a given sample
	// from the following ordered sequence
	//  1, 2, 3 ... n
	ID         uint64
	StartedAt  time.Time
	FinishedAt time.Time
	// Err is set if the sample had an error (it failed), otherwise nil
	Err error
}

Sample holds information related to a sample

func (s Sample) String() string

type SortedByID ¶

type SortedByID []*Sample

func (s SortedByID) Len() int

func (s SortedByID) Less(i, j int) bool

func (s SortedByID) Swap(i, j int)

type SortedByStartedAt ¶

type SortedByStartedAt []*Sample

func (s SortedByStartedAt) Len() int

func (s SortedByStartedAt) Less(i, j int) bool

func (s SortedByStartedAt) Swap(i, j int)