Skip to content

Commit a2af118

Browse files
openshift-merge-bot[bot]openshift-merge-bot[bot]
authored
Merge pull request #1536 from ratailor/fix-logger
Use structured logging
2 parents c4bce29 + 5a198f0 commit a2af118

File tree

6 files changed

+28
-23
lines changed

6 files changed

+28
-23
lines changed

‎controllers/client/openstackclient_controller.go‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ type OpenStackClientReconciler struct {
6262
Kclient kubernetes.Interface
6363
}
6464

65-
// GetLog returns a logger object with a prefix of "conroller.name" and aditional controller context fields
65+
// GetLogger returns a logger object with a prefix of "controller.name" and additional controller context fields
6666
func (r *OpenStackClientReconciler) GetLogger(ctx context.Context) logr.Logger {
6767
return log.FromContext(ctx).WithName("Controllers").WithName("OpenStackClient")
6868
}
@@ -515,7 +515,7 @@ func (r *OpenStackClientReconciler) SetupWithManager(
515515
func (r *OpenStackClientReconciler) findObjectsForSrc(ctx context.Context, src client.Object) []reconcile.Request {
516516
requests := []reconcile.Request{}
517517

518-
l := log.FromContext(context.Background()).WithName("Controllers").WithName("OpenStackClient")
518+
Log := r.GetLogger(context.Background())
519519

520520
for _, field := range allWatchFields {
521521
crList := &clientv1.OpenStackClientList{}
@@ -525,12 +525,12 @@ func (r *OpenStackClientReconciler) findObjectsForSrc(ctx context.Context, src c
525525
}
526526
err := r.List(ctx, crList, listOps)
527527
if err != nil {
528-
l.Error(err, fmt.Sprintf("listing %s for field: %s - %s", crList.GroupVersionKind().Kind, field, src.GetNamespace()))
528+
Log.Error(err, fmt.Sprintf("listing %s for field: %s - %s", crList.GroupVersionKind().Kind, field, src.GetNamespace()))
529529
return requests
530530
}
531531

532532
for _, item := range crList.Items {
533-
l.Info(fmt.Sprintf("input source %s changed, reconcile: %s - %s", src.GetName(), item.GetName(), item.GetNamespace()))
533+
Log.Info(fmt.Sprintf("input source %s changed, reconcile: %s - %s", src.GetName(), item.GetName(), item.GetNamespace()))
534534

535535
requests = append(requests,
536536
reconcile.Request{

‎controllers/core/openstackcontrolplane_controller.go‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ type OpenStackControlPlaneReconciler struct {
7777
Kclient kubernetes.Interface
7878
}
7979

80-
// GetLog returns a logger object with a prefix of "conroller.name" and aditional controller context fields
80+
// GetLogger returns a logger object with a prefix of "controller.name" and additional controller context fields
8181
func (r *OpenStackControlPlaneReconciler) GetLogger(ctx context.Context) logr.Logger {
8282
return log.FromContext(ctx).WithName("Controllers").WithName("OpenStackControlPlane")
8383
}
@@ -733,7 +733,7 @@ func (r *OpenStackControlPlaneReconciler) SetupWithManager(
733733
func (r *OpenStackControlPlaneReconciler) findObjectsForSrc(ctx context.Context, src client.Object) []reconcile.Request {
734734
requests := []reconcile.Request{}
735735

736-
l := log.FromContext(ctx).WithName("Controllers").WithName("OpenStackControlPlane")
736+
Log := r.GetLogger(ctx)
737737

738738
for _, field := range allWatchFields {
739739
crList := &corev1beta1.OpenStackControlPlaneList{}
@@ -743,12 +743,12 @@ func (r *OpenStackControlPlaneReconciler) findObjectsForSrc(ctx context.Context,
743743
}
744744
err := r.List(ctx, crList, listOps)
745745
if err != nil {
746-
l.Error(err, fmt.Sprintf("listing %s for field: %s - %s", crList.GroupVersionKind().Kind, field, src.GetNamespace()))
746+
Log.Error(err, fmt.Sprintf("listing %s for field: %s - %s", crList.GroupVersionKind().Kind, field, src.GetNamespace()))
747747
return requests
748748
}
749749

750750
for _, item := range crList.Items {
751-
l.Info(fmt.Sprintf("input source %s changed, reconcile: %s - %s", src.GetName(), item.GetName(), item.GetNamespace()))
751+
Log.Info(fmt.Sprintf("input source %s changed, reconcile: %s - %s", src.GetName(), item.GetName(), item.GetNamespace()))
752752

753753
requests = append(requests,
754754
reconcile.Request{

‎controllers/core/openstackversion_controller.go‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,6 @@ type OpenStackVersionReconciler struct {
7070
client.Client
7171
Kclient kubernetes.Interface
7272
Scheme *runtime.Scheme
73-
Log logr.Logger
7473
}
7574

7675
// GetLogger returns a logger object with a prefix of "controller.name" and additional controller context fields

‎controllers/dataplane/openstackdataplanedeployment_controller.go‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,7 @@ func (r *OpenStackDataPlaneDeploymentReconciler) Reconcile(ctx context.Context,
154154
}()
155155

156156
// Ensure NodeSets
157-
nodeSets, err := r.listNodeSets(ctx, &Log, instance)
157+
nodeSets, err := r.listNodeSets(ctx, instance)
158158
if err != nil {
159159
if k8s_errors.IsNotFound(err) {
160160
return ctrl.Result{RequeueAfter: time.Second * time.Duration(instance.Spec.DeploymentRequeueTime)}, nil
@@ -493,11 +493,13 @@ func (r *OpenStackDataPlaneDeploymentReconciler) SetupWithManager(mgr ctrl.Manag
493493
Complete(r)
494494
}
495495

496-
func (r *OpenStackDataPlaneDeploymentReconciler) listNodeSets(ctx context.Context, Log *logr.Logger, instance *dataplanev1.OpenStackDataPlaneDeployment) (*dataplanev1.OpenStackDataPlaneNodeSetList, error) {
496+
func (r *OpenStackDataPlaneDeploymentReconciler) listNodeSets(ctx context.Context, instance *dataplanev1.OpenStackDataPlaneDeployment) (*dataplanev1.OpenStackDataPlaneNodeSetList, error) {
497497

498498
var nodeSets = dataplanev1.OpenStackDataPlaneNodeSetList{}
499499
var err error
500500

501+
Log := r.GetLogger(ctx)
502+
501503
for _, nodeSet := range instance.Spec.NodeSets {
502504

503505
// Fetch the OpenStackDataPlaneNodeSet instance

‎controllers/operator/openstack_controller.go‎

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ type OpenStackReconciler struct {
5959
Kclient kubernetes.Interface
6060
}
6161

62-
// GetLog returns a logger object with a prefix of "controller.name" and aditional controller context fields
62+
// GetLogger returns a logger object with a prefix of "controller.name" and additional controller context fields
6363
func (r *OpenStackReconciler) GetLogger(ctx context.Context) logr.Logger {
6464
return log.FromContext(ctx).WithName("Controllers").WithName("OpenStackOperator")
6565
}
@@ -406,11 +406,13 @@ func isWebhookEndpoint(name string) bool {
406406
// checkServiceEndpoints -
407407
func (r *OpenStackReconciler) checkServiceEndpoints(ctx context.Context, instance *operatorv1beta1.OpenStack) (ctrl.Result, error) {
408408

409+
Log := r.GetLogger(ctx)
410+
409411
endpointSliceList := &discoveryv1.EndpointSliceList{}
410412
err := r.Client.List(ctx, endpointSliceList, &client.ListOptions{Namespace: instance.Namespace})
411413
if err != nil {
412414
if apierrors.IsNotFound(err) {
413-
log.Log.Info("Webhook endpoint not found. Requeuing...")
415+
Log.Info("Webhook endpoint not found. Requeuing...")
414416
return ctrl.Result{RequeueAfter: time.Duration(5) * time.Second}, nil
415417
}
416418
return ctrl.Result{}, err
@@ -427,7 +429,7 @@ func (r *OpenStackReconciler) checkServiceEndpoints(ctx context.Context, instanc
427429
op.Replicas != nil && *op.Replicas == 0 {
428430

429431
disabled = true
430-
log.Log.Info(fmt.Sprintf("Webhook %s disabled, skipping endpoint slice check", endpointSliceName), "name", endpointSlice.GetName())
432+
Log.Info(fmt.Sprintf("Webhook %s disabled, skipping endpoint slice check", endpointSliceName), "name", endpointSlice.GetName())
431433
break
432434
}
433435
}
@@ -436,17 +438,17 @@ func (r *OpenStackReconciler) checkServiceEndpoints(ctx context.Context, instanc
436438
}
437439

438440
if len(endpointSlice.Endpoints) == 0 {
439-
log.Log.Info("Webhook endpoint not configured. Requeuing...", "name", endpointSlice.GetName())
441+
Log.Info("Webhook endpoint not configured. Requeuing...", "name", endpointSlice.GetName())
440442
return ctrl.Result{RequeueAfter: time.Duration(5) * time.Second}, nil
441443
}
442444
for _, endpoint := range endpointSlice.Endpoints {
443445
if len(endpoint.Addresses) == 0 {
444-
log.Log.Info("Webhook endpoint addresses aren't healthy. Requeuing...", "name", endpointSlice.GetName())
446+
Log.Info("Webhook endpoint addresses aren't healthy. Requeuing...", "name", endpointSlice.GetName())
445447
return ctrl.Result{RequeueAfter: time.Duration(5) * time.Second}, nil
446448
}
447449
bFalse := false
448450
if endpoint.Conditions.Ready == &bFalse || endpoint.Conditions.Serving == &bFalse {
449-
log.Log.Info("Webhook endpoint addresses aren't serving. Requeuing...", "name", endpointSlice.GetName())
451+
Log.Info("Webhook endpoint addresses aren't serving. Requeuing...", "name", endpointSlice.GetName())
450452
return ctrl.Result{RequeueAfter: time.Duration(5) * time.Second}, nil
451453
}
452454
}
@@ -457,22 +459,23 @@ func (r *OpenStackReconciler) checkServiceEndpoints(ctx context.Context, instanc
457459
}
458460

459461
func (r *OpenStackReconciler) applyManifests(ctx context.Context, instance *operatorv1beta1.OpenStack) error {
462+
Log := r.GetLogger(ctx)
460463
// only apply CRDs and RBAC once per each containerImage change
461464
if !containerImageMatch(instance) {
462465
if err := r.applyCRDs(ctx, instance); err != nil {
463-
log.Log.Error(err, "failed applying CRD manifests")
466+
Log.Error(err, "failed applying CRD manifests")
464467
return err
465468
}
466469

467470
if err := r.applyRBAC(ctx, instance); err != nil {
468-
log.Log.Error(err, "failed applying RBAC manifests")
471+
Log.Error(err, "failed applying RBAC manifests")
469472
return err
470473
}
471474
}
472475
instance.Status.ContainerImage = &operatorImage
473476

474477
if err := r.applyOperator(ctx, instance); err != nil {
475-
log.Log.Error(err, "failed applying Operator manifests")
478+
Log.Error(err, "failed applying Operator manifests")
476479
return err
477480
}
478481

@@ -673,6 +676,7 @@ func (r *OpenStackReconciler) renderAndApply(
673676
) error {
674677
var err error
675678

679+
Log := r.GetLogger(ctx)
676680
bindir := util.GetEnvVar("BASE_BINDATA", "/bindata")
677681

678682
sourceFullDirectory := filepath.Join(bindir, sourceDirectory)
@@ -695,13 +699,13 @@ func (r *OpenStackReconciler) renderAndApply(
695699
if setControllerReference {
696700
// Set the controller reference.
697701
if obj.GetNamespace() != "" {
698-
log.Log.Info("Setting controller reference", "object", obj.GetName(), "controller", instance.Name)
702+
Log.Info("Setting controller reference", "object", obj.GetName(), "controller", instance.Name)
699703
err = controllerutil.SetControllerReference(instance, obj, r.Scheme)
700704
if err != nil {
701705
return errors.Wrap(err, "failed to set owner reference")
702706
}
703707
} else {
704-
log.Log.Info("skipping controller reference (cluster scoped)", "object", obj.GetName(), "controller", instance.Name)
708+
Log.Info("skipping controller reference (cluster scoped)", "object", obj.GetName(), "controller", instance.Name)
705709
}
706710
}
707711

‎pkg/openstack/common.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ const (
7272
caCertSelector = "ca-cert"
7373
)
7474

75-
// GetLog returns a logger object with a prefix of "controller.name" and aditional controller context fields
75+
// GetLogger returns a logger object with a prefix of "controller.name" and additional controller context fields
7676
func GetLogger(ctx context.Context) logr.Logger {
7777
return log.FromContext(ctx).WithName("Controllers").WithName("OpenstackControlPlane")
7878
}

0 commit comments

Comments
 (0)