Skip to content

Commit c07d08f

Browse files
author
Justin Fudally
authored
Merge pull request #864 from github/logging-interface-contrib
Logging interface contrib
2 parents 4dab06e + b02900a commit c07d08f

File tree

11 files changed

+320
-233
lines changed

11 files changed

+320
-233
lines changed

‎go/base/context.go

+21
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"
@@ -217,6 +218,25 @@ type MigrationContext struct {
217218
ForceTmpTableName string
218219

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

222242
type ContextConfig struct {
@@ -251,6 +271,7 @@ func NewMigrationContext() *MigrationContext {
251271
pointOfInterestTimeMutex: &sync.Mutex{},
252272
ColumnRenameMap: make(map[string]string),
253273
PanicAbort: make(chan error),
274+
Log: NewDefaultLogger(),
254275
}
255276
}
256277

‎go/base/default_logger.go

+73
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

+1-2
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

+7-6
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

+32-32
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 {
@@ -157,69 +157,69 @@ func main() {
157157
return
158158
}
159159

160-
log.SetLevel(log.ERROR)
160+
migrationContext.Log.SetLevel(log.ERROR)
161161
if *verbose {
162-
log.SetLevel(log.INFO)
162+
migrationContext.Log.SetLevel(log.INFO)
163163
}
164164
if *debug {
165-
log.SetLevel(log.DEBUG)
165+
migrationContext.Log.SetLevel(log.DEBUG)
166166
}
167167
if *stack {
168-
log.SetPrintStackTrace(*stack)
168+
migrationContext.Log.SetPrintStackTrace(*stack)
169169
}
170170
if *quiet {
171171
// Override!!
172-
log.SetLevel(log.ERROR)
172+
migrationContext.Log.SetLevel(log.ERROR)
173173
}
174174

175175
if migrationContext.DatabaseName == "" {
176-
log.Fatalf("--database must be provided and database name must not be empty")
176+
migrationContext.Log.Fatalf("--database must be provided and database name must not be empty")
177177
}
178178
if migrationContext.OriginalTableName == "" {
179-
log.Fatalf("--table must be provided and table name must not be empty")
179+
migrationContext.Log.Fatalf("--table must be provided and table name must not be empty")
180180
}
181181
if migrationContext.AlterStatement == "" {
182-
log.Fatalf("--alter must be provided and statement must not be empty")
182+
migrationContext.Log.Fatalf("--alter must be provided and statement must not be empty")
183183
}
184184
migrationContext.Noop = !(*executeFlag)
185185
if migrationContext.AllowedRunningOnMaster && migrationContext.TestOnReplica {
186-
log.Fatalf("--allow-on-master and --test-on-replica are mutually exclusive")
186+
migrationContext.Log.Fatalf("--allow-on-master and --test-on-replica are mutually exclusive")
187187
}
188188
if migrationContext.AllowedRunningOnMaster && migrationContext.MigrateOnReplica {
189-
log.Fatalf("--allow-on-master and --migrate-on-replica are mutually exclusive")
189+
migrationContext.Log.Fatalf("--allow-on-master and --migrate-on-replica are mutually exclusive")
190190
}
191191
if migrationContext.MigrateOnReplica && migrationContext.TestOnReplica {
192-
log.Fatalf("--migrate-on-replica and --test-on-replica are mutually exclusive")
192+
migrationContext.Log.Fatalf("--migrate-on-replica and --test-on-replica are mutually exclusive")
193193
}
194194
if migrationContext.SwitchToRowBinlogFormat && migrationContext.AssumeRBR {
195-
log.Fatalf("--switch-to-rbr and --assume-rbr are mutually exclusive")
195+
migrationContext.Log.Fatalf("--switch-to-rbr and --assume-rbr are mutually exclusive")
196196
}
197197
if migrationContext.TestOnReplicaSkipReplicaStop {
198198
if !migrationContext.TestOnReplica {
199-
log.Fatalf("--test-on-replica-skip-replica-stop requires --test-on-replica to be enabled")
199+
migrationContext.Log.Fatalf("--test-on-replica-skip-replica-stop requires --test-on-replica to be enabled")
200200
}
201-
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.")
201+
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.")
202202
}
203203
if migrationContext.CliMasterUser != "" && migrationContext.AssumeMasterHostname == "" {
204-
log.Fatalf("--master-user requires --assume-master-host")
204+
migrationContext.Log.Fatalf("--master-user requires --assume-master-host")
205205
}
206206
if migrationContext.CliMasterPassword != "" && migrationContext.AssumeMasterHostname == "" {
207-
log.Fatalf("--master-password requires --assume-master-host")
207+
migrationContext.Log.Fatalf("--master-password requires --assume-master-host")
208208
}
209209
if migrationContext.TLSCACertificate != "" && !migrationContext.UseTLS {
210-
log.Fatalf("--ssl-ca requires --ssl")
210+
migrationContext.Log.Fatalf("--ssl-ca requires --ssl")
211211
}
212212
if migrationContext.TLSCertificate != "" && !migrationContext.UseTLS {
213-
log.Fatalf("--ssl-cert requires --ssl")
213+
migrationContext.Log.Fatalf("--ssl-cert requires --ssl")
214214
}
215215
if migrationContext.TLSKey != "" && !migrationContext.UseTLS {
216-
log.Fatalf("--ssl-key requires --ssl")
216+
migrationContext.Log.Fatalf("--ssl-key requires --ssl")
217217
}
218218
if migrationContext.TLSAllowInsecure && !migrationContext.UseTLS {
219-
log.Fatalf("--ssl-allow-insecure requires --ssl")
219+
migrationContext.Log.Fatalf("--ssl-allow-insecure requires --ssl")
220220
}
221221
if *replicationLagQuery != "" {
222-
log.Warningf("--replication-lag-query is deprecated")
222+
migrationContext.Log.Warningf("--replication-lag-query is deprecated")
223223
}
224224

225225
switch *cutOver {
@@ -228,19 +228,19 @@ func main() {
228228
case "two-step":
229229
migrationContext.CutOverType = base.CutOverTwoStep
230230
default:
231-
log.Fatalf("Unknown cut-over: %s", *cutOver)
231+
migrationContext.Log.Fatalf("Unknown cut-over: %s", *cutOver)
232232
}
233233
if err := migrationContext.ReadConfigFile(); err != nil {
234-
log.Fatale(err)
234+
migrationContext.Log.Fatale(err)
235235
}
236236
if err := migrationContext.ReadThrottleControlReplicaKeys(*throttleControlReplicas); err != nil {
237-
log.Fatale(err)
237+
migrationContext.Log.Fatale(err)
238238
}
239239
if err := migrationContext.ReadMaxLoad(*maxLoad); err != nil {
240-
log.Fatale(err)
240+
migrationContext.Log.Fatale(err)
241241
}
242242
if err := migrationContext.ReadCriticalLoad(*criticalLoad); err != nil {
243-
log.Fatale(err)
243+
migrationContext.Log.Fatale(err)
244244
}
245245
if migrationContext.ServeSocketFile == "" {
246246
migrationContext.ServeSocketFile = fmt.Sprintf("/tmp/gh-ost.%s.%s.sock", migrationContext.DatabaseName, migrationContext.OriginalTableName)
@@ -249,7 +249,7 @@ func main() {
249249
fmt.Println("Password:")
250250
bytePassword, err := terminal.ReadPassword(int(syscall.Stdin))
251251
if err != nil {
252-
log.Fatale(err)
252+
migrationContext.Log.Fatale(err)
253253
}
254254
migrationContext.CliPassword = string(bytePassword)
255255
}
@@ -264,13 +264,13 @@ func main() {
264264
migrationContext.SetDefaultNumRetries(*defaultRetries)
265265
migrationContext.ApplyCredentials()
266266
if err := migrationContext.SetupTLS(); err != nil {
267-
log.Fatale(err)
267+
migrationContext.Log.Fatale(err)
268268
}
269269
if err := migrationContext.SetCutOverLockTimeoutSeconds(*cutOverLockTimeoutSeconds); err != nil {
270-
log.Errore(err)
270+
migrationContext.Log.Errore(err)
271271
}
272272
if err := migrationContext.SetExponentialBackoffMaxInterval(*exponentialBackoffMaxInterval); err != nil {
273-
log.Errore(err)
273+
migrationContext.Log.Errore(err)
274274
}
275275

276276
log.Infof("starting gh-ost %+v", AppVersion)
@@ -280,7 +280,7 @@ func main() {
280280
err := migrator.Migrate()
281281
if err != nil {
282282
migrator.ExecOnFailureHook()
283-
log.Fatale(err)
283+
migrationContext.Log.Fatale(err)
284284
}
285285
fmt.Fprintf(os.Stdout, "# Done\n")
286286
}

0 commit comments

Comments
 (0)