Skip to content

gwctl performance improvements #3145

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

Merged
k8s-ci-robot merged 2 commits into from
Jun 12, 2024
Merged

gwctl performance improvements #3145

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
860d1dc
Fetch resources in bulk instead of single API calls as the default.
gauravkghildiyal Jun 2, 2024
930d3ca
Lazily fetch events instead of making them part of the ResourceModel.
gauravkghildiyal Jun 8, 2024
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
8 changes: 4 additions & 4 deletions gwctl/cmd/subcommand.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -217,7 +217,7 @@ func runGetOrDescribeNamespaces(f cmdutils.Factory, o *getOrDescribeOptions) {
handleErrOrExitWithMsg(err, "failed to discover Namespace resources")

realClock := clock.RealClock{}
nsPrinter := &printer.NamespacesPrinter{Writer: o.out, Clock: realClock}
nsPrinter := &printer.NamespacesPrinter{Writer: o.out, Clock: realClock, EventFetcher: discoverer}
if o.cmdName == commandNameGet {
printer.Print(nsPrinter, resourceModel, o.outputFormat)
} else {
Expand Down Expand Up @@ -248,7 +248,7 @@ func runGetOrDescribeGatewayClasses(f cmdutils.Factory, o *getOrDescribeOptions)
handleErrOrExitWithMsg(err, "failed to discover GatewayClass resources")

realClock := clock.RealClock{}
gwcPrinter := &printer.GatewayClassesPrinter{Writer: o.out, Clock: realClock}
gwcPrinter := &printer.GatewayClassesPrinter{Writer: o.out, Clock: realClock, EventFetcher: discoverer}
if o.cmdName == commandNameGet {
printer.Print(gwcPrinter, resourceModel, o.outputFormat)
} else {
Expand Down Expand Up @@ -281,7 +281,7 @@ func runGetOrDescribeGateways(f cmdutils.Factory, o *getOrDescribeOptions) {
handleErrOrExitWithMsg(err, "failed to discover Gateway resources")

realClock := clock.RealClock{}
gwPrinter := &printer.GatewaysPrinter{Writer: o.out, Clock: realClock}
gwPrinter := &printer.GatewaysPrinter{Writer: o.out, Clock: realClock, EventFetcher: discoverer}
if o.cmdName == commandNameGet {
printer.Print(gwPrinter, resourceModel, o.outputFormat)
} else {
Expand Down Expand Up @@ -347,7 +347,7 @@ func runGetOrDescribeBackends(f cmdutils.Factory, o *getOrDescribeOptions) {
handleErrOrExitWithMsg(err, "failed to discover Backend resources")

realClock := clock.RealClock{}
backendsPrinter := &printer.BackendsPrinter{Writer: o.out, Clock: realClock}
backendsPrinter := &printer.BackendsPrinter{Writer: o.out, Clock: realClock, EventFetcher: discoverer}
if o.cmdName == commandNameGet {
printer.Print(backendsPrinter, resourceModel, o.outputFormat)
} else {
Expand Down
7 changes: 5 additions & 2 deletions gwctl/pkg/printer/backends.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ limitations under the License.
package printer

import (
"context"
"fmt"
"io"
"strings"
Expand All @@ -31,7 +32,8 @@ import (

type BackendsPrinter struct {
io.Writer
Clock clock.Clock
Clock clock.Clock
EventFetcher eventFetcher
}

func (bp *BackendsPrinter) GetPrintableNodes(resourceModel *resourcediscovery.ResourceModel) []NodeResource {
Expand Down Expand Up @@ -155,7 +157,8 @@ func (bp *BackendsPrinter) PrintDescribeView(resourceModel *resourcediscovery.Re
}

// Events
pairs = append(pairs, &DescriberKV{Key: "Events", Value: convertEventsSliceToTable(backendNode.Events, bp.Clock)})
eventList := bp.EventFetcher.FetchEventsFor(context.Background(), backendNode.Backend)
pairs = append(pairs, &DescriberKV{Key: "Events", Value: convertEventsSliceToTable(eventList.Items, bp.Clock)})

Describe(bp, pairs)

Expand Down
5 changes: 5 additions & 0 deletions gwctl/pkg/printer/common.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ limitations under the License.
package printer

import (
"context"
"fmt"
"io"
"os"
Expand Down Expand Up @@ -208,3 +209,7 @@ func NodeResources[K NodeResource](items []K) []NodeResource {
}
return output
}

type eventFetcher interface {
FetchEventsFor(context.Context, client.Object) *corev1.EventList
}
7 changes: 5 additions & 2 deletions gwctl/pkg/printer/gatewayclasses.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ limitations under the License.
package printer

import (
"context"
"fmt"
"io"

Expand All @@ -31,7 +32,8 @@ var _ Printer = (*GatewayClassesPrinter)(nil)

type GatewayClassesPrinter struct {
io.Writer
Clock clock.Clock
Clock clock.Clock
EventFetcher eventFetcher
}

func (gcp *GatewayClassesPrinter) GetPrintableNodes(resourceModel *resourcediscovery.ResourceModel) []NodeResource {
Expand Down Expand Up @@ -106,7 +108,8 @@ func (gcp *GatewayClassesPrinter) PrintDescribeView(resourceModel *resourcedisco
pairs = append(pairs, &DescriberKV{Key: "DirectlyAttachedPolicies", Value: convertPolicyRefsToTable(policyRefs)})

// Events
pairs = append(pairs, &DescriberKV{Key: "Events", Value: convertEventsSliceToTable(gatewayClassNode.Events, gcp.Clock)})
eventList := gcp.EventFetcher.FetchEventsFor(context.Background(), gatewayClassNode.GatewayClass)
pairs = append(pairs, &DescriberKV{Key: "Events", Value: convertEventsSliceToTable(eventList.Items, gcp.Clock)})

Describe(gcp, pairs)

Expand Down
5 changes: 3 additions & 2 deletions gwctl/pkg/printer/gatewayclasses_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -331,8 +331,9 @@ Events: <none>
}

gcp := &GatewayClassesPrinter{
Writer: buff,
Clock: fakeClock,
Writer: buff,
Clock: fakeClock,
EventFetcher: discoverer,
}
gcp.PrintDescribeView(resourceModel)

Expand Down
7 changes: 5 additions & 2 deletions gwctl/pkg/printer/gateways.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ limitations under the License.
package printer

import (
"context"
"fmt"
"io"
"strings"
Expand All @@ -32,7 +33,8 @@ var _ Printer = (*GatewaysPrinter)(nil)

type GatewaysPrinter struct {
io.Writer
Clock clock.Clock
Clock clock.Clock
EventFetcher eventFetcher
}

func (gp *GatewaysPrinter) GetPrintableNodes(resourceModel *resourcediscovery.ResourceModel) []NodeResource {
Expand Down Expand Up @@ -152,7 +154,8 @@ func (gp *GatewaysPrinter) PrintDescribeView(resourceModel *resourcediscovery.Re
}

// Events
pairs = append(pairs, &DescriberKV{Key: "Events", Value: convertEventsSliceToTable(gatewayNode.Events, gp.Clock)})
eventList := gp.EventFetcher.FetchEventsFor(context.Background(), gatewayNode.Gateway)
pairs = append(pairs, &DescriberKV{Key: "Events", Value: convertEventsSliceToTable(eventList.Items, gp.Clock)})

Describe(gp, pairs)

Expand Down
5 changes: 3 additions & 2 deletions gwctl/pkg/printer/gateways_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -485,8 +485,9 @@ func TestGatewaysPrinter_PrintDescribeView(t *testing.T) {
}

gp := &GatewaysPrinter{
Writer: buff,
Clock: fakeClock,
Writer: buff,
Clock: fakeClock,
EventFetcher: discoverer,
}
gp.PrintDescribeView(resourceModel)

Expand Down
7 changes: 5 additions & 2 deletions gwctl/pkg/printer/namespace.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ limitations under the License.
package printer

import (
"context"
"fmt"
"io"

Expand All @@ -31,7 +32,8 @@ var _ Printer = (*NamespacesPrinter)(nil)

type NamespacesPrinter struct {
io.Writer
Clock clock.Clock
Clock clock.Clock
EventFetcher eventFetcher
}

func (nsp *NamespacesPrinter) GetPrintableNodes(resourceModel *resourcediscovery.ResourceModel) []NodeResource {
Expand Down Expand Up @@ -94,7 +96,8 @@ func (nsp *NamespacesPrinter) PrintDescribeView(resourceModel *resourcediscovery
pairs = append(pairs, &DescriberKV{Key: "DirectlyAttachedPolicies", Value: convertPolicyRefsToTable(policyRefs)})

// Events
pairs = append(pairs, &DescriberKV{Key: "Events", Value: convertEventsSliceToTable(namespaceNode.Events, nsp.Clock)})
eventList := nsp.EventFetcher.FetchEventsFor(context.Background(), namespaceNode.Namespace)
pairs = append(pairs, &DescriberKV{Key: "Events", Value: convertEventsSliceToTable(eventList.Items, nsp.Clock)})

Describe(nsp, pairs)

Expand Down
5 changes: 3 additions & 2 deletions gwctl/pkg/printer/namespace_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -282,8 +282,9 @@ func TestNamespacePrinter_PrintDescribeView(t *testing.T) {
}

nsp := &NamespacesPrinter{
Writer: buff,
Clock: fakeClock,
Writer: buff,
Clock: fakeClock,
EventFetcher: discoverer,
}
nsp.PrintDescribeView(resourceModel)

Expand Down
Loading