Advanced settings

  Administration > System administration > Server > Admin Console Management >

Advanced settings

Previous pageNext page Print this topic! Mail us feedback on this topic!

The following advanced settings can be configured through the Admin Console. This is typically only done when working with Jama Support.

 

Accessing advanced settings

1.Use a browser to navigate to Admin Console > Settings and scroll to the bottom.

advanced settings 01

 

2.Expand the pertinent advanced settings by selecting the checkbox next to Show Advanced Memory Settings or Show Advanced Startup Settings. Configuration details can be found below.
3.Select Save and navigate to Dashboard at the top of the screen.
4.Return to the "Save the settings and go to the dashboard" section on the Installation of Jama page

 

Advanced memory settings

 

The advanced memory settings allow making changes to the memory allocation of containers that are running Java processes:

oCore Jama application: uses 4GB by default, plus a proportion of the remaining total memory
oSearch service: uses 1GB by default, plus a proportion of the remaining total memory
oElasticsearch: uses 2GB by default, plus a proportion of the remaining total memory

 

advanced settings 02 memory

 

The memory settings can be expressed as a simple formula, using:

oOperators "+", "-", "/" and "*"
oBrackets "(" and ")" to specify order of operations
oThe $total variable to reference the total memory of the application server
oNumbers with units KB, MB, GB, or percentages "%"

 

When changing memory settings, make sure to not over-allocate the total memory of the application server. Also make sure to leave a fair amount of memory available for system processes.

 

Advanced startup settings

The advanced startup settings allow the enablement of JMX remote for containers that are running Java processes:

oCore Jama application
oSearch service
oElasticsearch

The formula can also be used to set an exact memory amount, e.g.: 10GB.

When JMX is enabled, the port number can be specified. Make sure to not overlap JMX ports between containers. Also make sure to not overlap other ports that are already in use on the application server.

Note that the JMX support is meant for troubleshooting and should be used in a secure environment, as there is no authentication on the JMX ports when JMX is enabled.

The advanced startup settings also allow to set additional JVM options (JAVA_OPTS) for containers that are running Java processes. Note that each of these containers already adds a number of their own JVM options that may clash with additional JVM options configured here.

A single Java RMI server host name can be given that works across all containers that have JMX enabled. The host IP address will be used by default. However, if the host IP address is not accessible by the JMX client for the configured JMX ports, the public host name or the public host IP should be set here. If an SSH tunnel is used, the host name should be set to "localhost".

 

advanced settings 03 startup jmx jvm

 

The Advanced Startup Settings also allow to set additional services configuration, specific to Jama, such as throttling.

 

advanced settings 04 startup services configuration

 

Sentry Crash Reporting

Sentry is a tool for real-time crash monitoring that reports on error messages and stack traces. The "Additional Java JVM options for Jama core" can be used to enable Sentry by adding a Sentry DSN to the options: -DSENTRY_DSN=<your_dsn>

You can obtain a Sentry DSN in the "Client Keys (DSN)" section for your project, inside Sentry. After adding this option, you need to restart Jama.

Note: This option is only available for Jama core (and not for the other containers).

 

GC Logging

Logging of garbage collection (GC logging) is automatically enabled for containers that are running Java processes. GC log files will be available alongside other log files for the respective container (see Folder Locations). Note that on restart of the Jama application, previous GC log files are packaged as a ZIP file to start fresh. The default GC logging configuration should be sufficient, but it is possible to override GC logging parameters through the additional JVM options (see above).