Skip to content

Commit 9656885

Browse files
ronethingCopilot
authored andcommitted
chore: unified logger print (#2456)
Signed-off-by: ashing <[email protected]> Co-authored-by: Copilot <[email protected]> (cherry picked from commit 8a2b2b1)
1 parent 0c0118d commit 9656885

File tree

15 files changed

+51
-47
lines changed

15 files changed

+51
-47
lines changed

internal/controller/apisixglobalrule_controller.go

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,6 @@ import (
2121
"context"
2222
"fmt"
2323

24-
"github.com/api7/gopkg/pkg/log"
2524
"github.com/go-logr/logr"
2625
networkingv1 "k8s.io/api/networking/v1"
2726
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
@@ -83,19 +82,19 @@ func (r *ApisixGlobalRuleReconciler) Reconcile(ctx context.Context, req ctrl.Req
8382
// get the ingress class
8483
ingressClass, err := GetIngressClass(tctx, r.Client, r.Log, globalRule.Spec.IngressClassName)
8584
if err != nil {
86-
log.Error(err, "failed to get IngressClass")
85+
r.Log.Error(err, "failed to get IngressClass")
8786
return ctrl.Result{}, err
8887
}
8988

9089
// process IngressClass parameters if they reference GatewayProxy
9190
if err := ProcessIngressClassParameters(tctx, r.Client, r.Log, &globalRule, ingressClass); err != nil {
92-
log.Error(err, "failed to process IngressClass parameters", "ingressClass", ingressClass.Name)
91+
r.Log.Error(err, "failed to process IngressClass parameters", "ingressClass", ingressClass.Name)
9392
return ctrl.Result{}, err
9493
}
9594

9695
// Sync the global rule to APISIX
9796
if err := r.Provider.Update(ctx, tctx, &globalRule); err != nil {
98-
log.Error(err, "failed to sync global rule to provider")
97+
r.Log.Error(err, "failed to sync global rule to provider")
9998
// Update status with failure condition
10099
r.updateStatus(&globalRule, metav1.Condition{
101100
Type: string(apiv2.ConditionTypeAccepted),

internal/controller/apisixtls_controller.go

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,6 @@ import (
2121
"context"
2222
"fmt"
2323

24-
"github.com/api7/gopkg/pkg/log"
2524
"github.com/go-logr/logr"
2625
corev1 "k8s.io/api/core/v1"
2726
networkingv1 "k8s.io/api/networking/v1"
@@ -115,7 +114,7 @@ func (r *ApisixTlsReconciler) Reconcile(ctx context.Context, req ctrl.Request) (
115114
// get the ingress class
116115
ingressClass, err := GetIngressClass(tctx, r.Client, r.Log, tls.Spec.IngressClassName)
117116
if err != nil {
118-
log.Error(err, "failed to get IngressClass")
117+
r.Log.Error(err, "failed to get IngressClass")
119118
r.updateStatus(&tls, metav1.Condition{
120119
Type: string(apiv2.ConditionTypeAccepted),
121120
Status: metav1.ConditionFalse,
@@ -129,7 +128,7 @@ func (r *ApisixTlsReconciler) Reconcile(ctx context.Context, req ctrl.Request) (
129128

130129
// process IngressClass parameters if they reference GatewayProxy
131130
if err := ProcessIngressClassParameters(tctx, r.Client, r.Log, &tls, ingressClass); err != nil {
132-
log.Error(err, "failed to process IngressClass parameters", "ingressClass", ingressClass.Name)
131+
r.Log.Error(err, "failed to process IngressClass parameters", "ingressClass", ingressClass.Name)
133132
r.updateStatus(&tls, metav1.Condition{
134133
Type: string(apiv2.ConditionTypeAccepted),
135134
Status: metav1.ConditionFalse,
@@ -143,7 +142,7 @@ func (r *ApisixTlsReconciler) Reconcile(ctx context.Context, req ctrl.Request) (
143142

144143
// process ApisixTls validation
145144
if err := r.processApisixTls(ctx, tctx, &tls); err != nil {
146-
log.Error(err, "failed to process ApisixTls")
145+
r.Log.Error(err, "failed to process ApisixTls")
147146
r.updateStatus(&tls, metav1.Condition{
148147
Type: string(apiv2.ConditionTypeAccepted),
149148
Status: metav1.ConditionFalse,
@@ -156,7 +155,7 @@ func (r *ApisixTlsReconciler) Reconcile(ctx context.Context, req ctrl.Request) (
156155
}
157156

158157
if err := r.Provider.Update(ctx, tctx, &tls); err != nil {
159-
log.Error(err, "failed to sync apisix tls to provider")
158+
r.Log.Error(err, "failed to sync apisix tls to provider")
160159
// Update status with failure condition
161160
r.updateStatus(&tls, metav1.Condition{
162161
Type: string(apiv2.ConditionTypeAccepted),

internal/controller/consumer_controller.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -212,7 +212,7 @@ func (r *ConsumerReconciler) Reconcile(ctx context.Context, req ctrl.Request) (c
212212

213213
rk := utils.NamespacedNameKind(consumer)
214214

215-
if err := ProcessGatewayProxy(r.Client, tctx, gateway, rk); err != nil {
215+
if err := ProcessGatewayProxy(r.Client, r.Log, tctx, gateway, rk); err != nil {
216216
r.Log.Error(err, "failed to process gateway proxy", "gateway", gateway)
217217
statusErr = err
218218
}

internal/controller/gateway_controller.go

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,6 @@ import (
2323
"fmt"
2424
"reflect"
2525

26-
"github.com/api7/gopkg/pkg/log"
2726
"github.com/go-logr/logr"
2827
corev1 "k8s.io/api/core/v1"
2928
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
@@ -412,7 +411,7 @@ func (r *GatewayReconciler) listReferenceGrantsForGateway(ctx context.Context, o
412411
}
413412

414413
func (r *GatewayReconciler) processInfrastructure(tctx *provider.TranslateContext, gateway *gatewayv1.Gateway) error {
415-
return ProcessGatewayProxy(r.Client, tctx, gateway, utils.NamespacedNameKind(gateway))
414+
return ProcessGatewayProxy(r.Client, r.Log, tctx, gateway, utils.NamespacedNameKind(gateway))
416415
}
417416

418417
func (r *GatewayReconciler) processListenerConfig(tctx *provider.TranslateContext, gateway *gatewayv1.Gateway) {
@@ -432,12 +431,12 @@ func (r *GatewayReconciler) processListenerConfig(tctx *provider.TranslateContex
432431
Namespace: ns,
433432
Name: string(ref.Name),
434433
}, &secret); err != nil {
435-
log.Error(err, "failed to get secret", "namespace", ns, "name", ref.Name)
434+
r.Log.Error(err, "failed to get secret", "namespace", ns, "name", ref.Name)
436435
SetGatewayListenerConditionProgrammed(gateway, string(listener.Name), false, err.Error())
437436
SetGatewayListenerConditionResolvedRefs(gateway, string(listener.Name), false, err.Error())
438437
break
439438
}
440-
log.Info("Setting secret for listener", "listener", listener.Name, "secret", secret.Name, " namespace", ns)
439+
r.Log.Info("Setting secret for listener", "listener", listener.Name, "secret", secret.Name, " namespace", ns)
441440
tctx.Secrets[types.NamespacedName{Namespace: ns, Name: string(ref.Name)}] = &secret
442441
}
443442
}

internal/controller/httproute_controller.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -177,7 +177,7 @@ func (r *HTTPRouteReconciler) Reconcile(ctx context.Context, req ctrl.Request) (
177177
tctx.RouteParentRefs = hr.Spec.ParentRefs
178178
rk := utils.NamespacedNameKind(hr)
179179
for _, gateway := range gateways {
180-
if err := ProcessGatewayProxy(r.Client, tctx, gateway.Gateway, rk); err != nil {
180+
if err := ProcessGatewayProxy(r.Client, r.Log, tctx, gateway.Gateway, rk); err != nil {
181181
acceptStatus.status = false
182182
acceptStatus.msg = err.Error()
183183
}

internal/controller/ingress_controller.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -471,7 +471,7 @@ func (r *IngressReconciler) processTLS(tctx *provider.TranslateContext, ingress
471471
Namespace: ingress.Namespace,
472472
Name: tls.SecretName,
473473
}, &secret); err != nil {
474-
log.Error(err, "failed to get secret", "namespace", ingress.Namespace, "name", tls.SecretName)
474+
r.Log.Error(err, "failed to get secret", "namespace", ingress.Namespace, "name", tls.SecretName)
475475
return err
476476
}
477477

internal/controller/ingressclass_controller.go

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,6 @@ import (
2121
"context"
2222
"fmt"
2323

24-
"github.com/api7/gopkg/pkg/log"
2524
"github.com/go-logr/logr"
2625
corev1 "k8s.io/api/core/v1"
2726
networkingv1 "k8s.io/api/networking/v1"
@@ -217,7 +216,7 @@ func (r *IngressClassReconciler) processInfrastructure(tctx *provider.TranslateC
217216
Namespace: namespace,
218217
Name: secretRef.Name,
219218
}, secret); err != nil {
220-
log.Error(err, "failed to get secret for gateway proxy", "namespace", namespace, "name", secretRef.Name)
219+
r.Log.Error(err, "failed to get secret for gateway proxy", "namespace", namespace, "name", secretRef.Name)
221220
return err
222221
}
223222
tctx.Secrets[client.ObjectKey{

internal/controller/utils.go

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -380,8 +380,11 @@ func ParseRouteParentRefs(
380380
listenerName = string(listener.Name)
381381
ok, err := routeMatchesListenerAllowedRoutes(ctx, mgrc, route, listener.AllowedRoutes, gateway.Namespace, parentRef.Namespace)
382382
if err != nil {
383-
log.Warnf("failed matching listener %s to a route %s for gateway %s: %v",
384-
listener.Name, route.GetName(), gateway.Name, err,
383+
log.Warnw("failed matching listener to a route for gateway",
384+
zap.String("listener", string(listener.Name)),
385+
zap.String("route", route.GetName()),
386+
zap.String("gateway", gateway.Name),
387+
zap.Error(err),
385388
)
386389
}
387390
if !ok {
@@ -895,7 +898,7 @@ func SplitMetaNamespaceKey(key string) (namespace, name string, err error) {
895898
return "", "", fmt.Errorf("unexpected key format: %q", key)
896899
}
897900

898-
func ProcessGatewayProxy(r client.Client, tctx *provider.TranslateContext, gateway *gatewayv1.Gateway, rk types.NamespacedNameKind) error {
901+
func ProcessGatewayProxy(r client.Client, log logr.Logger, tctx *provider.TranslateContext, gateway *gatewayv1.Gateway, rk types.NamespacedNameKind) error {
899902
if gateway == nil {
900903
return nil
901904
}
@@ -914,10 +917,10 @@ func ProcessGatewayProxy(r client.Client, tctx *provider.TranslateContext, gatew
914917
Namespace: ns,
915918
Name: paramRef.Name,
916919
}, gatewayProxy); err != nil {
917-
log.Errorw("failed to get GatewayProxy", zap.String("namespace", ns), zap.String("name", paramRef.Name), zap.Error(err))
920+
log.Error(err, "failed to get GatewayProxy", "namespace", ns, "name", paramRef.Name)
918921
return err
919922
} else {
920-
log.Infow("found GatewayProxy for Gateway", zap.String("namespace", gateway.Namespace), zap.String("name", gateway.Name))
923+
log.Info("found GatewayProxy for Gateway", "namespace", gateway.Namespace, "name", gateway.Name)
921924
tctx.GatewayProxies[gatewayKind] = *gatewayProxy
922925
tctx.ResourceParentRefs[rk] = append(tctx.ResourceParentRefs[rk], gatewayKind)
923926

@@ -941,10 +944,7 @@ func ProcessGatewayProxy(r client.Client, tctx *provider.TranslateContext, gatew
941944
return err
942945
}
943946

944-
log.Info("found secret for GatewayProxy provider",
945-
"gateway", gateway.Name,
946-
"gatewayproxy", gatewayProxy.Name,
947-
"secret", secretRef.Name)
947+
log.Info("found secret for GatewayProxy provider", "gateway", gateway.Name, "gatewayproxy", gatewayProxy.Name, "secret", secretRef.Name)
948948

949949
tctx.Secrets[k8stypes.NamespacedName{
950950
Namespace: ns,
@@ -1445,12 +1445,12 @@ func distinctRequests(requests []reconcile.Request) []reconcile.Request {
14451445
}
14461446

14471447
func addProviderEndpointsToTranslateContext(tctx *provider.TranslateContext, c client.Client, serviceNN k8stypes.NamespacedName) error {
1448-
log.Debugf("to process provider endpints by provider.service: %s", serviceNN)
1448+
log.Debugw("to process provider endpoints by provider.service", zap.Any("service", serviceNN))
14491449
var (
14501450
service corev1.Service
14511451
)
14521452
if err := c.Get(tctx, serviceNN, &service); err != nil {
1453-
log.Error(err, "failed to get service from GatewayProxy provider", "key", serviceNN)
1453+
log.Errorw("failed to get service from GatewayProxy provider", zap.Error(err), zap.Any("key", serviceNN))
14541454
return err
14551455
}
14561456
tctx.Services[serviceNN] = &service
@@ -1464,7 +1464,7 @@ func addProviderEndpointsToTranslateContext(tctx *provider.TranslateContext, c c
14641464
client.MatchingLabels{
14651465
discoveryv1.LabelServiceName: serviceNN.Name,
14661466
}); err != nil {
1467-
log.Error(err, "failed to get endpoints for GatewayProxy provider", "endpoints", serviceNN)
1467+
log.Errorw("failed to get endpoints for GatewayProxy provider", zap.Error(err), zap.Any("endpoints", serviceNN))
14681468
return err
14691469
}
14701470
tctx.EndpointSlices[serviceNN] = esList.Items

internal/provider/adc/adc.go

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -403,7 +403,12 @@ func (d *adcClient) sync(ctx context.Context, task Task) error {
403403
var failedConfigs []string
404404
for _, config := range task.configs {
405405
if err := d.executor.Execute(ctx, d.BackendMode, config, args); err != nil {
406-
log.Errorw("failed to execute adc command", zap.Error(err), zap.Any("config", config))
406+
log.Errorw("failed to execute adc command",
407+
zap.Error(err),
408+
zap.String("configName", config.Name),
409+
zap.Any("serverAddrs", config.ServerAddrs),
410+
zap.Bool("tlsVerify", config.TlsVerify),
411+
)
407412
failedConfigs = append(failedConfigs, config.Name)
408413
}
409414
}
@@ -432,7 +437,7 @@ func prepareSyncFile(resources any) (string, func(), error) {
432437
return "", nil, err
433438
}
434439

435-
log.Debugf("generated adc file, filename: %s, json: %s\n", tmpFile.Name(), string(data))
440+
log.Debugw("generated adc file", zap.String("filename", tmpFile.Name()), zap.String("json", string(data)))
436441

437442
return tmpFile.Name(), cleanup, nil
438443
}

internal/provider/adc/executor.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ func (e *DefaultADCExecutor) runForSingleServer(ctx context.Context, serverAddr,
8686
cmd.Stderr = &stderr
8787
cmd.Env = append(os.Environ(), env...)
8888

89-
log.Debug("running adc command",
89+
log.Debugw("running adc command",
9090
zap.String("command", strings.Join(cmd.Args, " ")),
9191
zap.Strings("env", env),
9292
)
@@ -123,7 +123,7 @@ func (e *DefaultADCExecutor) buildCmdError(runErr error, stdout, stderr []byte)
123123

124124
func (e *DefaultADCExecutor) handleOutput(output []byte) error {
125125
var result adctypes.SyncResult
126-
log.Debugf("adc output: %s", string(output))
126+
log.Debugw("adc output", zap.String("output", string(output)))
127127
if lines := bytes.Split(output, []byte{'\n'}); len(lines) > 0 {
128128
output = lines[len(lines)-1]
129129
}

0 commit comments

Comments
 (0)