-
Notifications
You must be signed in to change notification settings - Fork 245
/
options.go
242 lines (212 loc) · 7.12 KB
/
options.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
package crdb
import (
"fmt"
"time"
)
type crdbOptions struct {
connMaxIdleTime *time.Duration
connMaxLifetime *time.Duration
connHealthCheckInterval *time.Duration
minOpenConns *int
maxOpenConns *int
watchBufferLength uint16
revisionQuantization time.Duration
followerReadDelay time.Duration
maxRevisionStalenessPercent float64
gcWindow time.Duration
maxRetries uint8
splitAtUsersetCount uint16
overlapStrategy string
overlapKey string
disableStats bool
enablePrometheusStats bool
}
const (
errQuantizationTooLarge = "revision quantization (%s) must be less than GC window (%s)"
overlapStrategyPrefix = "prefix"
overlapStrategyStatic = "static"
overlapStrategyInsecure = "insecure"
defaultRevisionQuantization = 5 * time.Second
defaultFollowerReadDelay = 0 * time.Second
defaultMaxRevisionStalenessPercent = 0.1
defaultWatchBufferLength = 128
defaultSplitSize = 1024
defaultMaxRetries = 5
defaultOverlapKey = "defaultsynckey"
defaultOverlapStrategy = overlapStrategyStatic
defaultEnablePrometheusStats = false
)
// Option provides the facility to configure how clients within the CRDB
// datastore interact with the running CockroachDB database.
type Option func(*crdbOptions)
func generateConfig(options []Option) (crdbOptions, error) {
computed := crdbOptions{
gcWindow: 24 * time.Hour,
watchBufferLength: defaultWatchBufferLength,
revisionQuantization: defaultRevisionQuantization,
followerReadDelay: defaultFollowerReadDelay,
maxRevisionStalenessPercent: defaultMaxRevisionStalenessPercent,
splitAtUsersetCount: defaultSplitSize,
maxRetries: defaultMaxRetries,
overlapKey: defaultOverlapKey,
overlapStrategy: defaultOverlapStrategy,
disableStats: false,
enablePrometheusStats: defaultEnablePrometheusStats,
}
for _, option := range options {
option(&computed)
}
// Run any checks on the config that need to be done
if computed.revisionQuantization >= computed.gcWindow {
return computed, fmt.Errorf(
errQuantizationTooLarge,
computed.revisionQuantization,
computed.gcWindow,
)
}
return computed, nil
}
// SplitAtUsersetCount is the batch size for which userset queries will be
// split into smaller queries.
//
// This defaults to 1024.
func SplitAtUsersetCount(splitAtUsersetCount uint16) Option {
return func(po *crdbOptions) {
po.splitAtUsersetCount = splitAtUsersetCount
}
}
// ConnHealthCheckInterval is the frequency at which both idle and max lifetime connections
// are checked, and also the frequency at which the minimum number of connections is
// checked. This happens asynchronously.
//
// This is not the only approach to evaluate these counts: connection idle/max lifetime
// is also checked when connections are released to the pool.
//
// There is no guarantee connections won't last longer than their specified idle/max lifetime. It's largely
// dependent on the health-check goroutine being able to pull them from the connection pool. The health-check
// may not be able to clean up those connections if they are held by the application very frequently.
//
// This value defaults to 30s.
func ConnHealthCheckInterval(interval time.Duration) Option {
return func(po *crdbOptions) {
po.connHealthCheckInterval = &interval
}
}
// ConnMaxIdleTime is the duration after which an idle connection will be
// automatically closed by the health check.
//
// This value defaults to having no maximum.
func ConnMaxIdleTime(idle time.Duration) Option {
return func(po *crdbOptions) {
po.connMaxIdleTime = &idle
}
}
// ConnMaxLifetime is the duration since creation after which a connection will
// be automatically closed.
//
// This value defaults to having no maximum.
func ConnMaxLifetime(lifetime time.Duration) Option {
return func(po *crdbOptions) {
po.connMaxLifetime = &lifetime
}
}
// MinOpenConns is the minimum size of the connection pool.
// The health check will increase the number of connections to this amount if
// it had dropped below.
//
// This value defaults to zero.
func MinOpenConns(conns int) Option {
return func(po *crdbOptions) {
po.minOpenConns = &conns
}
}
// MaxOpenConns is the maximum size of the connection pool.
//
// This value defaults to having no maximum.
func MaxOpenConns(conns int) Option {
return func(po *crdbOptions) {
po.maxOpenConns = &conns
}
}
// WatchBufferLength is the number of entries that can be stored in the watch
// buffer while awaiting read by the client.
//
// This value defaults to 128.
func WatchBufferLength(watchBufferLength uint16) Option {
return func(po *crdbOptions) {
po.watchBufferLength = watchBufferLength
}
}
// RevisionQuantization is the time bucket size to which advertised revisions
// will be rounded.
//
// This value defaults to 5 seconds.
func RevisionQuantization(bucketSize time.Duration) Option {
return func(po *crdbOptions) {
po.revisionQuantization = bucketSize
}
}
// FollowerReadDelay is the time delay to apply to enable historial reads.
//
// This value defaults to 0 seconds.
func FollowerReadDelay(delay time.Duration) Option {
return func(po *crdbOptions) {
po.followerReadDelay = delay
}
}
// MaxRevisionStalenessPercent is the amount of time, expressed as a percentage of
// the revision quantization window, that a previously computed rounded revision
// can still be advertised after the next rounded revision would otherwise be ready.
//
// This value defaults to 0.1 (10%).
func MaxRevisionStalenessPercent(stalenessPercent float64) Option {
return func(po *crdbOptions) {
po.maxRevisionStalenessPercent = stalenessPercent
}
}
// GCWindow is the maximum age of a passed revision that will be considered
// valid.
//
// This value defaults to 24 hours.
func GCWindow(window time.Duration) Option {
return func(po *crdbOptions) {
po.gcWindow = window
}
}
// MaxRetries is the maximum number of times a retriable transaction will be
// client-side retried.
// Default: 5
func MaxRetries(maxRetries uint8) Option {
return func(po *crdbOptions) {
po.maxRetries = maxRetries
}
}
// OverlapStrategy is the strategy used to generate overlap keys on write.
// Default: 'static'
func OverlapStrategy(strategy string) Option {
return func(po *crdbOptions) {
po.overlapStrategy = strategy
}
}
// OverlapKey is a key touched on every write if OverlapStrategy is "static"
// Default: 'key'
func OverlapKey(key string) Option {
return func(po *crdbOptions) {
po.overlapKey = key
}
}
// DisableStats disables recording counts to the stats table
func DisableStats(disable bool) Option {
return func(po *crdbOptions) {
po.disableStats = disable
}
}
// WithEnablePrometheusStats marks whether Prometheus metrics provided by the Postgres
// clients being used by the datastore are enabled.
//
// Prometheus metrics are disabled by default.
func WithEnablePrometheusStats(enablePrometheusStats bool) Option {
return func(po *crdbOptions) {
po.enablePrometheusStats = enablePrometheusStats
}
}