cache

Documentation

Index

• Variables
• type Cache
  • func NewTracingCache(cache Cache) Cache
• type InMemoryCache
  • func NewInMemoryCache(name string, logger log.Logger, reg prometheus.Registerer, conf []byte) (*InMemoryCache, error)
  • func NewInMemoryCacheWithConfig(name string, logger log.Logger, reg prometheus.Registerer, ...) (*InMemoryCache, error)
  • func (c *InMemoryCache) Fetch(ctx context.Context, keys []string) map[string][]byte
  • func (c *InMemoryCache) Store(ctx context.Context, data map[string][]byte, ttl time.Duration)
• type InMemoryCacheConfig
• type MemcachedCache
  • func NewMemcachedCache(name string, logger log.Logger, memcached cacheutil.MemcachedClient, ...) *MemcachedCache
  • func (c *MemcachedCache) Fetch(ctx context.Context, keys []string) map[string][]byte
  • func (c *MemcachedCache) Store(ctx context.Context, data map[string][]byte, ttl time.Duration)
• type TracingCache
  • func (t TracingCache) Fetch(ctx context.Context, keys []string) (result map[string][]byte)
  • func (t TracingCache) Store(ctx context.Context, data map[string][]byte, ttl time.Duration)

Variables

var (
	DefaultInMemoryCacheConfig = InMemoryCacheConfig{
		MaxSize:     250 * 1024 * 1024,
		MaxItemSize: 125 * 1024 * 1024,
	}
)

Types

type Cache

type Cache interface {
	// Store data into the cache.
	//
	// Note that individual byte buffers may be retained by the cache!
	Store(ctx context.Context, data map[string][]byte, ttl time.Duration)

	// Fetch multiple keys from cache. Returns map of input keys to data.
	// If key isn't in the map, data for given key was not found.
	Fetch(ctx context.Context, keys []string) map[string][]byte
}

Generic best-effort cache.

func NewTracingCache

func NewTracingCache(cache Cache) Cache

type InMemoryCache

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

func NewInMemoryCache

func NewInMemoryCache(name string, logger log.Logger, reg prometheus.Registerer, conf []byte) (*InMemoryCache, error)

NewInMemoryCache creates a new thread-safe LRU cache and ensures the total cache size approximately does not exceed maxBytes.

func NewInMemoryCacheWithConfig

func NewInMemoryCacheWithConfig(name string, logger log.Logger, reg prometheus.Registerer, config InMemoryCacheConfig) (*InMemoryCache, error)

NewInMemoryCacheWithConfig creates a new thread-safe LRU cache and ensures the total cache size approximately does not exceed maxBytes.

func (*InMemoryCache) Fetch

func (c *InMemoryCache) Fetch(ctx context.Context, keys []string) map[string][]byte

Fetch fetches multiple keys and returns a map containing cache hits In case of error, it logs and return an empty cache hits map.

func (*InMemoryCache) Store

func (c *InMemoryCache) Store(ctx context.Context, data map[string][]byte, ttl time.Duration)

type InMemoryCacheConfig

type InMemoryCacheConfig struct {
	// MaxSize represents overall maximum number of bytes cache can contain.
	MaxSize model.Bytes `yaml:"max_size"`
	// MaxItemSize represents maximum size of single item.
	MaxItemSize model.Bytes `yaml:"max_item_size"`
}

InMemoryCacheConfig holds the in-memory cache config.

type MemcachedCache

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

MemcachedCache is a memcached-based cache.

func NewMemcachedCache

func NewMemcachedCache(name string, logger log.Logger, memcached cacheutil.MemcachedClient, reg prometheus.Registerer) *MemcachedCache

NewMemcachedCache makes a new MemcachedCache.

func (*MemcachedCache) Fetch

func (c *MemcachedCache) Fetch(ctx context.Context, keys []string) map[string][]byte

Fetch fetches multiple keys and returns a map containing cache hits, along with a list of missing keys. In case of error, it logs and return an empty cache hits map.

func (*MemcachedCache) Store

func (c *MemcachedCache) Store(ctx context.Context, data map[string][]byte, ttl time.Duration)

Store data identified by keys. The function enqueues the request and returns immediately: the entry will be asynchronously stored in the cache.

type TracingCache

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

TracingCache includes Fetch operation in the traces.

func (TracingCache) Fetch

func (t TracingCache) Fetch(ctx context.Context, keys []string) (result map[string][]byte)

func (TracingCache) Store

func (t TracingCache) Store(ctx context.Context, data map[string][]byte, ttl time.Duration)