stats

Documentation

Index

• type BucketScore
  • func (b *BucketScore) String() string
• type BucketScoreArray
  • func (b BucketScoreArray) Len() int
  • func (b BucketScoreArray) Less(i, j int) bool
  • func (b BucketScoreArray) Swap(i, j int)
• type BucketScores
• type Listener
  • func NewMemoryStatsListener() Listener
  • func NewRedisClusterStatsListener(redisClusterOpts *redis.ClusterOptions, statsBatchSize int, ...) Listener
  • func NewRedisStatsListener(redisOpts *redis.Options, statsBatchSize int, statsBatchDeadline time.Duration) Listener

Types

type BucketScore

type BucketScore struct {
	Bucket string `json:"bucket"`
	Score  int64  `json:"value"`
}

BucketScore stores a specific bucket's stats. Used for top-lists.

func (*BucketScore) String

func (b *BucketScore) String() string

type BucketScoreArray

type BucketScoreArray []*BucketScore

BucketScoreArray mplements a sortable BucketScore array

func (BucketScoreArray) Len

func (b BucketScoreArray) Len() int

func (BucketScoreArray) Less

func (b BucketScoreArray) Less(i, j int) bool

func (BucketScoreArray) Swap

func (b BucketScoreArray) Swap(i, j int)

type BucketScores

type BucketScores struct {
	Hits   int64 `json:"hits"`
	Misses int64 `json:"misses"`
}

BucketScores stores a specific bucket's stats on hits and misses

type Listener

type Listener interface {
	TopHits(string) []*BucketScore
	TopMisses(string) []*BucketScore
	Get(string, string) *BucketScores
	HandleEvent(events.Event)
}

Listener is an interface for consuming and retrieving dynamic bucket hits and misses

func NewMemoryStatsListener

func NewMemoryStatsListener() Listener

NewMemoryStatsListener creates an in-memory stats listener.

func NewRedisClusterStatsListener

func NewRedisClusterStatsListener(redisClusterOpts *redis.ClusterOptions, statsBatchSize int, statsBatchDeadline time.Duration) Listener

NewRedisClusterStatsListener creates a stats listener backed by a Redis cluster.

func NewRedisStatsListener

func NewRedisStatsListener(redisOpts *redis.Options, statsBatchSize int, statsBatchDeadline time.Duration) Listener

NewRedisStatsListener creates a stats listener backed by a standalone Redis instance.