cache

type Cache interface {
	// Set adds the trace to the cache. If it is kicking out a trace from the cache
	// that has not yet been sent, it will return that trace. Otherwise returns nil.
	Set(trace *types.Trace) *types.Trace
	Get(traceID string) *types.Trace
	// GetAll is used during shutdown to get all in-flight traces to flush them
	GetAll() []*types.Trace

	// Retrieve and remove all traces which are past their SendBy date.
	// Does not check whether they've been sent.
	TakeExpiredTraces(now time.Time) []*types.Trace
}

type CuckooTraceChecker struct {
	// contains filtered or unexported fields
}

type DefaultInMemCache struct {
	Metrics metrics.Metrics
	Logger  logger.Logger
	// contains filtered or unexported fields
}

type TraceSentCache interface {
	// Record preserves the record of a trace being sent or not.
	Record(trace *types.Trace, keep bool)
	// Check tests if a trace corresponding to the span is in the cache; if found, it returns the appropriate TraceSentRecord and true,
	// else nil and false.
	Check(span *types.Span) (TraceSentRecord, bool)
	// Stop halts the cache in preparation for shutdown
	Stop()
	// Resize adjusts the size of the cache according to the Config passed in
	Resize(cfg config.SampleCacheConfig) error
}

type TraceSentRecord interface {
	// Kept returns whether the trace was kept (sampled and sent to honeycomb) or dropped.
	Kept() bool
	// Rate() returns the sample rate for the trace
	Rate() uint
	// DescendantCount returns the count of items associated with the trace, including all types of children like span links and span events.
	DescendantCount() uint
	// Count records additional spans in the totals
	Count(*types.Span)
}