imported>Jason.nicholls at 09:52, 10 July 2014

2014-07-10T09:52:26Z

← Older revision		Revision as of 09:52, 10 July 2014
Line 1:		Line 1:
	[[Category:enPortal 5.5]]		[[Category:enPortal 5.5]]
	{{DISPLAYTITLE:Memory Configuration}}		{{DISPLAYTITLE:Memory Configuration}}
	~~This page details some settings that the AppBoard system administrator can modify to allocate the proper amount of server memory to AppBoard.~~

			== Overview ==

	~~== Memory Tuning ==~~		enPortal is a Java application and therefore only uses as much memory as the Java Runtime Environment is configured to use, regardless of how much actual memory the server has available. By default the enPortal turnkey installation is configured to only use 2GB of RAM to ensure it can run on a large variety of systems. This default should be changed on production systems to make use of all allocated memory.


	{{Tip\|~~If your system is experiencing lag or~~ performance ~~issues, or you see the error message "Out of heap space", you may want to allocate additional memory to the Java Virtual Machine~~.}}		{{Tip\|Read over the [[enportal/5.5/admin/enPortal_installation/performance_and_sizing\|Performance Tuning & Sizing]] page for a broader look at overall performance considerations.}}

			== Memory Runtime Options ==

	The heap size is the amount of Java object storage memory the Java Virtual Machine (JVM) is allowed to allocate. By default enPortal / AppBoard size the maximum heap size (-Xmx) option to work on a system with 2GB minimum physical RAM. Please refer to the [[~~appboard~~/2.5/admin/runtime_options\|Runtime Options]] page for the ~~current~~ default ~~settings and where to make changes to these~~ values.		Refer to the [[enportal/5.5/admin/enPortal_installation/installation/runtime_options\|Runtime Options]] page for all runtime options, including memory options and the default configuration values. The important options are documented below with additional information:


	== ~~Tuning~~ JAVA_MEMORY_MAX (-Xmx) ==		=== <tt>JAVA_MEMORY_MAX</tt> (-Xmx) ===

	For a server dedicated to running enPortal ~~/ AppBoard~~ allocate as much available ~~physical~~ memory as possible. It's important to avoid allocating ~~too much~~ memory however, as this may lead to the OS using swap memory (i.e. disk) further degrading system performance. Factor in memory the OS is using itself, other applications on the system, and the <tt>JAVA_PERM_SIZE_MAX</tt> setting too.		For a server dedicated to running enPortal allocate as much available memory as possible. It's important to avoid allocating ''all'' memory however, as this may lead to the OS using swap memory (i.e. disk) further degrading system performance. Factor in memory the OS is using itself, other applications on the system, and the <tt>JAVA_PERM_SIZE_MAX</tt> setting too.

	On 32-bit operating systems there is a theoretical limit of 4GB but in practice it depends. On 32-bit Windows systems the max -Xmx setting that will work is around 1.6GB. On 32-bit Linux systems it's closer to 3GB.		On 32-bit operating systems there is a theoretical limit of 4GB but in practice it depends. On 32-bit Windows systems the max -Xmx setting that will work is around 1.6GB. On 32-bit Linux systems it's closer to 3GB.

	== ~~Tuning JAVA_PERM_SIZE_MAX~~ (-~~XX:MaxPermSize~~) ==		=== <tt>JAVA_MEMORY_INIT</tt> (-Xms) ===

	Memory reserved for permanent generation is in addition to the ~~<tt>-Xmx</tt>~~ value ~~configured~~ above. If there are <tt>java.lang.OutOfMemoryError:		This sets the initial memory allocation requested by the Java runtime environment, which can then grow to the max size.

			For production environments with dedicated resources this should be set to match the max value.

			=== <tt>JAVA_PERM_SIZE_MAX</tt> (-XX:MaxPermSize) ===

			The following applies only for Java 7 as Java 8 uses a different model.

			Memory reserved for permanent generation is in addition to the max value above. If there are <tt>java.lang.OutOfMemoryError:
	PermGen space</tt> errors in the logs then it is necessary to increase this value.		PermGen space</tt> errors in the logs then it is necessary to increase this value.

	== Monitoring Garbage Collection ==		=== Monitoring Garbage Collection ===

	Monitoring the JVM garbage collection events can provide insight into how ~~AppBoard~~ is utilizing the memory available to it and help to diagnose performance issues and out of memory issues.		Monitoring the JVM garbage collection events can provide insight into how enPortal is utilizing the memory available to it and help to diagnose performance issues and out of memory issues.

	To enable GC logging use the <tt>JAVA_GC_LOGGING</tt> runtime option which will generate a <tt>gc.log</tt> log file in the ~~AppBoard~~ logs directory. Enabling GC logging is not resource intensive and does not create a huge log - it is '''safe for production use'''. The ~~AppBoard~~ server must be restarted after changing this option.		To enable GC logging use the <tt>JAVA_GC_LOGGING</tt> runtime option which will generate a <tt>gc.log</tt> log file in the enPortal logs directory. Enabling GC logging is not resource intensive and does not create a huge log - it is '''safe for production use'''. The enPortal server must be restarted after changing this option.

	Analysing the gc.log file produced is possible with a number of tools such as [https://github.com/chewiebug/GCViewer GCViewer], or Edge Support may be able to provide assistance by sending us the <tt>gc.log</tt> for analysis.		Analysing the gc.log file produced is possible with a number of tools such as [https://github.com/chewiebug/GCViewer GCViewer], or Edge Support may be able to provide assistance by sending us the <tt>gc.log</tt> for analysis.

imported>Jason.nicholls: 1 revision

2014-07-10T05:09:11Z

1 revision

← Older revision	Revision as of 05:09, 10 July 2014
(No difference)

imported>Jason.nicholls at 06:56, 1 April 2014

2014-04-01T06:56:21Z

New page

[[Category:enPortal 5.5]]
{{DISPLAYTITLE:Memory Configuration}}
This page details some settings that the AppBoard system administrator can modify to allocate the proper amount of server memory to AppBoard.

== Memory Tuning ==

{{Tip|If your system is experiencing lag or performance issues, or you see the error message "Out of heap space", you may want to allocate additional memory to the Java Virtual Machine.}}

The heap size is the amount of Java object storage memory the Java Virtual Machine (JVM) is allowed to allocate. By default enPortal / AppBoard size the maximum heap size (-Xmx) option to work on a system with 2GB minimum physical RAM. Please refer to the [[appboard/2.5/admin/runtime_options|Runtime Options]] page for the current default settings and where to make changes to these values.

== Tuning JAVA_MEMORY_MAX (-Xmx) ==

For a server dedicated to running enPortal / AppBoard allocate as much available physical memory as possible. It's important to avoid allocating too much memory however, as this may lead to the OS using swap memory (i.e. disk) further degrading system performance. Factor in memory the OS is using itself, other applications on the system, and the <tt>JAVA_PERM_SIZE_MAX</tt> setting too.

On 32-bit operating systems there is a theoretical limit of 4GB but in practice it depends. On 32-bit Windows systems the max -Xmx setting that will work is around 1.6GB. On 32-bit Linux systems it's closer to 3GB.

== Tuning JAVA_PERM_SIZE_MAX (-XX:MaxPermSize) ==

Memory reserved for permanent generation is in addition to the <tt>-Xmx</tt> value configured above. If there are <tt>java.lang.OutOfMemoryError:
PermGen space</tt> errors in the logs then it is necessary to increase this value.

== Monitoring Garbage Collection ==

Monitoring the JVM garbage collection events can provide insight into how AppBoard is utilizing the memory available to it and help to diagnose performance issues and out of memory issues.

To enable GC logging use the <tt>JAVA_GC_LOGGING</tt> runtime option which will generate a <tt>gc.log</tt> log file in the AppBoard logs directory. Enabling GC logging is not resource intensive and does not create a huge log - it is '''safe for production use'''. The AppBoard server must be restarted after changing this option.

Analysing the gc.log file produced is possible with a number of tools such as [https://github.com/chewiebug/GCViewer GCViewer], or Edge Support may be able to provide assistance by sending us the <tt>gc.log</tt> for analysis.

Enportal/5.5/admin/enPortal installation/installation/memory configuration - Revision history

imported>Jason.nicholls at 09:52, 10 July 2014

imported>Jason.nicholls: 1 revision

imported>Jason.nicholls at 06:56, 1 April 2014