diff doc/upgrading.txt @ 7819:0fe2b9f6e19f

issue2551212 - enable wsgi cache_tracker by default Switch the code so the wsgi cache_tracker optimization is enabled by default. Leave the unoptimized/uncached code path available in case it breaks something. The feature flag can be set to False to disable caching. Updated tests to test the disabled (non-cache) code path. Updated upgrading.txt with info on how to disable caching.
author John Rouillard <rouilj@ieee.org>
date Wed, 20 Mar 2024 17:13:30 -0400
parents af898d1d66dc
children 8b31893f5930
line wrap: on
line diff
--- a/doc/upgrading.txt	Wed Mar 20 12:06:46 2024 -0400
+++ b/doc/upgrading.txt	Wed Mar 20 17:13:30 2024 -0400
@@ -112,6 +112,24 @@
 
 This will insert the bad API login rate limiting settings.
 
+Disable performance improvement for wsgi mode (optional)
+--------------------------------------------------------
+
+In Roundup version 2.2.0 an experimental option to improve performance
+when running in wsgi mode was added. It as disabled at that time. In
+the last two years it has been in use at a few sits with no reports of
+issues.
+
+So the default mode is now to enable this improvement. This will get
+more people using it. In case there is a latent bug that hasn't been
+discovered, it can still be disabled. To disable it, add the
+feature_flags to the RequestDispatcher as below:
+
+   feature_flags = { "cache_tracker": False }
+   app =  RequestDispatcher(tracker_home, feature_flags=feature_flags)
+
+and restart your wsgi instance.
+
 Fix duplicate id for confirm password in user.item.html (optional)
 ------------------------------------------------------------------
 

Roundup Issue Tracker: http://roundup-tracker.org/