Rally - On-premises: An error has occurred trying to run your search

Products

• Rally On-Premise
• Rally SaaS

Issue/Introduction

When trying to perform a search, the search fails and reports the following error:

An error has occurred trying to run your search. The error has been recorded.

Environment

Release:
Component: ACPREM

Cause

This error can be caused by the search service running out of memory.

This can be verified by gathering a log bundle from the Control Panel and looking at the solr-startup.log file.
Searching for "Caused by" will typically locate the first instance of the problem and the message may appear as follows:

Caused by: java.lang.OutOfMemoryError: Java heap space

Resolution

It may be necessary to increase the memory assigned to the search service.  You are welcome to open a support case to perform this action if you are not comfortable working on the command line or if you do not have root access to your appliance.

Increasing search memory allocation

1. Log in as root to your appliance
2. Edit /home/appuser/etc/rally_node_overrides.cfg using your preferred text editor
   
   • Example:
     

     # nano /home/appuser/etc/rally_node_overrides.cfg

3. Locate the following line: 
   

   • set(:solr_max_memory) { "256m" }

4. Change 256 to 512:
   

   • set(:solr_max_memory) { "512m" }

5. Restart the Agile Central services
6. Verify that the setting has been updated using 'ps'
   

   1. # ps ax | grep solr| grep 512m

   2. 14622 ?        Sl     3:08 /usr/lib/jvm/jdk1.8.0_144/bin/java -Dkill-tag=false -DLOG_DIR=/home/appuser/domains/solr/logs -Dlogback.configurationFile=file:///home/appuser/appserver-config-latest/solr/etc/logback.xml -Dsolr.solr.home=/home/appuser/appserver-config-latest/solr/homes/alm -Dsolr.data.dir=/home/appuser/solrdata -DSOLR_BIND_ADDRESS=rallyonprem-oraclese -DSOLR_HTTP_SERVER_PORT=8081 -DSOLR_MASTER_ENABLED=true -DSOLR_SLAVE_ENABLED=false -DSOLR_SLAVE_MASTER_URL=http://rallyonprem-oraclese:8081/solr/alm/replication -DSOLR_HTTP_BASIC_AUTH_USER=solr -DSOLR_HTTP_BASIC_AUTH_PASSWORD=solr -Dcom.sun.management.jmxremote -Dcom.sun.management.jmxremote.port=6003 -Dcom.sun.management.jmxremote.ssl=false -Dcom.sun.management.jmxremote.authenticate=false -Djava.awt.headless=true -Djava.security.egd=file:///dev/urandom -Djetty.home=/home/appuser/appserver-config-latest/jetty-9 -Djetty.base=/home/appuser/appserver-config-latest/jetty-9 -Drally.jetty.home=/home/appuser/appserver-config-latest/solr -disableassertions -Xms128m -Xmx512m -Xloggc:/home/appuser/domains/solr/logs/gc.log -XX:MaxPermSize=256m -XX:+PrintGCDetails -XX:+PrintGCTimeStamps -XX:-TraceClassUnloading -XX:NewRatio=3 -XX:+UseCompressedOops -XX:+UseG1GC -jar /home/appuser/appserver-config-latest/solr/webapps/solr-jetty-uberjar.jar /home/appuser/appserver-config-latest/solr/etc/jetty-users.properties /home/appuser/appserver-config-latest/solr/etc/jetty.xml