Uploaded image for project: 'Solr'
  1. Solr
  2. SOLR-16647

Circuit breaker examples are wrong and don't match documentation

    XMLWordPrintableJSON

Details

    • Improvement
    • Status: Closed
    • Trivial
    • Resolution: Fixed
    • None
    • main (10.0), 9.2
    • None
    • None

    Description

      I was diffing the solrconfig.xml in _default and sample_techproducts_configs and saw that they had different circuitBreaker config. The one in _default uses invalid tags according to https://solr.apache.org/guide/solr/latest/deployment-guide/circuit-breakers.html#circuit-breaker-configurations

      The default config attempts to enable circuit breakers, but I don't think they actually are enabled given the apparently invalid XML tags

      https://github.com/apache/solr/blob/92b376a17482496a197ce9c20b5b757f9b354724/solr/server/solr/configsets/_default/conf/solrconfig.xml#L578

       

      The sample techproducts config has them commented out, but uses the correct tags

      https://github.com/apache/solr/blob/c96c78132d77974adaec62ffaaf4b819f76f49a9/solr/server/solr/configsets/sample_techproducts_configs/conf/solrconfig.xml#L600

       

       

      Also the documentation says to configure the breakers like this:

      <str name="memEnabled">true</str>
      <str name="memThreshold">75</str>
      <str name="cpuEnabled">true</str>
      <str name="cpuThreshold">75</str>

      But the example configs use

      <memoryCircuitBreakerThresholdPct>100</memoryCircuitBreakerThresholdPct>
      
      <cpuBreaker enabled="true" threshold="75"/>

      Looks like documentation is correct and the examples are wrong: https://github.com/apache/solr/blob/c99af207c761ec34812ef1cc3054eb2804b7448b/solr/core/src/java/org/apache/solr/util/circuitbreaker/CircuitBreakerManager.java#L160:L163

       

      Attachments

        Issue Links

          Activity

            People

              krisden Kevin Risden
              colvinco Colvin Cowie
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved:

                Time Tracking

                  Estimated:
                  Original Estimate - Not Specified
                  Not Specified
                  Remaining:
                  Remaining Estimate - 0h
                  0h
                  Logged:
                  Time Spent - 20m
                  20m