Wiki source code of Performance

Last modified by Thomas Mortagne on 2024/09/04

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