hotkey

Documentation

Index

• type Collector
  • func NewCollector(capacity uint8, options ...collectorOption) *Collector
  • func (c *Collector) AllocCounter(name string) *Counter
  • func (c *Collector) HotKeys() []HotKey
  • func (c *Collector) Run(stop <-chan struct{})
• type Counter
  • func NewCounter(capacity uint8, freeCb func()) *Counter
  • func (c *Counter) Free()
  • func (c *Counter) Incr(key string)
  • func (c *Counter) Latch() map[string]uint64
• type HotKey

Types

type Collector

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

Collector is used to collect hot keys.

func NewCollector

func NewCollector(capacity uint8, options ...collectorOption) *Collector

NewCollector creates a hot keys collector with given parameters.

func (*Collector) AllocCounter

func (c *Collector) AllocCounter(name string) *Counter

AllocCounter allocates a general counter which is used to record the actual visits of keys.

func (*Collector) HotKeys

func (c *Collector) HotKeys() []HotKey

HotKeys returns the collected hot keys which are sorted by logarithmic hit count.

func (*Collector) Run

func (c *Collector) Run(stop <-chan struct{})

Run runs the collector unitl receive the stop signal.

type Counter

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

Counter is used to record the actual visits number of keys. To minimize the memory footprint, only the keys that are frequently accessed are recorded.

It's not goroutine-safe, every redis client should have its own.

func NewCounter

func NewCounter(capacity uint8, freeCb func()) *Counter

NewCounter creates a counter with given parameters. NOTE: It's only for test, don't rely on it directly.

func (*Counter) Free

func (c *Counter) Free()

Free frees the counter.

func (*Counter) Incr

func (c *Counter) Incr(key string)

Incr increases the specified key visits.

func (*Counter) Latch

func (c *Counter) Latch() map[string]uint64

Latch returns the cached key visits and reset it.

type HotKey

type HotKey struct {
	Name    string
	Counter *logrithmCounter
}

HotKey represents a hot key.