Skip to content

Commit ae09d0e

Browse files
kevwankevwan
authored
chore: use logc instead of logx if possible (#4610)
1 parent 0bc4206 commit ae09d0e

File tree

12 files changed

+43
-39
lines changed

12 files changed

+43
-39
lines changed

Diff for: ‎core/discov/internal/registry.go

+7-7
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ import (
1111
"time"
1212

1313
"github.com/zeromicro/go-zero/core/lang"
14-
"github.com/zeromicro/go-zero/core/logx"
14+
"github.com/zeromicro/go-zero/core/logc"
1515
"github.com/zeromicro/go-zero/core/mathx"
1616
"github.com/zeromicro/go-zero/core/syncx"
1717
"github.com/zeromicro/go-zero/core/threading"
@@ -249,7 +249,7 @@ func (c *cluster) handleChanges(key watchKey, kvs []KV) {
249249
}
250250
}
251251

252-
func (c *cluster) handleWatchEvents(key watchKey, events []*clientv3.Event) {
252+
func (c *cluster) handleWatchEvents(ctx context.Context, key watchKey, events []*clientv3.Event) {
253253
c.lock.RLock()
254254
watcher, ok := c.watchers[key]
255255
if !ok {
@@ -283,7 +283,7 @@ func (c *cluster) handleWatchEvents(key watchKey, events []*clientv3.Event) {
283283
})
284284
}
285285
default:
286-
logx.Errorf("Unknown event type: %v", ev.Type)
286+
logc.Errorf(ctx, "Unknown event type: %v", ev.Type)
287287
}
288288
}
289289
}
@@ -304,7 +304,7 @@ func (c *cluster) load(cli EtcdClient, key watchKey) int64 {
304304
break
305305
}
306306

307-
logx.Errorf("%s, key: %s, exactMatch: %t", err.Error(), key.key, key.exactMatch)
307+
logc.Errorf(cli.Ctx(), "%s, key: %s, exactMatch: %t", err.Error(), key.key, key.exactMatch)
308308
time.Sleep(coolDownUnstable.AroundDuration(coolDownInterval))
309309
}
310310

@@ -382,12 +382,12 @@ func (c *cluster) watch(cli EtcdClient, key watchKey, rev int64) {
382382
}
383383

384384
if rev != 0 && errors.Is(err, rpctypes.ErrCompacted) {
385-
logx.Errorf("etcd watch stream has been compacted, try to reload, rev %d", rev)
385+
logc.Errorf(cli.Ctx(), "etcd watch stream has been compacted, try to reload, rev %d", rev)
386386
rev = c.load(cli, key)
387387
}
388388

389389
// log the error and retry
390-
logx.Error(err)
390+
logc.Error(cli.Ctx(), err)
391391
}
392392
}
393393

@@ -407,7 +407,7 @@ func (c *cluster) watchStream(cli EtcdClient, key watchKey, rev int64) error {
407407
return fmt.Errorf("etcd monitor chan error: %w", wresp.Err())
408408
}
409409

410-
c.handleWatchEvents(key, wresp.Events)
410+
c.handleWatchEvents(ctx, key, wresp.Events)
411411
case <-ctx.Done():
412412
return nil
413413
case <-c.done:

Diff for: ‎core/discov/internal/registry_test.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -300,7 +300,7 @@ func TestCluster_handleWatchEvents(t *testing.T) {
300300
},
301301
}
302302
assert.NotPanics(t, func() {
303-
c.handleWatchEvents(watchKey{
303+
c.handleWatchEvents(context.Background(), watchKey{
304304
key: "another",
305305
}, nil)
306306
})

Diff for: ‎core/discov/publisher.go

+7-6
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ import (
55

66
"github.com/zeromicro/go-zero/core/discov/internal"
77
"github.com/zeromicro/go-zero/core/lang"
8+
"github.com/zeromicro/go-zero/core/logc"
89
"github.com/zeromicro/go-zero/core/logx"
910
"github.com/zeromicro/go-zero/core/proc"
1011
"github.com/zeromicro/go-zero/core/syncx"
@@ -91,12 +92,12 @@ func (p *Publisher) doKeepAlive() error {
9192
default:
9293
cli, err := p.doRegister()
9394
if err != nil {
94-
logx.Errorf("etcd publisher doRegister: %s", err.Error())
95+
logc.Errorf(cli.Ctx(), "etcd publisher doRegister: %s", err.Error())
9596
break
9697
}
9798

9899
if err := p.keepAliveAsync(cli); err != nil {
99-
logx.Errorf("etcd publisher keepAliveAsync: %s", err.Error())
100+
logc.Errorf(cli.Ctx(), "etcd publisher keepAliveAsync: %s", err.Error())
100101
break
101102
}
102103

@@ -130,17 +131,17 @@ func (p *Publisher) keepAliveAsync(cli internal.EtcdClient) error {
130131
if !ok {
131132
p.revoke(cli)
132133
if err := p.doKeepAlive(); err != nil {
133-
logx.Errorf("etcd publisher KeepAlive: %s", err.Error())
134+
logc.Errorf(cli.Ctx(), "etcd publisher KeepAlive: %s", err.Error())
134135
}
135136
return
136137
}
137138
case <-p.pauseChan:
138-
logx.Infof("paused etcd renew, key: %s, value: %s", p.key, p.value)
139+
logc.Infof(cli.Ctx(), "paused etcd renew, key: %s, value: %s", p.key, p.value)
139140
p.revoke(cli)
140141
select {
141142
case <-p.resumeChan:
142143
if err := p.doKeepAlive(); err != nil {
143-
logx.Errorf("etcd publisher KeepAlive: %s", err.Error())
144+
logc.Errorf(cli.Ctx(), "etcd publisher KeepAlive: %s", err.Error())
144145
}
145146
return
146147
case <-p.quit.Done():
@@ -175,7 +176,7 @@ func (p *Publisher) register(client internal.EtcdClient) (clientv3.LeaseID, erro
175176

176177
func (p *Publisher) revoke(cli internal.EtcdClient) {
177178
if _, err := cli.Revoke(cli.Ctx(), p.lease); err != nil {
178-
logx.Errorf("etcd publisher revoke: %s", err.Error())
179+
logc.Errorf(cli.Ctx(), "etcd publisher revoke: %s", err.Error())
179180
}
180181
}
181182

Diff for: ‎rest/handler/authhandler.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import (
77
"net/http/httputil"
88

99
"github.com/golang-jwt/jwt/v4"
10-
"github.com/zeromicro/go-zero/core/logx"
10+
"github.com/zeromicro/go-zero/core/logc"
1111
"github.com/zeromicro/go-zero/rest/internal/response"
1212
"github.com/zeromicro/go-zero/rest/token"
1313
)
@@ -100,7 +100,7 @@ func WithUnauthorizedCallback(callback UnauthorizedCallback) AuthorizeOption {
100100
func detailAuthLog(r *http.Request, reason string) {
101101
// discard dump error, only for debug purpose
102102
details, _ := httputil.DumpRequest(r, true)
103-
logx.Errorf("authorize failed: %s\n=> %+v", reason, string(details))
103+
logc.Errorf(r.Context(), "authorize failed: %s\n=> %+v", reason, string(details))
104104
}
105105

106106
func unauthorized(w http.ResponseWriter, r *http.Request, err error, callback UnauthorizedCallback) {

Diff for: ‎rest/handler/breakerhandler.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ import (
66
"strings"
77

88
"github.com/zeromicro/go-zero/core/breaker"
9-
"github.com/zeromicro/go-zero/core/logx"
9+
"github.com/zeromicro/go-zero/core/logc"
1010
"github.com/zeromicro/go-zero/core/stat"
1111
"github.com/zeromicro/go-zero/rest/httpx"
1212
"github.com/zeromicro/go-zero/rest/internal/response"
@@ -22,7 +22,7 @@ func BreakerHandler(method, path string, metrics *stat.Metrics) func(http.Handle
2222
promise, err := brk.Allow()
2323
if err != nil {
2424
metrics.AddDrop()
25-
logx.Errorf("[http] dropped, %s - %s - %s",
25+
logc.Errorf(r.Context(), "[http] dropped, %s - %s - %s",
2626
r.RequestURI, httpx.GetRemoteAddr(r), r.UserAgent())
2727
w.WriteHeader(http.StatusServiceUnavailable)
2828
return

Diff for: ‎rest/handler/contentsecurityhandler.go

+3-3
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ import (
55
"time"
66

77
"github.com/zeromicro/go-zero/core/codec"
8-
"github.com/zeromicro/go-zero/core/logx"
8+
"github.com/zeromicro/go-zero/core/logc"
99
"github.com/zeromicro/go-zero/rest/httpx"
1010
"github.com/zeromicro/go-zero/rest/internal/security"
1111
)
@@ -34,11 +34,11 @@ func LimitContentSecurityHandler(limitBytes int64, decrypters map[string]codec.R
3434
case http.MethodDelete, http.MethodGet, http.MethodPost, http.MethodPut:
3535
header, err := security.ParseContentSecurity(decrypters, r)
3636
if err != nil {
37-
logx.Errorf("Signature parse failed, X-Content-Security: %s, error: %s",
37+
logc.Errorf(r.Context(), "Signature parse failed, X-Content-Security: %s, error: %s",
3838
r.Header.Get(contentSecurity), err.Error())
3939
executeCallbacks(w, r, next, strict, httpx.CodeSignatureInvalidHeader, callbacks)
4040
} else if code := security.VerifySignature(r, header, tolerance); code != httpx.CodeSignaturePass {
41-
logx.Errorf("Signature verification failed, X-Content-Security: %s",
41+
logc.Errorf(r.Context(), "Signature verification failed, X-Content-Security: %s",
4242
r.Header.Get(contentSecurity))
4343
executeCallbacks(w, r, next, strict, code, callbacks)
4444
} else if r.ContentLength > 0 && header.Encrypted() {

Diff for: ‎rest/handler/cryptionhandler.go

+6-5
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,15 @@ package handler
33
import (
44
"bufio"
55
"bytes"
6+
"context"
67
"encoding/base64"
78
"errors"
89
"io"
910
"net"
1011
"net/http"
1112

1213
"github.com/zeromicro/go-zero/core/codec"
13-
"github.com/zeromicro/go-zero/core/logx"
14+
"github.com/zeromicro/go-zero/core/logc"
1415
)
1516

1617
const maxBytes = 1 << 20 // 1 MiB
@@ -27,7 +28,7 @@ func LimitCryptionHandler(limitBytes int64, key []byte) func(http.Handler) http.
2728
return func(next http.Handler) http.Handler {
2829
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
2930
cw := newCryptionResponseWriter(w)
30-
defer cw.flush(key)
31+
defer cw.flush(r.Context(), key)
3132

3233
if r.ContentLength <= 0 {
3334
next.ServeHTTP(cw, r)
@@ -118,7 +119,7 @@ func (w *cryptionResponseWriter) WriteHeader(statusCode int) {
118119
w.ResponseWriter.WriteHeader(statusCode)
119120
}
120121

121-
func (w *cryptionResponseWriter) flush(key []byte) {
122+
func (w *cryptionResponseWriter) flush(ctx context.Context, key []byte) {
122123
if w.buf.Len() == 0 {
123124
return
124125
}
@@ -131,8 +132,8 @@ func (w *cryptionResponseWriter) flush(key []byte) {
131132

132133
body := base64.StdEncoding.EncodeToString(content)
133134
if n, err := io.WriteString(w.ResponseWriter, body); err != nil {
134-
logx.Errorf("write response failed, error: %s", err)
135+
logc.Errorf(ctx, "write response failed, error: %s", err)
135136
} else if n < len(body) {
136-
logx.Errorf("actual bytes: %d, written bytes: %d", len(body), n)
137+
logc.Errorf(ctx, "actual bytes: %d, written bytes: %d", len(body), n)
137138
}
138139
}

Diff for: ‎rest/handler/cryptionhandler_test.go

+4-3
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ package handler
22

33
import (
44
"bytes"
5+
"context"
56
"crypto/rand"
67
"encoding/base64"
78
"io"
@@ -174,7 +175,7 @@ func TestCryptionResponseWriter_Flush(t *testing.T) {
174175
w := newCryptionResponseWriter(f)
175176
_, err := w.Write(body)
176177
assert.NoError(t, err)
177-
w.flush(aesKey)
178+
w.flush(context.Background(), aesKey)
178179
b, err := io.ReadAll(recorder.Body)
179180
assert.NoError(t, err)
180181
expected, err := codec.EcbEncrypt(aesKey, body)
@@ -191,7 +192,7 @@ func TestCryptionResponseWriter_Flush(t *testing.T) {
191192
w := newCryptionResponseWriter(f)
192193
_, err := w.Write(body)
193194
assert.NoError(t, err)
194-
w.flush(aesKey)
195+
w.flush(context.Background(), aesKey)
195196
b, err := io.ReadAll(recorder.Body)
196197
assert.NoError(t, err)
197198
expected, err := codec.EcbEncrypt(aesKey, body)
@@ -207,7 +208,7 @@ func TestCryptionResponseWriter_Flush(t *testing.T) {
207208
w := newCryptionResponseWriter(f)
208209
_, err := w.Write(body)
209210
assert.NoError(t, err)
210-
w.flush(aesKey)
211+
w.flush(context.Background(), aesKey)
211212
assert.True(t, strings.Contains(buf.Content(), io.ErrClosedPipe.Error()))
212213
})
213214
}

Diff for: ‎rest/handler/sheddinghandler.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ import (
55
"sync"
66

77
"github.com/zeromicro/go-zero/core/load"
8-
"github.com/zeromicro/go-zero/core/logx"
8+
"github.com/zeromicro/go-zero/core/logc"
99
"github.com/zeromicro/go-zero/core/stat"
1010
"github.com/zeromicro/go-zero/rest/httpx"
1111
"github.com/zeromicro/go-zero/rest/internal/response"
@@ -35,7 +35,7 @@ func SheddingHandler(shedder load.Shedder, metrics *stat.Metrics) func(http.Hand
3535
if err != nil {
3636
metrics.AddDrop()
3737
sheddingStat.IncrementDrop()
38-
logx.Errorf("[http] dropped, %s - %s - %s",
38+
logc.Errorf(r.Context(), "[http] dropped, %s - %s - %s",
3939
r.RequestURI, httpx.GetRemoteAddr(r), r.UserAgent())
4040
w.WriteHeader(http.StatusServiceUnavailable)
4141
return

Diff for: ‎rest/httpx/responses.go

+2-1
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ import (
99
"net/http"
1010
"sync"
1111

12+
"github.com/zeromicro/go-zero/core/logc"
1213
"github.com/zeromicro/go-zero/core/logx"
1314
"github.com/zeromicro/go-zero/rest/internal/errcode"
1415
"github.com/zeromicro/go-zero/rest/internal/header"
@@ -119,7 +120,7 @@ func WriteJson(w http.ResponseWriter, code int, v any) {
119120
// WriteJsonCtx writes v as json string into w with code.
120121
func WriteJsonCtx(ctx context.Context, w http.ResponseWriter, code int, v any) {
121122
if err := doWriteJson(w, code, v); err != nil {
122-
logx.WithContext(ctx).Error(err)
123+
logc.Error(ctx, err)
123124
}
124125
}
125126

Diff for: ‎rest/internal/security/contentsecurity.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ import (
1414

1515
"github.com/zeromicro/go-zero/core/codec"
1616
"github.com/zeromicro/go-zero/core/iox"
17-
"github.com/zeromicro/go-zero/core/logx"
17+
"github.com/zeromicro/go-zero/core/logc"
1818
"github.com/zeromicro/go-zero/rest/httpx"
1919
)
2020

@@ -123,7 +123,7 @@ func VerifySignature(r *http.Request, securityHeader *ContentSecurityHeader, tol
123123
return httpx.CodeSignaturePass
124124
}
125125

126-
logx.Infof("signature different, expect: %s, actual: %s",
126+
logc.Infof(r.Context(), "signature different, expect: %s, actual: %s",
127127
securityHeader.Signature, actualSignature)
128128

129129
return httpx.CodeSignatureInvalidToken

Diff for: ‎zrpc/internal/serverinterceptors/recoverinterceptor.go

+5-5
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import (
44
"context"
55
"runtime/debug"
66

7-
"github.com/zeromicro/go-zero/core/logx"
7+
"github.com/zeromicro/go-zero/core/logc"
88
"google.golang.org/grpc"
99
"google.golang.org/grpc/codes"
1010
"google.golang.org/grpc/status"
@@ -14,7 +14,7 @@ import (
1414
func StreamRecoverInterceptor(svr any, stream grpc.ServerStream, _ *grpc.StreamServerInfo,
1515
handler grpc.StreamHandler) (err error) {
1616
defer handleCrash(func(r any) {
17-
err = toPanicError(r)
17+
err = toPanicError(context.Background(), r)
1818
})
1919

2020
return handler(svr, stream)
@@ -24,7 +24,7 @@ func StreamRecoverInterceptor(svr any, stream grpc.ServerStream, _ *grpc.StreamS
2424
func UnaryRecoverInterceptor(ctx context.Context, req any, _ *grpc.UnaryServerInfo,
2525
handler grpc.UnaryHandler) (resp any, err error) {
2626
defer handleCrash(func(r any) {
27-
err = toPanicError(r)
27+
err = toPanicError(ctx, r)
2828
})
2929

3030
return handler(ctx, req)
@@ -36,7 +36,7 @@ func handleCrash(handler func(any)) {
3636
}
3737
}
3838

39-
func toPanicError(r any) error {
40-
logx.Errorf("%+v\n\n%s", r, debug.Stack())
39+
func toPanicError(ctx context.Context, r any) error {
40+
logc.Errorf(ctx, "%+v\n\n%s", r, debug.Stack())
4141
return status.Errorf(codes.Internal, "panic: %v", r)
4242
}

0 commit comments

Comments
 (0)