Wiki source code of Performance
Version 40.1 by Thomas Mortagne on 2014/08/29
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | {{box cssClass="floatinginfobox" title="**Contents**"}} | ||
| 2 | {{toc/}} | ||
| 3 | {{/box}} | ||
| 4 | |||
| 5 | Here are some tips to increase XWiki's performance. | ||
| 6 | |||
| 7 | = Gzip compression and caching of static pages = | ||
| 8 | |||
| 9 | We're working on making these features part of the XWiki core (see [[XWIKI-2022>>http://jira.xwiki.org/jira/browse/XWIKI-2022]]). While waiting for this to be natively implemented, the recommended solution is to set up an Apache Web Server in front of your servlet container and install/configure the following modules: | ||
| 10 | |||
| 11 | * [[mod-deflate>>http://httpd.apache.org/docs/2.0/mod/mod_deflate.html]] | ||
| 12 | * [[mod-expire>>http://httpd.apache.org/docs/2.0/mod/mod_expires.html]] | ||
| 13 | * [[mod-proxy-ajp>>http://httpd.apache.org/docs/2.2/mod/mod_proxy_ajp.html]] (note that this depends on [[mod-proxy>>http://httpd.apache.org/docs/2.2/mod/mod_proxy.html]] that you also need to install) | ||
| 14 | |||
| 15 | Modify your Apache configuration file to load the different modules: | ||
| 16 | |||
| 17 | {{code language="none"}} | ||
| 18 | LoadModule expires_module /usr/lib/apache2/modules/mod_expires.so | ||
| 19 | LoadModule deflate_module /usr/lib/apache2/modules/mod_deflate.so | ||
| 20 | LoadModule proxy_module /usr/lib/apache2/modules/mod_proxy.so | ||
| 21 | # Depends: proxy | ||
| 22 | LoadModule proxy_ajp_module /usr/lib/apache2/modules/mod_proxy_ajp.so | ||
| 23 | {{/code}} | ||
| 24 | |||
| 25 | //Alternatively you can run the following commands as root (sudo)// | ||
| 26 | |||
| 27 | {{code language="bash"}} | ||
| 28 | a2enmod deflate | ||
| 29 | a2enmod proxy_ajp | ||
| 30 | a2enmod expires | ||
| 31 | {{/code}} | ||
| 32 | |||
| 33 | and configure your different modules as described below: | ||
| 34 | |||
| 35 | == Mod Deflate Configuration == | ||
| 36 | |||
| 37 | {{code language="none"}} | ||
| 38 | vwwwpro-1:~# cat /etc/apache2/conf.d/deflate | ||
| 39 | <Location /> | ||
| 40 | # Insert filter | ||
| 41 | SetOutputFilter DEFLATE | ||
| 42 | |||
| 43 | # Netscape 4.x has some problems... | ||
| 44 | BrowserMatch ^Mozilla/4 gzip-only-text/html | ||
| 45 | |||
| 46 | # Netscape 4.06-4.08 have some more problems | ||
| 47 | BrowserMatch ^Mozilla/4.0[678] no-gzip | ||
| 48 | |||
| 49 | # MSIE masquerades as Netscape, but it is fine | ||
| 50 | # BrowserMatch bMSIE !no-gzip !gzip-only-text/html | ||
| 51 | |||
| 52 | # NOTE: Due to a bug in mod_setenvif up to Apache 2.0.48 | ||
| 53 | # the above regex won't work. You can use the following | ||
| 54 | # workaround to get the desired effect: | ||
| 55 | BrowserMatch bMSI[E] !no-gzip !gzip-only-text/html | ||
| 56 | |||
| 57 | # Don't compress images | ||
| 58 | SetEnvIfNoCase Request_URI .(?:gif|jpe?g|png)$ no-gzip dont-vary | ||
| 59 | |||
| 60 | # Make sure proxies don't deliver the wrong content | ||
| 61 | #Header append Vary User-Agent env=!dont-vary | ||
| 62 | </Location> | ||
| 63 | {{/code}} | ||
| 64 | |||
| 65 | //On debian apache2 the config file for deflate is located under /etc/apache2/mods-enabled/deflate.conf// | ||
| 66 | |||
| 67 | == Mod Expire Configuration == | ||
| 68 | |||
| 69 | {{code language="none"}} | ||
| 70 | vwwwpro-1:~# cat /etc/apache2/conf.d/expires | ||
| 71 | <Location /xwiki/skins/> | ||
| 72 | ExpiresActive on | ||
| 73 | ExpiresDefault "access plus 1 day" | ||
| 74 | </Location> | ||
| 75 | |||
| 76 | <Location /xwiki/bin/skin/> | ||
| 77 | ExpiresActive on | ||
| 78 | ExpiresDefault "access plus 1 day" | ||
| 79 | </Location> | ||
| 80 | {{/code}} | ||
| 81 | |||
| 82 | == Mod Proxy AJP Configuration == | ||
| 83 | |||
| 84 | {{code language="none"}} | ||
| 85 | ProxyRequests Off | ||
| 86 | <Proxy *> | ||
| 87 | Order deny,allow | ||
| 88 | Allow from all | ||
| 89 | </Proxy> | ||
| 90 | ProxyPreserveHost On | ||
| 91 | ProxyPass /xwiki ajp://192.168.1.181:8009/xwiki | ||
| 92 | {{/code}} | ||
| 93 | |||
| 94 | where ##ajp:~/~/192.168.1.181:8009/xwiki## is the internal address of your Servlet container where XWiki is running. | ||
| 95 | |||
| 96 | If you use Tomcat(7) you need to enable the ajp connector in the /etc/tomcat7/server.xml. Comment out the following line with adding {{code}}<!-- -->{{/code}}. //Maybe give a comment why you did it.// | ||
| 97 | |||
| 98 | {{code}} | ||
| 99 | <!-- disable to use ajp connector instead | ||
| 100 | <Connector port="8080" protocol="HTTP/1.1" | ||
| 101 | connectionTimeout="20000" | ||
| 102 | URIEncoding="UTF-8" | ||
| 103 | redirectPort="8443" /> | ||
| 104 | --> | ||
| 105 | {{/code}} | ||
| 106 | |||
| 107 | Uncomment the following line by removing the {{code}}<!-- -->{{/code}} and add {{code}}URIEncoding="UTF-8"{{/code}} to it.Maybe give a comment too. | ||
| 108 | |||
| 109 | {{code}} | ||
| 110 | <!-- Activate ajp connector for apache proxy_ajp --> | ||
| 111 | <Connector port="8009" protocol="AJP/1.3" redirectPort="8443" URIEncoding="UTF-8"/> | ||
| 112 | {{/code}} | ||
| 113 | |||
| 114 | = Memory = | ||
| 115 | |||
| 116 | You need to configure your Servlet container so that XWiki has enough memory. You'll need to tune the value to your need. You should check the logs and see if there are any "out of memory" errors. Here are some good default values: | ||
| 117 | |||
| 118 | * Small installs: A minimum of 300MB of heap memory and 196MB of permGen (##-Xmx300m -XX:MaxPermSize=196m##) | ||
| 119 | * Medium installs: 512MB for the heap and 196MB of permGen (##-Xmx512m -XX:MaxPermSize=196m##) | ||
| 120 | * Large installs: 800MB for the heap and 196MB of permGen (##-Xmx800m -XX:MaxPermSize=196m##). Try not to ge beyond 1024MB since adding more memory means more GC time and thus lower performance. | ||
| 121 | |||
| 122 | {{warning}} | ||
| 123 | Note that storing attachments with the default (in database) storage mechanism is very memory intensive. See the [[administrators guide to attachments>>platform:AdminGuide.Attachments]] for more information about memory cost and the alternative filesystem based attachment store. | ||
| 124 | |||
| 125 | Also note that uploading a lot of pages can trigger out of memory (OOM) errors due to scheduled watchlist jobs. For example uploading 1 million pages will trigger OOM errors even when the JVM is configured to run with 2GB of heap space. For such kind of load we recommend to disable (unschedule) the Watchlist jobs (in ##/xwiki/bin/view/Scheduler/##) before uploading the pages. | ||
| 126 | {{/warning}} | ||
| 127 | |||
| 128 | For your information here are the values used for the xwiki.org site: | ||
| 129 | |||
| 130 | {{code}} | ||
| 131 | CATALINA_OPTS="-server -Xms800m -Xmx800m -XX:MaxPermSize=196m -Dfile.encoding=utf-8 -Djava.awt.headless=true -XX:+UseParallelGC -XX:MaxGCPauseMillis=100" | ||
| 132 | {{/code}} | ||
| 133 | |||
| 134 | = Database Indexes = | ||
| 135 | |||
| 136 | Make sure you've set [[Database indexes>>Database Administration]]. This is especially important when you start having lots of documents. | ||
| 137 | |||
| 138 | = Panels = | ||
| 139 | |||
| 140 | Some panels take more resources than others. For example the Navigation panel should NOT be used for wikis with a lot of documents since it displays all documents in the wiki. In the future that panel should be improved for performance but that's not the case right now. Originally this panel was only meant as a starting point. A better approach is to use a "Quick Links Panel" as we've now set up in the default XWiki Enterprise wiki version 1.1 (we've removed the default usage of the Navigation Panel in that version). | ||
| 141 | |||
| 142 | = Robots.txt = | ||
| 143 | |||
| 144 | If your wiki is open on the Internet, it'll be crawled by search robots (like GoogleBot, etc). They will call all the URLs and especially the ones that are resource hungry like exports (PDF/RTF). You need to protect against this. To do so configure a ##robots.txt## file like this one and put it in your webserver configuration: | ||
| 145 | |||
| 146 | {{code language="none"}} | ||
| 147 | User-agent: * | ||
| 148 | Disallow: /xwiki/bin/attach/ | ||
| 149 | Disallow: /xwiki/bin/cancel/ | ||
| 150 | Disallow: /xwiki/bin/commentadd/ | ||
| 151 | Disallow: /xwiki/bin/delattachment/ | ||
| 152 | Disallow: /xwiki/bin/delete/ | ||
| 153 | Disallow: /xwiki/bin/dot/ | ||
| 154 | Disallow: /xwiki/bin/download/ | ||
| 155 | Disallow: /xwiki/bin/downloadrev/ | ||
| 156 | Disallow: /xwiki/bin/edit/ | ||
| 157 | Disallow: /xwiki/bin/export/ | ||
| 158 | Disallow: /xwiki/bin/get/ | ||
| 159 | Disallow: /xwiki/bin/inline/ | ||
| 160 | Disallow: /xwiki/bin/lifeblog/ | ||
| 161 | Disallow: /xwiki/bin/login/ | ||
| 162 | Disallow: /xwiki/bin/loginerror/ | ||
| 163 | Disallow: /xwiki/bin/logout/ | ||
| 164 | Disallow: /xwiki/bin/objectremove/ | ||
| 165 | Disallow: /xwiki/bin/pdf/ | ||
| 166 | Disallow: /xwiki/bin/preview/ | ||
| 167 | Disallow: /xwiki/bin/propadd/ | ||
| 168 | Disallow: /xwiki/bin/propdelete/ | ||
| 169 | Disallow: /xwiki/bin/propupdate/ | ||
| 170 | Disallow: /xwiki/bin/register/ | ||
| 171 | Disallow: /xwiki/bin/save/ | ||
| 172 | Disallow: /xwiki/bin/skin/ | ||
| 173 | Disallow: /xwiki/bin/status/ | ||
| 174 | Disallow: /xwiki/bin/upload/ | ||
| 175 | Disallow: /xwiki/bin/viewattachrev/ | ||
| 176 | Disallow: /xwiki/bin/viewrev/ | ||
| 177 | Disallow: /xwiki/bin/xmlrpc/ | ||
| 178 | # It could be also usefull to block certain spaces from crawling, | ||
| 179 | # especially if this spaces doesn't provide new content | ||
| 180 | Disallow: /xwiki/bin/view/Main/ | ||
| 181 | Disallow: /xwiki/bin/view/XWiki/ | ||
| 182 | # on the other hand you would like to have your recent (public) changes included | ||
| 183 | Allow: /xwiki/bin/view/Main/Dashboard | ||
| 184 | {{/code}} | ||
| 185 | |||
| 186 | |||
| 187 | **Note:** | ||
| 188 | |||
| 189 | For Tomcat6 the placement of the ##robots.txt## file should be within the //$TOMCAT/webapps/ROOT// folder and should have permission 644 applied. | ||
| 190 | |||
| 191 | {{code}} | ||
| 192 | -rw-r--r-- 1 root www 1478 Jan 8 15:52 robots.txt | ||
| 193 | {{/code}} | ||
| 194 | |||
| 195 | In order to test if the ##robots.txt## file is either accessable or working as desired use this [[checker>>http://www.frobee.com/robots-txt-check]]. | ||
| 196 | |||
| 197 | = Statistics = | ||
| 198 | |||
| 199 | {{info}} | ||
| 200 | This is no longer true starting with XE 1.4M2 since statistics are now put on a queue and written in a different thread in the database in one go, thus reducing the overhead to a maximum. | ||
| 201 | {{/info}} | ||
| 202 | |||
| 203 | The statistics module is off by default since it's quite database intensive. If you don't need it you should turn it off. | ||
| 204 | |||
| 205 | = Monitoring = | ||
| 206 | |||
| 207 | More a developer-oriented feature, XWiki can monitor its own code, reporting the time spent for each sub-component activated during a request. While the monitoring code isn't time consuming, it increases the memory consumption a bit, and the create/start/stop/log/destroy calls are spread all around the code, so you will save a lot of method calls by disabling this. You can do that by setting the following line in ##xwiki.cfg##: | ||
| 208 | |||
| 209 | {{code language="null"}} | ||
| 210 | xwiki.monitor=0 | ||
| 211 | {{/code}} | ||
| 212 | |||
| 213 | = Cache sizes = | ||
| 214 | |||
| 215 | Tune the document cache in ##xwiki.cfg##. The value depends on how much memory you have. The higher the better. A good reasonable value is 1000. | ||
| 216 | |||
| 217 | {{code language="none"}} | ||
| 218 | xwiki.store.cache.capacity=1000 | ||
| 219 | {{/code}} | ||
| 220 | |||
| 221 | = Cache Macro = | ||
| 222 | |||
| 223 | It's possible to perform selective content caching by using the [[Cache Macro>>extensions:Extension.Cache Macro]]. | ||
| 224 | |||
| 225 | = Rendering cache = | ||
| 226 | |||
| 227 | Some pages are complex to render (they may aggregate outside data for example or do complex and slow queries). For theses pages you can use rendering cache. | ||
| 228 | |||
| 229 | == Configuration based == | ||
| 230 | |||
| 231 | Pages can be cached (i.e. their rendered content cached) to speed up displaying. The configuration is done in ##xwiki.properties## with the following configuration options: | ||
| 232 | |||
| 233 | {{code language="none"}} | ||
| 234 | #-# [Since 2.4M1] | ||
| 235 | #-# Indicate if the rendering cache is enabled. | ||
| 236 | #-# Default value is false. | ||
| 237 | # core.renderingcache.enabled=true | ||
| 238 | |||
| 239 | #-# [Since 2.4M1] | ||
| 240 | #-# A list of Java regex patterns matching full documents reference. | ||
| 241 | # core.renderingcache.documents=wiki:Space\.Page | ||
| 242 | # core.renderingcache.documents=wiki:Space\..* | ||
| 243 | |||
| 244 | #-# [Since 2.4M1] | ||
| 245 | #-# The time (in seconds) after which data should be removed from the cache when not used. | ||
| 246 | #-# Default value is 300 (5 min). | ||
| 247 | # core.renderingcache.duration=300 | ||
| 248 | |||
| 249 | #-# [Since 2.4M1] | ||
| 250 | #-# The size of the rendering cache. Not that it's not the number of cached documents but the number of cached results. | ||
| 251 | #-# (For a single document several cache entries are created, because each action, language and request query string | ||
| 252 | #-# produces a unique rendering result) | ||
| 253 | #-# Default value is 100. | ||
| 254 | # core.renderingcache.size=100 | ||
| 255 | {{/code}} | ||
| 256 | |||
| 257 | You can force a page to refresh using ##refresh=1## in the URL. | ||
| 258 | |||
| 259 | Since 6.2 it's also possible to programmatically refresh any document cache using the following API: | ||
| 260 | |||
| 261 | {{code language="java"}} | ||
| 262 | @Inject | ||
| 263 | private RenderingCache renderingCache; | ||
| 264 | |||
| 265 | ... | ||
| 266 | |||
| 267 | renderingCache.flushWholeCache(); | ||
| 268 | renderingCache.flushCache(new DocumentReference("xwiki", "MySpace", "MyCachedDocument")); | ||
| 269 | {{/code}} | ||
| 270 | |||
| 271 | == Enabled using velocity in document content itself (XWiki 1.0 syntax only) == | ||
| 272 | |||
| 273 | You can add the following to their content to cache them after they are rendered. Note that the document is refreshed whenever the content of the document changes, and the cache takes into account the URL, so it is pretty safe to add a long cache duration for all documents that don't contain scripts gathering data from the wiki. For example to cache the rendered content for 60 seconds you would add: | ||
| 274 | |||
| 275 | {{code language="none"}} | ||
| 276 | $context.setCacheDuration(60) | ||
| 277 | {{/code}} | ||
| 278 | |||
| 279 | Since 1.5M2, you can set the default rendering cache duration for all pages in ##xwiki.cfg##: | ||
| 280 | |||
| 281 | {{code language="none"}} | ||
| 282 | ## cache all rendered documents for one hour | ||
| 283 | xwiki.rendering.defaultCacheDuration=3600 | ||
| 284 | {{/code}} | ||
| 285 | |||
| 286 | Setting the default cache duration to a large value, and manually disabling the cache in dynamic pages would really speed up the wiki, since the rendering is one of the most time consuming processes. | ||
| 287 | |||
| 288 | = Merge the CSS files = | ||
| 289 | |||
| 290 | In order to reduce the number of requests and files that are downloaded from the browser or client, it could help to merge all XWiki CSS files into a single one. See the [[Merge CSS Script>>extensions:Extension.Merge CSS]]. | ||
| 291 | |||
| 292 | = Set up NginX = | ||
| 293 | |||
| 294 | If you experience //__heavy loads__// on your wiki, you could try using NginX. | ||
| 295 | |||
| 296 | NginX is used to fetch static content: images, javascript, styles, etc, but it can also be used as a reverse-proxy to pass requests down to the web container (e.g. Tomcat on port 8080). | ||
| 297 | |||
| 298 | Unlike Apache, which instantiates a new process per every static file, NginX uses the same process to fetch all the static data, and thus gives you extra perfomance "for free". | ||
| 299 | |||
| 300 | For more info on setting up NginX check [[this guide>>NginX]]. | ||
| 301 | |||
| 302 | = Backlinks = | ||
| 303 | |||
| 304 | While a pretty neat feature, keeping track of the backlinks has a medium impact on the document saving time and a minor impact on the document loading time. If you feel that your wiki does not need backlinks, you can safely disable them with the following line in ##xwiki.cfg##: | ||
| 305 | |||
| 306 | {{code language="none"}} | ||
| 307 | xwiki.backlinks=0 | ||
| 308 | {{/code}} | ||
| 309 | |||
| 310 | = Versioning = | ||
| 311 | |||
| 312 | One of the key features of any wiki system, versioning greatly affects the database size and the document update time. If you are sure your wiki does not need to keep track of all the changes and you will never need to revert documents to a previous version, then you can add the following line in ##xwiki.cfg##: | ||
| 313 | |||
| 314 | {{code language="none"}} | ||
| 315 | xwiki.store.versioning=0 | ||
| 316 | {{/code}} | ||
| 317 | |||
| 318 | = Custom Mapping = | ||
| 319 | |||
| 320 | In some cases you may not want to rely on XWiki's generic database schema for storing XClass data and instead you'd like to provide your own optimized table. For these use cases you can use [[Custom Mapping>>platform:DevGuide.CustomMapping]]. | ||
| 321 | |||
| 322 | = Wiki syntax features for XWiki Syntax 1.0 = | ||
| 323 | |||
| 324 | If you don't plan to use all of the wiki features, like the --strikethrough-- filter, the automatic http links filter, the SVG, Laszlo or style macros, you can disable them in ##xwiki-core-*.jar/META-INF/services/com.xpn.xwiki.render.*##. The wiki rendering is the most costly operation in the rendering process, so any disabled feature counts. |
