gocache

Documentation

Overview

Package gocache instruments github.com/levskiy0/go-cache operations and locks as webpprof cache entries.

Index

• type Cache
  • func Profile(cache Cache, stores ...string) Cache
  • func ProfileWith(profiler *webpprof.Profiler, cache Cache, stores ...string) Cache
• type CacheDriver
• type Lock
• type ProfilerGoCache
  • func New(stores ...string) ProfilerGoCache
  • func (ProfilerGoCache) Name() string
  • func (d ProfilerGoCache) Profile(scope webpprof.Scope, cache Cache) Cache

Types

type Cache

type Cache = cachecontract.Cache

Cache aliases the go-cache facade accepted by Profile.

func Profile

func Profile(cache Cache, stores ...string) Cache

Profile instruments cache with the default profiler.

func ProfileWith

func ProfileWith(profiler *webpprof.Profiler, cache Cache, stores ...string) Cache

ProfileWith instruments cache with an explicit profiler.

type CacheDriver

type CacheDriver = cachecontract.Driver

CacheDriver aliases the go-cache driver wrapped by the integration.

type Lock

type Lock = cachecontract.Lock

Lock aliases the go-cache lock contract returned by instrumented drivers.

type ProfilerGoCache

type ProfilerGoCache struct {
	Store string
}

ProfilerGoCache implements webpprof.Integration for go-cache instances.

func New

func New(stores ...string) ProfilerGoCache

New creates a go-cache integration. The first non-empty store name is shown in captured entries; it defaults to "default".

func (ProfilerGoCache) Name

func (ProfilerGoCache) Name() string

Name returns the integration cache namespace.

func (ProfilerGoCache) Profile

func (d ProfilerGoCache) Profile(scope webpprof.Scope, cache Cache) Cache

Profile wraps cache so operations and locks are recorded. Wrapping is idempotent for the same profiler.