Skip to content

Commit 6b6f9ec

Browse files
author
Justin Fudally
authored
Merge pull request #789 from abeyum/master
implement a logging interface
2 parents 7c9c2b3 + a36d6be commit 6b6f9ec

File tree

11 files changed

+320
-233
lines changed

11 files changed

+320
-233
lines changed

‎go/base/context.go

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ import (
1919

2020
"github.com/github/gh-ost/go/mysql"
2121
"github.com/github/gh-ost/go/sql"
22+
"github.com/outbrain/golib/log"
2223

2324
"gopkg.in/gcfg.v1"
2425
gcfgscanner "gopkg.in/gcfg.v1/scanner"
@@ -216,6 +217,25 @@ type MigrationContext struct {
216217
ForceTmpTableName string
217218

218219
recentBinlogCoordinates mysql.BinlogCoordinates
220+
221+
Log Logger
222+
}
223+
224+
type Logger interface {
225+
Debug(args ...interface{})
226+
Debugf(format string, args ...interface{})
227+
Info(args ...interface{})
228+
Infof(format string, args ...interface{})
229+
Warning(args ...interface{}) error
230+
Warningf(format string, args ...interface{}) error
231+
Error(args ...interface{}) error
232+
Errorf(format string, args ...interface{}) error
233+
Errore(err error) error
234+
Fatal(args ...interface{}) error
235+
Fatalf(format string, args ...interface{}) error
236+
Fatale(err error) error
237+
SetLevel(level log.LogLevel)
238+
SetPrintStackTrace(printStackTraceFlag bool)
219239
}
220240

221241
type ContextConfig struct {
@@ -250,6 +270,7 @@ func NewMigrationContext() *MigrationContext {
250270
pointOfInterestTimeMutex: &sync.Mutex{},
251271
ColumnRenameMap: make(map[string]string),
252272
PanicAbort: make(chan error),
273+
Log: NewDefaultLogger(),
253274
}
254275
}
255276

‎go/base/default_logger.go

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
package base
2+
3+
import (
4+
"github.com/outbrain/golib/log"
5+
)
6+
7+
type simpleLogger struct{}
8+
9+
func NewDefaultLogger() *simpleLogger {
10+
return &simpleLogger{}
11+
}
12+
13+
func (*simpleLogger) Debug(args ...interface{}) {
14+
log.Debug(args[0].(string), args[1:])
15+
return
16+
}
17+
18+
func (*simpleLogger) Debugf(format string, args ...interface{}) {
19+
log.Debugf(format, args...)
20+
return
21+
}
22+
23+
func (*simpleLogger) Info(args ...interface{}) {
24+
log.Info(args[0].(string), args[1:])
25+
return
26+
}
27+
28+
func (*simpleLogger) Infof(format string, args ...interface{}) {
29+
log.Infof(format, args...)
30+
return
31+
}
32+
33+
func (*simpleLogger) Warning(args ...interface{}) error {
34+
return log.Warning(args[0].(string), args[1:])
35+
}
36+
37+
func (*simpleLogger) Warningf(format string, args ...interface{}) error {
38+
return log.Warningf(format, args...)
39+
}
40+
41+
func (*simpleLogger) Error(args ...interface{}) error {
42+
return log.Error(args[0].(string), args[1:])
43+
}
44+
45+
func (*simpleLogger) Errorf(format string, args ...interface{}) error {
46+
return log.Errorf(format, args...)
47+
}
48+
49+
func (*simpleLogger) Errore(err error) error {
50+
return log.Errore(err)
51+
}
52+
53+
func (*simpleLogger) Fatal(args ...interface{}) error {
54+
return log.Fatal(args[0].(string), args[1:])
55+
}
56+
57+
func (*simpleLogger) Fatalf(format string, args ...interface{}) error {
58+
return log.Fatalf(format, args...)
59+
}
60+
61+
func (*simpleLogger) Fatale(err error) error {
62+
return log.Fatale(err)
63+
}
64+
65+
func (*simpleLogger) SetLevel(level log.LogLevel) {
66+
log.SetLevel(level)
67+
return
68+
}
69+
70+
func (*simpleLogger) SetPrintStackTrace(printStackTraceFlag bool) {
71+
log.SetPrintStackTrace(printStackTraceFlag)
72+
return
73+
}

‎go/base/utils.go

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,6 @@ import (
1414

1515
gosql "database/sql"
1616
"github.com/github/gh-ost/go/mysql"
17-
"github.com/outbrain/golib/log"
1817
)
1918

2019
var (
@@ -86,7 +85,7 @@ func ValidateConnection(db *gosql.DB, connectionConfig *mysql.ConnectionConfig,
8685
}
8786

8887
if connectionConfig.Key.Port == port || (extraPort > 0 && connectionConfig.Key.Port == extraPort) {
89-
log.Infof("connection validated on %+v", connectionConfig.Key)
88+
migrationContext.Log.Infof("connection validated on %+v", connectionConfig.Key)
9089
return version, nil
9190
} else if extraPort == 0 {
9291
return "", fmt.Errorf("Unexpected database port reported: %+v", port)

‎go/binlog/gomysql_reader.go

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,13 @@ import (
1313
"github.com/github/gh-ost/go/mysql"
1414
"github.com/github/gh-ost/go/sql"
1515

16-
"github.com/outbrain/golib/log"
1716
gomysql "github.com/siddontang/go-mysql/mysql"
1817
"github.com/siddontang/go-mysql/replication"
1918
"golang.org/x/net/context"
2019
)
2120

2221
type GoMySQLReader struct {
22+
migrationContext *base.MigrationContext
2323
connectionConfig *mysql.ConnectionConfig
2424
binlogSyncer *replication.BinlogSyncer
2525
binlogStreamer *replication.BinlogStreamer
@@ -30,6 +30,7 @@ type GoMySQLReader struct {
3030

3131
func NewGoMySQLReader(migrationContext *base.MigrationContext) (binlogReader *GoMySQLReader, err error) {
3232
binlogReader = &GoMySQLReader{
33+
migrationContext: migrationContext,
3334
connectionConfig: migrationContext.InspectorConnectionConfig,
3435
currentCoordinates: mysql.BinlogCoordinates{},
3536
currentCoordinatesMutex: &sync.Mutex{},
@@ -57,11 +58,11 @@ func NewGoMySQLReader(migrationContext *base.MigrationContext) (binlogReader *Go
5758
// ConnectBinlogStreamer
5859
func (this *GoMySQLReader) ConnectBinlogStreamer(coordinates mysql.BinlogCoordinates) (err error) {
5960
if coordinates.IsEmpty() {
60-
return log.Errorf("Empty coordinates at ConnectBinlogStreamer()")
61+
return this.migrationContext.Log.Errorf("Empty coordinates at ConnectBinlogStreamer()")
6162
}
6263

6364
this.currentCoordinates = coordinates
64-
log.Infof("Connecting binlog streamer at %+v", this.currentCoordinates)
65+
this.migrationContext.Log.Infof("Connecting binlog streamer at %+v", this.currentCoordinates)
6566
// Start sync with specified binlog file and position
6667
this.binlogStreamer, err = this.binlogSyncer.StartSync(gomysql.Position{this.currentCoordinates.LogFile, uint32(this.currentCoordinates.LogPos)})
6768

@@ -78,7 +79,7 @@ func (this *GoMySQLReader) GetCurrentBinlogCoordinates() *mysql.BinlogCoordinate
7879
// StreamEvents
7980
func (this *GoMySQLReader) handleRowsEvent(ev *replication.BinlogEvent, rowsEvent *replication.RowsEvent, entriesChannel chan<- *BinlogEntry) error {
8081
if this.currentCoordinates.SmallerThanOrEquals(&this.LastAppliedRowsEventHint) {
81-
log.Debugf("Skipping handled query at %+v", this.currentCoordinates)
82+
this.migrationContext.Log.Debugf("Skipping handled query at %+v", this.currentCoordinates)
8283
return nil
8384
}
8485

@@ -147,14 +148,14 @@ func (this *GoMySQLReader) StreamEvents(canStopStreaming func() bool, entriesCha
147148
defer this.currentCoordinatesMutex.Unlock()
148149
this.currentCoordinates.LogFile = string(rotateEvent.NextLogName)
149150
}()
150-
log.Infof("rotate to next log from %s:%d to %s", this.currentCoordinates.LogFile, int64(ev.Header.LogPos), rotateEvent.NextLogName)
151+
this.migrationContext.Log.Infof("rotate to next log from %s:%d to %s", this.currentCoordinates.LogFile, int64(ev.Header.LogPos), rotateEvent.NextLogName)
151152
} else if rowsEvent, ok := ev.Event.(*replication.RowsEvent); ok {
152153
if err := this.handleRowsEvent(ev, rowsEvent, entriesChannel); err != nil {
153154
return err
154155
}
155156
}
156157
}
157-
log.Debugf("done streaming events")
158+
this.migrationContext.Log.Debugf("done streaming events")
158159

159160
return nil
160161
}

‎go/cmd/gh-ost/main.go

Lines changed: 32 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ func acceptSignals(migrationContext *base.MigrationContext) {
3131
for sig := range c {
3232
switch sig {
3333
case syscall.SIGHUP:
34-
log.Infof("Received SIGHUP. Reloading configuration")
34+
migrationContext.Log.Infof("Received SIGHUP. Reloading configuration")
3535
if err := migrationContext.ReadConfigFile(); err != nil {
3636
log.Errore(err)
3737
} else {
@@ -156,69 +156,69 @@ func main() {
156156
return
157157
}
158158

159-
log.SetLevel(log.ERROR)
159+
migrationContext.Log.SetLevel(log.ERROR)
160160
if *verbose {
161-
log.SetLevel(log.INFO)
161+
migrationContext.Log.SetLevel(log.INFO)
162162
}
163163
if *debug {
164-
log.SetLevel(log.DEBUG)
164+
migrationContext.Log.SetLevel(log.DEBUG)
165165
}
166166
if *stack {
167-
log.SetPrintStackTrace(*stack)
167+
migrationContext.Log.SetPrintStackTrace(*stack)
168168
}
169169
if *quiet {
170170
// Override!!
171-
log.SetLevel(log.ERROR)
171+
migrationContext.Log.SetLevel(log.ERROR)
172172
}
173173

174174
if migrationContext.DatabaseName == "" {
175-
log.Fatalf("--database must be provided and database name must not be empty")
175+
migrationContext.Log.Fatalf("--database must be provided and database name must not be empty")
176176
}
177177
if migrationContext.OriginalTableName == "" {
178-
log.Fatalf("--table must be provided and table name must not be empty")
178+
migrationContext.Log.Fatalf("--table must be provided and table name must not be empty")
179179
}
180180
if migrationContext.AlterStatement == "" {
181-
log.Fatalf("--alter must be provided and statement must not be empty")
181+
migrationContext.Log.Fatalf("--alter must be provided and statement must not be empty")
182182
}
183183
migrationContext.Noop = !(*executeFlag)
184184
if migrationContext.AllowedRunningOnMaster && migrationContext.TestOnReplica {
185-
log.Fatalf("--allow-on-master and --test-on-replica are mutually exclusive")
185+
migrationContext.Log.Fatalf("--allow-on-master and --test-on-replica are mutually exclusive")
186186
}
187187
if migrationContext.AllowedRunningOnMaster && migrationContext.MigrateOnReplica {
188-
log.Fatalf("--allow-on-master and --migrate-on-replica are mutually exclusive")
188+
migrationContext.Log.Fatalf("--allow-on-master and --migrate-on-replica are mutually exclusive")
189189
}
190190
if migrationContext.MigrateOnReplica && migrationContext.TestOnReplica {
191-
log.Fatalf("--migrate-on-replica and --test-on-replica are mutually exclusive")
191+
migrationContext.Log.Fatalf("--migrate-on-replica and --test-on-replica are mutually exclusive")
192192
}
193193
if migrationContext.SwitchToRowBinlogFormat && migrationContext.AssumeRBR {
194-
log.Fatalf("--switch-to-rbr and --assume-rbr are mutually exclusive")
194+
migrationContext.Log.Fatalf("--switch-to-rbr and --assume-rbr are mutually exclusive")
195195
}
196196
if migrationContext.TestOnReplicaSkipReplicaStop {
197197
if !migrationContext.TestOnReplica {
198-
log.Fatalf("--test-on-replica-skip-replica-stop requires --test-on-replica to be enabled")
198+
migrationContext.Log.Fatalf("--test-on-replica-skip-replica-stop requires --test-on-replica to be enabled")
199199
}
200-
log.Warning("--test-on-replica-skip-replica-stop enabled. We will not stop replication before cut-over. Ensure you have a plugin that does this.")
200+
migrationContext.Log.Warning("--test-on-replica-skip-replica-stop enabled. We will not stop replication before cut-over. Ensure you have a plugin that does this.")
201201
}
202202
if migrationContext.CliMasterUser != "" && migrationContext.AssumeMasterHostname == "" {
203-
log.Fatalf("--master-user requires --assume-master-host")
203+
migrationContext.Log.Fatalf("--master-user requires --assume-master-host")
204204
}
205205
if migrationContext.CliMasterPassword != "" && migrationContext.AssumeMasterHostname == "" {
206-
log.Fatalf("--master-password requires --assume-master-host")
206+
migrationContext.Log.Fatalf("--master-password requires --assume-master-host")
207207
}
208208
if migrationContext.TLSCACertificate != "" && !migrationContext.UseTLS {
209-
log.Fatalf("--ssl-ca requires --ssl")
209+
migrationContext.Log.Fatalf("--ssl-ca requires --ssl")
210210
}
211211
if migrationContext.TLSCertificate != "" && !migrationContext.UseTLS {
212-
log.Fatalf("--ssl-cert requires --ssl")
212+
migrationContext.Log.Fatalf("--ssl-cert requires --ssl")
213213
}
214214
if migrationContext.TLSKey != "" && !migrationContext.UseTLS {
215-
log.Fatalf("--ssl-key requires --ssl")
215+
migrationContext.Log.Fatalf("--ssl-key requires --ssl")
216216
}
217217
if migrationContext.TLSAllowInsecure && !migrationContext.UseTLS {
218-
log.Fatalf("--ssl-allow-insecure requires --ssl")
218+
migrationContext.Log.Fatalf("--ssl-allow-insecure requires --ssl")
219219
}
220220
if *replicationLagQuery != "" {
221-
log.Warningf("--replication-lag-query is deprecated")
221+
migrationContext.Log.Warningf("--replication-lag-query is deprecated")
222222
}
223223

224224
switch *cutOver {
@@ -227,19 +227,19 @@ func main() {
227227
case "two-step":
228228
migrationContext.CutOverType = base.CutOverTwoStep
229229
default:
230-
log.Fatalf("Unknown cut-over: %s", *cutOver)
230+
migrationContext.Log.Fatalf("Unknown cut-over: %s", *cutOver)
231231
}
232232
if err := migrationContext.ReadConfigFile(); err != nil {
233-
log.Fatale(err)
233+
migrationContext.Log.Fatale(err)
234234
}
235235
if err := migrationContext.ReadThrottleControlReplicaKeys(*throttleControlReplicas); err != nil {
236-
log.Fatale(err)
236+
migrationContext.Log.Fatale(err)
237237
}
238238
if err := migrationContext.ReadMaxLoad(*maxLoad); err != nil {
239-
log.Fatale(err)
239+
migrationContext.Log.Fatale(err)
240240
}
241241
if err := migrationContext.ReadCriticalLoad(*criticalLoad); err != nil {
242-
log.Fatale(err)
242+
migrationContext.Log.Fatale(err)
243243
}
244244
if migrationContext.ServeSocketFile == "" {
245245
migrationContext.ServeSocketFile = fmt.Sprintf("/tmp/gh-ost.%s.%s.sock", migrationContext.DatabaseName, migrationContext.OriginalTableName)
@@ -248,7 +248,7 @@ func main() {
248248
fmt.Println("Password:")
249249
bytePassword, err := terminal.ReadPassword(int(syscall.Stdin))
250250
if err != nil {
251-
log.Fatale(err)
251+
migrationContext.Log.Fatale(err)
252252
}
253253
migrationContext.CliPassword = string(bytePassword)
254254
}
@@ -262,13 +262,13 @@ func main() {
262262
migrationContext.SetDefaultNumRetries(*defaultRetries)
263263
migrationContext.ApplyCredentials()
264264
if err := migrationContext.SetupTLS(); err != nil {
265-
log.Fatale(err)
265+
migrationContext.Log.Fatale(err)
266266
}
267267
if err := migrationContext.SetCutOverLockTimeoutSeconds(*cutOverLockTimeoutSeconds); err != nil {
268-
log.Errore(err)
268+
migrationContext.Log.Errore(err)
269269
}
270270
if err := migrationContext.SetExponentialBackoffMaxInterval(*exponentialBackoffMaxInterval); err != nil {
271-
log.Errore(err)
271+
migrationContext.Log.Errore(err)
272272
}
273273

274274
log.Infof("starting gh-ost %+v", AppVersion)
@@ -278,7 +278,7 @@ func main() {
278278
err := migrator.Migrate()
279279
if err != nil {
280280
migrator.ExecOnFailureHook()
281-
log.Fatale(err)
281+
migrationContext.Log.Fatale(err)
282282
}
283283
fmt.Fprintf(os.Stdout, "# Done\n")
284284
}

0 commit comments

Comments
 (0)