Documentation ¶
Overview ¶
Package groupcache provides a data loading mechanism with caching and de-duplication that works across a set of peer processes.
Each data Get first consults its local cache, otherwise delegates to the requested key's canonical owner, which then checks its cache or finally gets the data. In the common case, many concurrent cache misses across a set of peers for the same key result in just one cache fill.
Index ¶
- func DefaultPeerErrorHandler(ctx context.Context, group *Group, key string, peerURL string, err error) (tryLocally bool, e error)
- func DefaultServerErrorHandler(ctx context.Context, w http.ResponseWriter, r *http.Request, err error)
- func DeregisterGroup(name string)
- func RegisterNewGroupHook(fn func(*Group))
- func RegisterPeerPicker(fn func() PeerPicker)
- func RegisterPerGroupPeerPicker(fn func(groupName string) PeerPicker)
- func RegisterServerStart(fn func())
- func SetLogger(log *logrus.Entry)
- type AtomicInt
- type BadGroupcacheRequestError
- type ByteView
- func (v ByteView) At(i int) byte
- func (v ByteView) ByteSlice() []byte
- func (v ByteView) Copy(dest []byte) int
- func (v ByteView) Equal(b2 ByteView) bool
- func (v ByteView) EqualBytes(b2 []byte) bool
- func (v ByteView) EqualString(s string) bool
- func (v ByteView) Expire() time.Time
- func (v ByteView) Len() int
- func (v ByteView) ReadAt(p []byte, off int64) (n int, err error)
- func (v ByteView) Reader() io.ReadSeeker
- func (v ByteView) Slice(from, to int) ByteView
- func (v ByteView) SliceFrom(from int) ByteView
- func (v ByteView) String() string
- func (v ByteView) WriteTo(w io.Writer) (n int64, err error)
- type CacheStats
- type CacheType
- type Getter
- type GetterFunc
- type Group
- type GroupNotFoundError
- type GroupOption
- type HTTPPool
- type HTTPPoolOptions
- type NoPeers
- type PeerErrorHandler
- type PeerPicker
- type ProtoGetter
- type RemoteLoadError
- type Sink
- type Stats
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func DefaultPeerErrorHandler ¶
func DeregisterGroup ¶
func DeregisterGroup(name string)
DeregisterGroup removes group from group pool
func RegisterNewGroupHook ¶
func RegisterNewGroupHook(fn func(*Group))
RegisterNewGroupHook registers a hook that is run each time a group is created.
func RegisterPeerPicker ¶
func RegisterPeerPicker(fn func() PeerPicker)
RegisterPeerPicker registers the peer initialization function. It is called once, when the first group is created. Either RegisterPeerPicker or RegisterPerGroupPeerPicker should be called exactly once, but not both.
func RegisterPerGroupPeerPicker ¶
func RegisterPerGroupPeerPicker(fn func(groupName string) PeerPicker)
RegisterPerGroupPeerPicker registers the peer initialization function, which takes the groupName, to be used in choosing a PeerPicker. It is called once, when the first group is created. Either RegisterPeerPicker or RegisterPerGroupPeerPicker should be called exactly once, but not both.
func RegisterServerStart ¶
func RegisterServerStart(fn func())
RegisterServerStart registers a hook that is run when the first group is created.
Types ¶
type BadGroupcacheRequestError ¶
type BadGroupcacheRequestError struct {
// contains filtered or unexported fields
}
func (BadGroupcacheRequestError) Error ¶
func (e BadGroupcacheRequestError) Error() string
type ByteView ¶
type ByteView struct {
// contains filtered or unexported fields
}
A ByteView holds an immutable view of bytes. Internally it wraps either a []byte or a string, but that detail is invisible to callers.
A ByteView is meant to be used as a value type, not a pointer (like a time.Time).
func (ByteView) EqualBytes ¶
EqualBytes returns whether the bytes in b are the same as the bytes in b2.
func (ByteView) EqualString ¶
EqualString returns whether the bytes in b are the same as the bytes in s.
func (ByteView) Reader ¶
func (v ByteView) Reader() io.ReadSeeker
Reader returns an io.ReadSeeker for the bytes in v.
type CacheStats ¶
type CacheStats struct { // Counters (always increasing) Bytes int64 Items int64 Gets int64 Hits int64 Evictions int64 // Instantaneous values ActiveSingleFlightLoads int64 SingleFlightLoadOldestAge time.Duration ActiveSingleFlightRemoves int64 SingleFlightRemoveOldestAge time.Duration }
CacheStats are returned by stats accessors on Group.
type Getter ¶
type Getter interface { // Get returns the value identified by key, populating dest. // // The returned data must be unversioned. That is, key must // uniquely describe the loaded data, without an implicit // current time, and without relying on cache expiration // mechanisms. Get(ctx context.Context, key string, dest Sink) error }
A Getter loads data for a key.
type GetterFunc ¶
A GetterFunc implements Getter with a function.
type Group ¶
type Group struct { // Stats are statistics on the group. Stats Stats // contains filtered or unexported fields }
A Group is a cache namespace and associated data loaded spread over a group of 1 or more machines.
func GetGroup ¶
GetGroup returns the named group previously created with NewGroup, or nil if there's no such group.
func NewGroup ¶
func NewGroup(name string, cacheBytes int64, getter Getter, opts ...GroupOption) *Group
NewGroup creates a coordinated group-aware Getter from a Getter.
The returned Getter tries (but does not guarantee) to run only one Get call at once for a given key across an entire set of peer processes. Concurrent callers both in the local process and in other processes receive copies of the answer once the original Get completes.
The group name must be unique for each getter.
func (*Group) CacheStats ¶
func (g *Group) CacheStats(which CacheType) CacheStats
CacheStats returns stats about the provided cache within the group.
type GroupNotFoundError ¶
type GroupNotFoundError struct {
// contains filtered or unexported fields
}
func (GroupNotFoundError) Error ¶
func (e GroupNotFoundError) Error() string
type GroupOption ¶
type GroupOption func(group *Group)
func WithPeerErrorHandler ¶
func WithPeerErrorHandler(handler PeerErrorHandler) GroupOption
WithPeerErrorHandler allows to override the way remote load errors are processed.
func WithPeerPicker ¶ added in v2.5.1
func WithPeerPicker(pickerFn PeerPicker) GroupOption
WithPeerPicker allows the group to be created using a different set of peers than the normal set (that is globally set). This may allow using the group with the local node only, for some local LRU + single-flight cache implementation identical to distributed ones. This is a 'cleaner' way of specifying the peers to use for a group rather than relying on the 'portPicker' global variable that the original implementation uses.
type HTTPPool ¶
type HTTPPool struct {
// contains filtered or unexported fields
}
HTTPPool implements PeerPicker for a pool of HTTP peers.
func NewHTTPPool ¶
NewHTTPPool initializes an HTTP pool of peers, and registers itself as a PeerPicker. For convenience, it also registers itself as an http.Handler with http.DefaultServeMux. The self argument should be a valid base URL that points to the current server, for example "http://example.net:8000".
func NewHTTPPoolOpts ¶
func NewHTTPPoolOpts(self string, o *HTTPPoolOptions) *HTTPPool
NewHTTPPoolOpts initializes an HTTP pool of peers with the given options. Unlike NewHTTPPool, this function does not register the created pool as an HTTP handler. The returned *HTTPPool implements http.Handler and must be registered using http.Handle.
func (*HTTPPool) GetAll ¶
func (p *HTTPPool) GetAll() []ProtoGetter
GetAll returns all the peers in the pool
func (*HTTPPool) Set ¶
Set updates the pool's list of peers. Each peer value should be a valid base URL, for example "http://example.net:8000".
type HTTPPoolOptions ¶
type HTTPPoolOptions struct { // BasePath specifies the HTTP path that will serve groupcache requests. // If blank, it defaults to "/_groupcache/". BasePath string // Replicas specifies the number of key replicas on the consistent hash. // If blank, it defaults to 50. Replicas int // HashFn specifies the hash function of the consistent hash. // If blank, it defaults to crc32.ChecksumIEEE. HashFn consistenthash.Hash // Transport optionally specifies an http.RoundTripper for the client // to use when it makes a request. // If nil, the client uses http.DefaultTransport. Transport func(context.Context) http.RoundTripper // Context optionally specifies a context for the server to use when it // receives a request. // If nil, uses the http.Request.Context() Context func(*http.Request) context.Context // ServerErrorHandler optionally specifies a function that will serialize the error that occurred during the remote load and forward it to the requesting // peer. It may be deserialized on the peer side using a custom PeerErrorHandler if needed. ServerErrorHandler func(context.Context, http.ResponseWriter, *http.Request, error) }
HTTPPoolOptions are the configurations of a HTTPPool.
type NoPeers ¶
type NoPeers struct{}
NoPeers is an implementation of PeerPicker that never finds a peer.
func (NoPeers) GetAll ¶
func (NoPeers) GetAll() []ProtoGetter
type PeerErrorHandler ¶
type PeerPicker ¶
type PeerPicker interface { // PickPeer returns the peer that owns the specific key // and true to indicate that a remote peer was nominated. // It returns nil, false if the key owner is the current peer. PickPeer(key string) (peer ProtoGetter, ok bool) // GetAll returns all the peers in the group GetAll() []ProtoGetter }
PeerPicker is the interface that must be implemented to locate the peer that owns a specific key.
type ProtoGetter ¶
type ProtoGetter interface { Get(context context.Context, in *pb.GetRequest, out *pb.GetResponse) error Remove(context context.Context, in *pb.GetRequest) error // GetURL returns the peer URL GetURL() string }
ProtoGetter is the interface that must be implemented by a peer.
type RemoteLoadError ¶
type RemoteLoadError struct { Group string Key string StatusCode int Status string Body []byte Err error }
func (RemoteLoadError) Error ¶
func (r RemoteLoadError) Error() string
func (RemoteLoadError) Unwrap ¶ added in v2.3.0
func (r RemoteLoadError) Unwrap() error
type Sink ¶
type Sink interface { // SetString sets the value to s. SetString(s string, e time.Time) error // SetBytes sets the value to the contents of v. // The caller retains ownership of v. SetBytes(v []byte, e time.Time) error // SetProto sets the value to the encoded version of m. // The caller retains ownership of m. SetProto(m proto.Message, e time.Time) error // contains filtered or unexported methods }
A Sink receives data from a Get call.
Implementation of Getter must call exactly one of the Set methods on success.
func AllocatingByteSliceSink ¶
AllocatingByteSliceSink returns a Sink that allocates a byte slice to hold the received value and assigns it to *dst. The memory is not retained by groupcache.
func ByteViewSink ¶
ByteViewSink returns a Sink that populates a ByteView.
func StringSink ¶
StringSink returns a Sink that populates the provided string pointer.
func TruncatingByteSliceSink ¶
TruncatingByteSliceSink returns a Sink that writes up to len(*dst) bytes to *dst. If more bytes are available, they're silently truncated. If fewer bytes are available than len(*dst), *dst is shrunk to fit the number of bytes available.
type Stats ¶
type Stats struct { Gets AtomicInt // any Get request, including from peers CacheHits AtomicInt // either cache was good GetFromPeersLatencyLower AtomicInt // slowest duration to request value from peers PeerLoads AtomicInt // either remote load or remote cache hit (not an error) PeerErrors AtomicInt Loads AtomicInt // (gets - cacheHits) LoadsDeduped AtomicInt // after singleflight LocalLoads AtomicInt // total good local loads LocalLoadErrs AtomicInt // total bad local loads ServerRequests AtomicInt // gets that came over the network from peers }
Stats are per-group statistics.
Directories ¶
Path | Synopsis |
---|---|
Package consistenthash provides an implementation of a ring hash.
|
Package consistenthash provides an implementation of a ring hash. |
Package groupcachepb is a generated protocol buffer package.
|
Package groupcachepb is a generated protocol buffer package. |
Package lru implements an LRU cache.
|
Package lru implements an LRU cache. |
Package singleflight provides a duplicate function call suppression mechanism.
|
Package singleflight provides a duplicate function call suppression mechanism. |