Skip to content

feat: add redis pool_timeout #354

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 10, 2023
Merged

feat: add redis pool_timeout #354

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions cache/redis_client.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,11 @@ type RedisClientConfig struct {
// Maximum number of socket connections.
ConnectionPoolSize int `yaml:"connection_pool_size" category:"advanced"`

// Amount of time client waits for connection if all connections
// are busy before returning an error.
// Default is ReadTimeout + 1 second.
ConnectionPoolTimeout time.Duration `yaml:"connection_pool_timeout" category:"advanced"`

// MinIdleConnections specifies the minimum number of idle connections which is useful when establishing
// new connection is slow.
MinIdleConnections int `yaml:"min_idle_connections" category:"advanced"`
Expand Down Expand Up @@ -111,6 +116,7 @@ func (c *RedisClientConfig) RegisterFlagsWithPrefix(prefix string, f *flag.FlagS
f.DurationVar(&c.DialTimeout, prefix+"dial-timeout", time.Second*5, "Client dial timeout.")
f.DurationVar(&c.ReadTimeout, prefix+"read-timeout", time.Second*3, "Client read timeout.")
f.DurationVar(&c.WriteTimeout, prefix+"write-timeout", time.Second*3, "Client write timeout.")
f.DurationVar(&c.ConnectionPoolTimeout, prefix+"connection-pool-timeout", time.Second*4, "Maximum duration to wait to get a connection from pool.")
f.IntVar(&c.ConnectionPoolSize, prefix+"connection-pool-size", 100, "Maximum number of connections in the pool.")
f.IntVar(&c.MinIdleConnections, prefix+"min-idle-connections", 10, "Minimum number of idle connections.")
f.DurationVar(&c.MaxConnectionAge, prefix+"max-connection-age", 0, "Close connections older than this duration. If the value is zero, then the pool does not close connections based on age.")
Expand Down Expand Up @@ -162,6 +168,7 @@ func NewRedisClient(logger log.Logger, name string, config RedisClientConfig, re
ReadTimeout: config.ReadTimeout,
WriteTimeout: config.WriteTimeout,
PoolSize: config.ConnectionPoolSize,
PoolTimeout: config.ConnectionPoolTimeout,
MinIdleConns: config.MinIdleConnections,
MaxConnAge: config.MaxConnectionAge,
IdleTimeout: config.IdleTimeout,
Expand Down Expand Up @@ -201,6 +208,7 @@ func NewRedisClient(logger log.Logger, name string, config RedisClientConfig, re
"dial_timeout": config.DialTimeout.String(),
"read_timeout": config.ReadTimeout.String(),
"write_timeout": config.WriteTimeout.String(),
"connection_pool_timeout": config.ConnectionPoolTimeout.String(),
"connection_pool_size": strconv.Itoa(config.ConnectionPoolSize),
"max_async_concurrency": strconv.Itoa(config.MaxAsyncConcurrency),
"max_async_buffer_size": strconv.Itoa(config.MaxAsyncBufferSize),
Expand Down