Skip to Content

Wiki source code of Performance

Version 45.1 by Thomas Mortagne on 2015/01/17
Show last authors
1 {{box cssClass="floatinginfobox" title="**Contents**"}}
2 {{toc/}}
3 {{/box}}
4
5 Here are some tips to increase XWiki's performance.
6
7 = Slow random number generation on UNIX =
8
9 The library used for random number generation in Sun's JVM relies on /dev/random by default for UNIX platforms.
10
11 Although /dev/random is more secure, it's possible te use /dev/urandom if the default JVM configuration instead.
12
13 To determine if your operating system exhibits this behavior, try displaying a portion of the file from a shell prompt:
14
15 {{code language="bash"}}
16 head -n 1 /dev/random
17 {{/code}}
18
19 If the command returns immediately, you can use /dev/random as the default generator for SUN's JVM. If the command does not return immediately, use these steps to configure the JVM to use /dev/urandom:
20
21 1. Open the ##$JAVA_HOME/jre/lib/security/java.security## file in a text editor.
22 1. Change the line:
23 {{code language="properties"}}
24 securerandom.source=file:/dev/random
25 {{/code}}
26 to read:
27 {{code language="properties"}}
28 securerandom.source=file:/dev/urandom
29 {{/code}}
30 1. Save your change and exit the text editor.
31
32 = Gzip compression and caching of static pages =
33
34 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:
35
36 * [[mod-deflate>>http://httpd.apache.org/docs/2.0/mod/mod_deflate.html]]
37 * [[mod-expire>>http://httpd.apache.org/docs/2.0/mod/mod_expires.html]]
38 * [[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)
39
40 Modify your Apache configuration file to load the different modules:
41
42 {{code language="none"}}
43 LoadModule expires_module /usr/lib/apache2/modules/mod_expires.so
44 LoadModule deflate_module /usr/lib/apache2/modules/mod_deflate.so
45 LoadModule proxy_module /usr/lib/apache2/modules/mod_proxy.so
46 # Depends: proxy
47 LoadModule proxy_ajp_module /usr/lib/apache2/modules/mod_proxy_ajp.so
48 {{/code}}
49
50 //Alternatively you can run the following commands as root (sudo)//
51
52 {{code language="bash"}}
53 a2enmod deflate
54 a2enmod proxy_ajp
55 a2enmod expires
56 {{/code}}
57
58 and configure your different modules as described below:
59
60 == Mod Deflate Configuration ==
61
62 {{code language="none"}}
63 vwwwpro-1:~# cat /etc/apache2/conf.d/deflate
64 <Location />
65 # Insert filter
66 SetOutputFilter DEFLATE
67
68 # Netscape 4.x has some problems...
69 BrowserMatch ^Mozilla/4 gzip-only-text/html
70
71 # Netscape 4.06-4.08 have some more problems
72 BrowserMatch ^Mozilla/4.0[678] no-gzip
73
74 # MSIE masquerades as Netscape, but it is fine
75 # BrowserMatch bMSIE !no-gzip !gzip-only-text/html
76
77 # NOTE: Due to a bug in mod_setenvif up to Apache 2.0.48
78 # the above regex won't work. You can use the following
79 # workaround to get the desired effect:
80 BrowserMatch bMSI[E] !no-gzip !gzip-only-text/html
81
82 # Don't compress images
83 SetEnvIfNoCase Request_URI .(?:gif|jpe?g|png)$ no-gzip dont-vary
84
85 # Make sure proxies don't deliver the wrong content
86 #Header append Vary User-Agent env=!dont-vary
87 </Location>
88 {{/code}}
89
90 //On debian apache2 the config file for deflate is located under /etc/apache2/mods-enabled/deflate.conf//
91
92 == Mod Expire Configuration ==
93
94 {{code language="none"}}
95 vwwwpro-1:~# cat /etc/apache2/conf.d/expires
96 <Location /xwiki/skins/>
97 ExpiresActive on
98 ExpiresDefault "access plus 1 day"
99 </Location>
100
101 <Location /xwiki/bin/skin/>
102 ExpiresActive on
103 ExpiresDefault "access plus 1 day"
104 </Location>
105 {{/code}}
106
107 == Mod Proxy AJP Configuration ==
108
109 {{code language="none"}}
110 ProxyRequests Off
111 <Proxy *>
112 Order deny,allow
113 Allow from all
114 </Proxy>
115 ProxyPreserveHost On
116 ProxyPass /xwiki ajp://192.168.1.181:8009/xwiki
117 {{/code}}
118
119 where ##ajp:~/~/192.168.1.181:8009/xwiki## is the internal address of your Servlet container where XWiki is running.
120
121 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.//
122
123 {{code}}
124 <!-- disable to use ajp connector instead
125 <Connector port="8080" protocol="HTTP/1.1"
126 connectionTimeout="20000"
127 URIEncoding="UTF-8"
128 redirectPort="8443" />
129 -->
130 {{/code}}
131
132 Uncomment the following line by removing the {{code}}<!-- -->{{/code}} and add {{code}}URIEncoding="UTF-8"{{/code}} to it.Maybe give a comment too.
133
134 {{code}}
135 <!-- Activate ajp connector for apache proxy_ajp -->
136 <Connector port="8009" protocol="AJP/1.3" redirectPort="8443" URIEncoding="UTF-8"/>
137 {{/code}}
138
139 = Memory =
140
141 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:
142
143 * Small installs: A minimum of 300MB of heap memory and 196MB of permGen (##-Xmx300m -XX:MaxPermSize=196m##)
144 * Medium installs: 512MB for the heap and 196MB of permGen (##-Xmx512m -XX:MaxPermSize=196m##)
145 * 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.
146
147 {{warning}}
148 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.
149
150 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.
151 {{/warning}}
152
153 For your information here are the values used for the xwiki.org site:
154
155 {{code}}
156 CATALINA_OPTS="-server -Xms800m -Xmx800m -XX:MaxPermSize=196m -Dfile.encoding=utf-8 -Djava.awt.headless=true -XX:+UseParallelGC -XX:MaxGCPauseMillis=100"
157 {{/code}}
158
159 = Database Indexes =
160
161 Make sure you've set [[Database indexes>>Database Administration]]. This is especially important when you start having lots of documents.
162
163 = Panels =
164
165 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).
166
167 = Robots.txt =
168
169 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:
170
171 {{code language="none"}}
172 User-agent: *
173 Disallow: /xwiki/bin/attach/
174 Disallow: /xwiki/bin/cancel/
175 Disallow: /xwiki/bin/commentadd/
176 Disallow: /xwiki/bin/delattachment/
177 Disallow: /xwiki/bin/delete/
178 Disallow: /xwiki/bin/dot/
179 Disallow: /xwiki/bin/download/
180 Disallow: /xwiki/bin/downloadrev/
181 Disallow: /xwiki/bin/edit/
182 Disallow: /xwiki/bin/export/
183 Disallow: /xwiki/bin/get/
184 Disallow: /xwiki/bin/inline/
185 Disallow: /xwiki/bin/lifeblog/
186 Disallow: /xwiki/bin/login/
187 Disallow: /xwiki/bin/loginerror/
188 Disallow: /xwiki/bin/logout/
189 Disallow: /xwiki/bin/objectremove/
190 Disallow: /xwiki/bin/pdf/
191 Disallow: /xwiki/bin/preview/
192 Disallow: /xwiki/bin/propadd/
193 Disallow: /xwiki/bin/propdelete/
194 Disallow: /xwiki/bin/propupdate/
195 Disallow: /xwiki/bin/register/
196 Disallow: /xwiki/bin/save/
197 Disallow: /xwiki/bin/skin/
198 Disallow: /xwiki/bin/status/
199 Disallow: /xwiki/bin/upload/
200 Disallow: /xwiki/bin/viewattachrev/
201 Disallow: /xwiki/bin/viewrev/
202 Disallow: /xwiki/bin/xmlrpc/
203 # It could be also usefull to block certain spaces from crawling,
204 # especially if this spaces doesn't provide new content
205 Disallow: /xwiki/bin/view/Main/
206 Disallow: /xwiki/bin/view/XWiki/
207 # on the other hand you would like to have your recent (public) changes included
208 Allow: /xwiki/bin/view/Main/Dashboard
209 {{/code}}
210
211
212 **Note:**
213
214 For Tomcat6 the placement of the ##robots.txt## file should be within the //$TOMCAT/webapps/ROOT// folder and should have permission 644 applied.
215
216 {{code}}
217 -rw-r--r-- 1 root www 1478 Jan 8 15:52 robots.txt
218 {{/code}}
219
220 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]].
221
222 = Statistics =
223
224 {{info}}
225 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.
226 {{/info}}
227
228 The statistics module is off by default since it's quite database intensive. If you don't need it you should turn it off.
229
230 = Monitoring =
231
232 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##:
233
234 {{code language="null"}}
235 xwiki.monitor=0
236 {{/code}}
237
238 = Cache sizes =
239
240 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.
241
242 {{code language="none"}}
243 xwiki.store.cache.capacity=1000
244 {{/code}}
245
246 = Cache Macro =
247
248 It's possible to perform selective content caching by using the [[Cache Macro>>extensions:Extension.Cache Macro]].
249
250 = Rendering cache =
251
252 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.
253
254 == Configuration based ==
255
256 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:
257
258 {{code language="none"}}
259 #-# [Since 2.4M1]
260 #-# Indicate if the rendering cache is enabled.
261 #-# Default value is false.
262 # core.renderingcache.enabled=true
263
264 #-# [Since 2.4M1]
265 #-# A list of Java regex patterns matching full documents reference.
266 # core.renderingcache.documents=wiki:Space\.Page
267 # core.renderingcache.documents=wiki:Space\..*
268
269 #-# [Since 2.4M1]
270 #-# The time (in seconds) after which data should be removed from the cache when not used.
271 #-# Default value is 300 (5 min).
272 # core.renderingcache.duration=300
273
274 #-# [Since 2.4M1]
275 #-# The size of the rendering cache. Not that it's not the number of cached documents but the number of cached results.
276 #-# (For a single document several cache entries are created, because each action, language and request query string
277 #-# produces a unique rendering result)
278 #-# Default value is 100.
279 # core.renderingcache.size=100
280 {{/code}}
281
282 You can force a page to refresh using ##refresh=1## in the URL.
283
284 Since 6.2 it's also possible to programmatically refresh any document cache using ##com.xpn.xwiki.internal.cache.rendering.RenderingCache## component:
285
286 {{code language="java"}}
287 @Inject
288 private RenderingCache renderingCache;
289
290 ...
291
292 renderingCache.flushWholeCache();
293 renderingCache.flushCache(new DocumentReference("xwiki", "MySpace", "MyCachedDocument"));
294 {{/code}}
295
296 == Enabled using velocity in document content itself (XWiki 1.0 syntax only) ==
297
298 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:
299
300 {{code language="none"}}
301 $context.setCacheDuration(60)
302 {{/code}}
303
304 Since 1.5M2, you can set the default rendering cache duration for all pages in ##xwiki.cfg##:
305
306 {{code language="none"}}
307 ## cache all rendered documents for one hour
308 xwiki.rendering.defaultCacheDuration=3600
309 {{/code}}
310
311 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.
312
313 = Merge the CSS files =
314
315 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]].
316
317 = Set up NginX =
318
319 If you experience //__heavy loads__// on your wiki, you could try using NginX.
320
321 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).
322
323 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".
324
325 For more info on setting up NginX check [[this guide>>NginX]].
326
327 = Backlinks =
328
329 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##:
330
331 {{code language="none"}}
332 xwiki.backlinks=0
333 {{/code}}
334
335 = Versioning =
336
337 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##:
338
339 {{code language="none"}}
340 xwiki.store.versioning=0
341 {{/code}}
342
343 = Custom Mapping =
344
345 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]].
346
347 = Wiki syntax features for XWiki Syntax 1.0 =
348
349 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.

About

About

Support

Platform

User Guide

Admin Guide

Developer Guide

Projects

XWiki

Extensions

Other

Contribute

Status

Practices

Under the Hood

Get Involved

Get Connected