framework/config,server: configkey caching #9628

shwstppr · 2024-09-03T11:18:34Z

Description

Added caching for ConfigKey value retrievals based on the Caffeine in-memory caching library.
https://github.com/ben-manes/caffeine
Currently, expire time for a cache is 30s and each update of the config key invalidates the cache. On any update or reset of the configuration, the cache automatically invalidates for it.

This useful when there are concurrent operations as it will prevent multiple DB queries within a short span of time.

Types of changes

Breaking change (fix or feature that would cause existing functionality to change)
New feature (non-breaking change which adds functionality)
Bug fix (non-breaking change which fixes an issue)
Enhancement (improves an existing feature and functionality)
Cleanup (Code refactoring and cleanup, that may add test cases)
build/CI
test (unit or integration test code)

Feature/Enhancement Scale or Bug Severity

Feature/Enhancement Scale

Major
Minor

Bug Severity

Screenshots (if appropriate):

How Has This Been Tested?

How did you try to break this feature and the system with this change?

codecov · 2024-09-03T11:25:34Z

Codecov Report

Attention: Patch coverage is 41.66667% with 42 lines in your changes missing coverage. Please review.

Project coverage is 15.58%. Comparing base (0692a29) to head (a890b6a).
Report is 22 commits behind head on main.

Files with missing lines	Patch %	Lines
...udstack/framework/config/impl/ConfigDepotImpl.java	63.88%	11 Missing and 2 partials ⚠️
.../cloud/configuration/ConfigurationManagerImpl.java	0.00%	7 Missing ⚠️
.../apache/cloudstack/framework/config/ConfigKey.java	58.33%	5 Missing ⚠️
...ava/com/cloud/domain/dao/DomainDetailsDaoImpl.java	0.00%	3 Missing ⚠️
...ain/java/com/cloud/user/AccountDetailsDaoImpl.java	0.00%	3 Missing ⚠️
...oudstack/framework/config/ScopedConfigStorage.java	0.00%	3 Missing ⚠️
.../main/java/com/cloud/dc/ClusterDetailsDaoImpl.java	0.00%	2 Missing ⚠️
...ava/com/cloud/dc/dao/DataCenterDetailsDaoImpl.java	0.00%	2 Missing ⚠️
...m/cloud/storage/dao/StoragePoolDetailsDaoImpl.java	0.00%	2 Missing ⚠️
...storage/datastore/db/ImageStoreDetailsDaoImpl.java	0.00%	2 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##               main    #9628    +/-   ##
==========================================
  Coverage     15.57%   15.58%            
- Complexity    12049    12054     +5     
==========================================
  Files          5505     5506     +1     
  Lines        482635   482694    +59     
  Branches      61701    60954   -747     
==========================================
+ Hits          75187    75211    +24     
- Misses       399141   399176    +35     
  Partials       8307     8307

Flag	Coverage Δ
uitests	`4.16% <ø> (-0.01%)`	⬇️
unittests	`16.36% <41.66%> (+<0.01%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

rohityadavcloud

LGTM - real world tests may be necessary, or a smoketests on test matrix.

Added caching for ConfigKey value retrievals based on the Caffeine in-memory caching library. https://github.com/ben-manes/caffeine Currently, expire time for a cache is 30s and each update of the config key invalidates the cache. On any update or reset of the configuration, cache automatically invalidates for it. Signed-off-by: Abhishek Kumar <abhishek.mrt22@gmail.com>

shwstppr · 2024-09-03T12:44:10Z

@blueorangutan package

blueorangutan · 2024-09-03T12:46:04Z

@shwstppr a [SL] Jenkins job has been kicked to build packages. It will be bundled with KVM, XenServer and VMware SystemVM templates. I'll keep you posted as I make progress.

blueorangutan · 2024-09-03T14:03:00Z

Packaging result [SF]: ✔️ el8 ✔️ el9 ✔️ debian ✔️ suse15. SL-JID 10930

shwstppr · 2024-09-03T18:51:44Z

@blueorangutan test

blueorangutan · 2024-09-03T18:54:05Z

@shwstppr a [SL] Trillian-Jenkins test job (ol8 mgmt + kvm-ol8) has been kicked to run smoke tests

blueorangutan · 2024-09-04T08:57:54Z

[SF] Trillian test result (tid-11317)
Environment: kvm-ol8 (x2), Advanced Networking with Mgmt server ol8
Total time taken: 48173 seconds
Marvin logs: https://github.com/blueorangutan/acs-prs/releases/download/trillian/pr9628-t11317-kvm-ol8.zip
Smoke tests completed. 139 look OK, 0 have errors, 0 did not run
Only failed and skipped tests results shown below:

Test	Result	Time (s)	Test File

ui/public/locales/en.json

ui/src/views/setting/ConfigurationValue.vue

weizhouapache

good improvement !

framework/config/src/main/java/org/apache/cloudstack/framework/config/impl/ConfigDepotImpl.java

Pearl1594

Code LGTM. Just a couple of queries.

rohityadavcloud · 2024-09-05T04:01:52Z

framework/config/src/main/java/org/apache/cloudstack/framework/config/impl/ConfigDepotImpl.java


    private HashMap<String, Pair<String, ConfigKey<?>>> _allKeys = new HashMap<String, Pair<String, ConfigKey<?>>>(1007);

    HashMap<ConfigKey.Scope, Set<ConfigKey<?>>> _scopeLevelConfigsMap = new HashMap<ConfigKey.Scope, Set<ConfigKey<?>>>();

    public ConfigDepotImpl() {
+        configCache = Caffeine.newBuilder()


Minor - in the next iteration, could we move/refactor caching library object creation & configuration to a separate class/utility/framework; so users only need to import & call the method to get the Cache objects/entities, but configuration etc are in that utility - making it easier to change the caching library in future. Otherwise LGTM, thanks @shwstppr

Follow up for apache#9628 Creates a utility class LazyCache which currently wraps Caffeine library Cache class. Signed-off-by: Abhishek Kumar <abhishek.mrt22@gmail.com>

Follow up from apache#9628 (comment) Signed-off-by: Abhishek Kumar <abhishek.mrt22@gmail.com>

Added caching for ConfigKey value retrievals based on the Caffeine in-memory caching library. https://github.com/ben-manes/caffeine Currently, expire time for a cache is 30s and each update of the config key invalidates the cache. On any update or reset of the configuration, cache automatically invalidates for it. Signed-off-by: Abhishek Kumar <abhishek.mrt22@gmail.com>

Follow up for apache#9628 Creates a utility class LazyCache which currently wraps Caffeine library Cache class. Signed-off-by: Abhishek Kumar <abhishek.mrt22@gmail.com>

boring-cyborg bot added component:build component:storage component:UI labels Sep 3, 2024

rohityadavcloud requested review from rohityadavcloud, DaanHoogland, vishesh92 and weizhouapache September 3, 2024 12:37

rohityadavcloud added this to the 4.20.0.0 milestone Sep 3, 2024

rohityadavcloud approved these changes Sep 3, 2024

View reviewed changes

shwstppr force-pushed the add-configkey-caching branch from 16530f1 to a890b6a Compare September 3, 2024 12:41

boring-cyborg bot added the component:orchestration label Sep 3, 2024

rohityadavcloud marked this pull request as ready for review September 4, 2024 06:56

rohityadavcloud requested review from harikrishna-patnala, nvazquez and sureshanaparti September 4, 2024 09:59

vishesh92 reviewed Sep 4, 2024

View reviewed changes

ui/public/locales/en.json Show resolved Hide resolved

DaanHoogland approved these changes Sep 4, 2024

View reviewed changes

ui/src/views/setting/ConfigurationValue.vue Show resolved Hide resolved

weizhouapache approved these changes Sep 4, 2024

View reviewed changes

Pearl1594 reviewed Sep 4, 2024

View reviewed changes

framework/config/src/main/java/org/apache/cloudstack/framework/config/impl/ConfigDepotImpl.java Show resolved Hide resolved

Pearl1594 reviewed Sep 4, 2024

View reviewed changes

framework/config/src/main/java/org/apache/cloudstack/framework/config/impl/ConfigDepotImpl.java Show resolved Hide resolved

Pearl1594 approved these changes Sep 4, 2024

View reviewed changes

rohityadavcloud reviewed Sep 5, 2024

View reviewed changes

rohityadavcloud merged commit 31b0ed0 into apache:main Sep 5, 2024
26 checks passed

rohityadavcloud deleted the add-configkey-caching branch September 5, 2024 04:02

shwstppr mentioned this pull request Sep 5, 2024

utils: add wrapper for the loading cache #9638

Closed

14 tasks

shwstppr added a commit to shapeblue/cloudstack that referenced this pull request Sep 5, 2024

ui: refactor config update/reset notification

633b0e4

Follow up from apache#9628 (comment) Signed-off-by: Abhishek Kumar <abhishek.mrt22@gmail.com>

shwstppr mentioned this pull request Sep 5, 2024

ui: refactor config update/reset notification #9639

Merged

14 tasks

shwstppr added a commit to shapeblue/cloudstack that referenced this pull request Sep 5, 2024

ui: refactor config update/reset notification

22227b0

Follow up from apache#9628 (comment) Signed-off-by: Abhishek Kumar <abhishek.mrt22@gmail.com>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

framework/config,server: configkey caching #9628

framework/config,server: configkey caching #9628

shwstppr commented Sep 3, 2024

codecov bot commented Sep 3, 2024 •

edited

Loading

rohityadavcloud left a comment

shwstppr commented Sep 3, 2024

blueorangutan commented Sep 3, 2024

blueorangutan commented Sep 3, 2024

shwstppr commented Sep 3, 2024

blueorangutan commented Sep 3, 2024

blueorangutan commented Sep 4, 2024

weizhouapache left a comment

Pearl1594 left a comment

rohityadavcloud Sep 5, 2024

framework/config,server: configkey caching #9628

framework/config,server: configkey caching #9628

Conversation

shwstppr commented Sep 3, 2024

Description

Types of changes

Feature/Enhancement Scale or Bug Severity

Feature/Enhancement Scale

Bug Severity

Screenshots (if appropriate):

How Has This Been Tested?

How did you try to break this feature and the system with this change?

codecov bot commented Sep 3, 2024 • edited Loading

Codecov Report

rohityadavcloud left a comment

Choose a reason for hiding this comment

shwstppr commented Sep 3, 2024

blueorangutan commented Sep 3, 2024

blueorangutan commented Sep 3, 2024

shwstppr commented Sep 3, 2024

blueorangutan commented Sep 3, 2024

blueorangutan commented Sep 4, 2024

weizhouapache left a comment

Choose a reason for hiding this comment

Pearl1594 left a comment

Choose a reason for hiding this comment

rohityadavcloud Sep 5, 2024

Choose a reason for hiding this comment

codecov bot commented Sep 3, 2024 •

edited

Loading