Note: You are currently viewing documentation for Moodle 3.9. Up-to-date documentation for the latest stable version of Moodle may be available here: Performance overview.

Performance overview: Difference between revisions

From MoodleDocs
(Performance overview proposal page)
 
(Check API developer docs link (MDL-68185))
 
(13 intermediate revisions by 7 users not shown)
Line 1: Line 1:
This Moodle performance overview proposal page is created in response to Moodle issue [http://tracker.moodle.org/browse/MDL-35716 MDL-35716]
{{Performance}}
The performance overview report in ''Site administration > Reports > Performance overview'' lists issues which may affect performance of the site.


The general problem from the issue seems to be the related to users not having insight into what configuration settings they have turned on or off that may affect Moodle performance.
[[File:performance overview.png|thumb|400px|center|Performance overview report]]


My proposed solution is to create a "Performance overview" page, similar to the existing "Security overview" page that lists performance-related configuration settings for a Moodle site, along with a suggestion to what the setting should be set, and allow the user to modify individual settings by visiting the setting's link.
For each of the issues, it is possible to edit the setting by clicking the icon and either enable or disable it. Reasons are given for keeping the settings as defaut and the consequences of changing them.


I've added a link to a UI screenshot of what this can look like. It lists just some of the possible configuration settings that relate to performance. A new "Performance overview" page is added in the settings block:
==See also==
Site Administration > Reports > Performance overview


The table has three fields: configuration setting, value and suggestion. All of the settings listed on the page are configuration settings that may be relevant to Moodle performance (eg. Javascript caching). The "value" column indicates the value of the current setting ("enabled", "disabled" or something else). The "suggestion" column is a general suggestion to what the setting should be set for best performance. The values under the "configuration setting" column are all links that point to a Moodle configuration page where the user can change that particular setting.
* MDL-35716 for discussion of items in the report
* [[:dev:Check API|Check API]] developer docs


UI screenshot:
[[Category:Report]]
https://docs.moodle.org/24/en/images_en/thumb/a/a9/moodle.png/800px-moodle.png


One issue with creating this performance overview page is with how performance improvement suggestions are subjective. Changing the value of one particular setting may impact Moodle performance differently depending in what environment it's in. Therefore, these would be suggestions that will "generally" improve Moodle performance.
[[es:Vista general sobre desempeño]]
 
[[de:Performanceübersicht]]
Currently this design requires no database modifications to Moodle except maybe an addition to capabilities/permissions defined in access.php.
[[fr:Panorama de performance]]

Latest revision as of 07:08, 4 August 2020

The performance overview report in Site administration > Reports > Performance overview lists issues which may affect performance of the site.

Performance overview report

For each of the issues, it is possible to edit the setting by clicking the icon and either enable or disable it. Reasons are given for keeping the settings as defaut and the consequences of changing them.

See also