[feat] Make memcached client timeout configurable

The default value of `100ms` for `memcached` client timeout might not always be sufficient. Therefore, we would like to be able to fine-tune this parameter via environment var.
flashbots · Apr 7, 2023 · 650be2e · 650be2e
1 parent 84a9439
commit 650be2e
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 7 deletions.
diff --git a/cmd/api.go b/cmd/api.go
@@ -7,6 +7,7 @@ import (
 	"strings"
 	"syscall"
 
+	"github.com/bradfitz/gomemcache/memcache"
 	"github.com/ethereum/go-ethereum/common/hexutil"
 	"github.com/flashbots/go-boost-utils/bls"
 	"github.com/flashbots/mev-boost-relay/beaconclient"
@@ -47,6 +48,7 @@ func init() {
 	apiCmd.Flags().StringSliceVar(&beaconNodeURIs, "beacon-uris", defaultBeaconURIs, "beacon endpoints")
 	apiCmd.Flags().StringVar(&redisURI, "redis-uri", defaultRedisURI, "redis uri")
 	apiCmd.Flags().StringVar(&postgresDSN, "db", defaultPostgresDSN, "PostgreSQL DSN")
+	apiCmd.Flags().DurationVar(&memcachedTimeout, "memcached-timeout", memcache.DefaultTimeout, "Specify memcached client timeout")
 	apiCmd.Flags().StringSliceVar(&memcachedURIs, "memcached-uris", defaultMemcachedURIs,
 		"Enable memcached, typically used as secondary backup to Redis for redundancy")
 	apiCmd.Flags().StringVar(&apiSecretKey, "secret-key", apiDefaultSecretKey, "secret key for signing bids")
@@ -104,7 +106,7 @@ var apiCmd = &cobra.Command{
 		var mem *datastore.Memcached
 		if len(memcachedURIs) > 0 {
 			log.Infof("Connecting to Memcached at %s ...", strings.Join(memcachedURIs, ", "))
-			mem, err = datastore.NewMemcached(networkInfo.Name, memcachedURIs...)
+			mem, err = datastore.NewMemcached(networkInfo.Name, memcachedTimeout, memcachedURIs...)
 			if err != nil {
 				log.WithError(err).Fatalf("Failed to connect to Memcached")
 			}

diff --git a/cmd/variables.go b/cmd/variables.go
@@ -2,6 +2,7 @@ package cmd
 
 import (
 	"os"
+	"time"
 
 	"github.com/flashbots/mev-boost-relay/common"
 )
@@ -15,10 +16,11 @@ var (
 	defaultLogJSON       = os.Getenv("LOG_JSON") != ""
 	defaultLogLevel      = common.GetEnv("LOG_LEVEL", "info")
 
-	beaconNodeURIs []string
-	redisURI       string
-	postgresDSN    string
-	memcachedURIs  []string
+	beaconNodeURIs   []string
+	redisURI         string
+	postgresDSN      string
+	memcachedTimeout time.Duration
+	memcachedURIs    []string
 
 	logJSON  bool
 	logLevel string

diff --git a/datastore/memcached.go b/datastore/memcached.go
@@ -4,6 +4,7 @@ import (
 	"encoding/json"
 	"errors"
 	"fmt"
+	"time"
 
 	"github.com/bradfitz/gomemcache/memcache"
 	"github.com/flashbots/go-utils/cli"
@@ -75,7 +76,7 @@ func (m *Memcached) GetExecutionPayload(slot uint64, proposerPubKey, blockHash s
 	return result, nil
 }
 
-func NewMemcached(prefix string, servers ...string) (*Memcached, error) {
+func NewMemcached(prefix string, timeout time.Duration, servers ...string) (*Memcached, error) {
 	if len(servers) == 0 {
 		return nil, nil
 	}
@@ -89,6 +90,7 @@ func NewMemcached(prefix string, servers ...string) (*Memcached, error) {
 	if err := client.Ping(); err != nil {
 		return nil, err
 	}
+	client.Timeout = timeout
 
 	return &Memcached{client: client, keyPrefix: prefix}, nil
 }
diff --git a/datastore/memcached_test.go b/datastore/memcached_test.go
@@ -9,6 +9,7 @@ import (
 	"time"
 
 	consensusspec "github.com/attestantio/go-eth2-client/spec"
+	"github.com/bradfitz/gomemcache/memcache"
 	"github.com/ethereum/go-ethereum/common/hexutil"
 	"github.com/ethereum/go-ethereum/common/math"
 	"github.com/flashbots/go-boost-utils/bls"
@@ -81,7 +82,7 @@ func initMemcached(t *testing.T) (mem *Memcached, err error) {
 		return
 	}
 
-	mem, err = NewMemcached("test", memcachedEndpoints...)
+	mem, err = NewMemcached("test", memcache.DefaultTimeout, memcachedEndpoints...)
 	if err != nil {
 		return
 	}