cache

Documentation

Index

• Variables
• func Key(k string) string
• func Observe(ctx context.Context, typ string, counter metric.Int64Counter)
• type Cacher

Variables

var (
	// Hit is a counter for cache hits.
	Hit = metrics.MustInt64().
		Counter(
			prometheus.BuildFQName(namespace, subsystem, "hit"),
			metric.WithDescription("The number of cache hits"),
		)
		// Miss is a counter for cache misses.
	Miss = metrics.MustInt64().
			Counter(
			prometheus.BuildFQName(namespace, subsystem, "miss"),
			metric.WithDescription("The number of cache misses"),
		)
		// Error is a counter for cache errors.
	Error = metrics.MustInt64().
			Counter(
			prometheus.BuildFQName(namespace, subsystem, "error"),
			metric.WithDescription("The number of times an error occurred reading or writing to the cache"),
		)
)

Functions

func Key

func Key(k string) string

func Observe

func Observe(ctx context.Context, typ string, counter metric.Int64Counter)

Observe adds one to the provided counter and records the cache type attribute supplied by typ.

Types

type Cacher

type Cacher interface {
	// Get retrieves a value from the cache, the bool indicates if the item was found
	Get(ctx context.Context, key string) ([]byte, bool, error)
	// Set sets a value in the cache
	Set(ctx context.Context, key string, value []byte) error
	// Delete removes a value from the cache
	Delete(ctx context.Context, key string) error
	fmt.Stringer
}

Cacher modifies and queries a cache