-
Notifications
You must be signed in to change notification settings - Fork 168
/
instance_dao.go
2154 lines (1986 loc) · 74.6 KB
/
instance_dao.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
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
Copyright 2014 Outbrain Inc.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package inst
import (
"fmt"
"regexp"
"sort"
"strings"
"time"
"github.com/outbrain/golib/log"
"github.com/outbrain/golib/math"
"github.com/outbrain/golib/sqlutils"
"github.com/outbrain/orchestrator/go/attributes"
"github.com/outbrain/orchestrator/go/config"
"github.com/outbrain/orchestrator/go/db"
"github.com/pmylund/go-cache"
"github.com/rcrowley/go-metrics"
)
const backendDBConcurrency = 20
var instanceReadChan = make(chan bool, backendDBConcurrency)
var instanceWriteChan = make(chan bool, backendDBConcurrency)
// InstancesByCountSlaveHosts is a sortable type for Instance
type InstancesByCountSlaveHosts [](*Instance)
func (this InstancesByCountSlaveHosts) Len() int { return len(this) }
func (this InstancesByCountSlaveHosts) Swap(i, j int) { this[i], this[j] = this[j], this[i] }
func (this InstancesByCountSlaveHosts) Less(i, j int) bool {
return len(this[i].SlaveHosts) < len(this[j].SlaveHosts)
}
// instanceKeyInformativeClusterName is a non-authoritative cache; used for auditing or general purpose.
var instanceKeyInformativeClusterName = cache.New(time.Duration(config.Config.InstancePollSeconds/2)*time.Second, time.Second)
var readTopologyInstanceCounter = metrics.NewCounter()
var readInstanceCounter = metrics.NewCounter()
var writeInstanceCounter = metrics.NewCounter()
func init() {
metrics.Register("instance.read_topology", readTopologyInstanceCounter)
metrics.Register("instance.read", readInstanceCounter)
metrics.Register("instance.write", writeInstanceCounter)
}
// ExecDBWriteFunc chooses how to execute a write onto the database: whether synchronuously or not
func ExecDBWriteFunc(f func() error) error {
instanceWriteChan <- true
defer func() { recover(); <-instanceWriteChan }()
res := f()
return res
}
// logReadTopologyInstanceError logs an error, if applicable, for a ReadTopologyInstance operation,
// providing context and hint as for the source of the error.
func logReadTopologyInstanceError(instanceKey *InstanceKey, hint string, err error) error {
if err == nil {
return nil
}
return log.Errorf("ReadTopologyInstance(%+v) %+v: %+v", *instanceKey, hint, err)
}
// ReadTopologyInstance connects to a topology MySQL instance and reads its configuration and
// replication status. It writes read info into orchestrator's backend.
func ReadTopologyInstance(instanceKey *InstanceKey) (*Instance, error) {
defer func() {
if err := recover(); err != nil {
logReadTopologyInstanceError(instanceKey, "Unexpected, aborting", fmt.Errorf("%+v", err))
}
}()
instance := NewInstance()
instanceFound := false
foundByShowSlaveHosts := false
longRunningProcesses := []Process{}
resolvedHostname := ""
maxScaleMasterHostname := ""
isMaxScale := false
isMaxScale110 := false
slaveStatusFound := false
var resolveErr error
// Before we even begin anything, declare that we're about to cehck this instance.If anything goes wrong network-wise,
// this is our source of truth in terms of instance being inaccessible
_ = UpdateInstanceLastAttemptedCheck(instanceKey)
if !instanceKey.IsValid() {
return instance, fmt.Errorf("ReadTopologyInstance will not act on invalid instance key: %+v", *instanceKey)
}
db, err := db.OpenTopology(instanceKey.Hostname, instanceKey.Port)
if err != nil {
goto Cleanup
}
instance.Key = *instanceKey
{
// Is this MaxScale? (a proxy, not a real server)
err = sqlutils.QueryRowsMap(db, "show variables like 'maxscale%'", func(m sqlutils.RowMap) error {
variableName := m.GetString("Variable_name")
if variableName == "MAXSCALE_VERSION" {
originalVersion := m.GetString("Value")
if originalVersion == "" {
originalVersion = m.GetString("value")
}
if originalVersion == "" {
originalVersion = "0.0.0"
}
instance.Version = originalVersion + "-maxscale"
instance.ServerID = 0
instance.ServerUUID = ""
instance.Uptime = 0
instance.Binlog_format = "INHERIT"
instance.ReadOnly = true
instance.LogBinEnabled = true
instance.LogSlaveUpdatesEnabled = true
resolvedHostname = instance.Key.Hostname
UpdateResolvedHostname(resolvedHostname, resolvedHostname)
isMaxScale = true
}
return nil
})
if err != nil {
logReadTopologyInstanceError(instanceKey, "show variables like 'maxscale%'", err)
// We do not "goto Cleanup" here, although it should be the correct flow.
// Reason is 5.7's new security feature that requires GRANTs on performance_schema.session_variables.
// There is a wrong decision making in this design and the migration path to 5.7 will be difficult.
// I don't want orchestrator to put even more burden on this.
// If the statement errors, then we are unable to determine that this is maxscale, hence assume it is not.
// In which case there would be other queries sent to the server that are not affected by 5.7 behavior, and that will fail.
}
}
if isMaxScale && strings.Contains(instance.Version, "1.1.0") {
isMaxScale110 = true
}
if isMaxScale110 {
// Buggy buggy maxscale 1.1.0. Reported Master_Host can be corrupted.
// Therefore we (currently) take @@hostname (which is masquarading as master host anyhow)
err = db.QueryRow("select @@hostname").Scan(&maxScaleMasterHostname)
if err != nil {
goto Cleanup
}
}
if isMaxScale {
if isMaxScale110 {
// Only this is supported:
db.QueryRow("select @@server_id").Scan(&instance.ServerID)
} else {
db.QueryRow("select @@global.server_id").Scan(&instance.ServerID)
db.QueryRow("select @@global.server_uuid").Scan(&instance.ServerUUID)
}
}
if !isMaxScale {
var mysqlHostname, mysqlReportHost string
err = db.QueryRow("select @@global.hostname, ifnull(@@global.report_host, ''), @@global.server_id, @@global.version, @@global.read_only, @@global.binlog_format, @@global.log_bin, @@global.log_slave_updates").Scan(
&mysqlHostname, &mysqlReportHost, &instance.ServerID, &instance.Version, &instance.ReadOnly, &instance.Binlog_format, &instance.LogBinEnabled, &instance.LogSlaveUpdatesEnabled)
if err != nil {
goto Cleanup
}
switch strings.ToLower(config.Config.MySQLHostnameResolveMethod) {
case "none":
resolvedHostname = instance.Key.Hostname
case "default", "hostname", "@@hostname":
resolvedHostname = mysqlHostname
case "report_host", "@@report_host":
if mysqlReportHost == "" {
err = fmt.Errorf("MySQLHostnameResolveMethod configured to use @@report_host but %+v has NULL/empty @@report_host", instanceKey)
goto Cleanup
}
resolvedHostname = mysqlReportHost
default:
resolvedHostname = instance.Key.Hostname
}
if instance.IsOracleMySQL() && !instance.IsSmallerMajorVersionByString("5.6") {
var masterInfoRepositoryOnTable bool
// Stuff only supported on Oracle MySQL >= 5.6
// ...
// @@gtid_mode only available in Orcale MySQL >= 5.6
// Previous version just issued this query brute-force, but I don't like errors being issued where they shouldn't.
_ = db.QueryRow("select @@global.gtid_mode = 'ON', @@global.server_uuid, @@global.gtid_purged, @@global.master_info_repository = 'TABLE'").Scan(&instance.SupportsOracleGTID, &instance.ServerUUID, &instance.GtidPurged, &masterInfoRepositoryOnTable)
if masterInfoRepositoryOnTable {
_ = db.QueryRow("select count(*) > 0 and MAX(User_name) != '' from mysql.slave_master_info").Scan(&instance.ReplicationCredentialsAvailable)
}
}
}
{
var dummy string
// show global status works just as well with 5.6 & 5.7 (5.7 moves variables to performance_schema)
err = db.QueryRow("show global status like 'Uptime'").Scan(&dummy, &instance.Uptime)
if err != nil {
logReadTopologyInstanceError(instanceKey, "show global status like 'Uptime'", err)
// We do not "goto Cleanup" here, although it should be the correct flow.
// Reason is 5.7's new security feature that requires GRANTs on performance_schema.global_variables.
// There is a wrong decisionmaking in this design and the migration path to 5.7 will be difficult.
// I don't want orchestrator to put even more burden on this. The 'Uptime' variable is not that important
// so as to completely fail reading a 5.7 instance.
// This is supposed to be fixed in 5.7.9
}
}
if resolvedHostname != instance.Key.Hostname {
UpdateResolvedHostname(instance.Key.Hostname, resolvedHostname)
instance.Key.Hostname = resolvedHostname
}
if instance.Key.Hostname == "" {
err = fmt.Errorf("ReadTopologyInstance: empty hostname (%+v). Bailing out", *instanceKey)
goto Cleanup
}
if config.Config.DataCenterPattern != "" {
if pattern, err := regexp.Compile(config.Config.DataCenterPattern); err == nil {
match := pattern.FindStringSubmatch(instance.Key.Hostname)
if len(match) != 0 {
instance.DataCenter = match[1]
}
}
// This can be overriden by later invocation of DetectDataCenterQuery
}
if config.Config.PhysicalEnvironmentPattern != "" {
if pattern, err := regexp.Compile(config.Config.PhysicalEnvironmentPattern); err == nil {
match := pattern.FindStringSubmatch(instance.Key.Hostname)
if len(match) != 0 {
instance.PhysicalEnvironment = match[1]
}
}
// This can be overriden by later invocation of DetectPhysicalEnvironmentQuery
}
err = sqlutils.QueryRowsMap(db, "show slave status", func(m sqlutils.RowMap) error {
instance.HasReplicationCredentials = (m.GetString("Master_User") != "")
instance.Slave_IO_Running = (m.GetString("Slave_IO_Running") == "Yes")
if isMaxScale110 {
// Covering buggy MaxScale 1.1.0
instance.Slave_IO_Running = instance.Slave_IO_Running && (m.GetString("Slave_IO_State") == "Binlog Dump")
}
instance.Slave_SQL_Running = (m.GetString("Slave_SQL_Running") == "Yes")
instance.ReadBinlogCoordinates.LogFile = m.GetString("Master_Log_File")
instance.ReadBinlogCoordinates.LogPos = m.GetInt64("Read_Master_Log_Pos")
instance.ExecBinlogCoordinates.LogFile = m.GetString("Relay_Master_Log_File")
instance.ExecBinlogCoordinates.LogPos = m.GetInt64("Exec_Master_Log_Pos")
instance.IsDetached, _, _ = instance.ExecBinlogCoordinates.DetachedCoordinates()
instance.RelaylogCoordinates.LogFile = m.GetString("Relay_Log_File")
instance.RelaylogCoordinates.LogPos = m.GetInt64("Relay_Log_Pos")
instance.RelaylogCoordinates.Type = RelayLog
instance.LastSQLError = m.GetString("Last_SQL_Error")
instance.LastIOError = m.GetString("Last_IO_Error")
instance.SQLDelay = m.GetUintD("SQL_Delay", 0)
instance.UsingOracleGTID = (m.GetIntD("Auto_Position", 0) == 1)
instance.ExecutedGtidSet = m.GetStringD("Executed_Gtid_Set", "")
instance.UsingMariaDBGTID = (m.GetStringD("Using_Gtid", "No") != "No")
instance.HasReplicationFilters = ((m.GetStringD("Replicate_Do_DB", "") != "") || (m.GetStringD("Replicate_Ignore_DB", "") != "") || (m.GetStringD("Replicate_Do_Table", "") != "") || (m.GetStringD("Replicate_Ignore_Table", "") != "") || (m.GetStringD("Replicate_Wild_Do_Table", "") != "") || (m.GetStringD("Replicate_Wild_Ignore_Table", "") != ""))
masterHostname := m.GetString("Master_Host")
if isMaxScale110 {
// Buggy buggy maxscale 1.1.0. Reported Master_Host can be corrupted.
// Therefore we (currently) take @@hostname (which is masquarading as master host anyhow)
masterHostname = maxScaleMasterHostname
}
masterKey, err := NewInstanceKeyFromStrings(masterHostname, m.GetString("Master_Port"))
if err != nil {
logReadTopologyInstanceError(instanceKey, "NewInstanceKeyFromStrings", err)
}
masterKey.Hostname, resolveErr = ResolveHostname(masterKey.Hostname)
if resolveErr != nil {
logReadTopologyInstanceError(instanceKey, fmt.Sprintf("ResolveHostname(%+v)", masterKey.Hostname), resolveErr)
}
instance.MasterKey = *masterKey
instance.IsDetachedMaster = instance.MasterKey.IsDetached()
instance.SecondsBehindMaster = m.GetNullInt64("Seconds_Behind_Master")
if instance.SecondsBehindMaster.Valid && instance.SecondsBehindMaster.Int64 < 0 {
log.Warningf("Host: %+v, instance.SecondsBehindMaster < 0 [%+v], correcting to 0", instanceKey, instance.SecondsBehindMaster.Int64)
instance.SecondsBehindMaster.Int64 = 0
}
// And until told otherwise:
instance.SlaveLagSeconds = instance.SecondsBehindMaster
instance.AllowTLS = (m.GetString("Master_SSL_Allowed") == "Yes")
// Not breaking the flow even on error
slaveStatusFound = true
return nil
})
if err != nil {
goto Cleanup
}
if isMaxScale && !slaveStatusFound {
err = fmt.Errorf("No 'SHOW SLAVE STATUS' output found for a MaxScale instance: %+v", instanceKey)
goto Cleanup
}
if instance.LogBinEnabled {
err = sqlutils.QueryRowsMap(db, "show master status", func(m sqlutils.RowMap) error {
var err error
instance.SelfBinlogCoordinates.LogFile = m.GetString("File")
instance.SelfBinlogCoordinates.LogPos = m.GetInt64("Position")
return err
})
if err != nil {
goto Cleanup
}
}
instanceFound = true
// -------------------------------------------------------------------------
// Anything after this point does not affect the fact the instance is found.
// No `goto Cleanup` after this point.
// -------------------------------------------------------------------------
// Get slaves, either by SHOW SLAVE HOSTS or via PROCESSLIST
// MaxScale does not support PROCESSLIST, so SHOW SLAVE HOSTS is the only option
if config.Config.DiscoverByShowSlaveHosts || isMaxScale {
err := sqlutils.QueryRowsMap(db, `show slave hosts`,
func(m sqlutils.RowMap) error {
slaveKey, err := NewInstanceKeyFromStrings(m.GetString("Host"), m.GetString("Port"))
if err == nil && slaveKey.IsValid() {
slaveKey.Hostname, resolveErr = ResolveHostname(slaveKey.Hostname)
instance.AddSlaveKey(slaveKey)
foundByShowSlaveHosts = true
}
return err
})
logReadTopologyInstanceError(instanceKey, "show slave hosts", err)
}
if !foundByShowSlaveHosts && !isMaxScale {
// Either not configured to read SHOW SLAVE HOSTS or nothing was there.
// Discover by processlist
err := sqlutils.QueryRowsMap(db, `
select
substring_index(host, ':', 1) as slave_hostname
from
information_schema.processlist
where
command='Binlog Dump'
or command='Binlog Dump GTID'
`,
func(m sqlutils.RowMap) error {
cname, resolveErr := ResolveHostname(m.GetString("slave_hostname"))
if resolveErr != nil {
logReadTopologyInstanceError(instanceKey, "ResolveHostname: processlist", resolveErr)
}
slaveKey := InstanceKey{Hostname: cname, Port: instance.Key.Port}
instance.AddSlaveKey(&slaveKey)
return err
})
logReadTopologyInstanceError(instanceKey, "processlist", err)
}
if config.Config.ReadLongRunningQueries && !isMaxScale {
// Get long running processes
err := sqlutils.QueryRowsMap(db, `
select
id,
user,
host,
db,
command,
time,
state,
left(processlist.info, 1024) as info,
now() - interval time second as started_at
from
information_schema.processlist
where
time > 60
and command != 'Sleep'
and id != connection_id()
and user != 'system user'
and command != 'Binlog dump'
and command != 'Binlog Dump GTID'
and user != 'event_scheduler'
order by
time desc
`,
func(m sqlutils.RowMap) error {
process := Process{}
process.Id = m.GetInt64("id")
process.User = m.GetString("user")
process.Host = m.GetString("host")
process.Db = m.GetString("db")
process.Command = m.GetString("command")
process.Time = m.GetInt64("time")
process.State = m.GetString("state")
process.Info = m.GetString("info")
process.StartedAt = m.GetString("started_at")
longRunningProcesses = append(longRunningProcesses, process)
return nil
})
logReadTopologyInstanceError(instanceKey, "processlist, long queries", err)
}
instance.UsingPseudoGTID = false
if config.Config.DetectPseudoGTIDQuery != "" && !isMaxScale {
if resultData, err := sqlutils.QueryResultData(db, config.Config.DetectPseudoGTIDQuery); err == nil {
if len(resultData) > 0 {
if len(resultData[0]) > 0 {
if resultData[0][0].Valid && resultData[0][0].String == "1" {
instance.UsingPseudoGTID = true
}
}
}
} else {
logReadTopologyInstanceError(instanceKey, "DetectPseudoGTIDQuery", err)
}
}
if config.Config.SlaveLagQuery != "" && !isMaxScale {
if err := db.QueryRow(config.Config.SlaveLagQuery).Scan(&instance.SlaveLagSeconds); err == nil {
if instance.SlaveLagSeconds.Valid && instance.SlaveLagSeconds.Int64 < 0 {
log.Warningf("Host: %+v, instance.SlaveLagSeconds < 0 [%+v], correcting to 0", instanceKey, instance.SlaveLagSeconds.Int64)
instance.SlaveLagSeconds.Int64 = 0
}
} else {
instance.SlaveLagSeconds = instance.SecondsBehindMaster
logReadTopologyInstanceError(instanceKey, "SlaveLagQuery", err)
}
}
if config.Config.DetectDataCenterQuery != "" && !isMaxScale {
err := db.QueryRow(config.Config.DetectDataCenterQuery).Scan(&instance.DataCenter)
logReadTopologyInstanceError(instanceKey, "DetectDataCenterQuery", err)
}
if config.Config.DetectPhysicalEnvironmentQuery != "" && !isMaxScale {
err := db.QueryRow(config.Config.DetectPhysicalEnvironmentQuery).Scan(&instance.PhysicalEnvironment)
logReadTopologyInstanceError(instanceKey, "DetectPhysicalEnvironmentQuery", err)
}
if config.Config.DetectInstanceAliasQuery != "" && !isMaxScale {
err := db.QueryRow(config.Config.DetectInstanceAliasQuery).Scan(&instance.InstanceAlias)
logReadTopologyInstanceError(instanceKey, "DetectInstanceAliasQuery", err)
}
if config.Config.DetectSemiSyncEnforcedQuery != "" && !isMaxScale {
err := db.QueryRow(config.Config.DetectSemiSyncEnforcedQuery).Scan(&instance.SemiSyncEnforced)
logReadTopologyInstanceError(instanceKey, "DetectSemiSyncEnforcedQuery", err)
}
{
err = ReadInstanceClusterAttributes(instance)
logReadTopologyInstanceError(instanceKey, "ReadInstanceClusterAttributes", err)
}
// First read the current PromotionRule from candidate_database_instance.
{
err = ReadInstancePromotionRule(instance)
logReadTopologyInstanceError(instanceKey, "ReadInstanceClusterAttributes", err)
}
// Then check if the instance wants to set a different PromotionRule.
// We'll set it here on their behalf so there's no race between the first
// time an instance is discovered, and setting a rule like "must_not".
if config.Config.DetectPromotionRuleQuery != "" && !isMaxScale {
var value string
err := db.QueryRow(config.Config.DetectPromotionRuleQuery).Scan(&value)
logReadTopologyInstanceError(instanceKey, "DetectPromotionRuleQuery", err)
promotionRule, err := ParseCandidatePromotionRule(value)
logReadTopologyInstanceError(instanceKey, "ParseCandidatePromotionRule", err)
if err == nil {
// We need to update candidate_database_instance.
// We register the rule even if it hasn't changed,
// to bump the last_suggested time.
instance.PromotionRule = promotionRule
err = RegisterCandidateInstance(instanceKey, promotionRule)
logReadTopologyInstanceError(instanceKey, "RegisterCandidateInstance", err)
}
}
if instance.ReplicationDepth == 0 && config.Config.DetectClusterAliasQuery != "" && !isMaxScale {
// Only need to do on masters
clusterAlias := ""
err := db.QueryRow(config.Config.DetectClusterAliasQuery).Scan(&clusterAlias)
if err != nil {
clusterAlias = ""
logReadTopologyInstanceError(instanceKey, "DetectClusterAliasQuery", err)
}
instance.SuggestedClusterAlias = clusterAlias
}
if instance.ReplicationDepth == 0 && config.Config.DetectClusterDomainQuery != "" && !isMaxScale {
// Only need to do on masters
domainName := ""
if err := db.QueryRow(config.Config.DetectClusterDomainQuery).Scan(&domainName); err != nil {
domainName = ""
logReadTopologyInstanceError(instanceKey, "DetectClusterDomainQuery", err)
}
if domainName != "" {
err := WriteClusterDomainName(instance.ClusterName, domainName)
logReadTopologyInstanceError(instanceKey, "WriteClusterDomainName", err)
}
}
Cleanup:
readTopologyInstanceCounter.Inc(1)
logReadTopologyInstanceError(instanceKey, "Cleanup", err)
if instanceFound {
instance.IsLastCheckValid = true
instance.IsRecentlyChecked = true
instance.IsUpToDate = true
_ = writeInstance(instance, instanceFound, err)
WriteLongRunningProcesses(&instance.Key, longRunningProcesses)
return instance, nil
} else {
_ = UpdateInstanceLastChecked(&instance.Key)
return nil, fmt.Errorf("Failed ReadTopologyInstance")
}
}
// ReadInstanceClusterAttributes will return the cluster name for a given instance by looking at its master
// and getting it from there.
// It is a non-recursive function and so-called-recursion is performed upon periodic reading of
// instances.
func ReadInstanceClusterAttributes(instance *Instance) (err error) {
if config.Config.DatabaselessMode__experimental {
return nil
}
var masterMasterKey InstanceKey
var masterClusterName string
var masterReplicationDepth uint
masterDataFound := false
// Read the cluster_name of the _master_ of our instance, derive it from there.
query := `
select
cluster_name,
replication_depth,
master_host,
master_port
from database_instance
where hostname=? and port=?
`
args := sqlutils.Args(instance.MasterKey.Hostname, instance.MasterKey.Port)
err = db.QueryOrchestrator(query, args, func(m sqlutils.RowMap) error {
masterClusterName = m.GetString("cluster_name")
masterReplicationDepth = m.GetUint("replication_depth")
masterMasterKey.Hostname = m.GetString("master_host")
masterMasterKey.Port = m.GetInt("master_port")
masterDataFound = true
return nil
})
if err != nil {
return log.Errore(err)
}
var replicationDepth uint = 0
var clusterName string
if masterDataFound {
replicationDepth = masterReplicationDepth + 1
clusterName = masterClusterName
}
clusterNameByInstanceKey := instance.Key.StringCode()
if clusterName == "" {
// Nothing from master; we set it to be named after the instance itself
clusterName = clusterNameByInstanceKey
}
isCoMaster := false
if masterMasterKey.Equals(&instance.Key) {
// co-master calls for special case, in fear of the infinite loop
isCoMaster = true
clusterNameByCoMasterKey := instance.MasterKey.StringCode()
if clusterName != clusterNameByInstanceKey && clusterName != clusterNameByCoMasterKey {
// Can be caused by a co-master topology failover
log.Errorf("ReadInstanceClusterAttributes: in co-master topology %s is not in (%s, %s). Forcing it to become one of them", clusterName, clusterNameByInstanceKey, clusterNameByCoMasterKey)
clusterName = math.TernaryString(instance.Key.SmallerThan(&instance.MasterKey), clusterNameByInstanceKey, clusterNameByCoMasterKey)
}
if clusterName == clusterNameByInstanceKey {
// circular replication. Avoid infinite ++ on replicationDepth
replicationDepth = 0
} // While the other stays "1"
}
instance.ClusterName = clusterName
instance.ReplicationDepth = replicationDepth
instance.IsCoMaster = isCoMaster
return nil
}
func ReadInstancePromotionRule(instance *Instance) (err error) {
if config.Config.DatabaselessMode__experimental {
return nil
}
var promotionRule CandidatePromotionRule = NeutralPromoteRule
// Read the cluster_name of the _master_ of our instance, derive it from there.
query := `
select
ifnull(nullif(promotion_rule, ''), 'neutral') as promotion_rule
from candidate_database_instance
where hostname=? and port=?
`
args := sqlutils.Args(instance.Key.Hostname, instance.Key.Port)
err = db.QueryOrchestrator(query, args, func(m sqlutils.RowMap) error {
promotionRule = CandidatePromotionRule(m.GetString("promotion_rule"))
return nil
})
instance.PromotionRule = promotionRule
return log.Errore(err)
}
// readInstanceRow reads a single instance row from the orchestrator backend database.
func readInstanceRow(m sqlutils.RowMap) *Instance {
instance := NewInstance()
instance.Key.Hostname = m.GetString("hostname")
instance.Key.Port = m.GetInt("port")
instance.Uptime = m.GetUint("uptime")
instance.ServerID = m.GetUint("server_id")
instance.ServerUUID = m.GetString("server_uuid")
instance.Version = m.GetString("version")
instance.ReadOnly = m.GetBool("read_only")
instance.Binlog_format = m.GetString("binlog_format")
instance.LogBinEnabled = m.GetBool("log_bin")
instance.LogSlaveUpdatesEnabled = m.GetBool("log_slave_updates")
instance.MasterKey.Hostname = m.GetString("master_host")
instance.MasterKey.Port = m.GetInt("master_port")
instance.IsDetachedMaster = instance.MasterKey.IsDetached()
instance.Slave_SQL_Running = m.GetBool("slave_sql_running")
instance.Slave_IO_Running = m.GetBool("slave_io_running")
instance.HasReplicationFilters = m.GetBool("has_replication_filters")
instance.SupportsOracleGTID = m.GetBool("supports_oracle_gtid")
instance.UsingOracleGTID = m.GetBool("oracle_gtid")
instance.ExecutedGtidSet = m.GetString("executed_gtid_set")
instance.GtidPurged = m.GetString("gtid_purged")
instance.UsingMariaDBGTID = m.GetBool("mariadb_gtid")
instance.UsingPseudoGTID = m.GetBool("pseudo_gtid")
instance.SelfBinlogCoordinates.LogFile = m.GetString("binary_log_file")
instance.SelfBinlogCoordinates.LogPos = m.GetInt64("binary_log_pos")
instance.ReadBinlogCoordinates.LogFile = m.GetString("master_log_file")
instance.ReadBinlogCoordinates.LogPos = m.GetInt64("read_master_log_pos")
instance.ExecBinlogCoordinates.LogFile = m.GetString("relay_master_log_file")
instance.ExecBinlogCoordinates.LogPos = m.GetInt64("exec_master_log_pos")
instance.IsDetached, _, _ = instance.ExecBinlogCoordinates.DetachedCoordinates()
instance.RelaylogCoordinates.LogFile = m.GetString("relay_log_file")
instance.RelaylogCoordinates.LogPos = m.GetInt64("relay_log_pos")
instance.RelaylogCoordinates.Type = RelayLog
instance.LastSQLError = m.GetString("last_sql_error")
instance.LastIOError = m.GetString("last_io_error")
instance.SecondsBehindMaster = m.GetNullInt64("seconds_behind_master")
instance.SlaveLagSeconds = m.GetNullInt64("slave_lag_seconds")
instance.SQLDelay = m.GetUint("sql_delay")
slaveHostsJSON := m.GetString("slave_hosts")
instance.ClusterName = m.GetString("cluster_name")
instance.SuggestedClusterAlias = m.GetString("suggested_cluster_alias")
instance.DataCenter = m.GetString("data_center")
instance.PhysicalEnvironment = m.GetString("physical_environment")
instance.SemiSyncEnforced = m.GetBool("semi_sync_enforced")
instance.ReplicationDepth = m.GetUint("replication_depth")
instance.IsCoMaster = m.GetBool("is_co_master")
instance.ReplicationCredentialsAvailable = m.GetBool("replication_credentials_available")
instance.HasReplicationCredentials = m.GetBool("has_replication_credentials")
instance.IsUpToDate = (m.GetUint("seconds_since_last_checked") <= config.Config.InstancePollSeconds)
instance.IsRecentlyChecked = (m.GetUint("seconds_since_last_checked") <= config.Config.InstancePollSeconds*5)
instance.LastSeenTimestamp = m.GetString("last_seen")
instance.IsLastCheckValid = m.GetBool("is_last_check_valid")
instance.SecondsSinceLastSeen = m.GetNullInt64("seconds_since_last_seen")
instance.IsCandidate = m.GetBool("is_candidate")
instance.PromotionRule = CandidatePromotionRule(m.GetString("promotion_rule"))
instance.IsDowntimed = m.GetBool("is_downtimed")
instance.DowntimeReason = m.GetString("downtime_reason")
instance.DowntimeOwner = m.GetString("downtime_owner")
instance.DowntimeEndTimestamp = m.GetString("downtime_end_timestamp")
instance.UnresolvedHostname = m.GetString("unresolved_hostname")
instance.AllowTLS = m.GetBool("allow_tls")
instance.InstanceAlias = m.GetString("instance_alias")
instance.SlaveHosts.ReadJson(slaveHostsJSON)
return instance
}
// readInstancesByCondition is a generic function to read instances from the backend database
func readInstancesByCondition(condition string, args []interface{}, sort string) ([](*Instance), error) {
readFunc := func() ([](*Instance), error) {
instances := [](*Instance){}
if sort == "" {
sort = `hostname, port`
}
query := fmt.Sprintf(`
select
*,
timestampdiff(second, last_checked, now()) as seconds_since_last_checked,
(last_checked <= last_seen) is true as is_last_check_valid,
timestampdiff(second, last_seen, now()) as seconds_since_last_seen,
candidate_database_instance.last_suggested is not null
and candidate_database_instance.promotion_rule in ('must', 'prefer') as is_candidate,
ifnull(nullif(candidate_database_instance.promotion_rule, ''), 'neutral') as promotion_rule,
ifnull(unresolved_hostname, '') as unresolved_hostname,
(
database_instance_downtime.downtime_active IS NULL
or database_instance_downtime.end_timestamp < NOW()
) is false as is_downtimed,
ifnull(database_instance_downtime.reason, '') as downtime_reason,
ifnull(database_instance_downtime.owner, '') as downtime_owner,
ifnull(database_instance_downtime.end_timestamp, '') as downtime_end_timestamp
from
database_instance
left join candidate_database_instance using (hostname, port)
left join hostname_unresolve using (hostname)
left join database_instance_downtime using (hostname, port)
where
%s
order by
%s
`, condition, sort)
err := db.QueryOrchestrator(query, args, func(m sqlutils.RowMap) error {
instance := readInstanceRow(m)
instances = append(instances, instance)
return nil
})
if err != nil {
return instances, log.Errore(err)
}
err = PopulateInstancesAgents(instances)
if err != nil {
return instances, log.Errore(err)
}
return instances, err
}
instanceReadChan <- true
instances, err := readFunc()
<-instanceReadChan
return instances, err
}
// ReadInstance reads an instance from the orchestrator backend database
func ReadInstance(instanceKey *InstanceKey) (*Instance, bool, error) {
if config.Config.DatabaselessMode__experimental {
instance, err := ReadTopologyInstance(instanceKey)
return instance, (err == nil), err
}
condition := `
hostname = ?
and port = ?
`
instances, err := readInstancesByCondition(condition, sqlutils.Args(instanceKey.Hostname, instanceKey.Port), "")
// We know there will be at most one (hostname & port are PK)
// And we expect to find one
readInstanceCounter.Inc(1)
if len(instances) == 0 {
return nil, false, err
}
if err != nil {
return instances[0], false, err
}
return instances[0], true, nil
}
// ReadClusterInstances reads all instances of a given cluster
func ReadClusterInstances(clusterName string) ([](*Instance), error) {
if strings.Index(clusterName, "'") >= 0 {
return [](*Instance){}, log.Errorf("Invalid cluster name: %s", clusterName)
}
condition := `cluster_name = ?`
return readInstancesByCondition(condition, sqlutils.Args(clusterName), "")
}
// ReadClusterWriteableMaster returns the/a writeable master of this cluster
// Typically, the cluster name indicates the master of the cluster. However, in circular
// master-master replication one master can assume the name of the cluster, and it is
// not guaranteed that it is the writeable one.
func ReadClusterWriteableMaster(clusterName string) ([](*Instance), error) {
condition := `
cluster_name = ?
and read_only = 0
and (replication_depth = 0 or is_co_master)
`
return readInstancesByCondition(condition, sqlutils.Args(clusterName), "replication_depth asc")
}
// ReadWriteableClustersMasters returns writeable masters of all clusters, but only one
// per cluster, in similar logic to ReadClusterWriteableMaster
func ReadWriteableClustersMasters() (instances [](*Instance), err error) {
condition := `
read_only = 0
and (replication_depth = 0 or is_co_master)
`
allMasters, err := readInstancesByCondition(condition, sqlutils.Args(), "cluster_name asc, replication_depth asc")
if err != nil {
return instances, err
}
visitedClusters := make(map[string]bool)
for _, instance := range allMasters {
if !visitedClusters[instance.ClusterName] {
visitedClusters[instance.ClusterName] = true
instances = append(instances, instance)
}
}
return instances, err
}
// ReadSlaveInstances reads slaves of a given master
func ReadSlaveInstances(masterKey *InstanceKey) ([](*Instance), error) {
condition := `
master_host = ?
and master_port = ?
`
return readInstancesByCondition(condition, sqlutils.Args(masterKey.Hostname, masterKey.Port), "")
}
// ReadSlaveInstancesIncludingBinlogServerSubSlaves returns a list of direct slves including any slaves
// of a binlog server replica
func ReadSlaveInstancesIncludingBinlogServerSubSlaves(masterKey *InstanceKey) ([](*Instance), error) {
slaves, err := ReadSlaveInstances(masterKey)
if err != nil {
return slaves, err
}
for _, slave := range slaves {
slave := slave
if slave.IsBinlogServer() {
binlogServerSlaves, err := ReadSlaveInstancesIncludingBinlogServerSubSlaves(&slave.Key)
if err != nil {
return slaves, err
}
slaves = append(slaves, binlogServerSlaves...)
}
}
return slaves, err
}
// ReadBinlogServerSlaveInstances reads direct slaves of a given master that are binlog servers
func ReadBinlogServerSlaveInstances(masterKey *InstanceKey) ([](*Instance), error) {
condition := `
master_host = ?
and master_port = ?
and binlog_server = 1
`
return readInstancesByCondition(condition, sqlutils.Args(masterKey.Hostname, masterKey.Port), "")
}
// ReadUnseenInstances reads all instances which were not recently seen
func ReadUnseenInstances() ([](*Instance), error) {
condition := `last_seen < last_checked`
return readInstancesByCondition(condition, sqlutils.Args(), "")
}
// ReadProblemInstances reads all instances with problems
func ReadProblemInstances(clusterName string) ([](*Instance), error) {
condition := `
cluster_name LIKE IF(? = '', '%', ?)
and (
(last_seen < last_checked)
or (not ifnull(timestampdiff(second, last_checked, now()) <= ?, false))
or (not slave_sql_running)
or (not slave_io_running)
or (abs(cast(seconds_behind_master as signed) - cast(sql_delay as signed)) > ?)
or (abs(cast(slave_lag_seconds as signed) - cast(sql_delay as signed)) > ?)
)
`
args := sqlutils.Args(clusterName, clusterName, config.Config.InstancePollSeconds, config.Config.ReasonableReplicationLagSeconds, config.Config.ReasonableReplicationLagSeconds)
instances, err := readInstancesByCondition(condition, args, "")
if err != nil {
return instances, err
}
var reportedInstances [](*Instance)
for _, instance := range instances {
skip := false
if instance.IsDowntimed {
skip = true
}
for _, filter := range config.Config.ProblemIgnoreHostnameFilters {
if matched, _ := regexp.MatchString(filter, instance.Key.Hostname); matched {
skip = true
}
}
if !skip {
reportedInstances = append(reportedInstances, instance)
}
}
return reportedInstances, nil
}
// SearchInstances reads all instances qualifying for some searchString
func SearchInstances(searchString string) ([](*Instance), error) {
searchString = strings.TrimSpace(searchString)
condition := `
locate(?, hostname) > 0
or locate(?, cluster_name) > 0
or locate(?, version) > 0
or locate(?, concat(hostname, ':', port)) > 0
or concat(server_id, '') = ?
or concat(port, '') = ?
`
args := sqlutils.Args(searchString, searchString, searchString, searchString, searchString, searchString)
return readInstancesByCondition(condition, args, `replication_depth asc, num_slave_hosts desc, cluster_name, hostname, port`)
}
// FindInstances reads all instances whose name matches given pattern
func FindInstances(regexpPattern string) ([](*Instance), error) {
condition := `hostname rlike ?`
return readInstancesByCondition(condition, sqlutils.Args(regexpPattern), `replication_depth asc, num_slave_hosts desc, cluster_name, hostname, port`)
}
// FindFuzzyInstances return instances whose names are like the one given (host & port substrings)
// For example, the given `mydb-3:3306` might find `myhosts-mydb301-production.mycompany.com:3306`
func FindFuzzyInstances(fuzzyInstanceKey *InstanceKey) ([](*Instance), error) {
condition := `
hostname like concat('%', ?, '%')
and port = ?
`
return readInstancesByCondition(condition, sqlutils.Args(fuzzyInstanceKey.Hostname, fuzzyInstanceKey.Port), `replication_depth asc, num_slave_hosts desc, cluster_name, hostname, port`)
}
// FindClusterNameByFuzzyInstanceKey attempts to find a uniquely identifyable cluster name
// given a fuzze key. It hopes to find instances matching given fuzzy key such that they all
// belong to same cluster
func FindClusterNameByFuzzyInstanceKey(fuzzyInstanceKey *InstanceKey) (string, error) {
clusterNames := make(map[string]bool)
instances, err := FindFuzzyInstances(fuzzyInstanceKey)
if err != nil {
return "", err
}
for _, instance := range instances {
clusterNames[instance.ClusterName] = true
}
if len(clusterNames) == 1 {
for clusterName := range clusterNames {
return clusterName, nil
}
}
return "", log.Errorf("findClusterNameByFuzzyInstanceKey: cannot uniquely identify cluster name by %+v", *fuzzyInstanceKey)
}
// ReadFuzzyInstanceKey accepts a fuzzy instance key and expects to return a single, fully qualified,
// known instance key.
func ReadFuzzyInstanceKey(fuzzyInstanceKey *InstanceKey) *InstanceKey {
if fuzzyInstanceKey == nil {
return nil
}
if fuzzyInstanceKey.Hostname != "" {
// Fuzzy instance search
if fuzzyInstances, _ := FindFuzzyInstances(fuzzyInstanceKey); len(fuzzyInstances) == 1 {
return &(fuzzyInstances[0].Key)
}
}
return nil
}
// ReadFuzzyInstanceKeyIfPossible accepts a fuzzy instance key and hopes to return a single, fully qualified,
// known instance key, or else the original given key
func ReadFuzzyInstanceKeyIfPossible(fuzzyInstanceKey *InstanceKey) *InstanceKey {
if instanceKey := ReadFuzzyInstanceKey(fuzzyInstanceKey); instanceKey != nil {
return instanceKey
}
return fuzzyInstanceKey
}
// ReadFuzzyInstance accepts a fuzzy instance key and expects to return a single instance.
// Multiple instances matching the fuzzy keys are not allowed.
func ReadFuzzyInstance(fuzzyInstanceKey *InstanceKey) (*Instance, error) {
if fuzzyInstanceKey == nil {
return nil, log.Errorf("ReadFuzzyInstance received nil input")
}
if fuzzyInstanceKey.Hostname != "" {
// Fuzzy instance search
if fuzzyInstances, _ := FindFuzzyInstances(fuzzyInstanceKey); len(fuzzyInstances) == 1 {
return fuzzyInstances[0], nil
}
}
return nil, log.Errorf("Cannot determine fuzzy instance %+v", *fuzzyInstanceKey)
}
// ReadLostInRecoveryInstances returns all instances (potentially filtered by cluster)
// which are currently indicated as downtimed due to being lost during a topology recovery.
// Keep in mind:
// - instances are only marked as such when config's MasterFailoverLostInstancesDowntimeMinutes > 0
// - The downtime expires at some point
func ReadLostInRecoveryInstances(clusterName string) ([](*Instance), error) {
condition := `
ifnull(
database_instance_downtime.downtime_active = 1
and database_instance_downtime.end_timestamp > now()
and database_instance_downtime.reason = ?, false)