redis

Documentation

Overview

Package redis contains wiring and observability for the go-redis Redis client.

There is support for: - observability (both for queries and connection info) - health checks

Index

• func Load(o Options, sys *system.System) *redis.Client
• func LoadCluster(o ClusterOptions, sys *system.System) *redis.ClusterClient
• func New(o Options) *redis.Client
• func NewCluster(o ClusterOptions) *redis.ClusterClient
• type ClusterOptions
• type HealthCheck
  • func NewHealthCheck(client redis.UniversalClient, name string) *HealthCheck
  • func (r *HealthCheck) HealthChecks() (name string, ready, live func(ctx context.Context) error)
• type Metrics
  • func NewMetrics(name string, client redis.UniversalClient) *Metrics
  • func (r *Metrics) Gauges(_ context.Context) map[string]float64
  • func (r *Metrics) MetricName() string
• type Options

Functions

func Load

func Load(o Options, sys *system.System) *redis.Client

Load will create a new Redis client, and wire it into the provided System with default lifecycle management and observability.

func LoadCluster

func LoadCluster(o ClusterOptions, sys *system.System) *redis.ClusterClient

LoadCluster will create a new Redis cluster client, and wire it into the provided System with default lifecycle management and observability.

func New

func New(o Options) *redis.Client

New will only construct a new Redis client with the provided options. It is the caller's responsibility to close it at the right time.

func NewCluster

func NewCluster(o ClusterOptions) *redis.ClusterClient

NewCluster will only construct a new Redis client with the provided options. It is the caller's responsibility to close it at the right time.

Types

type ClusterOptions

type ClusterOptions struct {
	// Name of the client for metrics and health check, default is "redis"
	Name string

	// A seed list of host:port addresses of cluster nodes.
	Addrs []string

	// The maximum number of retries before giving up. Command is retried
	// on network errors and MOVED/ASK redirects.
	// Default is 3 retries.
	MaxRedirects int

	// Enables read-only commands on slave nodes.
	ReadOnly bool
	// Allows routing read-only commands to the closest master or slave node.
	// It automatically enables ReadOnly.
	RouteByLatency bool
	// Allows routing read-only commands to the random master or slave node.
	// It automatically enables ReadOnly.
	RouteRandomly bool

	// Optional function that returns cluster slots information.
	// It is useful to manually create cluster of standalone Redis servers
	// and load-balance read/write operations between master and slaves.
	// It can use service like ZooKeeper to maintain configuration information
	// and Cluster.ReloadState to manually trigger state reloading.
	ClusterSlots func(context.Context) ([]redis.ClusterSlot, error)

	// Use the specified User to authenticate the current connection
	// with one of the connections defined in the ACL list when connecting
	// to a Redis 6.0 instance, or greater, that is using the Redis ACL system.
	User string
	// Optional password. Must match the password specified in the
	// requirepass server configuration option (if connecting to a Redis 5.0 instance, or lower),
	// or the User Password when connecting to a Redis 6.0 instance, or greater,
	// that is using the Redis ACL system.
	Password secret.String

	// Maximum number of retries before giving up.
	// Default is 3 retries; -1 (not 0) disables retries.
	MaxRetries int
	// Minimum backoff between each retry.
	// Default is 8 milliseconds; -1 disables backoff.
	MinRetryBackoff time.Duration
	// Maximum backoff between each retry.
	// Default is 512 milliseconds; -1 disables backoff.
	MaxRetryBackoff time.Duration

	// Dial timeout for establishing new connections.
	// Default is 5 seconds.
	DialTimeout time.Duration
	// Timeout for socket reads. If reached, commands will fail
	// with a timeout instead of blocking. Use value -1 for no timeout and 0 for default.
	// Default is 3 seconds.
	ReadTimeout time.Duration
	// Timeout for socket writes. If reached, commands will fail
	// with a timeout instead of blocking.
	// Default is ReadTimeout.
	WriteTimeout time.Duration

	// Type of connection pool.
	// true for FIFO pool, false for LIFO pool.
	// Note that fifo has higher overhead compared to lifo.
	PoolFIFO bool
	// Maximum number of socket connections.
	// Default is 10 connections per every available CPU as reported by runtime.GOMAXPROCS.
	PoolSize int
	// Amount of time client waits for connection if all connections
	// are busy before returning an error.
	// Default is ReadTimeout + 1 second.
	PoolTimeout time.Duration
	// Minimum number of idle connections which is useful when establishing
	// new connection is slow.
	MinIdleConns int
	// Maximum number of idle connections.
	MaxIdleConns int
	// Amount of time after which client closes idle connections.
	// Should be less than server's timeout.
	// Default is 5 minutes. -1 disables idle timeout check.
	ConnMaxIdleTime time.Duration
	// Connection age at which client retires (closes) the connection.
	// Default is to not close aged connections.
	ConnMaxLifetime time.Duration

	TLS    bool
	CAFunc func() *x509.CertPool
}

type HealthCheck

type HealthCheck struct {
	// contains filtered or unexported fields
}

func NewHealthCheck

func NewHealthCheck(client redis.UniversalClient, name string) *HealthCheck

func (*HealthCheck) HealthChecks

func (r *HealthCheck) HealthChecks() (name string, ready, live func(ctx context.Context) error)

type Metrics

type Metrics struct {
	// contains filtered or unexported fields
}

func NewMetrics

func NewMetrics(name string, client redis.UniversalClient) *Metrics

func (*Metrics) Gauges

func (r *Metrics) Gauges(_ context.Context) map[string]float64

func (*Metrics) MetricName

func (r *Metrics) MetricName() string

type Options

type Options struct {
	// Name of the client for metrics and health check, default is "redis"
	Name string

	Host string
	Port int

	// Use the specified User to authenticate the current connection
	// with one of the connections defined in the ACL list when connecting
	// to a Redis 6.0 instance, or greater, that is using the Redis ACL system.
	User string
	// Optional password. Must match the password specified in the
	// requirepass server configuration option (if connecting to a Redis 5.0 instance, or lower),
	// or the User Password when connecting to a Redis 6.0 instance, or greater,
	// that is using the Redis ACL system.
	Password secret.String

	// Database to be selected after connecting to the server.
	DB int
	// Maximum number of retries before giving up.
	// Default is 3 retries; -1 (not 0) disables retries.
	MaxRetries int
	// Minimum backoff between each retry.
	// Default is 8 milliseconds; -1 disables backoff.
	MinRetryBackoff time.Duration
	// Maximum backoff between each retry.
	// Default is 512 milliseconds; -1 disables backoff.
	MaxRetryBackoff time.Duration

	// Dial timeout for establishing new connections.
	// Default is 5 seconds.
	DialTimeout time.Duration
	// Timeout for socket reads. If reached, commands will fail
	// with a timeout instead of blocking. Use value -1 for no timeout and 0 for default.
	// Default is 3 seconds.
	ReadTimeout time.Duration
	// Timeout for socket writes. If reached, commands will fail
	// with a timeout instead of blocking.
	// Default is ReadTimeout.
	WriteTimeout time.Duration

	// Type of connection pool.
	// true for FIFO pool, false for LIFO pool.
	// Note that fifo has higher overhead compared to lifo.
	PoolFIFO bool
	// Maximum number of socket connections.
	// Default is 10 connections per every available CPU as reported by runtime.GOMAXPROCS.
	PoolSize int
	// Amount of time client waits for connection if all connections
	// are busy before returning an error.
	// Default is ReadTimeout + 1 second.
	PoolTimeout time.Duration
	// Minimum number of idle connections which is useful when establishing
	// new connection is slow.
	MinIdleConns int
	// Maximum number of idle connections.
	MaxIdleConns int
	// Amount of time after which client closes idle connections.
	// Should be less than server's timeout.
	// Default is 5 minutes. -1 disables idle timeout check.
	ConnMaxIdleTime time.Duration
	// Connection age at which client retires (closes) the connection.
	// Default is to not close aged connections.
	ConnMaxLifetime time.Duration

	TLS    bool
	CAFunc func() *x509.CertPool
}