Wiki source code of Performance

Version 34.2 by Vincent Massol on 2013/03/12

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
20.2	7	= Gzip compression and caching of static pages =
14.1	8
20.1	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:
14.1	10
20.1	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
14.1	15	Modify your Apache configuration file to load the different modules:
	16
20.1	17	{{code language="none"}}
14.1	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
20.1	23	{{/code}}
14.1	24
32.2	25	and configure your different modules as described below:
14.1	26
20.2	27	== Mod Deflate Configuration ==
14.1	28
20.1	29	{{code language="none"}}
14.1	30	vwwwpro-1:~# cat /etc/apache2/conf.d/deflate
	31	<Location />
	32	# Insert filter
	33	SetOutputFilter DEFLATE
	34
	35	# Netscape 4.x has some problems...
	36	BrowserMatch ^Mozilla/4 gzip-only-text/html
	37
	38	# Netscape 4.06-4.08 have some more problems
20.1	39	BrowserMatch ^Mozilla/4.0[678] no-gzip
14.1	40
	41	# MSIE masquerades as Netscape, but it is fine
20.1	42	# BrowserMatch bMSIE !no-gzip !gzip-only-text/html
14.1	43
	44	# NOTE: Due to a bug in mod_setenvif up to Apache 2.0.48
	45	# the above regex won't work. You can use the following
	46	# workaround to get the desired effect:
20.1	47	BrowserMatch bMSI[E] !no-gzip !gzip-only-text/html
14.1	48
	49	# Don't compress images
20.1	50	SetEnvIfNoCase Request_URI .(?:gif\|jpe?g\|png)$ no-gzip dont-vary
14.1	51
	52	# Make sure proxies don't deliver the wrong content
	53	#Header append Vary User-Agent env=!dont-vary
	54	</Location>
20.1	55	{{/code}}
14.1	56
20.2	57	== Mod Expire Configuration ==
14.1	58
20.1	59	{{code language="none"}}
14.1	60	vwwwpro-1:~# cat /etc/apache2/conf.d/expires
	61	<Location /xwiki/skins/>
	62	ExpiresActive on
	63	ExpiresDefault "access plus 1 day"
	64	</Location>
	65
	66	<Location /xwiki/bin/skin/>
	67	ExpiresActive on
	68	ExpiresDefault "access plus 1 day"
	69	</Location>
20.1	70	{{/code}}
14.1	71
20.2	72	== Mod Proxy AJP Configuration ==
14.1	73
20.1	74	{{code language="none"}}
	75	ProxyRequests Off
14.1	76	<Proxy *>
	77	Order deny,allow
	78	Allow from all
	79	</Proxy>
	80	ProxyPreserveHost On
	81	ProxyPass /xwiki ajp://192.168.1.181:8009/xwiki
20.1	82	{{/code}}
14.1	83
20.1	84	where ##ajp:~/~/192.168.1.181:8009/xwiki## is the internal address of your Servlet container where XWiki is running.
14.1	85
20.2	86	= Memory =
9.1	87
34.1	88	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:
	89	* Small installs: A minimum of 300MB of heap memory and 196MB of permGen (##-Xmx300m -XX:MaxPermSize=196m##)
	90	* Medium installs: 512MB for the heap and 196MB of permGen (##-Xmx512m -XX:MaxPermSize=196m##)
	91	* 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.
9.1	92
34.1	93	{{warning}}
	94	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.
	95	{{/warning}}
20.1	96
20.2	97	= Database Indexes =
1.1	98
32.2	99	Make sure you've set [[Database indexes>>Database Administration]]. This is especially important when you start having lots of documents.
1.1	100
20.2	101	= Panels =
1.1	102
32.2	103	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	104
20.2	105	= Robots.txt =
15.1	106
32.2	107	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	108
20.1	109	{{code language="none"}}
15.1	110	User-agent: *
22.1	111	Disallow: /xwiki/bin/attach/
	112	Disallow: /xwiki/bin/cancel/
	113	Disallow: /xwiki/bin/commentadd/
	114	Disallow: /xwiki/bin/delattachment/
	115	Disallow: /xwiki/bin/delete/
	116	Disallow: /xwiki/bin/dot/
	117	Disallow: /xwiki/bin/download/
	118	Disallow: /xwiki/bin/downloadrev/
15.1	119	Disallow: /xwiki/bin/edit/
22.1	120	Disallow: /xwiki/bin/export/
	121	Disallow: /xwiki/bin/get/
15.1	122	Disallow: /xwiki/bin/inline/
22.1	123	Disallow: /xwiki/bin/lifeblog/
	124	Disallow: /xwiki/bin/login/
	125	Disallow: /xwiki/bin/loginerror/
	126	Disallow: /xwiki/bin/logout/
	127	Disallow: /xwiki/bin/objectremove/
	128	Disallow: /xwiki/bin/pdf/
15.1	129	Disallow: /xwiki/bin/preview/
	130	Disallow: /xwiki/bin/propadd/
	131	Disallow: /xwiki/bin/propdelete/
22.1	132	Disallow: /xwiki/bin/propupdate/
	133	Disallow: /xwiki/bin/register/
	134	Disallow: /xwiki/bin/save/
15.1	135	Disallow: /xwiki/bin/skin/
	136	Disallow: /xwiki/bin/status/
22.1	137	Disallow: /xwiki/bin/upload/
	138	Disallow: /xwiki/bin/viewattachrev/
15.1	139	Disallow: /xwiki/bin/viewrev/
22.1	140	Disallow: /xwiki/bin/xmlrpc/
	141	# It could be also usefull to block certain spaces from crawling,
	142	# especially if this spaces doesn't provide new content
	143	Disallow: /xwiki/bin/view/Main/
	144	Disallow: /xwiki/bin/view/XWiki/
	145	# on the other hand you would like to have your recent (public) changes included
	146	Allow: /xwiki/bin/view/Main/Dashboard
20.1	147	{{/code}}
15.1	148
32.1	149
32.2	150	Note:
32.1	151
32.2	152	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	153
	154	{{code}}
	155	-rw-r--r-- 1 root www 1478 Jan 8 15:52 robots.txt
	156	{{/code}}
	157
32.2	158	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	159
20.2	160	= Statistics =
1.1	161
20.1	162	{{info}}
	163	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.
	164	{{/info}}
15.1	165
32.2	166	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	167
20.2	168	= Monitoring =
7.1	169
20.1	170	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##:
	171
	172	{{code language="null"}}
19.1	173	xwiki.monitor=0
20.1	174	{{/code}}
7.1	175
20.2	176	= Cache sizes =
1.2	177
20.1	178	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.
2.1	179
20.1	180	{{code language="none"}}
19.1	181	xwiki.store.cache.capacity=1000
20.1	182	{{/code}}
8.1	183
25.1	184	= Cache Macro =
	185
26.1	186	It's possible to perform selective content caching by using the [[Cache Macro>>extensions:Extension.Cache Macro]].
25.1	187
20.2	188	= Rendering cache =
2.1	189
30.1	190	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.
	191
29.1	192	== Configuration based ==
25.1	193
32.2	194	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	195
	196	{{code language="none"}}
	197	#-# [Since 2.4M1]
	198	#-# Indicate if the rendering cache is enabled.
	199	#-# Default value is false.
	200	# core.renderingcache.enabled=true
	201
	202	#-# [Since 2.4M1]
	203	#-# A list of Java regex patterns matching full documents reference.
	204	# core.renderingcache.documents=wiki:Space\.Page
	205	# core.renderingcache.documents=wiki:Space\..*
	206
	207	#-# [Since 2.4M1]
	208	#-# The time (in seconds) after which data should be removed from the cache when not used.
	209	#-# Default value is 300 (5 min).
	210	# core.renderingcache.duration=300
	211
	212	#-# [Since 2.4M1]
	213	#-# The size of the rendering cache. Not that it's not the number of cached documents but the number of cached results.
	214	#-# (For a single document several cache entries are created, because each action, language and request query string
	215	#-# produces a unique rendering result)
	216	#-# Default value is 100.
	217	# core.renderingcache.size=100
	218	{{/code}}
	219
31.1	220	You can force a page to refresh using ##refresh=1## in the URL.
30.1	221
28.1	222	== Enabled using velocity in document content itself (XWiki 1.0 syntax only) ==
25.1	223
30.1	224	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	225
20.1	226	{{code language="none"}}
19.1	227	$context.setCacheDuration(60)
20.1	228	{{/code}}
2.1	229
20.1	230	Since 1.5M2, you can set the default rendering cache duration for all pages in ##xwiki.cfg##:
	231
	232	{{code language="none"}}
16.1	233	## cache all rendered documents for one hour
	234	xwiki.rendering.defaultCacheDuration=3600
20.1	235	{{/code}}
	236
16.1	237	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.
	238
20.2	239	= Merge the CSS files =
11.1	240
32.2	241	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	242
20.2	243	= Set up NginX =
19.2	244
32.2	245	If you experience //__heavy loads__// on your wiki, you could try using NginX.
19.3	246
32.2	247	NginX is used to fetch static content: images, javascript, styles, etc.
19.2	248
32.2	249	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	250
32.2	251	For more info on setting up NginX check [[this guide>>NginX]].
19.2	252
20.2	253	= Backlinks =
4.1	254
20.1	255	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##:
	256
	257	{{code language="none"}}
19.1	258	xwiki.backlinks=0
20.1	259	{{/code}}
5.1	260
20.2	261	= Versioning =
5.1	262
32.2	263	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	264
	265	{{code language="none"}}
19.1	266	xwiki.store.versioning=0
20.1	267	{{/code}}
6.1	268
21.1	269	= Custom Mapping =
6.1	270
32.2	271	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	272
	273	= Wiki syntax features for XWiki Syntax 1.0 =
	274
20.2	275	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.

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