Wiki source code of Performance

Last modified by Thomas Mortagne on 2023/10/10

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
89.1	9	If you need high availability or if the load on your XWiki instance is too high you can [[configure XWiki in a cluster>>Documentation.AdminGuide.Clustering.WebHome]] to spread the load.
49.1	10
48.1	11	= Standalone Solr =
	12
110.2	13	By default XWiki use an embedded instance of Solr for ease of use, but if you struggle with very slow searches, you should try a external Solr instance.
	14	You can use ##debug=true## in the URL of the search to see how much time is spent inside Solr to verify if Solr is taking a long time, or the issue is somewhere else, for example the XWiki UI.
50.1	15
65.1	16	See [[Performance Guide in Solr module documentation>>extensions:Extension.Solr Search API#HPerformances]].
64.1	17
42.1	18	= Slow random number generation on UNIX =
	19
67.1	20	The library used for random number generation in Oracle's JVM relies on ##/dev/random## by default for UNIX platforms.
42.1	21
48.3	22	Although ##/dev/random## is more secure, it's possible to use ##/dev/urandom## if the default JVM configuration instead.
42.1	23
	24	To determine if your operating system exhibits this behavior, try displaying a portion of the file from a shell prompt:
	25
45.1	26	{{code language="bash"}}
42.1	27	head -n 1 /dev/random
45.1	28	{{/code}}
42.1	29
79.1	30	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 on of the following solutions to use ##/dev/urandom##:
42.1	31
79.1	32	== JVM setup ==
	33
44.1	34	1. Open the ##$JAVA_HOME/jre/lib/security/java.security## file in a text editor.
	35	1. Change the line:
50.1	36	{{code language="properties"}} securerandom.source=file:/dev/random{{/code}}
42.1	37	to read:
50.1	38	{{code language="properties"}} securerandom.source=file:/dev/urandom{{/code}}
44.1	39	1. Save your change and exit the text editor.
42.1	40
79.1	41	== Command line parameter ==
	42
109.1	43	The same effect can be obtained using ##-Djava.security.egd=file:/dev/./urandom## in the Java command line (usually in the application server configuration).
79.1	44
20.2	45	= Gzip compression and caching of static pages =
14.1	46
92.1	47	HTTP compression is a capability that can be built into web servers and web clients to improve transfer speed and bandwidth utilization. HTTP data is compressed before it is sent from the server: compliant browsers will announce what methods are supported to the server before downloading the correct format; browsers that do not support compliant compression method will download uncompressed data.
14.1	48
94.1	49	Many application servers (Tomcat, etc.) and HTTP proxies (Apache HTTPd, Nginx, etc.) support it.
92.1	50
93.1	51	== In Apache HTTP Server ==
92.1	52
	53	The recommended solution is to set up an Apache Web Server in front of your servlet container and install/configure the following modules:
	54
20.1	55	* [[mod-deflate>>http://httpd.apache.org/docs/2.0/mod/mod_deflate.html]]
81.1	56	* [[mod-expires>>http://httpd.apache.org/docs/2.0/mod/mod_expires.html]]
20.1	57	* [[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)
	58
14.1	59	Modify your Apache configuration file to load the different modules:
	60
20.1	61	{{code language="none"}}
14.1	62	LoadModule expires_module /usr/lib/apache2/modules/mod_expires.so
	63	LoadModule deflate_module /usr/lib/apache2/modules/mod_deflate.so
	64	LoadModule proxy_module /usr/lib/apache2/modules/mod_proxy.so
	65	# Depends: proxy
	66	LoadModule proxy_ajp_module /usr/lib/apache2/modules/mod_proxy_ajp.so
20.1	67	{{/code}}
14.1	68
37.1	69	//Alternatively you can run the following commands as root (sudo)//
	70
	71	{{code language="bash"}}
	72	a2enmod deflate
	73	a2enmod proxy_ajp
	74	a2enmod expires
	75	{{/code}}
	76
32.2	77	and configure your different modules as described below:
14.1	78
92.1	79	=== Mod Deflate Configuration ===
14.1	80
20.1	81	{{code language="none"}}
14.1	82	vwwwpro-1:~# cat /etc/apache2/conf.d/deflate
118.1	83	<Location ></Location>
14.1	84	# Insert filter
	85	SetOutputFilter DEFLATE
	86
	87	# Netscape 4.x has some problems...
	88	BrowserMatch ^Mozilla/4 gzip-only-text/html
	89
	90	# Netscape 4.06-4.08 have some more problems
20.1	91	BrowserMatch ^Mozilla/4.0[678] no-gzip
14.1	92
	93	# MSIE masquerades as Netscape, but it is fine
20.1	94	# BrowserMatch bMSIE !no-gzip !gzip-only-text/html
14.1	95
	96	# NOTE: Due to a bug in mod_setenvif up to Apache 2.0.48
	97	# the above regex won't work. You can use the following
	98	# workaround to get the desired effect:
20.1	99	BrowserMatch bMSI[E] !no-gzip !gzip-only-text/html
14.1	100
	101	# Don't compress images
20.1	102	SetEnvIfNoCase Request_URI .(?:gif\|jpe?g\|png)$ no-gzip dont-vary
14.1	103
	104	# Make sure proxies don't deliver the wrong content
	105	#Header append Vary User-Agent env=!dont-vary
	106	</Location>
20.1	107	{{/code}}
14.1	108
37.1	109	//On debian apache2 the config file for deflate is located under /etc/apache2/mods-enabled/deflate.conf//
	110
92.1	111	=== Mod Expire Configuration ===
14.1	112
20.1	113	{{code language="none"}}
14.1	114	vwwwpro-1:~# cat /etc/apache2/conf.d/expires
118.1	115	<Location /xwiki/skins></Location>
14.1	116	ExpiresActive on
	117	ExpiresDefault "access plus 1 day"
	118	</Location>
	119
118.1	120	<Location /xwiki/bin/skin></Location>
14.1	121	ExpiresActive on
	122	ExpiresDefault "access plus 1 day"
	123	</Location>
20.1	124	{{/code}}
14.1	125
92.1	126	=== Mod Proxy AJP Configuration ===
14.1	127
20.1	128	{{code language="none"}}
	129	ProxyRequests Off
14.1	130	<Proxy *>
	131	Order deny,allow
	132	Allow from all
	133	</Proxy>
	134	ProxyPreserveHost On
	135	ProxyPass /xwiki ajp://192.168.1.181:8009/xwiki
20.1	136	{{/code}}
14.1	137
119.15	138	where {{code}}ajp://192.168.1.181:8009/xwiki{{/code}} is the internal address of your Servlet container where XWiki is running.
14.1	139
119.16	140	If you use Tomcat(9) you need to enable the ajp connector in the ##/etc/tomcat9/server.xml##. Comment out the following line with adding ##<!~-~- ~-~->##.
37.1	141
	142	{{code}}
119.16	143	<!-- Disable to use ajp connector instead
119.17	144	<Connector port="8080"
	145	protocol="HTTP/1.1"
37.1	146	connectionTimeout="20000"
	147	URIEncoding="UTF-8"
119.18	148	redirectPort="8443">
119.17	149	</Connector>
119.16	150	-->
37.1	151	{{/code}}
	152
119.13	153	Uncomment the following line by removing the ##<!~-~- ~-~->## and add {{code}}URIEncoding="UTF-8"{{/code}} to it.
119.9	154
37.1	155	{{code}}
119.21	156	<!-- Activate ajp connector for apache proxy_ajp -->
119.17	157	<Connector port="8009"
	158	protocol="AJP/1.3"
	159	redirectPort="8443"
	160	URIEncoding="UTF-8">
	161	</Connector>
37.1	162	{{/code}}
	163
20.2	164	= Memory =
9.1	165
119.26	166	You need to configure your Servlet container so that XWiki has enough memory. This is done in the ##/etc/default/tomcat9## configuration file (or ##/etc/default/tomcat8## for Tomcat 8, etc). You'll need to tune the value to suit your needs. For possible memory issues you can check the logs to see if there are any "out of memory" errors.
36.1	167
119.25	168	Here are some good default values:
119.27	169
112.1	170	* Small and medium installs: A minimum of 1024MB (##-Xmx1024m)##
119.24	171	* Large installs: 2048MB or beyond (##-Xmx2048m)##
9.1	172
53.3	173	{{info}}
53.1	174	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	175	{{/info}}
53.1	176
34.1	177	{{warning}}
88.5	178	If you use HSQLDB as the wiki database, be aware that the full content of the database is stored in memory and thus the memory requirements are higher. See [[HSQLDB installation page>>Documentation.AdminGuide.Installation.InstallationWAR.InstallationHSQL.WebHome]] for more details.
76.1	179	{{/warning}}
	180
35.1	181	For your information here are the values used for the xwiki.org site:
	182
	183	{{code}}
106.3	184	CATALINA_OPTS="-server -Xms800m -Xmx1600m -Dfile.encoding=utf-8 -Djava.awt.headless=true -XX:+UseParallelGC -XX:MaxGCPauseMillis=100"
35.1	185	{{/code}}
	186
105.1	187	= Sizing =
	188
105.2	189	To give you an idea about what you need to run XWiki on, [[XWiki SAS>>https://xwiki.com]] has the following configuration for its cloud instances:
105.1	190
106.4	191	* 2GB of RAM (See [[XWiki memory needs>>#HMemory]]),
106.1	192	* 2 cores(((
	193	{{code language="none"}}
	194	AMD Opteron(tm) Processor 6386 SE
	195	cpu MHz : 2800.000
	196	cache size : 2048 KB
106.2	197	{{/code}}
106.1	198	)))
105.1	199	* 16GB disk size by default
	200
20.2	201	= Database Indexes =
1.1	202
90.1	203	Make sure you've set [[Database indexes>>Documentation.AdminGuide.Performances.Database Administration.WebHome]]. This is especially important when you start having lots of documents.
1.1	204
74.1	205	= Large number of users =
	206
	207	When you have large number of users it's recommended to turn on implicit All Group, i.e. to consider that all users are members of XWiki.XWikiAllGroup by default in the configuration. This is achieved by editing the ##xwiki.cfg## file and setting:
	208
	209	{{code language="none"}}
	210	xwiki.authentication.group.allgroupimplicit=1
	211	{{/code}}
	212
75.1	213	Then you should remove all the XObjects from the XWikiAllGroup page but you should keep the page since otherwise you won't be able to set permissions for this group. This will prevent XWiki from having to load all that page's XObjects representing the users (thousands of them if you have thousands of users).
74.1	214
75.2	215	Also make sure that the ##XWikiAllGroup## is listed in the ##xwiki.users.initialGroups## property (it's there by default if you haven't touched that property):
	216
	217	{{code language="none"}}
	218	#-# List of groups that a new user should be added to by default after registering. Comma-separated list of group
	219	#-# document names.
	220	# xwiki.users.initialGroups=XWiki.XWikiAllGroup
	221	{{/code}}
	222
20.2	223	= Robots.txt =
15.1	224
86.6	225	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 and put it in your webserver configuration.
15.1	226
85.1	227	Some example:
	228
20.1	229	{{code language="none"}}
15.1	230	User-agent: *
86.7	231	# Prevent bots from executing all actions except "view" since:
86.1	232	# 1) we don't want bots to execute stuff in the wiki!
86.2	233	# 2) we don't want bots to consume CPU and memory
86.7	234	# (for example to perform exports)
	235	# Note: You may want to allow /download/ if you wish to have
	236	# attachments indexed.
111.1	237	# Note2: Using * instead of /bin/ to also match path-based
	238	# subwikis like "/xwiki/wiki/wikialias/view/Space/Page"
	239	Disallow: /xwiki/*/viewattachrev/
	240	Disallow: /xwiki/*/viewrev/
	241	Disallow: /xwiki/*/pdf/
	242	Disallow: /xwiki/*/tex/
	243	Disallow: /xwiki/*/edit/
	244	Disallow: /xwiki/*/create/
	245	Disallow: /xwiki/*/inline/
	246	Disallow: /xwiki/*/preview/
	247	Disallow: /xwiki/*/save/
	248	Disallow: /xwiki/*/saveandcontinue/
	249	Disallow: /xwiki/*/rollback/
	250	Disallow: /xwiki/*/deleteversions/
	251	Disallow: /xwiki/*/cancel/
	252	Disallow: /xwiki/*/delete/
	253	Disallow: /xwiki/*/deletespace/
	254	Disallow: /xwiki/*/undelete/
	255	Disallow: /xwiki/*/reset/
	256	Disallow: /xwiki/*/register/
	257	Disallow: /xwiki/*/propupdate/
	258	Disallow: /xwiki/*/propadd/
	259	Disallow: /xwiki/*/propdisable/
	260	Disallow: /xwiki/*/propenable/
	261	Disallow: /xwiki/*/propdelete/
	262	Disallow: /xwiki/*/objectadd/
	263	Disallow: /xwiki/*/commentadd/
	264	Disallow: /xwiki/*/commentsave/
	265	Disallow: /xwiki/*/objectsync/
	266	Disallow: /xwiki/*/objectremove/
	267	Disallow: /xwiki/*/attach/
	268	Disallow: /xwiki/*/upload/
	269	Disallow: /xwiki/*/download/
	270	Disallow: /xwiki/*/temp/
	271	Disallow: /xwiki/*/downloadrev/
	272	Disallow: /xwiki/*/dot/
	273	Disallow: /xwiki/*/svg/
	274	Disallow: /xwiki/*/delattachment/
	275	Disallow: /xwiki/*/skin/
	276	Disallow: /xwiki/*/jsx/
	277	Disallow: /xwiki/*/ssx/
	278	Disallow: /xwiki/*/login/
	279	Disallow: /xwiki/*/loginsubmit/
	280	Disallow: /xwiki/*/loginerror/
	281	Disallow: /xwiki/*/logout/
	282	Disallow: /xwiki/*/charting/
	283	Disallow: /xwiki/*/lock/
	284	Disallow: /xwiki/*/redirect/
	285	Disallow: /xwiki/*/admin/
	286	Disallow: /xwiki/*/export/
	287	Disallow: /xwiki/*/import/
	288	Disallow: /xwiki/*/get/
	289	Disallow: /xwiki/*/distribution/
	290	Disallow: /xwiki/*/imagecaptcha/
	291	Disallow: /xwiki/*/unknown/
111.4	292	# Note: In addition, this matches both old /xwiki/bin/webjars/
	293	# and new /xwiki/webjars paths.
111.1	294	Disallow: /xwiki/*/webjars/
111.4	295	# Don't index additional UI-related resources.
	296	Disallow: /xwiki/resources/
86.2	297	# Don't index sandbox content since it's sample content
111.1	298	Disallow: /xwiki/*/view/Sandbox/
86.2	299	# Don't index Admin space since it contains Admin stuff.
	300	# Note that the Admin space is protected by permissions
	301	# anyway but this acts as a safety net to not have private
	302	# info leaked on the internet ;)
111.1	303	Disallow: /xwiki/*/view/Admin/
86.2	304	# Don't index Stats data (just because it's not useful and
	305	# those pages are a bit CPU intensive)
111.1	306	Disallow: /xwiki/*/view/Stats/
86.2	307	# Don't index Panels data (because we don't want it
	308	# indexed on the internet)
111.1	309	Disallow: /xwiki/*/view/Panels/
	310	# Don't index the search page.
	311	Disallow: /xwiki/*/Main/Search
	312	# Don't index the REST API.
	313	Disallow: /xwiki/rest/
	314	# These are just UI elements which can cause infinite loops in
	315	# web crawlers. See https://jira.xwiki.org/browse/XWIKI-16915
	316	Disallow: /xwiki/?xpage=*
86.1	317	{{/code}}
	318
	319	Other example:
	320
	321	{{code}}
	322	[...]
85.1	323	# It could be also useful to block certain spaces from crawling,
22.1	324	# especially if this spaces doesn't provide new content
	325	Disallow: /xwiki/bin/view/Main/
	326	Disallow: /xwiki/bin/view/XWiki/
85.1	327	# On the other hand you would like to have your recent (public) changes included
22.1	328	Allow: /xwiki/bin/view/Main/Dashboard
20.1	329	{{/code}}
15.1	330
32.2	331	Note:
32.1	332
32.2	333	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	334
	335	{{code}}
	336	-rw-r--r-- 1 root www 1478 Jan 8 15:52 robots.txt
	337	{{/code}}
	338
115.1	339	== Indexing JS and CSS ==
32.1	340
116.1	341	[[Google officially recommends>>https://developers.google.com/search/blog/2014/10/updating-our-technical-webmaster]] that you do not disallow crawling of the JS and CSS files which are now actually rendered by the crawler bot and used to better index your content. Also see this short [[video>>https://www.youtube.com/watch?v=B9BWbruCiDc]] on the topic.
115.1	342
	343	In this case, you might want to make sure to remove the following ##Disallow## entries from your robots.txt file:
	344
118.1	345	{{code language="none"}}
115.1	346	Disallow: /xwiki/*/skin/
	347	Disallow: /xwiki/*/jsx/
	348	Disallow: /xwiki/*/ssx/
	349	Disallow: /xwiki/*/webjars/
	350	Disallow: /xwiki/*/resources/
	351	{{/code}}
	352
116.1	353	== Indexing images ==
115.1	354
116.1	355	For images uploaded as attachments inside wiki pages, you should add the following ##Allow## entries for the ##/download/## action:
	356
118.1	357	{{code language="none"}}
115.1	358	Allow: /xwiki//download/.png$
	359	Allow: /xwiki//download/.jpg$
	360	Allow: /xwiki//download/.jpeg$
	361	Allow: /xwiki//download/.gif$
	362	{{/code}}
	363
	364
	365	In order to test if the ##robots.txt## file is either accessible or working as desired use this [[checker>>https://technicalseo.com/tools/robots-txt/]].
	366
20.2	367	= Statistics =
1.1	368
20.1	369	{{info}}
	370	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.
	371	{{/info}}
15.1	372
32.2	373	The statistics module is off by default since it's quite database intensive. If you don't need it you should turn it off.
110.4	374	The current recommendation is to use the [[Matomo extension>>extensions:Extension.Piwiki Integration]] for statistics instead.
1.2	375
52.3	376	= Document Cache =
1.2	377
114.2	378	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 (but of course it's not very useful to allocate more than the total number of documents you have).
2.1	379
20.1	380	{{code language="none"}}
19.1	381	xwiki.store.cache.capacity=1000
20.1	382	{{/code}}
8.1	383
25.1	384	= Cache Macro =
	385
26.1	386	It's possible to perform selective content caching by using the [[Cache Macro>>extensions:Extension.Cache Macro]].
25.1	387
77.1	388	= LESS CSS Performances =
51.1	389
77.1	390	[[LESS>>extensions:Extension.LESS Module]] is a preprocessor used to generate CSS files for skins and skin extensions. See the [[Performances section>>extensions:Extension.LESS Module#HPerformances]] of the LESS module documentation to learn more about how to optimize its cache for performances, and to set the appropriate number of simultaneous compilations your server can handle.
51.1	391
20.2	392	= Rendering cache =
2.1	393
30.1	394	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.
	395
29.1	396	== Configuration based ==
25.1	397
32.2	398	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	399
	400	{{code language="none"}}
	401	#-# [Since 2.4M1]
	402	#-# Indicate if the rendering cache is enabled.
	403	#-# Default value is false.
	404	# core.renderingcache.enabled=true
	405
	406	#-# [Since 2.4M1]
	407	#-# A list of Java regex patterns matching full documents reference.
	408	# core.renderingcache.documents=wiki:Space\.Page
	409	# core.renderingcache.documents=wiki:Space\..*
	410
	411	#-# [Since 2.4M1]
	412	#-# The time (in seconds) after which data should be removed from the cache when not used.
	413	#-# Default value is 300 (5 min).
	414	# core.renderingcache.duration=300
	415
	416	#-# [Since 2.4M1]
	417	#-# The size of the rendering cache. Not that it's not the number of cached documents but the number of cached results.
	418	#-# (For a single document several cache entries are created, because each action, language and request query string
	419	#-# produces a unique rendering result)
	420	#-# Default value is 100.
	421	# core.renderingcache.size=100
	422	{{/code}}
	423
31.1	424	You can force a page to refresh using ##refresh=1## in the URL.
30.1	425
41.1	426	Since 6.2 it's also possible to programmatically refresh any document cache using ##com.xpn.xwiki.internal.cache.rendering.RenderingCache## component:
39.1	427
	428	{{code language="java"}}
	429	@Inject
	430	private RenderingCache renderingCache;
	431
	432	...
	433
	434	renderingCache.flushWholeCache();
	435	renderingCache.flushCache(new DocumentReference("xwiki", "MySpace", "MyCachedDocument"));
	436	{{/code}}
	437
25.1	438
20.2	439	= Merge the CSS files =
11.1	440
110.5	441	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>>snippets:Extension.Merge CSS]].
11.1	442
20.2	443	= Set up NginX =
19.2	444
32.2	445	If you experience //__heavy loads__// on your wiki, you could try using NginX.
19.3	446
36.1	447	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	448
32.2	449	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	450
91.1	451	For more info on setting up NginX check [[this guide>>Documentation.AdminGuide.Installation.NginX.WebHome]].
19.2	452
107.1	453	= Local resource access =
	454
108.1	455	[[See URL API>>extensions:Extension.URL API#HResourcemodificationdate]].
107.1	456
20.2	457	= Backlinks =
4.1	458
20.1	459	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##:
	460
	461	{{code language="none"}}
19.1	462	xwiki.backlinks=0
20.1	463	{{/code}}
5.1	464
20.2	465	= Versioning =
5.1	466
32.2	467	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	468
	469	{{code language="none"}}
19.1	470	xwiki.store.versioning=0
20.1	471	{{/code}}
6.1	472
21.1	473	= Custom Mapping =
6.1	474
120.1	475	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>>Documentation.DevGuide.CustomMapping]].
21.1	476
73.1	477	= LDAP =
	478
	479	== Disable LDAP sub groups search ==
	480
114.1	481	By default when loading a LDAP group, each member is searched and loaded to figure out if it's a group or not (and then load the sub group members, etc). If you know there is no sub group in your LDAP groups you can disable it and speed up quite a lot big groups handling using ##xwiki.authentication.ldap.group_sync_resolve_subgroups## property in ##xwiki.cfg## configuration file.
73.1	482
56.1	483	= Performance tree =
	484
57.1	485	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]].
68.1	486
98.2	487	= Navigation Tree =
98.1	488
	489	The Navigation Panel and other navigation trees can have some small performance issues under very high volumes. Here ares some base measures we did on some developer laptops to give you some ideas of the performance you should expect:
	490
	491	Measure set 1:
	492
111.1	493	(% class="table-bordered" style="width:100%" %)
101.2	494	\|=(% width="20%" %)DB\|=(% width="10%" %)Levels\|=(% width="10%" %)Spaces\|=(% width="10%" %)Pages\|=(% width="15%" %)Requests\|=Time
100.1	495	\|MySQL\|5\|6887\|4049\|31\|180ms
	496	\|HSQLDB\|5\|6762\|4063\|27\|138ms
	497	\|MySQL\|1\|2514\|4962\|27\|331ms
	498	\|HSQLDB\|1\|2377\|4718\|21\|3.15s
98.1	499
	500	Measure set 2:
	501
111.1	502	(% class="table-bordered" style="width:100%" %)
101.2	503	\|=(% width="20%" %)DB\|=(% width="10%" %)Levels\|=(% width="10%" %)Spaces\|=(% width="10%" %)Pages\|=(% width="15%" %)Requests\|=Time
100.1	504	\|Oracle\|5\|6943\|4106\|20\|119ms
	505	\|Oracle\|1\|2493\|4982\|20\|153ms
98.1	506
	507	Measure set 3:
	508
111.1	509	(% class="table-bordered" style="width:100%" %)
101.2	510	\|=(% width="20%" %)DB\|=(% width="10%" %)Levels\|=(% width="10%" %)Spaces\|=(% width="10%" %)Pages\|=(% width="15%" %)Requests\|=Time
101.1	511	\|Oracle\|1\|2485\|4991\|20\|151ms
	512	\|PostgreSQL\|1\|2494\|4991\|20\|125ms
98.1	513
103.1	514	Measure set 4 (XWiki 10.5, Intel i7 CPU, SSD Storage):
102.1	515
111.1	516	(% class="table-bordered" style="width:100%" %)
102.1	517	\|=(% width="20%" %)DB\|=(% width="10%" %)Levels\|=(% width="10%" %)Spaces\|=(% width="10%" %)Pages\|=(% width="15%" %)Requests\|=Time
104.1	518	\|PostgreSQL 10\|5\|6847\|4052\|25\|74ms
102.1	519
68.1	520	= Legacy =
	521
71.1	522	== Monitor plugin ==
70.1	523
	524	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##:
	525
	526	{{code language="properties"}}
	527	xwiki.monitor=0
	528	{{/code}}
	529
68.1	530	== 1.0 rendering cache using velocity in document content itself ==
	531
	532	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:
	533
	534	{{code language="none"}}
	535	$context.setCacheDuration(60)
	536	{{/code}}
	537
	538	Since 1.5M2, you can set the default rendering cache duration for all pages in ##xwiki.cfg##:
	539
	540	{{code language="none"}}
	541	## cache all rendered documents for one hour
	542	xwiki.rendering.defaultCacheDuration=3600
	543	{{/code}}
	544
	545	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.
69.1	546
72.1	547	== Wiki syntax features for XWiki Syntax 1.0 ==
69.1	548
	549	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.
	550
	551	Now this will have no effect if you're using another syntax, like XWiki Syntax 2.x.

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