cache

Documentation

Overview

Package cache provides an interface which can be implemented by different cache types.

Index

• type BaseMetricsCollector
  • func GetBaseMetricsCollector() BaseMetricsCollector
• type Cache
• type EvictionMetricsCollector
  • func GetEvictionMetricsCollector() EvictionMetricsCollector
• type WithMetrics
  • func NewCacheWithMetrics[T any](wrapped Cache[T], metrics BaseMetricsCollector, cacheName string) *WithMetrics[T]
  • func (c *WithMetrics[T]) Clear()
  • func (c *WithMetrics[T]) Contents() string
  • func (c *WithMetrics[T]) Count() int
  • func (c *WithMetrics[T]) Delete(key string)
  • func (c *WithMetrics[T]) Exists(key string) bool
  • func (c *WithMetrics[T]) Get(key string) (T, bool)
  • func (c *WithMetrics[T]) Keys() []string
  • func (c *WithMetrics[T]) Set(key string, val T)
  • func (c *WithMetrics[T]) Values() []T

Types

type BaseMetricsCollector

type BaseMetricsCollector interface {
	RecordHit(cacheName string)
	RecordMiss(cacheName string)
	RecordSet(cacheName string)
	RecordDelete(cacheName string)
	RecordClear(cacheName string)
}

BaseMetricsCollector defines the interface for recording cache metrics. Each method corresponds to a specific cache-related operation.

func GetBaseMetricsCollector

func GetBaseMetricsCollector() BaseMetricsCollector

GetBaseMetricsCollector returns the singleton baseCollector instance.

type Cache

type Cache[T any] interface {
	// Set stores the given key/value pair.
	Set(key string, val T)
	// Get returns the value for the given key and a boolean indicating if the key was found.
	Get(key string) (T, bool)
	// Exists returns true if the given key exists in the cache.
	Exists(key string) bool
	// Delete the given key from the cache.
	Delete(key string)
	// Clear all key/value pairs from the cache.
	Clear()
	// Count the number of key/value pairs in the cache.
	Count() int
	// Keys returns all keys in the cache.
	Keys() []string
	// Values returns all values in the cache.
	Values() []T
	// Contents returns all keys in the cache encoded as a string.
	Contents() string
}

Cache is used to store key/value pairs.

type EvictionMetricsCollector

type EvictionMetricsCollector interface {
	RecordEviction(cacheName string)
}

EvictionMetricsCollector defines the interface for recording cache-specific eviction metrics.

func GetEvictionMetricsCollector

func GetEvictionMetricsCollector() EvictionMetricsCollector

GetEvictionMetricsCollector returns the singleton evictionMetrics instance.

type WithMetrics

type WithMetrics[T any] struct {
	// contains filtered or unexported fields
}

WithMetrics is a decorator that adds metrics collection to any Cache implementation.

func NewCacheWithMetrics

func NewCacheWithMetrics[T any](wrapped Cache[T], metrics BaseMetricsCollector, cacheName string) *WithMetrics[T]

NewCacheWithMetrics creates a new WithMetrics decorator that wraps the provided Cache and collects metrics using the provided BaseMetricsCollector. The cacheName parameter is used to identify the cache in the collected metrics.

func (*WithMetrics[T]) Clear

func (c *WithMetrics[T]) Clear()

Clear removes all entries from the cache. It also records a clear metric for the cache using the provided metrics collector and cache name.

func (*WithMetrics[T]) Contents

func (c *WithMetrics[T]) Contents() string

Contents returns all keys in the cache as a string. It also records a contents metric for the cache using the provided metrics collector and cache name.

func (*WithMetrics[T]) Count

func (c *WithMetrics[T]) Count() int

Count returns the number of entries in the cache. It also records a count metric for the cache using the provided metrics collector and cache name.

func (*WithMetrics[T]) Delete

func (c *WithMetrics[T]) Delete(key string)

Delete removes the value for the given key from the cache. It also records a delete metric for the cache using the provided metrics collector and cache name.

func (*WithMetrics[T]) Exists

func (c *WithMetrics[T]) Exists(key string) bool

Exists checks if the given key exists in the cache. It records a hit or miss metric for the cache using the provided metrics collector and cache name.

func (*WithMetrics[T]) Get

func (c *WithMetrics[T]) Get(key string) (T, bool)

Get retrieves the value for the given key from the underlying cache. It also records a hit or miss metric for the cache using the provided metrics collector and cache name.

func (*WithMetrics[T]) Keys

func (c *WithMetrics[T]) Keys() []string

Keys returns all keys in the cache. It also records a keys metric for the cache using the provided metrics collector and cache name.

func (*WithMetrics[T]) Set

func (c *WithMetrics[T]) Set(key string, val T)

Set sets the value for the given key in the cache. It also records a set metric for the cache using the provided metrics collector and cache name.

func (*WithMetrics[T]) Values

func (c *WithMetrics[T]) Values() []T

Values returns all values in the cache. It also records a values metric for the cache using the provided metrics collector and cache name.