Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Naive Tracing sketch #507

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Naive Tracing sketch #507

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions reconcilers/advice.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ import (
"sync"

"github.com/go-logr/logr"
"reconciler.io/runtime/trace"
ctrl "sigs.k8s.io/controller-runtime"
"sigs.k8s.io/controller-runtime/pkg/builder"
"sigs.k8s.io/controller-runtime/pkg/client"
Expand Down Expand Up @@ -137,6 +138,9 @@ func (r *Advice[T]) Reconcile(ctx context.Context, resource T) (Result, error) {
WithName(r.Name)
ctx = logr.NewContext(ctx, log)

trace.Enter(ctx, r.Name)
defer trace.Exit(ctx)

// before phase
beforeCtx, result, err := r.Before(ctx, resource)
if err != nil {
Expand Down
13 changes: 11 additions & 2 deletions reconcilers/aggregate.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ import (
"reconciler.io/runtime/duck"
"reconciler.io/runtime/internal"
rtime "reconciler.io/runtime/time"
"reconciler.io/runtime/trace"
"reconciler.io/runtime/tracker"
)

Expand Down Expand Up @@ -120,6 +121,11 @@ type AggregateReconciler[Type client.Object] struct {
// +optional
AfterReconcile func(ctx context.Context, req Request, res Result, err error) (Result, error)

// TraceProvider provides a new tracer for the current reconcile request.
//
// +optional
TraceProvider trace.TraceProvider

Config Config

// stamp manages the lifecycle of the aggregated resource.
Expand Down Expand Up @@ -241,15 +247,18 @@ func (r *AggregateReconciler[T]) Reconcile(ctx context.Context, req Request) (Re
return Result{}, nil
}

ctx = WithStash(ctx)

c := r.Config

log := logr.FromContextOrDiscard(ctx).
WithName(r.Name).
WithValues("resourceType", gvk(c, r.Type))
ctx = logr.NewContext(ctx, log)

ctx = trace.StashTracerFromProvider(ctx, r.TraceProvider)
trace.Enter(ctx, r.Name)
defer trace.Exit(ctx)

ctx = WithStash(ctx)
ctx = rtime.StashNow(ctx, time.Now())
ctx = StashRequest(ctx, req)
ctx = StashConfig(ctx, c)
Expand Down
14 changes: 9 additions & 5 deletions reconcilers/cast.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ import (
"sync"

"k8s.io/apimachinery/pkg/util/errors"
"reconciler.io/runtime/trace"

"github.com/go-logr/logr"
"k8s.io/apimachinery/pkg/api/equality"
Expand Down Expand Up @@ -105,11 +106,6 @@ func (r *CastResource[T, CT]) validate(ctx context.Context) error {
func (r *CastResource[T, CT]) Reconcile(ctx context.Context, resource T) (Result, error) {
r.init()

if r.noop {
// cast the type rather than convert the object
return r.Reconciler.Reconcile(ctx, client.Object(resource).(CT))
}

var nilCT CT
emptyCT := newEmpty(nilCT).(CT)

Expand All @@ -118,6 +114,14 @@ func (r *CastResource[T, CT]) Reconcile(ctx context.Context, resource T) (Result
WithValues("castResourceType", typeName(emptyCT))
ctx = logr.NewContext(ctx, log)

trace.Enter(ctx, r.Name)
defer trace.Exit(ctx)

if r.noop {
// cast the type rather than convert the object
return r.Reconciler.Reconcile(ctx, client.Object(resource).(CT))
}

ctx, castResource, err := r.cast(ctx, resource)
if err != nil {
return Result{}, err
Expand Down
4 changes: 4 additions & 0 deletions reconcilers/child.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ import (
"sigs.k8s.io/controller-runtime/pkg/client"

"reconciler.io/runtime/internal"
"reconciler.io/runtime/trace"
)

var (
Expand Down Expand Up @@ -276,6 +277,9 @@ func (r *ChildReconciler[T, CT, CLT]) Reconcile(ctx context.Context, resource T)
WithValues("childType", gvk(c, r.ChildType))
ctx = logr.NewContext(ctx, log)

trace.Enter(ctx, r.Name)
defer trace.Exit(ctx)

child, err := r.reconcile(ctx, resource)
if resource.GetDeletionTimestamp() != nil {
return Result{}, err
Expand Down
4 changes: 4 additions & 0 deletions reconcilers/childset.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ import (
utilerrors "k8s.io/apimachinery/pkg/util/errors"
"k8s.io/apimachinery/pkg/util/sets"
"reconciler.io/runtime/internal"
"reconciler.io/runtime/trace"
ctrl "sigs.k8s.io/controller-runtime"
"sigs.k8s.io/controller-runtime/pkg/builder"
"sigs.k8s.io/controller-runtime/pkg/client"
Expand Down Expand Up @@ -294,6 +295,9 @@ func (r *ChildSetReconciler[T, CT, CLT]) Reconcile(ctx context.Context, resource
WithName(r.Name)
ctx = logr.NewContext(ctx, log)

trace.Enter(ctx, r.Name)
defer trace.Exit(ctx)

knownChildren, err := r.knownChildren(ctx, resource)
if err != nil {
return Result{}, err
Expand Down
4 changes: 4 additions & 0 deletions reconcilers/finalizer.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ import (

"github.com/go-logr/logr"
corev1 "k8s.io/api/core/v1"
"reconciler.io/runtime/trace"
ctrl "sigs.k8s.io/controller-runtime"
"sigs.k8s.io/controller-runtime/pkg/builder"
"sigs.k8s.io/controller-runtime/pkg/client"
Expand Down Expand Up @@ -117,6 +118,9 @@ func (r *WithFinalizer[T]) Reconcile(ctx context.Context, resource T) (Result, e
WithName(r.Name)
ctx = logr.NewContext(ctx, log)

trace.Enter(ctx, r.Name)
defer trace.Exit(ctx)

if resource.GetDeletionTimestamp() == nil {
if err := AddFinalizer(ctx, resource, r.Finalizer); err != nil {
return Result{}, err
Expand Down
13 changes: 13 additions & 0 deletions reconcilers/flow.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ import (

"github.com/go-logr/logr"
"k8s.io/utils/pointer"
"reconciler.io/runtime/trace"
ctrl "sigs.k8s.io/controller-runtime"
"sigs.k8s.io/controller-runtime/pkg/builder"
"sigs.k8s.io/controller-runtime/pkg/client"
Expand Down Expand Up @@ -125,6 +126,9 @@ func (r *IfThen[T]) Reconcile(ctx context.Context, resource T) (Result, error) {
WithName(r.Name)
ctx = logr.NewContext(ctx, log)

trace.Enter(ctx, r.Name)
defer trace.Exit(ctx)

if r.If(ctx, resource) {
return r.Then.Reconcile(ctx, resource)
} else if r.Else != nil {
Expand Down Expand Up @@ -256,6 +260,9 @@ func (r *While[T]) Reconcile(ctx context.Context, resource T) (Result, error) {
WithName(r.Name)
ctx = logr.NewContext(ctx, log)

trace.Enter(ctx, r.Name)
defer trace.Exit(ctx)

aggregateResult := Result{}
for i := 0; true; i++ {
if *r.MaxIterations != 0 && i >= *r.MaxIterations {
Expand Down Expand Up @@ -387,6 +394,9 @@ func (r *TryCatch[T]) Reconcile(ctx context.Context, resource T) (Result, error)
WithName(r.Name)
ctx = logr.NewContext(ctx, log)

trace.Enter(ctx, r.Name)
defer trace.Exit(ctx)

result, err := r.Try.Reconcile(ctx, resource)
if r.Catch != nil {
result, err = r.Catch(ctx, resource, result, err)
Expand Down Expand Up @@ -474,6 +484,9 @@ func (r *OverrideSetup[T]) Reconcile(ctx context.Context, resource T) (Result, e
WithName(r.Name)
ctx = logr.NewContext(ctx, log)

trace.Enter(ctx, r.Name)
defer trace.Exit(ctx)

if r.Reconciler == nil {
return Result{}, nil
}
Expand Down
13 changes: 11 additions & 2 deletions reconcilers/resource.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ import (
"reconciler.io/runtime/duck"
"reconciler.io/runtime/internal"
rtime "reconciler.io/runtime/time"
"reconciler.io/runtime/trace"
)

var (
Expand Down Expand Up @@ -99,6 +100,11 @@ type ResourceReconciler[Type client.Object] struct {
// +optional
AfterReconcile func(ctx context.Context, req Request, res Result, err error) (Result, error)

// TraceProvider provides a new tracer for the current reconcile request.
//
// +optional
TraceProvider trace.TraceProvider

Config Config

lazyInit sync.Once
Expand Down Expand Up @@ -219,15 +225,18 @@ func (r *ResourceReconciler[T]) validate(ctx context.Context) error {
func (r *ResourceReconciler[T]) Reconcile(ctx context.Context, req Request) (Result, error) {
r.init()

ctx = WithStash(ctx)

c := r.Config

log := logr.FromContextOrDiscard(ctx).
WithName(r.Name).
WithValues("resourceType", gvk(c, r.Type))
ctx = logr.NewContext(ctx, log)

ctx = trace.StashTracerFromProvider(ctx, r.TraceProvider)
trace.Enter(ctx, r.Name)
defer trace.Exit(ctx)

ctx = WithStash(ctx)
ctx = rtime.StashNow(ctx, time.Now())
ctx = StashRequest(ctx, req)
ctx = StashConfig(ctx, c)
Expand Down
4 changes: 4 additions & 0 deletions reconcilers/sequence.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ import (
"fmt"

"github.com/go-logr/logr"
"reconciler.io/runtime/trace"
ctrl "sigs.k8s.io/controller-runtime"
"sigs.k8s.io/controller-runtime/pkg/builder"
"sigs.k8s.io/controller-runtime/pkg/client"
Expand Down Expand Up @@ -49,6 +50,9 @@ func (r Sequence[T]) SetupWithManager(ctx context.Context, mgr ctrl.Manager, bld
}

func (r Sequence[T]) Reconcile(ctx context.Context, resource T) (Result, error) {
trace.Enter(ctx, "Sequence")
defer trace.Exit(ctx)

aggregateResult := Result{}
for i, reconciler := range r {
log := logr.FromContextOrDiscard(ctx).
Expand Down
4 changes: 4 additions & 0 deletions reconcilers/sync.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ import (
"fmt"

"github.com/go-logr/logr"
"reconciler.io/runtime/trace"
ctrl "sigs.k8s.io/controller-runtime"
"sigs.k8s.io/controller-runtime/pkg/builder"
"sigs.k8s.io/controller-runtime/pkg/client"
Expand Down Expand Up @@ -124,6 +125,9 @@ func (r *SyncReconciler[T]) Reconcile(ctx context.Context, resource T) (Result,
WithName(r.Name)
ctx = logr.NewContext(ctx, log)

trace.Enter(ctx, r.Name)
defer trace.Exit(ctx)

result := Result{}

if resource.GetDeletionTimestamp() == nil || r.SyncDuringFinalization {
Expand Down
15 changes: 13 additions & 2 deletions reconcilers/webhook.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,12 +31,14 @@ import (
"k8s.io/apimachinery/pkg/api/equality"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/types"
"reconciler.io/runtime/internal"
rtime "reconciler.io/runtime/time"
"sigs.k8s.io/controller-runtime/pkg/client"
crlog "sigs.k8s.io/controller-runtime/pkg/log"
"sigs.k8s.io/controller-runtime/pkg/webhook"
"sigs.k8s.io/controller-runtime/pkg/webhook/admission"

"reconciler.io/runtime/internal"
rtime "reconciler.io/runtime/time"
"reconciler.io/runtime/trace"
)

// AdmissionWebhookAdapter allows using sub reconcilers to process admission webhooks. The full
Expand Down Expand Up @@ -90,6 +92,11 @@ type AdmissionWebhookAdapter[Type client.Object] struct {
// +optional
AfterHandle func(ctx context.Context, req admission.Request, resp *admission.Response)

// TraceProvider provides a new tracer for the current webhook request.
//
// +optional
TraceProvider trace.TraceProvider

Config Config

lazyInit sync.Once
Expand Down Expand Up @@ -154,6 +161,10 @@ func (r *AdmissionWebhookAdapter[T]) Handle(ctx context.Context, req admission.R
)
ctx = logr.NewContext(ctx, log)

ctx = trace.StashTracerFromProvider(ctx, r.TraceProvider)
trace.Enter(ctx, r.Name)
defer trace.Exit(ctx)

resp := &admission.Response{
AdmissionResponse: admissionv1.AdmissionResponse{
UID: req.UID,
Expand Down
30 changes: 30 additions & 0 deletions trace/discard.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
/*
Copyright 2024 the original author or 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 trace

import (
"context"
)

var (
_ Tracer = (*discardTracer)(nil)
)

type discardTracer struct{}

func (d *discardTracer) Enter(ctx context.Context, name string) {}
func (d *discardTracer) Exit(ctx context.Context) {}
31 changes: 31 additions & 0 deletions trace/interface.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
/*
Copyright 2024 the original author or 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 trace

import (
"context"
)

// Tracer observes the execution of a reconciler hierarchy.
type Tracer interface {
// Enter opens a new frame.
Enter(ctx context.Context, name string)
// Exit closes the most recently entered open frame.
Exit(ctx context.Context)
}

type TraceProvider = func(ctx context.Context) Tracer
Loading
Loading