Add retry policy and fix documentation for Cassandra storage backend (#10467)

* add simple_retry policy and initial_connection_timeout options,
fix docs for connection_timeout

* Cassandra: policy fix - added changelog.

Co-authored-by: Mehdi Ahmadi <aphorise@gmail.com>
This commit is contained in:
Ivan Buymov 2022-08-30 21:00:48 +03:00 committed by GitHub
parent 001e060e54
commit 99213c2616
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 35 additions and 6 deletions

3
changelog/10467.txt Normal file
View file

@ -0,0 +1,3 @@
```release-note:improvement
storage/cassandra: tuning parameters for clustered environments `connection_timeout`, `initial_connection_timeout`, `simple_retry_policy_retries`.
```

View file

@ -102,6 +102,14 @@ func NewCassandraBackend(conf map[string]string, logger log.Logger) (physical.Ba
cluster.Port = port cluster.Port = port
cluster.Keyspace = keyspace cluster.Keyspace = keyspace
if retryCountStr, ok := conf["simple_retry_policy_retries"]; ok {
retryCount, err := strconv.Atoi(retryCountStr)
if err != nil || retryCount <= 0 {
return nil, fmt.Errorf("'simple_retry_policy_retries' must be a positive integer")
}
cluster.RetryPolicy = &gocql.SimpleRetryPolicy{NumRetries: retryCount}
}
cluster.ProtoVersion = 2 cluster.ProtoVersion = 2
if protoVersionStr, ok := conf["protocol_version"]; ok { if protoVersionStr, ok := conf["protocol_version"]; ok {
protoVersion, err := strconv.Atoi(protoVersionStr) protoVersion, err := strconv.Atoi(protoVersionStr)
@ -122,10 +130,18 @@ func NewCassandraBackend(conf map[string]string, logger log.Logger) (physical.Ba
cluster.Authenticator = authenticator cluster.Authenticator = authenticator
} }
if initialConnectionTimeoutStr, ok := conf["initial_connection_timeout"]; ok {
initialConnectionTimeout, err := strconv.Atoi(initialConnectionTimeoutStr)
if err != nil || initialConnectionTimeout <= 0 {
return nil, fmt.Errorf("'initial_connection_timeout' must be a positive integer")
}
cluster.ConnectTimeout = time.Duration(initialConnectionTimeout) * time.Second
}
if connTimeoutStr, ok := conf["connection_timeout"]; ok { if connTimeoutStr, ok := conf["connection_timeout"]; ok {
connectionTimeout, err := strconv.Atoi(connTimeoutStr) connectionTimeout, err := strconv.Atoi(connTimeoutStr)
if err != nil { if err != nil || connectionTimeout <= 0 {
return nil, fmt.Errorf("'connection_timeout' must be an integer") return nil, fmt.Errorf("'connection_timeout' must be a positive integer")
} }
cluster.Timeout = time.Duration(connectionTimeout) * time.Second cluster.Timeout = time.Duration(connectionTimeout) * time.Second
} }

View file

@ -27,6 +27,9 @@ func TestCassandraBackend(t *testing.T) {
b, err := NewCassandraBackend(map[string]string{ b, err := NewCassandraBackend(map[string]string{
"hosts": host.ConnectionURL(), "hosts": host.ConnectionURL(),
"protocol_version": "3", "protocol_version": "3",
"connection_timeout": "5",
"initial_connection_timeout": "5",
"simple_retry_policy_retries": "3",
}, logger) }, logger)
if err != nil { if err != nil {
t.Fatalf("Failed to create new backend: %v", err) t.Fatalf("Failed to create new backend: %v", err)

View file

@ -69,8 +69,15 @@ CREATE TABLE "vault"."entries" (
- `password` `(string: "")` Password to use when authenticating with the - `password` `(string: "")` Password to use when authenticating with the
Cassandra hosts. Cassandra hosts.
- `connection_timeout` `(int: 0)` - A timeout in seconds to wait until a - `initial_connection_timeout` `(int: 0)` - A timeout in seconds to wait until an initial connection is established
connection is established with the Cassandra hosts. with the Cassandra hosts. If not set, default value from Cassandra driver(gocql) will be used - 600ms
- `connection_timeout` `(int: 0)` - A timeout in seconds for each query.
If not set, default value from Cassandra driver(gocql) will be used - 600ms
- `simple_retry_policy_retries` `(int: 0)` - Useful for Cassandra cluster with several nodes.
If current master node is down request will be retried on the next node `simple_retry_policy_retries`
times, and the client won't get an error.
- `tls` `(int: 0)` If `1`, indicates the connection with the Cassandra hosts - `tls` `(int: 0)` If `1`, indicates the connection with the Cassandra hosts
should use TLS. should use TLS.