Skip to Content

Wiki source code of Performance

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

About

About

Support

Platform

User Guide

Admin Guide

Developer Guide

Projects

XWiki

Extensions

Other

Contribute

Status

Practices

Under the Hood

Get Involved

Get Connected