Skip to content

Commit 351d124

Browse files
estrozestroz
committed
use controller-runtime/pkg/runtime/log.Log directly instead of SDKLog
1 parent 86143c3 commit 351d124

File tree

19 files changed

+39
-42
lines changed

19 files changed

+39
-42
lines changed

‎example/memcached-operator/memcached_controller.go.tmpl

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@ import (
66

77
cachev1alpha1 "github.com/example-inc/memcached-operator/pkg/apis/cache/v1alpha1"
88

9-
"github.com/operator-framework/operator-sdk/pkg/logutil"
109
appsv1 "k8s.io/api/apps/v1"
1110
corev1 "k8s.io/api/core/v1"
1211
"k8s.io/apimachinery/pkg/api/errors"
@@ -20,10 +19,11 @@ import (
2019
"sigs.k8s.io/controller-runtime/pkg/handler"
2120
"sigs.k8s.io/controller-runtime/pkg/manager"
2221
"sigs.k8s.io/controller-runtime/pkg/reconcile"
22+
logf "sigs.k8s.io/controller-runtime/pkg/runtime/log"
2323
"sigs.k8s.io/controller-runtime/pkg/source"
2424
)
2525

26-
var log = logutil.SDKLog.WithName("controller_memcached")
26+
var log = logf.Log.WithName("controller_memcached")
2727

2828
/**
2929
* USER ACTION REQUIRED: This is a scaffold file intended for the user to modify with their own Controller

‎pkg/ansible/controller/controller.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,18 +22,18 @@ import (
2222

2323
"github.com/operator-framework/operator-sdk/pkg/ansible/events"
2424
"github.com/operator-framework/operator-sdk/pkg/ansible/runner"
25-
"github.com/operator-framework/operator-sdk/pkg/logutil"
2625

2726
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
2827
"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
2928
"k8s.io/apimachinery/pkg/runtime/schema"
3029
"sigs.k8s.io/controller-runtime/pkg/controller"
3130
crthandler "sigs.k8s.io/controller-runtime/pkg/handler"
3231
"sigs.k8s.io/controller-runtime/pkg/manager"
32+
logf "sigs.k8s.io/controller-runtime/pkg/runtime/log"
3333
"sigs.k8s.io/controller-runtime/pkg/source"
3434
)
3535

36-
var log = logutil.SDKLog.WithName("ansible-controller")
36+
var log = logf.Log.WithName("ansible-controller")
3737

3838
// Options - options for your controller
3939
type Options struct {

‎pkg/ansible/controller/reconcile.go

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@ import (
3838
"k8s.io/apimachinery/pkg/runtime/schema"
3939
"sigs.k8s.io/controller-runtime/pkg/client"
4040
"sigs.k8s.io/controller-runtime/pkg/reconcile"
41+
logf "sigs.k8s.io/controller-runtime/pkg/runtime/log"
4142
)
4243

4344
const (
@@ -69,7 +70,7 @@ func (r *AnsibleOperatorReconciler) Reconcile(request reconcile.Request) (reconc
6970
}
7071

7172
ident := strconv.Itoa(rand.Int())
72-
logger := logutil.SDKLog.WithName("reconciler").WithValues(
73+
logger := logf.Log.WithName("reconciler").WithValues(
7374
"job", ident,
7475
"name", u.GetName(),
7576
"namespace", u.GetNamespace(),

‎pkg/ansible/controller/status/types.go

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,10 @@ import (
2222

2323
"k8s.io/api/core/v1"
2424
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
25+
logf "sigs.k8s.io/controller-runtime/pkg/runtime/log"
2526
)
2627

27-
var log = logutil.SDKLog.WithName("controller.status")
28+
var log = logf.Log.WithName("controller.status")
2829

2930
const (
3031
host = "localhost"

‎pkg/ansible/events/log_events.go

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ import (
2121
"github.com/operator-framework/operator-sdk/pkg/logutil"
2222

2323
"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
24+
logf "sigs.k8s.io/controller-runtime/pkg/runtime/log"
2425
)
2526

2627
// LogLevel - Levelt for the logging to take place.
@@ -51,7 +52,7 @@ func (l loggingEventHandler) Handle(ident string, u *unstructured.Unstructured,
5152
return
5253
}
5354

54-
logger := logutil.SDKLog.WithName("logging_event_handler").WithValues(
55+
logger := logf.Log.WithName("logging_event_handler").WithValues(
5556
"name", u.GetName(),
5657
"namespace", u.GetNamespace(),
5758
"gvk", u.GroupVersionKind().String(),

‎pkg/ansible/operator/operator.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,9 @@ import (
2020

2121
"github.com/operator-framework/operator-sdk/pkg/ansible/controller"
2222
"github.com/operator-framework/operator-sdk/pkg/ansible/runner"
23-
"github.com/operator-framework/operator-sdk/pkg/logutil"
2423

2524
"sigs.k8s.io/controller-runtime/pkg/manager"
25+
logf "sigs.k8s.io/controller-runtime/pkg/runtime/log"
2626
"sigs.k8s.io/controller-runtime/pkg/runtime/signals"
2727
)
2828

@@ -32,7 +32,7 @@ import (
3232
func Run(done chan error, mgr manager.Manager, watchesPath string, reconcilePeriod time.Duration) {
3333
watches, err := runner.NewFromWatches(watchesPath)
3434
if err != nil {
35-
logutil.SDKLog.WithName("manager").Error(err, "failed to get watches")
35+
logf.Log.WithName("manager").Error(err, "failed to get watches")
3636
done <- err
3737
return
3838
}

‎pkg/ansible/proxy/kubectl.go

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,15 +31,14 @@ import (
3131
"syscall"
3232
"time"
3333

34-
"github.com/operator-framework/operator-sdk/pkg/logutil"
35-
3634
utilnet "k8s.io/apimachinery/pkg/util/net"
3735
k8sproxy "k8s.io/apimachinery/pkg/util/proxy"
3836
"k8s.io/client-go/rest"
3937
"k8s.io/client-go/transport"
38+
logf "sigs.k8s.io/controller-runtime/pkg/runtime/log"
4039
)
4140

42-
var log = logutil.SDKLog.WithName("proxy")
41+
var log = logf.Log.WithName("proxy")
4342

4443
const (
4544
// DefaultHostAcceptRE is the default value for which hosts to accept.

‎pkg/ansible/proxy/proxy.go

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ import (
2828
"net/http/httputil"
2929

3030
"github.com/operator-framework/operator-sdk/pkg/logutil"
31+
3132
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
3233
"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
3334
"k8s.io/client-go/rest"

‎pkg/ansible/runner/eventapi/eventapi.go

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ import (
2828
"github.com/operator-framework/operator-sdk/pkg/logutil"
2929

3030
"github.com/go-logr/logr"
31+
logf "sigs.k8s.io/controller-runtime/pkg/runtime/log"
3132
)
3233

3334
// EventReceiver serves the event API
@@ -75,7 +76,7 @@ func New(ident string, errChan chan<- error) (*EventReceiver, error) {
7576
SocketPath: sockPath,
7677
URLPath: "/events/",
7778
ident: ident,
78-
logger: logutil.SDKLog.WithName("eventapi").WithValues("job", ident),
79+
logger: logf.Log.WithName("eventapi").WithValues("job", ident),
7980
}
8081

8182
mux := http.NewServeMux()

‎pkg/ansible/runner/internal/inputdir/inputdir.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,10 @@ import (
2121
"os"
2222
"path/filepath"
2323

24-
"github.com/operator-framework/operator-sdk/pkg/logutil"
24+
logf "sigs.k8s.io/controller-runtime/pkg/runtime/log"
2525
)
2626

27-
var log = logutil.SDKLog.WithName("inputdir")
27+
var log = logf.Log.WithName("inputdir")
2828

2929
// InputDir represents an input directory for ansible-runner.
3030
type InputDir struct {

‎pkg/ansible/runner/runner.go

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,9 +33,10 @@ import (
3333
yaml "gopkg.in/yaml.v2"
3434
"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
3535
"k8s.io/apimachinery/pkg/runtime/schema"
36+
logf "sigs.k8s.io/controller-runtime/pkg/runtime/log"
3637
)
3738

38-
var log = logutil.SDKLog.WithName("runner")
39+
var log = logf.Log.WithName("runner")
3940

4041
// Runner - a runnable that should take the parameters and name and namespace
4142
// and run the correct code.

‎pkg/leader/leader.go

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,10 @@ import (
3131
"k8s.io/apimachinery/pkg/util/wait"
3232
"k8s.io/client-go/rest"
3333
crclient "sigs.k8s.io/controller-runtime/pkg/client"
34+
logf "sigs.k8s.io/controller-runtime/pkg/runtime/log"
3435
)
3536

36-
var log = logutil.SDKLog.WithName("leader")
37+
var log = logf.Log.WithName("leader")
3738

3839
// errNoNS indicates that a namespace could not be found for the current
3940
// environment

‎pkg/logutil/log_util.go

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,6 @@
1414

1515
package logutil
1616

17-
import (
18-
logf "sigs.k8s.io/controller-runtime/pkg/runtime/log"
19-
)
20-
2117
// LogVerbosity is the level of verbosity of a particular log statement.
2218
// Usage: log.V(LogVerbosity).Info(...)
2319
type LogVerbosity = int
@@ -34,6 +30,3 @@ const (
3430
// VWarn == 1. log.V(VWarn).Info(...) == log.Warn(...)
3531
VWarn
3632
)
37-
38-
// SDKLog is the parent logger for logs generated by operator code.
39-
var SDKLog = logf.Log.WithName("operator-sdk")

‎pkg/scaffold/cmd.go

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,6 @@ import (
4646
"{{ .Repo }}/pkg/controller"
4747
4848
"github.com/operator-framework/operator-sdk/pkg/k8sutil"
49-
"github.com/operator-framework/operator-sdk/pkg/logutil"
5049
sdkVersion "github.com/operator-framework/operator-sdk/version"
5150
_ "k8s.io/client-go/plugin/pkg/client/auth/gcp"
5251
"sigs.k8s.io/controller-runtime/pkg/client/config"
@@ -56,9 +55,9 @@ import (
5655
)
5756
5857
func printVersion() {
59-
logutil.SDKLog.Info(fmt.Sprintf("Go Version: %s", runtime.Version()))
60-
logutil.SDKLog.Info(fmt.Sprintf("Go OS/Arch: %s/%s", runtime.GOOS, runtime.GOARCH))
61-
logutil.SDKLog.Info(fmt.Sprintf("operator-sdk Version: %v", sdkVersion.Version))
58+
logf.Log.Info(fmt.Sprintf("Go Version: %s", runtime.Version()))
59+
logf.Log.Info(fmt.Sprintf("Go OS/Arch: %s/%s", runtime.GOOS, runtime.GOARCH))
60+
logf.Log.Info(fmt.Sprintf("operator-sdk Version: %v", sdkVersion.Version))
6261
}
6362
6463
func main() {
@@ -70,7 +69,7 @@ func main() {
7069
// be propagated through the whole operator, generating
7170
// uniform and structured logs.
7271
logf.SetLogger(logf.ZapLogger(false))
73-
log := logutil.SDKLog.WithName("cmd")
72+
log := logf.Log.WithName("cmd")
7473
7574
namespace, err := k8sutil.GetWatchNamespace()
7675
if err != nil {

‎pkg/scaffold/cmd_test.go

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,6 @@ import (
4444
"github.com/example-inc/app-operator/pkg/apis"
4545
"github.com/example-inc/app-operator/pkg/controller"
4646
"github.com/operator-framework/operator-sdk/pkg/k8sutil"
47-
"github.com/operator-framework/operator-sdk/pkg/logutil"
4847
sdkVersion "github.com/operator-framework/operator-sdk/version"
4948
_ "k8s.io/client-go/plugin/pkg/client/auth/gcp"
5049
"sigs.k8s.io/controller-runtime/pkg/client/config"
@@ -54,9 +53,9 @@ import (
5453
)
5554
5655
func printVersion() {
57-
logutil.SDKLog.Info(fmt.Sprintf("Go Version: %s", runtime.Version()))
58-
logutil.SDKLog.Info(fmt.Sprintf("Go OS/Arch: %s/%s", runtime.GOOS, runtime.GOARCH))
59-
logutil.SDKLog.Info(fmt.Sprintf("operator-sdk Version: %v", sdkVersion.Version))
56+
logf.Log.Info(fmt.Sprintf("Go Version: %s", runtime.Version()))
57+
logf.Log.Info(fmt.Sprintf("Go OS/Arch: %s/%s", runtime.GOOS, runtime.GOARCH))
58+
logf.Log.Info(fmt.Sprintf("operator-sdk Version: %v", sdkVersion.Version))
6059
}
6160
6261
func main() {
@@ -68,7 +67,7 @@ func main() {
6867
// be propagated through the whole operator, generating
6968
// uniform and structured logs.
7069
logf.SetLogger(logf.ZapLogger(false))
71-
log := logutil.SDKLog.WithName("cmd")
70+
log := logf.Log.WithName("cmd")
7271
7372
namespace, err := k8sutil.GetWatchNamespace()
7473
if err != nil {

‎pkg/scaffold/controller_kind.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,6 @@ import (
4646
4747
{{ .Resource.Group}}{{ .Resource.Version }} "{{ .Repo }}/pkg/apis/{{ .Resource.Group}}/{{ .Resource.Version }}"
4848
49-
"github.com/operator-framework/operator-sdk/pkg/logutil"
5049
corev1 "k8s.io/api/core/v1"
5150
"k8s.io/apimachinery/pkg/api/errors"
5251
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
@@ -58,10 +57,11 @@ import (
5857
"sigs.k8s.io/controller-runtime/pkg/handler"
5958
"sigs.k8s.io/controller-runtime/pkg/manager"
6059
"sigs.k8s.io/controller-runtime/pkg/reconcile"
60+
logf "sigs.k8s.io/controller-runtime/pkg/runtime/log"
6161
"sigs.k8s.io/controller-runtime/pkg/source"
6262
)
6363
64-
var log = logutil.SDKLog.WithName("controller_{{ .Resource.LowerKind }}")
64+
var log = logf.Log.WithName("controller_{{ .Resource.LowerKind }}")
6565
6666
/**
6767
* USER ACTION REQUIRED: This is a scaffold file intended for the user to modify with their own Controller
@@ -170,7 +170,7 @@ func (r *Reconcile{{ .Resource.Kind }}) Reconcile(request reconcile.Request) (re
170170
return reconcile.Result{}, nil
171171
}
172172
173-
// newPodForCR returns a busybox pod with the same name/namespace as the cr
173+
// newPodForCR returns a busybox pod with the same name/namespace as the cr
174174
func newPodForCR(cr *{{ .Resource.Group}}{{ .Resource.Version }}.{{ .Resource.Kind }}) *corev1.Pod {
175175
labels := map[string]string{
176176
"app": cr.Name,

‎pkg/scaffold/controller_kind_test.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,6 @@ import (
4343
"context"
4444
4545
appv1alpha1 "github.com/example-inc/app-operator/pkg/apis/app/v1alpha1"
46-
"github.com/operator-framework/operator-sdk/pkg/logutil"
4746
corev1 "k8s.io/api/core/v1"
4847
"k8s.io/apimachinery/pkg/api/errors"
4948
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
@@ -55,10 +54,11 @@ import (
5554
"sigs.k8s.io/controller-runtime/pkg/handler"
5655
"sigs.k8s.io/controller-runtime/pkg/manager"
5756
"sigs.k8s.io/controller-runtime/pkg/reconcile"
57+
logf "sigs.k8s.io/controller-runtime/pkg/runtime/log"
5858
"sigs.k8s.io/controller-runtime/pkg/source"
5959
)
6060
61-
var log = logutil.SDKLog.WithName("controller_appservice")
61+
var log = logf.Log.WithName("controller_appservice")
6262
6363
/**
6464
* USER ACTION REQUIRED: This is a scaffold file intended for the user to modify with their own Controller

‎pkg/scaffold/scaffold.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -162,7 +162,7 @@ func (s *Scaffold) doTemplate(i input.Input, e input.File, absPath string) error
162162
}
163163

164164
_, err = f.Write(b)
165-
log.Info("Create", i.Path)
165+
log.Infoln("Create", i.Path)
166166
return err
167167
}
168168

‎pkg/sdk/metrics.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,16 +21,16 @@ import (
2121
"strconv"
2222

2323
"github.com/operator-framework/operator-sdk/pkg/k8sutil"
24-
"github.com/operator-framework/operator-sdk/pkg/logutil"
2524

2625
"github.com/prometheus/client_golang/prometheus/promhttp"
2726
v1 "k8s.io/api/core/v1"
2827
"k8s.io/apimachinery/pkg/api/errors"
2928
"sigs.k8s.io/controller-runtime/pkg/client"
3029
"sigs.k8s.io/controller-runtime/pkg/client/config"
30+
logf "sigs.k8s.io/controller-runtime/pkg/runtime/log"
3131
)
3232

33-
var log = logutil.SDKLog.WithName("metrics")
33+
var log = logf.Log.WithName("metrics")
3434

3535
// ExposeMetricsPort generate a Kubernetes Service to expose metrics port
3636
func ExposeMetricsPort() (*v1.Service, error) {

0 commit comments

Comments
 (0)