virtualization icon indicating copy to clipboard operation
virtualization copied to clipboard

chore(core): add indexers for slowest client.List operations

Open danilrwx opened this issue 4 months ago • 10 comments

Description

Use indexers for better performance. List on large size of namespaces drastically increases cpu usage, using indexers divide it by 2.

Checklist

  • [ ] The code is covered by unit tests.
  • [ ] e2e tests passed.
  • [ ] Documentation updated according to the changes.
  • [x] Changes were tested in the Kubernetes cluster manually.

Changelog entries

section: core
type: chore
summary: add indexers for slowest client.List operations
impact_level: low

danilrwx avatar Oct 30 '25 16:10 danilrwx

Reviewer's Guide

This PR adds a new indexer for VirtualMachine by IP and registers it in the global indexers list, refactors handler List calls to use MatchingFields for index-based queries to improve performance, and updates tests to use testutil.NewFakeClientWithObjects instead of manual fake client building.

Sequence diagram for optimized List operation using indexers

sequenceDiagram
participant Handler
participant Client
participant Indexer
participant VirtualMachineList
Handler->>Client: List(VirtualMachineList, MatchingFields{IndexFieldVMByVD: vd.Name})
Client->>Indexer: Use IndexFieldVMByVD to filter
Indexer-->>Client: Return filtered VirtualMachineList
Client-->>Handler: Return VirtualMachineList

Sequence diagram for List operation by IP using new indexer

sequenceDiagram
participant AttachedHandler
participant Client
participant Indexer
participant VirtualMachineList
AttachedHandler->>Client: List(VirtualMachineList, MatchingFields{IndexFieldVMByIP: vmip.Status.Address})
Client->>Indexer: Use IndexFieldVMByIP to filter
Indexer-->>Client: Return filtered VirtualMachineList
Client-->>AttachedHandler: Return VirtualMachineList

Class diagram for new and updated indexers in VirtualMachine

classDiagram
class VirtualMachine {
  +status: Status
  +spec: Spec
}
class Status {
  +ipAddress: string
  +node: string
}
class Spec {
  +blockDeviceRefs: BlockDeviceRefs
}
class BlockDeviceRefs {
  +VirtualDisk: string
  +VirtualImage: string
  +ClusterVirtualImage: string
}
class IndexGetters {
  +IndexVMByVD()
  +IndexVMByVI()
  +IndexVMByCVI()
  +IndexVMByIP()  % newly added
  +IndexVMByNode()
}
VirtualMachine --> Status
VirtualMachine --> Spec
Spec --> BlockDeviceRefs
IndexGetters --> VirtualMachine : uses

File-Level Changes

Change Details Files
Introduce new indexer for VirtualMachine by IP
  • Add IndexFieldVMByIP constant
  • Include IndexVMByIP in IndexGetters
  • Implement IndexVMByIP extraction function
pkg/controller/indexer/indexer.go
Switch handler List calls to use index-based MatchingFields
  • Replace ListOptions filtering by namespace with MatchingFields using indexer.IndexFieldVMByVD
  • Replace ListOptions filtering by namespace with MatchingFields using indexer.IndexFieldVMByIP
  • Import indexer package in handlers
pkg/controller/vd/internal/inuse.go
pkg/controller/vmip/internal/attached_handler.go
Refactor tests to use common fake client builder
  • Replace fake.NewClientBuilder calls with testutil.NewFakeClientWithObjects
  • Add error checks after testutil.NewFakeClientWithObjects
  • Update imports to include testutil and remove direct fake client import
pkg/controller/vd/internal/inuse_test.go

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an issue from a review comment by replying to it. You can also reply to a review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull request title to generate a title at any time. You can also comment @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in the pull request body to generate a PR summary at any time exactly where you want it. You can also comment @sourcery-ai summary on the pull request to (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the pull request to resolve all Sourcery comments. Useful if you've already addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull request to dismiss all existing Sourcery reviews. Especially useful if you want to start fresh with a new review - don't forget to comment @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

  • Contact our support team for questions or feedback.
  • Visit our documentation for detailed guides and information.
  • Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

sourcery-ai[bot] avatar Oct 30 '25 16:10 sourcery-ai[bot]

Workflow has started. Follow the progress here: Workflow Run

The target step completed with status: failure.

deckhouse-BOaTswain avatar Oct 31 '25 08:10 deckhouse-BOaTswain

Workflow has started. Follow the progress here: Workflow Run

The target step completed with status: failure.

deckhouse-BOaTswain avatar Nov 01 '25 11:11 deckhouse-BOaTswain

Workflow has started. Follow the progress here: Workflow Run

The target step completed with status: failure.

deckhouse-BOaTswain avatar Nov 01 '25 13:11 deckhouse-BOaTswain

Workflow has started. Follow the progress here: Workflow Run

The target step completed with status: failure.

deckhouse-BOaTswain avatar Nov 01 '25 13:11 deckhouse-BOaTswain

Workflow has started. Follow the progress here: Workflow Run

The target step completed with status: failure.

deckhouse-BOaTswain avatar Nov 05 '25 10:11 deckhouse-BOaTswain

Workflow has started. Follow the progress here: Workflow Run

The target step completed with status: failure.

deckhouse-BOaTswain avatar Nov 05 '25 12:11 deckhouse-BOaTswain

Workflow has started. Follow the progress here: Workflow Run

The target step completed with status: failure.

deckhouse-BOaTswain avatar Nov 05 '25 17:11 deckhouse-BOaTswain

Workflow has started. Follow the progress here: Workflow Run

The target step completed with status: failure.

deckhouse-BOaTswain avatar Nov 06 '25 08:11 deckhouse-BOaTswain

Workflow has started. Follow the progress here: Workflow Run

The target step completed with status: failure.

deckhouse-BOaTswain avatar Nov 06 '25 10:11 deckhouse-BOaTswain