sampler.go

package middleware

import (
	"math/rand"
	"sync"
	"sync/atomic"
	"time"
)

type (
	// Sampler is an interface for computing when a sample falls within a range.
	Sampler interface {
		// Sample returns true if the caller should sample now.
		Sample() bool
	}

	adaptiveSampler struct {
		sync.Mutex
		lastRate        int64
		maxSamplingRate int
		sampleSize      uint32
		start           time.Time
		counter         uint32
	}

	fixedSampler int
)

const (
	// adaptive upper bound has granularity in case caller becomes extremely busy.
	adaptiveUpperBoundInt   = 10000
	adaptiveUpperBoundFloat = float64(adaptiveUpperBoundInt)
)

var rnd = rand.New(rand.NewSource(1))

// NewAdaptiveSampler computes the interval for sampling for tracing middleware.
// it can also be used by non-web go routines to trace internal API calls.
//
// maxSamplingRate is the desired maximum sampling rate in requests per second.
//
// sampleSize sets the number of requests between two adjustments of the
// sampling rate when MaxSamplingRate is set. the sample rate cannot be adjusted
// until the sample size is reached at least once.
func NewAdaptiveSampler(maxSamplingRate, sampleSize int) Sampler {
	if maxSamplingRate <= 0 {
		panic("maxSamplingRate must be greater than 0")
	}
	if sampleSize <= 0 {
		panic("sample size must be greater than 0")
	}
	return &adaptiveSampler{
		lastRate:        adaptiveUpperBoundInt, // samples all until initial count reaches sample size
		maxSamplingRate: maxSamplingRate,
		sampleSize:      uint32(sampleSize),
		start:           time.Now(),
	}
}

// NewFixedSampler sets the tracing sampling rate as a percentage value.
func NewFixedSampler(samplingPercent int) Sampler {
	if samplingPercent < 0 || samplingPercent > 100 {
		panic("samplingPercent must be between 0 and 100")
	}
	return fixedSampler(samplingPercent)
}

// Sample implementation for adaptive rate
func (s *adaptiveSampler) Sample() bool {
	// adjust sampling rate whenever sample size is reached.
	var currentRate int
	if atomic.AddUint32(&s.counter, 1) == s.sampleSize { // exact match prevents
		atomic.StoreUint32(&s.counter, 0) // race is ok
		s.Lock()
		{
			d := time.Since(s.start).Seconds()
			r := float64(s.sampleSize) / d
			currentRate = int((float64(s.maxSamplingRate) * adaptiveUpperBoundFloat) / r)
			if currentRate > adaptiveUpperBoundInt {
				currentRate = adaptiveUpperBoundInt
			} else if currentRate < 1 {
				currentRate = 1
			}
			s.start = time.Now()
		}
		s.Unlock()
		atomic.StoreInt64(&s.lastRate, int64(currentRate))
	} else {
		currentRate = int(atomic.LoadInt64(&s.lastRate))
	}

	// currentRate is never zero.
	return currentRate == adaptiveUpperBoundInt || rnd.Intn(adaptiveUpperBoundInt) < currentRate
}

// Sample implementation for fixed percentage
func (s fixedSampler) Sample() bool {
	samplingPercent := int(s)
	return samplingPercent > 0 && (samplingPercent == 100 || rnd.Intn(100) < samplingPercent)
}