Skip to content

Commit

Permalink
add utils to inject klog values in context
Browse files Browse the repository at this point in the history
  • Loading branch information
limhawjia committed Jul 12, 2023
1 parent 84a7a00 commit f7df5f4
Show file tree
Hide file tree
Showing 3 changed files with 45 additions and 14 deletions.
7 changes: 3 additions & 4 deletions pkg/util/informermanager/federatedinformermanager.go
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ import (
fedcorev1a1informers "github.com/kubewharf/kubeadmiral/pkg/client/informers/externalversions/core/v1alpha1"
fedcorev1a1listers "github.com/kubewharf/kubeadmiral/pkg/client/listers/core/v1alpha1"
"github.com/kubewharf/kubeadmiral/pkg/controllers/util"
"github.com/kubewharf/kubeadmiral/pkg/util/logging"
)

type federatedInformerManager struct {
Expand Down Expand Up @@ -120,8 +121,7 @@ func (m *federatedInformerManager) worker(ctx context.Context) {
return
}

logger = logger.WithValues("cluster", name)
ctx = klog.NewContext(ctx, logger)
ctx, logger = logging.InjectLoggerValues(ctx, "cluster", name)

cluster, err := m.clusterInformer.Lister().Get(name)
if err != nil && !apierrors.IsNotFound(err) {
Expand Down Expand Up @@ -289,8 +289,7 @@ func (m *federatedInformerManager) Start(ctx context.Context) {
m.lock.Lock()
defer m.lock.Unlock()

logger := klog.LoggerWithName(klog.FromContext(ctx), "federated-informer-manager")
ctx = klog.NewContext(ctx, logger)
ctx, logger := logging.InjectLoggerName(ctx, "federated-informer-manager")

if m.started {
logger.Error(nil, "FederatedInformerManager cannot be started more than once")
Expand Down
16 changes: 6 additions & 10 deletions pkg/util/informermanager/informermanager.go
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ import (
fedcorev1a1informers "github.com/kubewharf/kubeadmiral/pkg/client/informers/externalversions/core/v1alpha1"
fedcorev1a1listers "github.com/kubewharf/kubeadmiral/pkg/client/listers/core/v1alpha1"
"github.com/kubewharf/kubeadmiral/pkg/util/bijection"
"github.com/kubewharf/kubeadmiral/pkg/util/logging"
)

type informerManager struct {
Expand Down Expand Up @@ -107,8 +108,7 @@ func (m *informerManager) worker(ctx context.Context) {
return
}

logger = logger.WithValues("ftc", name)
ctx = klog.NewContext(ctx, logger)
ctx, logger = logging.InjectLoggerValues(ctx, "ftc", name)

ftc, err := m.ftcInformer.Lister().Get(name)
if apierrors.IsNotFound(err) {
Expand Down Expand Up @@ -150,14 +150,12 @@ func (m *informerManager) processFTC(ctx context.Context, ftc *fedcorev1a1.Feder
ftcName := ftc.Name
gvr := ftc.GetSourceTypeGVR()

logger := klog.FromContext(ctx).WithValues("gvr", gvr.String())
ctx = klog.NewContext(ctx, logger)
ctx, logger := logging.InjectLoggerValues(ctx, "gvr", gvr.String())

var informer informers.GenericInformer

if oldGVR, exists := m.gvrMapping.LookupByT1(ftcName); exists {
logger = klog.FromContext(ctx).WithValues("old-gvr", oldGVR.String())
ctx = klog.NewContext(ctx, logger)
ctx, _ := logging.InjectLoggerValues(ctx, "old-gvr", oldGVR.String())

if oldGVR != gvr {
// This might occur if a ftc was deleted and recreated with a different source type within a short period of
Expand Down Expand Up @@ -232,8 +230,7 @@ func (m *informerManager) processFTCDeletion(ctx context.Context, ftcName string
defer m.lock.Unlock()

if gvr, exists := m.gvrMapping.LookupByT1(ftcName); exists {
logger := klog.FromContext(ctx).WithValues("gvr", gvr.String())
ctx = klog.NewContext(ctx, logger)
ctx, _ = logging.InjectLoggerValues(ctx, "gvr", gvr.String())
}

return m.processFTCDeletionUnlocked(ctx, ftcName)
Expand Down Expand Up @@ -297,8 +294,7 @@ func (m *informerManager) Start(ctx context.Context) {
m.lock.Lock()
defer m.lock.Unlock()

logger := klog.LoggerWithName(klog.FromContext(ctx), "informer-manager")
ctx = klog.NewContext(ctx, logger)
ctx, logger := logging.InjectLoggerName(ctx, "informer-manager")

if m.started {
logger.Error(nil, "InformerManager cannot be started more than once")
Expand Down
36 changes: 36 additions & 0 deletions pkg/util/logging/logging.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
/*
Copyright 2023 The KubeAdmiral Authors.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package logging

import (
"context"

"github.com/go-logr/logr"
"k8s.io/klog/v2"
)

func InjectLoggerValues(ctx context.Context, values ...interface{}) (context.Context, logr.Logger) {
logger := klog.FromContext(ctx).WithValues(values...)
ctx = klog.NewContext(ctx, logger)
return ctx, logger
}

func InjectLoggerName(ctx context.Context, name string) (context.Context, logr.Logger) {
logger := klog.LoggerWithName(klog.FromContext(ctx), name)
ctx = klog.NewContext(ctx, logger)
return ctx, logger
}

0 comments on commit f7df5f4

Please sign in to comment.