[MGNLADVCACHE-112] DOC: Clarify that site aware caching is tied to site definitions Created: 27/Aug/20  Updated: 31/Aug/21  Resolved: 31/Aug/21

Status: Closed
Project: Advanced Cache
Component/s: None
Affects Version/s: 2.3.1
Fix Version/s: None

Type: Improvement Priority: Neutral
Reporter: Richard Gange Assignee: Richard Gange
Resolution: Fixed Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
dependency
depends upon MGNLADVCACHE-116 Site aware caching no longer creates ... Closed
depends upon DOCU-2044 Troubleshooting page for cache issues Closed
depends upon MGNLADVCACHE-110 Improve advanced cache debug/trace lo... Closed
depends upon MGNLCACHE-231 Improve cache debug/trace logging Closed
relation
Template:
Acceptance criteria:
Empty
Task DoD:
[ ]* Doc/release notes changes? Comment present?
[ ]* Downstream builds green?
[ ]* Solution information and context easily available?
[ ]* Tests
[ ]* FixVersion filled and not yet released
[ ]  Architecture Decision Record (ADR)
Documentation update required:
Yes

 Description   

On this page Advanced Cache app module we give users the impression that site aware caching can be turned on by simply checking a box. This is really only part of the configuration required to make it work. Site aware caching is tied to the site definition. Each workspace needs a mapping which has to be created manually. For example, images in the dam will still go into the default cache unless the path they live under has been mapped to a site definition. The default cache is not site aware and will be dumped for all content updates.

Checking the box changes the configuration of the flush policy. What if you have multiple cache configurations? Is this just changing defaultPageCache? This should be clarified. Perhaps even an improvement in the app where I can use a drop down to toggle between configurations.

In the section "How to test" we need to add a link to a new troubleshooting page for cache (see DOCU-2044). Currently site aware caching is not working unless you use the workaround (see MGNLADVCACHE-111). Also, using the interface for verification isn't reliable (see MGNLCACHE-232). Instead users should be able to trace/debug the cache events in the log (see MGNLCACHE-231 & MGNLADVCACHE-110).

Notes
Publishing a home page triggers a complete flush:

2021-06-08 12:48:43,164 INFO  ing.receiver.operation.jcr.JcrPublicationOperation: About to update content under path [/travel].
2021-06-08 12:48:43,387 INFO  r.operation.jcr.JcrTransactionPublicationOperation: 364 User superuser successfully published website:/travel on magnoliaPublic.
2021-06-08 12:48:48,413 TRACE ule.advancedcache.SiteAwareFlushAllListeningPolicy: Cache flushed: sportstation
2021-06-08 12:48:48,427 TRACE ule.advancedcache.SiteAwareFlushAllListeningPolicy: Cache flushed: travel
2021-06-08 12:48:48,431 TRACE info.magnolia.module.cache.FlushAllListeningPolicy: Cache flushed: uuid-key-mapping
2021-06-08 12:48:48,434 TRACE ule.advancedcache.SiteAwareFlushAllListeningPolicy: Cache flushed: defaultPageCache

2021-06-08 12:56:17,172 INFO  ing.receiver.operation.jcr.JcrPublicationOperation: About to update content under path [/travel/tour-type].
2021-06-08 12:56:17,253 INFO  r.operation.jcr.JcrTransactionPublicationOperation: 360 User superuser successfully published website:/travel/tour-type on magnoliaPublic.
2021-06-08 12:56:22,410 TRACE ule.advancedcache.SiteAwareFlushAllListeningPolicy: Cache flushed: travel
2021-06-08 12:56:22,410 TRACE ule.advancedcache.SiteAwareFlushAllListeningPolicy: Cache flushed: defaultPageCache
2021-06-08 12:56:22,410 TRACE info.magnolia.module.cache.FlushAllListeningPolicy: Cache flushed: uuid-key-mapping


 Comments   
Comment by Richard Gange [ 20/Apr/21 ]

Update https://wiki.magnolia-cms.com/display/WIKI/Cache+Debugging once MULTISITE-101 is done.

Comment by Richard Gange [ 31/Aug/21 ]

Added a not to product board which is linked to this ticket. It might be easier if the advanced cache app was consolidated into the site app.

Generated at Sun Feb 11 23:11:08 CET 2024 using Jira 9.4.2#940002-sha1:46d1a51de284217efdcb32434eab47a99af2938b.