Skip to Content

Wiki source code of Performance

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