mirrors
/
TiddlyWiki5
mirror of https://github.com/Jermolene/TiddlyWiki5
1
0
Fork 0
Code Issues Releases Wiki Activity

Docs: Add performance instrumentation docs

This commit is contained in:
Jermolene 2019-03-16 16:39:08 +00:00
parent a7dc8b5583
commit 05243a6c48
2 changed files with 33 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
editions/tw5.com/tiddlers/features/Performance Instrumentation.tid Normal file
View File

@ -0,0 +1,31 @@
created: 20190316163428191
modified: 20190316163657710
tags: Features
title: Performance Instrumentation
type: text/vnd.tiddlywiki
The core has built-in performance instrumentation for the refresh cycle. See “Performance Instrumentation” on the “Settings” tab of control panel. The wiki will need to be reloaded before it takes effect.
With performance instrumentation switched on, there is additional timing information displayed the browser developer console each time a refresh cycle is triggered. For example:
```
performance: mainRender: 327.83ms
performance: +filter: 49.70ms
performance: styleRefresh: 9.14ms
performance: +filter: 2.46ms
performance: mainRefresh: 68.10ms
performance: +filter: 37.69ms
```
The information above should be interpreted as follows:
<<<
"Initial rendering of the main page took 327ms (of which 50ms was filter evaluation). Refreshing the page stylesheet took 9ms (of which 2ms was filter evaluation). Refreshing the main page took 68ms (of which 38ms was filter evaluation)"
<<<
* mainRender is the time taken for the initial display of the page template
* styleRefresh is the time taken to refresh the page stylesheet
* mainRender is the time taken to refresh the main page template
* in each case, +filter denotes the time taken up with filter evaluation.
As an example, try switching between the sidebar tabs to compare how long they take to render.

3
editions/tw5.com/tiddlers/workingwithtw/Performance.tid
View File

@ -1,5 +1,5 @@
created: 20150330155120127
modified: 20160607145222633
modified: 20190316163827303
tags: [[Working with TiddlyWiki]]
title: Performance
type: text/vnd.tiddlywiki
@ -10,3 +10,4 @@ TiddlyWiki ships with defaults that are designed to get the best out of modern d
* ''Use the "Vanilla" theme''. The default "Snow White" theme includes visual effects like shadows, transparency and blurring that can be slow to render on older devices
* ''Avoid large tiddlers''. Large bitmaps can significantly slow TiddlyWiki's performance. For example, an image taken with a modern smartphone will often be 5MB or more. Use ExternalImages whenever possible
* ''Don't have too many tiddlers open at once''. Every tiddler you have open will require processing to keep it up to date as the store changes (for example, while you type into a draft tiddler). It is particularly easy when using zoomin story view to end up with dozens of tiddlers listed in the ''Open'' tab in the sidebar. Get into the habit of periodically closing all open tiddlers with the {{$:/core/images/close-all-button}} ''close all'' button
* ''Use the built-in performance instrumentation''. Studying the [[performance instrumentation|Performance Instrumentation]] results can help highlight performance problems