Differences

This shows you the differences between two versions of the page.

--- administration:performance [2016/05/13 19:40] – [Heap Space] demiankatz
+++ administration:performance [2019/03/20 11:55] – [PHP Tuning] demiankatz
@@ Line 44: / Line 44: @@
 for more information).
 ==== Garbage Collection ====
+:!: Starting with VuFind 3.0, VuFind includes Solr 5, which does some garbage collection auto-tuning by default; the suggestions below may be less important for these newer releases, and you should probably not tinker with settings unless you have a known problem you are trying to solve.
 Garbage collection is how aggressive the JVM is with clearing out unneeded objects. For the purposes of Vufind, parallel garbage collection should work nicely, but read Sun's [[http://java.sun.com/docs/hotspot/gc5.0/gc_tuning_5.html | Tuning Garbage Collection]] for more in-depth information.
@@ Line 67: / Line 69: @@
 </code>
-Once you have a log file, you can use the [[http://www.tagtraum.com/gcviewer.html|gcviewer]] or [[http://www.alphaworks.ibm.com/tech/pmat|PMAT]] tool to get a visual representation of its contents.  This is very helpful in measuring whether your configuration changes have had a positive impact!
+Once you have a log file, you can use the [[https://github.com/chewiebug/GCViewer|gcviewer]] or [[http://www.alphaworks.ibm.com/tech/pmat|PMAT]] tool to get a visual representation of its contents.  This is very helpful in measuring whether your configuration changes have had a positive impact!
@@ Line 128: / Line 130: @@
 ====== PHP Tuning ======
 On PHP 5.4, installing a PHP cache like [[http://pecl.php.net/package/APC|APC]] can significantly improve performance by reducing the amount of time spent by PHP parsing and compiling code. PHP 5.6 comes with build-In OpCache, which is slightly faster than APC. When upgrading, remember to disable the Apache APC module. OpCache should be configured to 64 MB.
+===== Asset Pipeline =====
-If you created a custom module, remember to create a autoloader_classmap.php by calling
+Starting with VuFind 3.1, there is an optional "asset pipeline" which can be used to combine Javascript and/or CSS files together to reduce the number of HTTP requests necessary to load VuFind pages. This is turned off by default but can be activated using the asset_pipeline setting in [[configuration:files:config.ini|config.ini]].
-<code php>
-../../vendor/zendframework/zendframework/bin/classmap_generator.php -w
-</code>
-from module directory.
+===== Theme Compiler =====
+Starting with VuFind 4.1, there is a [[administration:command_line_utilities|command-line tool]] known as the "theme compiler" which can be run to flatten a hierarchy of themes into a single flat theme, reducing the amount of file searching VuFind needs to do in order to find assets and templates.
-===== Troubleshooting =====
+To use a compiled theme, follow these steps:
-There have been some reports of VuFind errors when running APC.  Excerpt from the vufind-tech mailing list (courtesy of Graham Seaman):
+. Run "php $VUFIND_HOME/public/index.php compile theme [your theme] [your compiled theme]" at the command line.
-//
+. Update your [[configuration:files:config.ini|config.ini]] file to use [your compiled theme] instead of [your theme] in the theme setting.
-Inserting the line in index.php
-//
-<code php>
+Note: NEVER EDIT THE COMPILED THEME. Instead, edit the source theme and recompile it when you need to make changes. You must use the --force switch of the compiler if you need to overwrite your compiled theme with a new version.
-register_shutdown_function('session_write_close');
-</code>
-//
+===== Session Handling =====
-immediately before requiring the session handler, seems to fix the problem with APC. Since this is the result of trawling the web and not of any deep understanding on my part, I can't guarantee this won't have sideffects (I'll report back if I find any), or that it will always work.
-//
-Note: As of VuFind 1.4, the default VuFind code will register the shutdown function, so this modification should no longer be necessary.
+When using database sessions, deleting expired sessions may be a surprisingly heavy process. On a busy site it may be beneficial to turn off PHP's session garbage collection (set session.gc_probability to 0 in php.ini) and run VuFind's expire_sessions utility regularly. This makes sure that garbage collection is done outside Apache that serves user requests and with a method that makes it possible to handle session deletion in a large table.
 ====== Apache Tuning ======
-For a productive environment, you should always enable GZIP compression. This reduces a amount of data transferred by 70% for text based files like html, js, ... To do so,
+===== GZIP Compression =====
+For a productive environment, you should always enable GZIP compression using [[https://httpd.apache.org/docs/2.4/mod/mod_deflate.html|mod_deflate]]. This reduces a amount of data transferred by 70% for text based files like html, js, ... To do so,
 <code bash>
@@ Line 167: / Line 165: @@
 </code>
-One thing you should also do is minifying JS and CSS files. This removes whitespaces and line breaks. It can by done by your IDE. Netbeans for example has a plugin Js CSS Minify Compress. The minified files must be configured in theme.config.php and in some cases in the theme files. Just search for ".js" and replace with ".min.js". If you use LESS to create your CSS files, there is an option --clean-css which optimizes your CSS, too.
+Note that the "application/json" type is not usually compressed by default, but turning on GZIP compression for this can significantly approve performance, especially if you use [[indexing:hierarchies_and_collections|hierarchies and collections]].
+===== Minification =====
+One thing you should also do is minifying JS and CSS files. This removes whitespaces and line breaks. It can by done by your IDE. Netbeans for example has a plugin Js CSS Minify Compress. The minified files must be configured in theme.config.php and in some cases in the theme files. Just search for ".js" and replace with ".min.js". If you use LESS to create your CSS files, there is an option --clean-css which optimizes your CSS, too.
+:!: Manual minification should not be necessary if you turn on VuFind's built-in asset pipeline (see above).
 ====== Solr Tuning ======
@@ Line 236: / Line 240: @@
 See the [[configuration:remote_marc_records|Remote MARC Records]] page for details on reducing index size by storing MARC records externally to your Solr index. (Note: requires VuFind 2.5 or newer).
+===== Limits =====
+Certain operating system limits can impact Solr performance, and starting with release 7.3.1, the software will warn you if you are below the recommended thresholds. See the [[administration:starting_and_stopping_solr#linux_method|Linux startup instructions]] for notes on how to correct this problem.
 ===== Further Reading =====
   * [[administration:solr_replication|Solr Replication]] - Basic information about making Solr highly available with replication in the context of VuFind.
+  * [[administration:fault_tolerance_and_load_balancing|Fault Tolerance and Load Balancing]] - Fault tolerance and load balancing strategies with VuFind.
   * [[http://wiki.apache.org/solr/SolrPerformanceFactors|Solr Wiki - Performance Factors]] - Pros and cons of various Solr configuration options; also linked to other helpful wiki pages.
   * [[http://groups.google.com/group/solrmarc-tech/browse_thread/thread/fe329385bb1dc953|solrmarc-tech indexing time thread]] - A discussion which goes into detail on several significant Solr settings.