[MAGNOLIA-9083] Doc: Create a large scale content guide Created: 07/Sep/23  Updated: 07/Feb/24

Status: Open
Project: Magnolia
Component/s: None
Affects Version/s: None
Fix Version/s: None

Type: Epic Priority: Neutral
Reporter: Michael Duerig Assignee: Alex Mansell
Resolution: Unresolved Votes: 0
Labels: performance
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Template:
Epic Name: large scale content
Acceptance criteria:
Empty
Date of First Response:

 Description   

We have some information regarding performance scattered across documentation. However, for customers with larger installations we should have a dedicated guide on performance collating all relevant points in a single location.

Repo for notes and ideas:

https://git.magnolia-cms.com/projects/DOCUMENTATION/repos/performance-content-guide-notes/browse

Questions for discovery

  • Collect Wikis, doc pages, tickets, etc. giving recommendations re. performance and scalability.
  • Can we plug into srhodes's auditing platform for checking performance best practices on a project basis? 
  • Notes from initial discussion.

Discvovery

  • From this GSheet:
    • We have seen customers invariably need to tune the memory and cache size of their Magnolia instance and lacking the expertise to do so. The documentation states recommended values that are not upheld in the example code. Example: Best Practices Documentation states "Using a magnoliaAuthor.setenv.memory.maxPercentage value of 60 (the default value)", but the example code given in https://docs.magnolia-cms.com/paas/deployment/webapp_deployment.html has 80% configured. This leads to customers needing to tune a value that they have never touched. https://docs.magnolia-cms.com/paas/best-practices/memory_resources.html
    • We don't have any scalability metrics on Magnolia PaaS.
      We have a scaling guide for on-prem but we should have sizings for infrastructure to show customers best practise. Some information is available from the best practices chapters of the PaaS documentation.
    • According to awarinner DAM problems are mostly about sizing and growing out of an internal JCR based DAM sooner than expected. We need to take this into account when writing the large scale content guide (i.e. by emphasising the importance to not underestimate future growth).
  • See the comment from Jan 9-th 2024 from mdrapela  for some more links to existing documentation to review.
  • New monitoring endpoints for monitoring repository and query statistics: MAGNOLIA-9184, MAGNOLIA-9183
  • Collect and document useful performance related metrics


 Comments   
Comment by Julie Legendre [ 05/Oct/23 ]

Server sizing guide: https://docs.google.com/spreadsheets/d/1Xg6N9VDN1fnCyvEcGcvJc9PmTGG6eMHorzErxIMrqOY/edit#gid=2106293842

Generated at Mon Feb 12 04:38:26 CET 2024 using Jira 9.4.2#940002-sha1:46d1a51de284217efdcb32434eab47a99af2938b.