Wiki source code of Performance

Version 64.1 by Thomas Mortagne on 2015/05/21

version	line-number	content
22.1	1	{{box cssClass="floatinginfobox" title="Contents"}}
	2	{{toc/}}
	3	{{/box}}
20.1	4
17.1	5	Here are some tips to increase XWiki's performance.
10.1	6
49.1	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
48.1	11	= Standalone Solr =
	12
64.1	13	By default XWiki use an embedded instance of Solr for easy of use by when your wiki starts to grow you mind need to move to an external instance of Solr.
50.1	14
64.1	15	See [[Performance Guide in Solr module documentation>>extensions.Extension.Solr Search API#HPerformances]].
	16
42.1	17	= Slow random number generation on UNIX =
	18
46.1	19	The library used for random number generation in Sun's JVM relies on ##/dev/random## by default for UNIX platforms.
42.1	20
48.3	21	Although ##/dev/random## is more secure, it's possible to use ##/dev/urandom## if the default JVM configuration instead.
42.1	22
	23	To determine if your operating system exhibits this behavior, try displaying a portion of the file from a shell prompt:
	24
45.1	25	{{code language="bash"}}
42.1	26	head -n 1 /dev/random
45.1	27	{{/code}}
42.1	28
46.1	29	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##:
42.1	30
44.1	31	1. Open the ##$JAVA_HOME/jre/lib/security/java.security## file in a text editor.
	32	1. Change the line:
50.1	33	{{code language="properties"}} securerandom.source=file:/dev/random{{/code}}
42.1	34	to read:
50.1	35	{{code language="properties"}} securerandom.source=file:/dev/urandom{{/code}}
44.1	36	1. Save your change and exit the text editor.
42.1	37
20.2	38	= Gzip compression and caching of static pages =
14.1	39
20.1	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:
14.1	41
20.1	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
14.1	46	Modify your Apache configuration file to load the different modules:
	47
20.1	48	{{code language="none"}}
14.1	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
20.1	54	{{/code}}
14.1	55
37.1	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
32.2	64	and configure your different modules as described below:
14.1	65
20.2	66	== Mod Deflate Configuration ==
14.1	67
20.1	68	{{code language="none"}}
14.1	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
20.1	78	BrowserMatch ^Mozilla/4.0[678] no-gzip
14.1	79
	80	# MSIE masquerades as Netscape, but it is fine
20.1	81	# BrowserMatch bMSIE !no-gzip !gzip-only-text/html
14.1	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:
20.1	86	BrowserMatch bMSI[E] !no-gzip !gzip-only-text/html
14.1	87
	88	# Don't compress images
20.1	89	SetEnvIfNoCase Request_URI .(?:gif\|jpe?g\|png)$ no-gzip dont-vary
14.1	90
	91	# Make sure proxies don't deliver the wrong content
	92	#Header append Vary User-Agent env=!dont-vary
	93	</Location>
20.1	94	{{/code}}
14.1	95
37.1	96	//On debian apache2 the config file for deflate is located under /etc/apache2/mods-enabled/deflate.conf//
	97
20.2	98	== Mod Expire Configuration ==
14.1	99
20.1	100	{{code language="none"}}
14.1	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>
20.1	111	{{/code}}
14.1	112
20.2	113	== Mod Proxy AJP Configuration ==
14.1	114
20.1	115	{{code language="none"}}
	116	ProxyRequests Off
14.1	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
20.1	123	{{/code}}
14.1	124
20.1	125	where ##ajp:~/~/192.168.1.181:8009/xwiki## is the internal address of your Servlet container where XWiki is running.
14.1	126
37.1	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
39.1	138	Uncomment the following line by removing the {{code}}<!-- -->{{/code}} and add {{code}}URIEncoding="UTF-8"{{/code}} to it.Maybe give a comment too.
37.1	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
20.2	145	= Memory =
9.1	146
34.1	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:
36.1	148
53.1	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##).
9.1	152
53.3	153	{{info}}
53.1	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).
53.3	155	{{/info}}
53.1	156
34.1	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.
38.2	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.
34.1	161	{{/warning}}
20.1	162
35.1	163	For your information here are the values used for the xwiki.org site:
	164
	165	{{code}}
53.2	166	CATALINA_OPTS="-server -Xms800m -Xmx1480m -XX:MaxPermSize=222m -Dfile.encoding=utf-8 -Djava.awt.headless=true -XX:+UseParallelGC -XX:MaxGCPauseMillis=100"
35.1	167	{{/code}}
	168
20.2	169	= Database Indexes =
1.1	170
32.2	171	Make sure you've set [[Database indexes>>Database Administration]]. This is especially important when you start having lots of documents.
1.1	172
20.2	173	= Panels =
1.1	174
32.2	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).
1.1	176
20.2	177	= Robots.txt =
15.1	178
32.2	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:
15.1	180
20.1	181	{{code language="none"}}
15.1	182	User-agent: *
22.1	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/
15.1	191	Disallow: /xwiki/bin/edit/
22.1	192	Disallow: /xwiki/bin/export/
	193	Disallow: /xwiki/bin/get/
15.1	194	Disallow: /xwiki/bin/inline/
22.1	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/
15.1	201	Disallow: /xwiki/bin/preview/
	202	Disallow: /xwiki/bin/propadd/
	203	Disallow: /xwiki/bin/propdelete/
22.1	204	Disallow: /xwiki/bin/propupdate/
	205	Disallow: /xwiki/bin/register/
	206	Disallow: /xwiki/bin/save/
15.1	207	Disallow: /xwiki/bin/skin/
	208	Disallow: /xwiki/bin/status/
22.1	209	Disallow: /xwiki/bin/upload/
	210	Disallow: /xwiki/bin/viewattachrev/
15.1	211	Disallow: /xwiki/bin/viewrev/
22.1	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
20.1	219	{{/code}}
15.1	220
32.1	221
32.2	222	Note:
32.1	223
32.2	224	For Tomcat6 the placement of the ##robots.txt## file should be within the //$TOMCAT/webapps/ROOT// folder and should have permission 644 applied.
32.1	225
	226	{{code}}
	227	-rw-r--r-- 1 root www 1478 Jan 8 15:52 robots.txt
	228	{{/code}}
	229
32.2	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]].
32.1	231
20.2	232	= Statistics =
1.1	233
20.1	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}}
15.1	237
32.2	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.
1.2	239
20.2	240	= Monitoring =
7.1	241
20.1	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"}}
19.1	245	xwiki.monitor=0
20.1	246	{{/code}}
7.1	247
52.3	248	= Document Cache =
1.2	249
52.3	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.
2.1	251
20.1	252	{{code language="none"}}
19.1	253	xwiki.store.cache.capacity=1000
20.1	254	{{/code}}
8.1	255
25.1	256	= Cache Macro =
	257
26.1	258	It's possible to perform selective content caching by using the [[Cache Macro>>extensions:Extension.Cache Macro]].
25.1	259
51.1	260	= LESS Cache =
	261
52.2	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.
51.1	263
20.2	264	= Rendering cache =
2.1	265
30.1	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
29.1	268	== Configuration based ==
25.1	269
32.2	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:
25.1	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
31.1	296	You can force a page to refresh using ##refresh=1## in the URL.
30.1	297
41.1	298	Since 6.2 it's also possible to programmatically refresh any document cache using ##com.xpn.xwiki.internal.cache.rendering.RenderingCache## component:
39.1	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
28.1	310	== Enabled using velocity in document content itself (XWiki 1.0 syntax only) ==
25.1	311
30.1	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:
2.1	313
20.1	314	{{code language="none"}}
19.1	315	$context.setCacheDuration(60)
20.1	316	{{/code}}
2.1	317
20.1	318	Since 1.5M2, you can set the default rendering cache duration for all pages in ##xwiki.cfg##:
	319
	320	{{code language="none"}}
16.1	321	## cache all rendered documents for one hour
	322	xwiki.rendering.defaultCacheDuration=3600
20.1	323	{{/code}}
	324
16.1	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
20.2	327	= Merge the CSS files =
11.1	328
32.2	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]].
11.1	330
20.2	331	= Set up NginX =
19.2	332
32.2	333	If you experience //__heavy loads__// on your wiki, you could try using NginX.
19.3	334
36.1	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).
19.2	336
32.2	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".
19.2	338
32.2	339	For more info on setting up NginX check [[this guide>>NginX]].
19.2	340
20.2	341	= Backlinks =
4.1	342
20.1	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"}}
19.1	346	xwiki.backlinks=0
20.1	347	{{/code}}
5.1	348
20.2	349	= Versioning =
5.1	350
32.2	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##:
20.1	352
	353	{{code language="none"}}
19.1	354	xwiki.store.versioning=0
20.1	355	{{/code}}
6.1	356
21.1	357	= Custom Mapping =
6.1	358
32.2	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]].
21.1	360
	361	= Wiki syntax features for XWiki Syntax 1.0 =
	362
47.1	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.
56.1	366
	367	= Performance tree =
	368
57.1	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]].

Wiki source code of Performance

Quick Links

Navigation

About

About

Support

Platform

User Guide

Admin Guide

Developer Guide

Projects

XWiki

Extensions

Other

Contribute

Status

Practices

Under the Hood

Get Involved

Get Connected