README
¶
Environment based configuration
REDIS_HOSTSdefault:redis:6379- host:port addresses, can be multiple separated by comma.
REDIS_PASSWORD- Optional password. Must match the password specified in the
requirepassserver configuration option.
- Optional password. Must match the password specified in the
REDIS_DB- Database to be selected after connecting to the server.
REDIS_MAX_RETRIES- Maximum number of retries before giving up. Default is to not retry failed commands.
REDIS_POOL_SIZEdefault:10- Maximum number of socket connections. Default is 10 connections per every CPU as reported by runtime.NumCPU.
REDIS_MIN_IDLE_CONNS- Minimum number of idle connections which is useful when establishing new connection is slow.
REDIS_MIN_RETRY_BACKOFFdefault:8ms- Minimum backoff between each retry. Default is 8 milliseconds; -1 disables backoff.
- Everything that can be parsed by ParseDuration
REDIS_MAX_RETRY_BACKOFFdefault:512ms- Maximum backoff between each retry. Default is 512 milliseconds; -1 disables backoff.
- Everything that can be parsed by ParseDuration
REDIS_DIAL_TIMEOUTdefault:5s- Dial timeout for establishing new connections. Default is 5 seconds.
- Everything that can be parsed by ParseDuration
REDIS_READ_TIMEOUTdefault:3s- Timeout for socket reads. If reached, commands will fail with a timeout instead of blocking. Default is 3 seconds.
- Everything that can be parsed by ParseDuration
REDIS_WRITE_TIMEOUT- Timeout for socket writes. If reached, commands will fail with a timeout instead of blocking. Default is ReadTimeout.
- Everything that can be parsed by ParseDuration
REDIS_MAX_CONNAGE- Connection age at which client retires (closes) the connection. Default is to not close aged connections.
- Everything that can be parsed by ParseDuration
REDIS_POOL_TIMEOUTdefault ReadTimeout + 1 second- Amount of time client waits for connection if all connections are busy before returning an error.
- Everything that can be parsed by ParseDuration
REDIS_IDLE_TIMEOUTdefault:5m- 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.
- Everything that can be parsed by ParseDuration
REDIS_IDLE_CHECK_FREQUENCYdefault:1m- Frequency of idle checks made by idle connections reaper. Default is 1 minute. -1 disables idle connections reaper, but idle connections are still discarded by the client if IdleTimeout is set.
- Everything that can be parsed by ParseDuration
REDIS_HEALTH_CHECK_KEYdefault:healthy- Name of the key that is written to check, if redis is healthy
REDIS_HEALTH_CHECK_RESULT_TTLdefault:10s- Amount of time to cache the last health check result
Documentation
¶
Overview ¶
Package redis helps creating redis connection pools
Index ¶
- func Client(overwriteOpts ...func(*redis.Options)) *redis.Client
- func ClusterClient() *redis.ClusterClient
- func CustomClient(opts *redis.Options) *redis.Client
- func CustomClusterClient(opts *redis.ClusterOptions) *redis.ClusterClient
- func IsErrConnectionFailed(err error) bool
- func WithClusterContext(ctx context.Context, c *redis.ClusterClient) *redis.ClusterClient
- func WithContext(ctx context.Context, c *redis.Client) *redis.Client
- type HealthCheck
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Client ¶
func Client(overwriteOpts ...func(*redis.Options)) *redis.Client
Client with environment based configuration
func ClusterClient ¶
func ClusterClient() *redis.ClusterClient
ClusterClient with environment based configuration
func CustomClient ¶
func CustomClient(opts *redis.Options) *redis.Client
CustomClient with passed configuration
func CustomClusterClient ¶
func CustomClusterClient(opts *redis.ClusterOptions) *redis.ClusterClient
CustomClusterClient with passed configuration
func IsErrConnectionFailed ¶ added in v0.4.5
func WithClusterContext ¶
WithClusterContext adds a logging and tracing wrapper to the passed client
func WithContext ¶
WithContext adds a logging and tracing wrapper to the passed client
Types ¶
type HealthCheck ¶ added in v0.1.15
type HealthCheck struct {
Client *redis.Client
// contains filtered or unexported fields
}
HealthCheck checks the state of a redis connection. It must not be changed after it was registered as a health check.
func (*HealthCheck) HealthCheck ¶ added in v0.1.15
func (h *HealthCheck) HealthCheck(ctx context.Context) servicehealthcheck.HealthCheckResult
HealthCheck checks if the redis is healthy. If the last result is outdated, redis is checked for writeability and readability, otherwise return the old result
Source Files
Click to show internal directories.
Click to hide internal directories.