[SOLR-11233] GC_LOG_OPTS customisation is a little confusing

• Type: Task
• Status: Closed
• Priority: Minor
• Resolution: Fixed
• Fix Version/s: 9.0, 8.9
• Assignee: Christine Poerschke
• Reporter: Christine Poerschke
• Created: 14/Aug/17 12:59
• Updated: 23/Jun/21 13:43
• Resolved: 19/Mar/21 18:54

Description

GC_LOG_OPTS customisation is currently supported but (pre Java 9) the customised settings are supplemented e.g. https://github.com/apache/lucene-solr/blob/releases/lucene-solr/6.6.0/solr/bin/solr#L1713

GC_LOG_OPTS+=("$gc_log_flag:$SOLR_LOGS_DIR/solr_gc.log" '-XX:+UseGCLogFileRotation' '-XX:NumberOfGCLogFiles=9' '-XX:GCLogFileSize=20M')

This seems unexpected and confusing. Some ideas for making it less confusing:

• a new GC_LOG_FILE_OPTS option
  • the new option can be customised but if unset it would default to existing behaviour

• use customised GC_LOG_OPTS 'as is'
  • this would be a change to existing behaviour i.e. the solr#L1713 settings mentioned above would no longer be appended

Issue Links

• relates to: SOLR-7728 bin/solr script: add port number to GC log filename
• relates to: SOLR-9971 Parameterise where solr creates its console and gc log files
• links to: GitHub Pull Request #2284