⚠ Add a context w/ logger to Reconciler interface #1054
+76
−61
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -130,6 +130,12 @@ func (blder *Builder) WithOptions(options controller.Options) *Builder { | |
| return blder | ||
| } | ||
|
|
||
| // WithLogger overrides the controller options's logger used. | ||
| func (blder *Builder) WithLogger(log logr.Logger) *Builder { | ||
| blder.log = log | ||
| return blder | ||
| } | ||
|
|
||
vincepri marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| // Named sets the name of the controller to the given name. The name shows up | ||
| // in metrics, among other things, and thus should be a prometheus compatible name | ||
| // (underscores and alphanumeric characters only). | ||
|
|
@@ -140,12 +146,6 @@ func (blder *Builder) Named(name string) *Builder { | |
| return blder | ||
| } | ||
|
|
||
| // Complete builds the Application ControllerManagedBy. | ||
| func (blder *Builder) Complete(r reconcile.Reconciler) error { | ||
| _, err := blder.Build(r) | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -44,7 +44,7 @@ import ( | |
|
|
||
| type typedNoop struct{} | ||
|
|
||
| func (typedNoop) Reconcile(context.Context, reconcile.Request) (reconcile.Result, error) { | ||
| return reconcile.Result{}, nil | ||
| } | ||
|
|
||
|
|
@@ -60,7 +60,9 @@ var _ = Describe("application", func() { | |
| close(stop) | ||
| }) | ||
|
|
||
| noop := reconcile.Func(func(context.Context, reconcile.Request) (reconcile.Result, error) { | ||
| return reconcile.Result{}, nil | ||
| }) | ||
|
|
||
| Describe("New", func() { | ||
| It("should return success if given valid objects", func() { | ||
|
|
@@ -302,7 +304,7 @@ func doReconcileTest(nameSuffix string, stop chan struct{}, blder *Builder, mgr | |
|
|
||
| By("Creating the application") | ||
| ch := make(chan reconcile.Request) | ||
| fn := reconcile.Func(func(_ context.Context, req reconcile.Request) (reconcile.Result, error) { | ||
| defer GinkgoRecover() | ||
| if !strings.HasSuffix(req.Name, nameSuffix) { | ||
| // From different test, ignore this request. Etcd is shared across tests. | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -79,25 +79,24 @@ type ReplicaSetReconciler struct { | |
| // * Read the ReplicaSet | ||
| // * Read the Pods | ||
| // * Set a Label on the ReplicaSet with the Pod count | ||
| func (a *ReplicaSetReconciler) Reconcile(ctx context.Context, req reconcile.Request) (reconcile.Result, error) { | ||
| // Read the ReplicaSet | ||
| rs := &appsv1.ReplicaSet{} | ||
| err := a.Get(ctx, req.NamespacedName, rs) | ||
| if err != nil { | ||
| return reconcile.Result{}, err | ||
| } | ||
|
|
||
| // List the Pods matching the PodTemplate Labels | ||
| pods := &corev1.PodList{} | ||
| err = a.List(ctx, pods, client.InNamespace(req.Namespace), client.MatchingLabels(rs.Spec.Template.Labels)) | ||
| if err != nil { | ||
| return reconcile.Result{}, err | ||
| } | ||
|
|
||
| // Update the ReplicaSet | ||
| rs.Labels["pod-count"] = fmt.Sprintf("%v", len(pods.Items)) | ||
| err = a.Update(ctx, rs) | ||
| if err != nil { | ||
| return reconcile.Result{}, err | ||
| } | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -43,7 +43,8 @@ type Options struct { | |
| // The overall is a token bucket and the per-item is exponential. | ||
| RateLimiter ratelimiter.RateLimiter | ||
|
|
||
| // Log is the logger used for this controller and passed to each reconciliation | ||
| // request via the context field. | ||
| Log logr.Logger | ||
| } | ||
|
|
||
|
|
@@ -91,6 +92,10 @@ func NewUnmanaged(name string, mgr manager.Manager, options Options) (Controller | |
| return nil, fmt.Errorf("must specify Name for Controller") | ||
| } | ||
|
|
||
| if options.Log == nil { | ||
| options.Log = mgr.GetLogger() | ||
| } | ||
|
|
||
| if options.MaxConcurrentReconciles <= 0 { | ||
| options.MaxConcurrentReconciles = 1 | ||
| } | ||
|
|
@@ -117,6 +122,6 @@ func NewUnmanaged(name string, mgr manager.Manager, options Options) (Controller | |
| MaxConcurrentReconciles: options.MaxConcurrentReconciles, | ||
| SetFields: mgr.SetFields, | ||
| Name: name, | ||
| Log: options.Log.WithName("controller").WithName(name), | ||
| }, nil | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -62,7 +62,7 @@ var _ = Describe("controller", func() { | |
| By("Creating the Controller") | ||
| instance, err := controller.New("foo-controller", cm, controller.Options{ | ||
| Reconciler: reconcile.Func( | ||
| func(_ context.Context, request reconcile.Request) (reconcile.Result, error) { | ||
| reconciled <- request | ||
| return reconcile.Result{}, nil | ||
| }), | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -17,6 +17,7 @@ limitations under the License. | |
| package controller_test | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
| rt "runtime" | ||
|
|
||
|
|
@@ -33,7 +34,7 @@ import ( | |
| var _ = Describe("controller.Controller", func() { | ||
| var stop chan struct{} | ||
|
|
||
| rec := reconcile.Func(func(context.Context, reconcile.Request) (reconcile.Result, error) { | ||
| return reconcile.Result{}, nil | ||
| }) | ||
| BeforeEach(func() { | ||
|
|
@@ -123,7 +124,7 @@ var _ inject.Client = &failRec{} | |
|
|
||
| type failRec struct{} | ||
|
|
||
| func (*failRec) Reconcile(context.Context, reconcile.Request) (reconcile.Result, error) { | ||
| return reconcile.Result{}, nil | ||
| } | ||
|
|
||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -17,6 +17,7 @@ limitations under the License. | |
| package controller_test | ||
|
|
||
| import ( | ||
| "context" | ||
| "os" | ||
|
|
||
| corev1 "k8s.io/api/core/v1" | ||
|
|
@@ -41,7 +42,7 @@ var ( | |
| // manager.Manager will be used to Start the Controller, and will provide it a shared Cache and Client. | ||
| func ExampleNew() { | ||
| _, err := controller.New("pod-controller", mgr, controller.Options{ | ||
| Reconciler: reconcile.Func(func(context.Context, reconcile.Request) (reconcile.Result, error) { | ||
| // Your business logic to implement the API by creating, updating, deleting objects goes here. | ||
| return reconcile.Result{}, nil | ||
| }), | ||
|
|
@@ -59,7 +60,7 @@ func ExampleController() { | |
| // Create a new Controller that will call the provided Reconciler function in response | ||
| // to events. | ||
| c, err := controller.New("pod-controller", mgr, controller.Options{ | ||
| Reconciler: reconcile.Func(func(context.Context, reconcile.Request) (reconcile.Result, error) { | ||
| // Your business logic to implement the API by creating, updating, deleting objects goes here. | ||
| return reconcile.Result{}, nil | ||
| }), | ||
|
|
@@ -90,7 +91,7 @@ func ExampleController_unstructured() { | |
| // Create a new Controller that will call the provided Reconciler function in response | ||
| // to events. | ||
| c, err := controller.New("pod-controller", mgr, controller.Options{ | ||
| Reconciler: reconcile.Func(func(context.Context, reconcile.Request) (reconcile.Result, error) { | ||
| // Your business logic to implement the API by creating, updating, deleting objects goes here. | ||
| return reconcile.Result{}, nil | ||
| }), | ||
|
|
@@ -129,7 +130,7 @@ func ExampleNewUnmanaged() { | |
| // Configure creates a new controller but does not add it to the supplied | ||
| // manager. | ||
| c, err := controller.NewUnmanaged("pod-controller", mgr, controller.Options{ | ||
| Reconciler: reconcile.Func(func(context.Context, reconcile.Request) (reconcile.Result, error) { | ||
| return reconcile.Result{}, nil | ||
| }), | ||
| }) | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -17,6 +17,7 @@ limitations under the License. | |
| package controller | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
| "sync" | ||
| "time" | ||
|
|
@@ -27,6 +28,7 @@ import ( | |
| "k8s.io/client-go/util/workqueue" | ||
| "sigs.k8s.io/controller-runtime/pkg/handler" | ||
| ctrlmetrics "sigs.k8s.io/controller-runtime/pkg/internal/controller/metrics" | ||
| logf "sigs.k8s.io/controller-runtime/pkg/log" | ||
| "sigs.k8s.io/controller-runtime/pkg/predicate" | ||
| "sigs.k8s.io/controller-runtime/pkg/reconcile" | ||
| "sigs.k8s.io/controller-runtime/pkg/runtime/inject" | ||
|
|
@@ -86,8 +88,10 @@ type watchDescription struct { | |
| } | ||
|
|
||
| // Reconcile implements reconcile.Reconciler | ||
| func (c *Controller) Reconcile(ctx context.Context, req reconcile.Request) (reconcile.Result, error) { | ||
| log := c.Log.WithValues("name", req.Name, "namespace", req.Namespace) | ||
| ctx = logf.IntoContext(ctx, log) | ||
| return c.Do.Reconcile(ctx, req) | ||
| } | ||
|
|
||
| // Watch implements controller.Controller | ||
|
|
@@ -229,12 +233,15 @@ func (c *Controller) reconcileHandler(obj interface{}) bool { | |
| } | ||
|
|
||
| log := c.Log.WithValues("name", req.Name, "namespace", req.Namespace) | ||
| ctx := logf.IntoContext(context.Background(), log) | ||
|
There was a problem hiding this comment. Would |
||
|
|
||
| // RunInformersAndControllers the syncHandler, passing it the namespace/Name string of the | ||
| // resource to be synced. | ||
| if result, err := c.Do.Reconcile(ctx, req); err != nil { | ||
| c.Queue.AddRateLimited(req) | ||
| if log.V(3).Enabled() { | ||
| log.Error(err, "Reconciler error") | ||
| } | ||
| ctrlmetrics.ReconcileErrors.WithLabelValues(c.Name).Inc() | ||
| ctrlmetrics.ReconcileTotal.WithLabelValues(c.Name, "error").Inc() | ||
| return false | ||
|
|
@@ -258,7 +265,7 @@ func (c *Controller) reconcileHandler(obj interface{}) bool { | |
| c.Queue.Forget(obj) | ||
|
|
||
| // TODO(directxman12): What does 1 mean? Do we want level constants? Do we want levels at all? | ||
| log.V(5).Info("Successfully Reconciled") | ||
|
|
||
| ctrlmetrics.ReconcileTotal.WithLabelValues(c.Name, "success").Inc() | ||
| // Return true, don't take a break | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -78,10 +78,10 @@ var _ = Describe("controller", func() { | |
|
|
||
| Describe("Reconciler", func() { | ||
| It("should call the Reconciler function", func() { | ||
| ctrl.Do = reconcile.Func(func(context.Context, reconcile.Request) (reconcile.Result, error) { | ||
| return reconcile.Result{Requeue: true}, nil | ||
| }) | ||
| result, err := ctrl.Reconcile(context.Background(), | ||
| reconcile.Request{NamespacedName: types.NamespacedName{Namespace: "foo", Name: "bar"}}) | ||
| Expect(err).NotTo(HaveOccurred()) | ||
| Expect(result).To(Equal(reconcile.Result{Requeue: true})) | ||
|
|
@@ -304,7 +304,7 @@ var _ = Describe("controller", func() { | |
| }) | ||
|
|
||
| It("should continue to process additional queue items after the first", func(done Done) { | ||
| ctrl.Do = reconcile.Func(func(context.Context, reconcile.Request) (reconcile.Result, error) { | ||
| defer GinkgoRecover() | ||
| Fail("Reconciler should not have been called") | ||
| return reconcile.Result{}, nil | ||
|
|
@@ -766,7 +766,7 @@ func (f *fakeReconciler) AddResult(res reconcile.Result, err error) { | |
| f.results <- fakeReconcileResultPair{Result: res, Err: err} | ||
| } | ||
|
|
||
| func (f *fakeReconciler) Reconcile(_ context.Context, r reconcile.Request) (reconcile.Result, error) { | ||
| res := <-f.results | ||
| if f.Requests != nil { | ||
| f.Requests <- r | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should the error cases below be updated to use the logger from the context to output error info rather than returning wrapped errors?