redis

Documentation

Index

• Constants
• Variables
• func RegisterMetrics(r metrics.Registerer, version, server string, stater PoolStater)
• type Cluster
  • func NewCluster(nodes []string, opts ...Option) (Cluster, error)
• type ConnectionOptions
  • func WithReadOnly() ConnectionOptions
  • func WithRetry(retries int, tryAgainDelay time.Duration) ConnectionOptions
  • func WithoutRetry() ConnectionOptions
• type Option
  • func WithDialConnectTimeout(timeout time.Duration) Option
  • func WithDialPassword(password string) Option
  • func WithLogger(logger *zap.Logger) Option
  • func WithMetrics(r metrics.Registerer) Option
  • func WithPoolIdleTimeout(timeout time.Duration) Option
  • func WithPoolMaxActive(num int) Option
  • func WithPoolMaxIdle(num int) Option
  • func WithServerName(serverName string) Option
• type PoolStater
• type PoolStats

Constants

const (
	CodeSuccess     = "Success"
	CodeFail        = "Fail"
	CodeNotFound    = "NotFound"
	CodeInvalidType = "InvalidType"
)

Variables

var (
	ReceivedCounter = prometheus.NewCounterVec(
		prometheus.CounterOpts{
			Namespace: "bucketeer",
			Subsystem: "redis",
			Name:      "received_total",
			Help:      "Total number of received commands.",
		}, []string{"version", "server", "command"})

	HandledCounter = prometheus.NewCounterVec(
		prometheus.CounterOpts{
			Namespace: "bucketeer",
			Subsystem: "redis",
			Name:      "handled_total",
			Help:      "Total number of completed commands.",
		}, []string{"version", "server", "command", "code"})

	HandledHistogram = prometheus.NewHistogramVec(
		prometheus.HistogramOpts{
			Namespace: "bucketeer",
			Subsystem: "redis",
			Name:      "handling_seconds",
			Help:      "Histogram of command response latency (seconds).",
			Buckets:   prometheus.DefBuckets,
		}, []string{"version", "server", "command", "code"})
)

var ErrNil = redis.ErrNil

Functions

func RegisterMetrics

func RegisterMetrics(r metrics.Registerer, version, server string, stater PoolStater)

Types

type Cluster

type Cluster interface {
	Get(opts ...ConnectionOptions) redis.Conn
	Check(context.Context) health.Status
	Stats() PoolStats
	Close() error
}

func NewCluster

func NewCluster(nodes []string, opts ...Option) (Cluster, error)

type ConnectionOptions

type ConnectionOptions func(*connectionOptions)

func WithReadOnly

func WithReadOnly() ConnectionOptions

func WithRetry

func WithRetry(retries int, tryAgainDelay time.Duration) ConnectionOptions

func WithoutRetry

func WithoutRetry() ConnectionOptions

type Option

type Option func(*options)

func WithDialConnectTimeout

func WithDialConnectTimeout(timeout time.Duration) Option

func WithDialPassword

func WithDialPassword(password string) Option

func WithLogger

func WithLogger(logger *zap.Logger) Option

func WithMetrics

func WithMetrics(r metrics.Registerer) Option

func WithPoolIdleTimeout

func WithPoolIdleTimeout(timeout time.Duration) Option

func WithPoolMaxActive

func WithPoolMaxActive(num int) Option

func WithPoolMaxIdle

func WithPoolMaxIdle(num int) Option

func WithServerName

func WithServerName(serverName string) Option

type PoolStater

type PoolStater interface {
	Stats() PoolStats
}

type PoolStats

type PoolStats interface {
	ActiveCount() int
	IdleCount() int
}