Documentation
¶
Index ¶
- func CloseTestDistCacheCluster(t *testing.T, cl *TestDistCacheCluster)
- func Module() fx.Option
- func RegisterDistCacheService(in RegisterDistCacheServiceIn) error
- type DistCache
- type DistCacheConstructor
- type DistCacheConstructorIn
- type DistCacheMetrics
- type OlricLogWriter
- type RegisterDistCacheServiceIn
- type ServiceDiscovery
- func (s *ServiceDiscovery) Close() error
- func (s *ServiceDiscovery) Deregister() error
- func (s *ServiceDiscovery) DiscoverPeers() ([]string, error)
- func (s *ServiceDiscovery) Initialize() error
- func (s *ServiceDiscovery) Register() error
- func (s *ServiceDiscovery) SetConfig(cfg map[string]interface{}) error
- func (s *ServiceDiscovery) SetLogger(l *stdlog.Logger)
- type TestDistCacheCluster
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CloseTestDistCacheCluster ¶
func CloseTestDistCacheCluster(t *testing.T, cl *TestDistCacheCluster)
CloseTestDistCacheCluster closes the test dist cache cluster.
func RegisterDistCacheService ¶
func RegisterDistCacheService(in RegisterDistCacheServiceIn) error
RegisterDistCacheService registers the handler on grpc.Server.
Types ¶
type DistCache ¶
type DistCache struct {
distcachev1.UnimplementedDistCacheServiceServer
// contains filtered or unexported fields
}
DistCache is a peer to peer distributed cache.
func NewDistCache ¶
func NewDistCache( config *olricconfig.Config, olric *olric.Olric, objStorage objectstorage.ObjectStorageIface, metrics *DistCacheMetrics, shutDowner fx.Shutdowner, prometheusRegistry *prometheus.Registry, ) *DistCache
NewDistCache creates a new instance of DistCache.
func (*DistCache) DeleteDMap ¶
DeleteDMap deletes a DMap.
type DistCacheConstructor ¶
type DistCacheConstructor struct {
ConfigKey string
DefaultConfig dcconfig.DistCacheConfig
}
DistCacheConstructor holds fields to create an instance of DistCache.
func (DistCacheConstructor) ProvideDistCache ¶
func (constructor DistCacheConstructor) ProvideDistCache(in DistCacheConstructorIn) (*DistCache, error)
ProvideDistCache creates a new instance of distributed cache. It also hooks in the service discovery plugin.
type DistCacheConstructorIn ¶
type DistCacheConstructorIn struct {
fx.In
PeerDiscovery *peers.PeerDiscovery
PrometheusRegistry *prometheus.Registry
LivenessMultiJob *jobs.MultiJob `name:"liveness.service"`
Unmarshaller config.Unmarshaller
Lifecycle fx.Lifecycle
Shutdowner fx.Shutdowner
ObjectStorage objectstorage.ObjectStorageIface `optional:"true"`
Logger *log.Logger
}
DistCacheConstructorIn holds parameters of ProvideDistCache.
type DistCacheMetrics ¶
type DistCacheMetrics struct {
EntriesTotal *prometheus.GaugeVec
DeleteHits *prometheus.GaugeVec
DeleteMisses *prometheus.GaugeVec
GetMisses *prometheus.GaugeVec
GetHits *prometheus.GaugeVec
EvictedTotal *prometheus.GaugeVec
PartitionsCount *prometheus.GaugeVec
BackupPartitionsCount *prometheus.GaugeVec
FragmentMigrationEventsTotal *prometheus.CounterVec
FragmentReceivedEventsTotal *prometheus.CounterVec
PartitionsLength *prometheus.GaugeVec
BackupPartitionsLength *prometheus.GaugeVec
}
DistCacheMetrics holds metrics from DistCache, Olric, DMap statistics.
type OlricLogWriter ¶
OlricLogWriter is wrapper around aperture Logger that parse the message before writing to olricConfig.LogOutput.
type RegisterDistCacheServiceIn ¶ added in v2.16.0
type RegisterDistCacheServiceIn struct {
fx.In
Handler *DistCache
Server *grpc.Server `name:"default"`
HealthSrv *health.Server
}
RegisterDistCacheServiceIn bundles and annotates parameters.
type ServiceDiscovery ¶
type ServiceDiscovery struct {
// contains filtered or unexported fields
}
ServiceDiscovery holds fields needed to implement Olric's Service Discovery interface.
func (*ServiceDiscovery) Close ¶
func (s *ServiceDiscovery) Close() error
Close stops underlying goroutines, if there is any. It should be a blocking call. This method is not implemented.
func (*ServiceDiscovery) Deregister ¶
func (s *ServiceDiscovery) Deregister() error
Deregister removes this node from a service discovery directory. This method is not implemented.
func (*ServiceDiscovery) DiscoverPeers ¶
func (s *ServiceDiscovery) DiscoverPeers() ([]string, error)
DiscoverPeers returns a list of known Olric nodes.
func (*ServiceDiscovery) Initialize ¶
func (s *ServiceDiscovery) Initialize() error
Initialize initializes the plugin: registers some internal data structures, clients etc. This method is not implemented.
func (*ServiceDiscovery) Register ¶
func (s *ServiceDiscovery) Register() error
Register registers this node to a service discovery directory. This method is not implemented.
func (*ServiceDiscovery) SetConfig ¶
func (s *ServiceDiscovery) SetConfig(cfg map[string]interface{}) error
SetConfig registers plugin configuration. This method is not implemented.
func (*ServiceDiscovery) SetLogger ¶
func (s *ServiceDiscovery) SetLogger(l *stdlog.Logger)
SetLogger sets an appropriate logger. This method is not implemented.
type TestDistCacheCluster ¶
TestDistCacheCluster is a test cluster of DistCache instances.
func NewTestDistCacheCluster ¶
func NewTestDistCacheCluster(t *testing.T, n int) *TestDistCacheCluster
NewTestDistCacheCluster creates a new DistCache cluster with n members.
Source Files
Directories