/
cluster.go
448 lines (366 loc) · 14.4 KB
/
cluster.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
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
package activerecord
import (
"bytes"
"context"
"fmt"
"hash"
"hash/crc32"
"math/rand"
"strconv"
"strings"
"sync"
"sync/atomic"
"time"
)
// Интерфейс которому должен соответствовать билдер опций подключения к конретному инстансу
type OptionInterface interface {
GetConnectionID() string
InstanceMode() ServerModeType
}
// Тип и константы для выбора инстанса в шарде
type ShardInstanceType uint8
const (
MasterInstanceType ShardInstanceType = iota // Любой из описанных мастеров. По умолчанию используется для rw запросов
ReplicaInstanceType // Любой из описанных реплик
ReplicaOrMasterInstanceType // Любая реплика если есть, если нет то любой мастер. По умолчанию используется при селекте
)
// Тип и константы для определения режима работы конкретного инстанса.
type ServerModeType uint8
const (
ModeMaster ServerModeType = iota
ModeReplica
)
// Структура используется для описания конфигурации конктретного инстанса
type ShardInstanceConfig struct {
Timeout time.Duration
Mode ServerModeType
PoolSize int
Addr string
User string
Password string
}
// Структура описывающая инстанс в кластере
type ShardInstance struct {
ParamsID string
Config ShardInstanceConfig
Options interface{}
Offline bool
}
// Структура описывающая конкретный шард. Каждый шард может состоять из набора мастеров и реплик
type Shard struct {
Masters []ShardInstance
Replicas []ShardInstance
curMaster int32
curReplica int32
}
// Функция выбирающая следующий доступный инстанс мастера в конкретном шарде
func (s *Shard) NextMaster() ShardInstance {
length := len(s.Masters)
switch length {
case 0:
panic("no master configured")
case 1:
master := s.Masters[0]
if master.Offline {
panic("no available master")
}
return master
}
// Из-за гонок при большом кол-ве недоступных инстансов может потребоватся много попыток найти доступный узел
attempt := 10 * length
for i := 0; i < attempt; i++ {
newVal := atomic.AddInt32(&s.curMaster, 1)
newValMod := newVal % int32(len(s.Masters))
if newValMod != newVal {
atomic.CompareAndSwapInt32(&s.curMaster, newVal, newValMod)
}
master := s.Masters[newValMod]
if master.Offline {
continue
}
return master
}
//nolint:gosec
// Есть небольшая вероятность при большой нагрузке и большом проценте недоступных инстансов можно залипнуть на доступном узле
// Чтобы не паниковать выбираем рандомный узел
return s.Masters[rand.Int()%length]
}
// Инстанс выбирающий следующий доступный инстанс реплики в конкретном шарде
func (s *Shard) NextReplica() ShardInstance {
length := len(s.Replicas)
if length == 1 && !s.Replicas[0].Offline {
return s.Replicas[0]
}
// Из-за гонок при большом кол-ве недоступных инстансов может потребоватся много попыток найти доступный узел
attempt := 10 * length
for i := 0; i < attempt; i++ {
newVal := atomic.AddInt32(&s.curReplica, 1)
newValMod := newVal % int32(len(s.Replicas))
if newValMod != newVal {
atomic.CompareAndSwapInt32(&s.curReplica, newVal, newValMod)
}
replica := s.Replicas[newValMod]
if replica.Offline {
continue
}
return replica
}
//nolint:gosec
// Есть небольшая вероятность при большой нагрузке и большом проценте недоступных инстансов поиск может залипнуть на недоступном узле
// Чтобы не паниковать выбираем рандомный узел
return s.Replicas[rand.Int()%length]
}
// Instances копия списка конфигураций всех инстансов шарды. В начале списка следуют мастера, потом реплики
func (c *Shard) Instances() []ShardInstance {
instances := make([]ShardInstance, 0, len(c.Masters)+len(c.Replicas))
instances = append(instances, c.Masters...)
instances = append(instances, c.Replicas...)
return instances
}
// Тип описывающий кластер. Сейчас кластер - это набор шардов.
type Cluster struct {
m sync.RWMutex
shards []Shard
hash hash.Hash
}
func NewCluster(shardCnt int) *Cluster {
return &Cluster{
m: sync.RWMutex{},
shards: make([]Shard, 0, shardCnt),
hash: crc32.NewIEEE(),
}
}
// NextMaster выбирает следующий доступный инстанс мастера в шарде shardNum
func (c *Cluster) NextMaster(shardNum int) ShardInstance {
c.m.RLock()
defer c.m.RUnlock()
return c.shards[shardNum].NextMaster()
}
// NextMaster выбирает следующий доступный инстанс реплики в шарде shardNum
func (c *Cluster) NextReplica(shardNum int) (ShardInstance, bool) {
c.m.RLock()
defer c.m.RUnlock()
for _, replica := range c.shards[shardNum].Replicas {
if replica.Offline {
continue
}
return c.shards[shardNum].NextReplica(), true
}
return ShardInstance{}, false
}
// Append добавляет новый шард в кластер
func (c *Cluster) Append(shard Shard) {
c.m.Lock()
defer c.m.Unlock()
c.shards = append(c.shards, shard)
c.hash.Reset()
for i := 0; i < len(c.shards); i++ {
for _, instance := range c.shards[i].Instances() {
c.hash.Write([]byte(instance.ParamsID))
}
}
}
// ShardInstances копия всех инстансов из шарды shardNum
func (c *Cluster) ShardInstances(shardNum int) []ShardInstance {
c.m.Lock()
defer c.m.Unlock()
return c.shards[shardNum].Instances()
}
// Shards кол-во доступных шард кластера
func (c *Cluster) Shards() int {
return len(c.shards)
}
// SetShardInstances заменяет инстансы кластера в шарде shardNum на инстансы из instances
func (c *Cluster) SetShardInstances(shardNum int, instances []ShardInstance) {
c.m.Lock()
defer c.m.Unlock()
shard := c.shards[shardNum]
shard.Masters = shard.Masters[:0]
shard.Replicas = shard.Replicas[:0]
for _, shardInstance := range instances {
switch shardInstance.Config.Mode {
case ModeMaster:
shard.Masters = append(shard.Masters, shardInstance)
case ModeReplica:
shard.Replicas = append(shard.Replicas, shardInstance)
}
}
c.shards[shardNum] = shard
}
// Equal сравнивает загруженные конфигурации кластеров на основе контрольной суммы всех инстансов кластера
func (c *Cluster) Equal(c2 *Cluster) bool {
if c == nil {
return false
}
if c2 == nil {
return false
}
return bytes.Equal(c.hash.Sum(nil), c2.hash.Sum(nil))
}
// Тип используемый для передачи набора значений по умолчанию для параметров
type MapGlobParam struct {
Timeout time.Duration
PoolSize int
}
// Конструктор который позволяет проинициализировать новый кластер. В опциях передаются все шарды,
// сколько шардов, столько и опций. Используется в случаях, когда информация по кластеру прописана
// непосредственно в декларации модели, а не в конфиге.
// Так же используется при тестировании.
func NewClusterInfo(opts ...clusterOption) *Cluster {
cl := NewCluster(0)
for _, opt := range opts {
opt.apply(cl)
}
return cl
}
// Констркуктор позволяющий проинициализировать кластер их конфигурации.
// На вход передаётся путь в конфиге, значения по умолчанию, и ссылка на функцию, которая
// создаёт структуру опций и считает контрольную сумму, для того, что бы следить за их изменением в онлайне.
func GetClusterInfoFromCfg(ctx context.Context, path string, globs MapGlobParam, optionCreator func(ShardInstanceConfig) (OptionInterface, error)) (*Cluster, error) {
cfg := Config()
shardCnt, exMaxShardOK := cfg.GetIntIfExists(ctx, path+"/max-shard")
if !exMaxShardOK {
shardCnt = 1
}
cluster := NewCluster(shardCnt)
globalTimeout, exGlobalTimeout := cfg.GetDurationIfExists(ctx, path+"/Timeout")
if exGlobalTimeout {
globs.Timeout = globalTimeout
}
globalPoolSize, exGlobalPoolSize := cfg.GetIntIfExists(ctx, path+"/PoolSize")
if !exGlobalPoolSize {
globalPoolSize = 1
}
globs.PoolSize = globalPoolSize
if exMaxShardOK {
// Если используется много шардов
for f := 0; f < shardCnt; f++ {
shard, err := getShardInfoFromCfg(ctx, path+"/"+strconv.Itoa(f), globs, optionCreator)
if err != nil {
return nil, fmt.Errorf("can't get shard %d info: %w", f, err)
}
cluster.Append(shard)
}
} else {
// Когда только один шард
shard, err := getShardInfoFromCfg(ctx, path, globs, optionCreator)
if err != nil {
return nil, fmt.Errorf("can't get shard info: %w", err)
}
cluster.Append(shard)
}
return cluster, nil
}
// Чтение информации по конкретному шарду из конфига
func getShardInfoFromCfg(ctx context.Context, path string, globParam MapGlobParam, optionCreator func(ShardInstanceConfig) (OptionInterface, error)) (Shard, error) {
cfg := Config()
ret := Shard{
Masters: []ShardInstance{},
Replicas: []ShardInstance{},
}
shardTimeout := cfg.GetDuration(ctx, path+"/Timeout", globParam.Timeout)
shardPoolSize := cfg.GetInt(ctx, path+"/PoolSize", globParam.PoolSize)
user, _ := cfg.GetStringIfExists(ctx, path+"/user")
password, _ := cfg.GetStringIfExists(ctx, path+"/password")
// информация по мастерам
master, exMaster := cfg.GetStringIfExists(ctx, path+"/master")
if !exMaster {
master, exMaster = cfg.GetStringIfExists(ctx, path)
if !exMaster {
return Shard{}, fmt.Errorf("master should be specified in '%s' or in '%s/master' and replica in '%s/replica'", path, path, path)
}
}
if master != "" {
for _, inst := range strings.Split(master, ",") {
if inst == "" {
return Shard{}, fmt.Errorf("invalid master instance options: addr is empty")
}
shardCfg := ShardInstanceConfig{
Addr: inst,
Mode: ModeMaster,
PoolSize: shardPoolSize,
Timeout: shardTimeout,
User: user,
Password: password,
}
opt, err := optionCreator(shardCfg)
if err != nil {
return Shard{}, fmt.Errorf("can't create instanceOption: %w", err)
}
ret.Masters = append(ret.Masters, ShardInstance{
ParamsID: opt.GetConnectionID(),
Config: shardCfg,
Options: opt,
})
}
}
// Информация по репликам
replica, exReplica := cfg.GetStringIfExists(ctx, path+"/replica")
if exReplica {
for _, inst := range strings.Split(replica, ",") {
if inst == "" {
return Shard{}, fmt.Errorf("invalid slave instance options: addr is empty")
}
shardCfg := ShardInstanceConfig{
Addr: inst,
Mode: ModeReplica,
PoolSize: shardPoolSize,
Timeout: shardTimeout,
User: user,
Password: password,
}
opt, err := optionCreator(shardCfg)
if err != nil {
return Shard{}, fmt.Errorf("can't create instanceOption: %w", err)
}
ret.Replicas = append(ret.Replicas, ShardInstance{
ParamsID: opt.GetConnectionID(),
Config: shardCfg,
Options: opt,
})
}
}
return ret, nil
}
// Структура для кеширования полученных конфигураций. Инвалидация происходит посредством
// сравнения updateTime сданной труктуры и самого конфига.
// Используется для шаринга конфигов между можелями если они используют одну и ту же
// конфигурацию для подключений
type DefaultConfigCacher struct {
lock sync.RWMutex
container map[string]*Cluster
updateTime time.Time
}
// Конструктор для создания нового кешера конфигов
func NewConfigCacher() *DefaultConfigCacher {
return &DefaultConfigCacher{
lock: sync.RWMutex{},
container: make(map[string]*Cluster),
updateTime: time.Now(),
}
}
// Получение конфигурации. Если есть в кеше и он еще валидный, то конфигурация берётся из кешаб
// если в кеше нет, то достаём из конфига и кешируем.
func (cc *DefaultConfigCacher) Get(ctx context.Context, path string, globs MapGlobParam, optionCreator func(ShardInstanceConfig) (OptionInterface, error)) (*Cluster, error) {
cc.lock.RLock()
conf, ex := cc.container[path]
confUpdateTime := cc.updateTime
cc.lock.RUnlock()
// Если конфигурация не найдена в кеше или конфигурация была обновлена, то перегружаем конфигурацию
if !ex || confUpdateTime.Sub(Config().GetLastUpdateTime()) < 0 {
cc.lock.Lock()
newConf, err := GetClusterInfoFromCfg(ctx, path, globs, optionCreator)
if err != nil {
cc.lock.Unlock()
return nil, fmt.Errorf("can't get config: %w", err)
}
// если конфигурация поменялась, то обновляем её в кеше
if !newConf.Equal(conf) {
conf = newConf
cc.container[path] = conf
cc.updateTime = time.Now()
}
cc.lock.Unlock()
}
return conf, nil
}