cachex

Documentation

Index

• type RistrettoCollector
  • func NewRistrettoCollector(prefix string, metricsFunc func() *ristretto.Metrics) *RistrettoCollector
  • func (c *RistrettoCollector) Collect(ch chan<- prometheus.Metric)
  • func (c *RistrettoCollector) Describe(ch chan<- *prometheus.Desc)

Types

type RistrettoCollector

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

RistrettoCollector collects Ristretto cache metrics.

func NewRistrettoCollector

func NewRistrettoCollector(prefix string, metricsFunc func() *ristretto.Metrics) *RistrettoCollector

NewRistrettoCollector creates a new RistrettoCollector.

To use this collector, you need to register it with a Prometheus registry:

func main() {
	cache, _ := ristretto.NewCache(&ristretto.Config{
		NumCounters: 1e7,
		MaxCost:     1 << 30,
		BufferItems: 64,
	})
	collector := NewRistrettoCollector("prefix_", func() *ristretto.Metrics {
		return cache.Metrics
	})
	prometheus.MustRegister(collector)
}

func (*RistrettoCollector) Collect

func (c *RistrettoCollector) Collect(ch chan<- prometheus.Metric)

Collect is called by the Prometheus registry when collecting metrics.

func (*RistrettoCollector) Describe

func (c *RistrettoCollector) Describe(ch chan<- *prometheus.Desc)

Describe sends the super-set of all possible descriptors of metrics collected by this Collector.