Skip to content

Commit 17f0a0a

Browse files
committed
chore: standardize logger messages
1 parent 3060bbd commit 17f0a0a

17 files changed

Lines changed: 52 additions & 52 deletions

File tree

common/alarm.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -52,13 +52,13 @@ func SendAlarm(code, info, more string) {
5252
code = cfg.AlarmCode
5353
}
5454
if cfg.PostAlarmAPI == "" || code == "" {
55-
LogSampled.Warn().Str("info", info).Str("more", more).Msg("SendAlarm")
55+
LogSampled.Warn().Str("info", info).Str("more", more).Msg("Sending alarm")
5656
return
5757
}
5858
data := GenAlarmJson(code, info, more)
5959
_ = ants.Submit(func() {
6060
if _, err := req.SetBodyJsonBytes(data).Post(cfg.PostAlarmAPI); err != nil {
61-
LogSampled.Warn().Err(err).Str("url", cfg.PostAlarmAPI).Msg("SendAlarm")
61+
LogSampled.Warn().Err(err).Str("url", cfg.PostAlarmAPI).Msg("Sending alarm")
6262
}
6363
})
6464
}
@@ -94,7 +94,7 @@ func sendAlarm(fn AlarmJsonGenerator, bs []byte) {
9494
}
9595
data := fn(cfg.AlarmCode, bs)
9696
if _, err := req.SetBodyJsonBytes(data).Post(cfg.PostAlarmAPI); err != nil {
97-
LogSampled.Warn().Err(err).Str("url", cfg.PostAlarmAPI).Msg("sendAlarm")
97+
LogSampled.Warn().Err(err).Str("url", cfg.PostAlarmAPI).Msg("Sending alarm")
9898
}
9999
}
100100

common/log.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ func loadLogger() error {
8484
alarmOn := config.AlarmOn.Load()
8585
if logAlarmOnConf != alarmOn {
8686
logAlarmOnConf = alarmOn
87-
Log.Warn().Bool("alarm_on", logAlarmOnConf).Msg("Alarm switch")
87+
Log.Warn().Bool("alarm_on", logAlarmOnConf).Msg("Alarm switch changed")
8888
}
8989
cfg := config.Config().LogConf
9090
if logCurrentConf == cfg {
@@ -113,7 +113,7 @@ func loadLogger() error {
113113
Str("app_name", config.AppName).Str("bin_name", config.BinName).Str("deb_name", config.DebName).
114114
Int("cpus", runtime.NumCPU()).Int("procs", runtime.GOMAXPROCS(0)).
115115
Bool("alarm_on", logAlarmOnConf).Str("alarm_code", cfg.AlarmCode).Bool("app_sampler", AppLoggerUseSampler).
116-
Msg("Logger initialized successfully")
116+
Msg("Logger initialized")
117117
return nil
118118
}
119119

common/log_sender.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ func logSender() {
5959
if bb.Len() > 0 {
6060
postLog(bb)
6161
}
62-
Log.Warn().Msg("logSender exited")
62+
Log.Warn().Msg("Log sender exited")
6363
return
6464
}
6565

@@ -92,7 +92,7 @@ func postLog(bb *buffer.Buffer) {
9292
_ = ants.Submit(func() {
9393
defer bb.Put()
9494
if _, err := req.SetBodyJsonBytes(bb.B).Post(postAPI); err != nil {
95-
LogSampled.Warn().Err(err).Str("api", postAPI).Msg("postLog")
95+
LogSampled.Warn().Err(err).Str("api", postAPI).Msg("Posting log")
9696
}
9797
})
9898
}
@@ -106,7 +106,7 @@ func PostLog(bs []byte) {
106106
// 推送日志数据到接口 POST JSON
107107
_ = ants.Submit(func() {
108108
if _, err := req.SetBodyJsonBytes(bs).Post(postAPI); err != nil {
109-
LogSampled.Warn().Err(err).Str("api", postAPI).Msg("postLog")
109+
LogSampled.Warn().Err(err).Str("api", postAPI).Msg("Posting log")
110110
}
111111
})
112112
}

common/now.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,6 @@ func SetClockOffset(dur time.Duration) {
5454
offset := int64(dur)
5555
if math.Abs(float64(offset-clockOffset.Load())) >= ClockOffsetLimit {
5656
clockOffset.Store(offset + ClockOffsetAdjust)
57-
Log.Warn().Str("clock_offset", GetClockOffset().String()).Msg("ntpdate")
57+
Log.Warn().Str("clock_offset", GetClockOffset().String()).Msg("NTP sync completed")
5858
}
5959
}

common/recovery.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,13 @@ var (
1313
func RecoverAlarm(err interface{}, trace []byte) {
1414
info := utils.MustString(err)
1515
more := utils.MustString(trace)
16-
Log.Error().Str("error", info).Str("trace", more).Msg("Recovery and alarm")
16+
Log.Error().Str("error", info).Str("trace", more).Msg("Recovered and triggered alarm")
1717
SendAlarm("", info, more)
1818
}
1919

2020
// RecoverLogger 记录崩溃日志
2121
func RecoverLogger(err interface{}, trace []byte) {
2222
info := utils.MustString(err)
2323
more := utils.MustString(trace)
24-
Log.Error().Str("error", info).Str("trace", more).Msg("Recovery")
24+
Log.Error().Str("error", info).Str("trace", more).Msg("Recovered from panic")
2525
}

common/req.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,13 +29,13 @@ func loadReq() {
2929
req.SetTimeout(cfg.ReqTimeoutDuration).
3030
SetCommonRetryCount(cfg.ReqMaxRetries).
3131
SetCommonRetryHook(func(resp *req.Response, err error) {
32-
LogSampled.Warn().Err(err).Str("resp", resp.String()).Msg("Retry request")
32+
LogSampled.Warn().Err(err).Str("resp", resp.String()).Msg("Retrying request")
3333
})
3434
if reqDebug == cfg.ReqDebug {
3535
return
3636
}
3737
reqDebug = cfg.ReqDebug
38-
Log.Warn().Bool("req_debug", reqDebug).Msg("Req debug switch")
38+
Log.Warn().Bool("req_debug", reqDebug).Msg("Request debug switch changed")
3939
req.SetLogger(NewAppLogger())
4040
ReqUpload.SetLogger(NewAppLogger())
4141
ReqDownload.SetLogger(NewAppLogger())

config/version.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ import (
55
)
66

77
var (
8-
Version = "v0.0.1"
8+
Version = "0.0.1"
99
GoVersion = ""
1010
GitCommit = ""
1111

crontab/init.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,5 +61,5 @@ func initMain() {
6161
}
6262
crontab = cron.New(opts...)
6363
crontab.Start()
64-
logger.Info().Msg("crontab is working")
64+
logger.Info().Msg("crontab started")
6565
}

crontab/job.go

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -58,14 +58,14 @@ func (j *Job) start(ctx context.Context, r Runner, opts ...cron.EntryOption) (*J
5858

5959
start := time.Now()
6060
rid := xid.NewString()
61-
logger.Info().Str("job", j.name).Str("rid", rid).Msg("Job start")
61+
logger.Info().Str("job", j.name).Str("rid", rid).Msg("starting job")
6262

6363
err := r.Run(j.ctx)
6464
if err != nil {
65-
alarm.Error().Err(err).Str("job", j.name).Str("rid", rid).Dur("took", time.Since(start)).Msg("Job run")
65+
alarm.Error().Err(err).Str("job", j.name).Str("rid", rid).Dur("took", time.Since(start)).Msg("Job execution failed")
6666
}
6767

68-
logger.Info().Str("job", j.name).Str("rid", rid).Dur("took", time.Since(start)).Msg("Job done")
68+
logger.Info().Str("job", j.name).Str("rid", rid).Dur("took", time.Since(start)).Msg("job completed")
6969
}
7070

7171
id, err := crontab.AddFunc(j.spec, cmd, opts...)
@@ -121,7 +121,7 @@ func (j *Job) Stop() {
121121
func AddJob(ctx context.Context, name, spec string, runner Runner, opts ...cron.EntryOption) (*Job, error) {
122122
if job, ok := GetJob(name); ok {
123123
if job.IsRunning() && job.spec == spec {
124-
logger.Info().Str(name, spec).Msg("ignore adding job")
124+
logger.Info().Str(name, spec).Msg("skipping job add")
125125
return job, nil
126126
}
127127
job.Stop()
@@ -140,7 +140,7 @@ func GetJob(name string) (*Job, bool) {
140140

141141
// StopJob 通过名称停止任务
142142
func StopJob(name string) bool {
143-
logger.Info().Str("job", name).Msg("about to stop")
143+
logger.Info().Str("job", name).Msg("stopping job")
144144
if j, ok := GetJob(name); ok {
145145
j.Stop()
146146
return true

master/depoly.go

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ var (
3636

3737
func installDeb(ver string) {
3838
if !debInstalling.CompareAndSwap(false, true) {
39-
logger.Warn().Str("ver", ver).Msg("skip installing deb")
39+
logger.Warn().Str("ver", ver).Msg("Deb installation skipped")
4040
return
4141
}
4242
defer debInstalling.Store(false)
@@ -53,26 +53,26 @@ func installDeb(ver string) {
5353
logger.Warn().Str("deb", deb).Float64("took_s", status.Runtime).
5454
Strs("stdout", status.Stdout).Strs("stderr", status.Stderr).
5555
Strs("cmd", updateCmd).
56-
Msg("install deb")
56+
Msg("Install deb")
5757

5858
status = cmder.RunCmd(cmdDpkgConfigure)
5959
logger.Warn().Str("deb", deb).Float64("took_s", status.Runtime).
6060
Strs("stdout", status.Stdout).Strs("stderr", status.Stderr).
6161
Strs("cmd", cmdDpkgConfigure).
62-
Msg("install deb")
62+
Msg("Install deb")
6363

6464
status = cmder.RunCmd(installCmd, aptTimeout)
6565
if status.Exit != 0 {
6666
logger.Error().Err(status.Error).Int("exit_code", status.Exit).Float64("took_s", status.Runtime).
6767
Str("deb", deb).Strs("stdout", status.Stdout).Strs("stderr", status.Stderr).
6868
Strs("cmd", installCmd).
69-
Msg("install deb")
69+
Msg("Deb package installation failed")
7070
} else {
7171
config.DebVersion = ver
7272
logger.Warn().Str("deb", deb).Float64("took_s", status.Runtime).
7373
Strs("stdout", status.Stdout).Strs("stderr", status.Stderr).
7474
Strs("cmd", installCmd).
75-
Msg("install deb")
75+
Msg("Deb package installed")
7676
}
7777
}
7878

@@ -101,7 +101,7 @@ func DebVersion(debName string) string {
101101
if n == 0 || status.Exit != 0 {
102102
logger.Error().Err(status.Error).Int("exit_code", status.Exit).Float64("took_s", status.Runtime).
103103
Strs("stdout", status.Stdout).Strs("stderr", status.Stderr).
104-
Msg("dpkg -l")
104+
Msg("Dpkg command failed")
105105
return ""
106106
}
107107

0 commit comments

Comments
 (0)