Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

SOLR-17187: make replica poll interval configurable #3144

Open
wants to merge 10 commits into
base: main
Choose a base branch
from

Conversation

cpoerschke
Copy link
Contributor

Continuation of @tboeghk's #2316 as a new pull request since pushing to the PR's branch is not possible (due to org vs. individual repo fork).

  • merged in latest origin/main
  • added (minimal) Solr Ref Guide update
  • added solr/CHANGES.txt entry

https://issues.apache.org/jira/browse/SOLR-17187

tboeghk and others added 10 commits February 22, 2024 13:53
A supplied `commitPollInterval` in `updateHandler` this has precendence over one calculated from hard/soft commit settings
Also add tests for retrieving and selecting the commit interval
Co-authored-by: Christine Poerschke <[email protected]>
Co-authored-by: Christine Poerschke <[email protected]>
Co-authored-by: Christine Poerschke <[email protected]>
- Move poll interval determination into single method
Resolved Conflicts:
	solr/core/src/java/org/apache/solr/handler/ReplicationHandler.java
@github-actions github-actions bot added documentation Improvements or additions to documentation tests cat:cloud labels Jan 29, 2025
@cpoerschke cpoerschke marked this pull request as ready for review January 29, 2025 17:01
Copy link
Contributor

@epugh epugh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for picking up this PR that has languished for a long time!

pollIntervalStr = calculatedPollIntervalString;
}
final SolrConfig.UpdateHandlerInfo uinfo = core.getSolrConfig().getUpdateHandlerInfo();
final String pollIntervalStr = determinePollInterval(uinfo);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is nicer.

*/
public static String determinePollInterval(SolrConfig.UpdateHandlerInfo uinfo) {
int hardCommitMaxTime = uinfo.autoCommmitMaxTime;
int softCommitMaxTime = uinfo.autoSoftCommmitMaxTime;
boolean hardCommitNewSearcher = uinfo.openSearcher;
String pollIntervalStr = null;
if (hardCommitMaxTime != -1) {
String customCommitPollInterval = uinfo.commitPollInterval;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

with the comment about the never null, do we need some sort of assert in here?

String customCommitPollInterval = uinfo.commitPollInterval;
String pollIntervalStr = "00:00:03";

if (System.getProperty("jetty.testMode") != null) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

are we still doing System.getProperty? I thought we had something else that abstracted this away? So you could use a system property or a config file? Maybe my imagination!

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You are thinking of EnvUtils but that's for real/operational settings a user might set. That doesn't apply here.

@@ -1485,7 +1486,8 @@ private Long readIntervalMs(String interval) {
return TimeUnit.MILLISECONDS.convert(readIntervalNs(interval), TimeUnit.NANOSECONDS);
}

private Long readIntervalNs(String interval) {
@VisibleForTesting
public static Long readIntervalNs(String interval) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do you need the public if you have @VisibleForTesting, or is that just to remind us why it's public?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

indeed; it explains why it's more open than it otherwise needs to be

private String jettyTestMode;

@Before
public void setUp() {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

don't we have some sort of Rule thing these days for this? @dsmiley ???

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Indeed we do. Firstly, all Solr tests ought to extend SolrTestCase, at least indirectly. This test doesn't; it should be modified. Secondly, STCJ4 includes:

  @Rule public TestRule solrTestRules = RuleChain.outerRule(new SystemPropertiesRestoreRule());

That obsoletes the setup & tearDown here.

So for now, I suggest removing the setup & teardown here and subclass STCJ4. It's a TODO for me in my work on making SolrTestCase a better base class to transition that line from STCJ4 to STC.

@@ -62,6 +62,8 @@ It is recommended that this be set for as long as is reasonable given the applic
A hard commit means that, if a server crashes, Solr will know exactly where your data was stored; a soft commit means that the data is stored, but the location information isn't yet stored.
The tradeoff is that a soft commit gives you faster visibility because it's not waiting for background merges to finish.

In a TLOG/PULL replica setup, the commit configuration also influences the interval at which the replica is polling the shard leader. You may optionally configure a custom `commitPollInterval`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please start new sentences on new lines. Not sure if this style choice is stated somewhere. Goal is reducing diffs and reducing need for line wrap.

@@ -1485,7 +1486,8 @@ private Long readIntervalMs(String interval) {
return TimeUnit.MILLISECONDS.convert(readIntervalNs(interval), TimeUnit.NANOSECONDS);
}

private Long readIntervalNs(String interval) {
@VisibleForTesting
public static Long readIntervalNs(String interval) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

indeed; it explains why it's more open than it otherwise needs to be

private String jettyTestMode;

@Before
public void setUp() {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Indeed we do. Firstly, all Solr tests ought to extend SolrTestCase, at least indirectly. This test doesn't; it should be modified. Secondly, STCJ4 includes:

  @Rule public TestRule solrTestRules = RuleChain.outerRule(new SystemPropertiesRestoreRule());

That obsoletes the setup & tearDown here.

So for now, I suggest removing the setup & teardown here and subclass STCJ4. It's a TODO for me in my work on making SolrTestCase a better base class to transition that line from STCJ4 to STC.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cat:cloud documentation Improvements or additions to documentation tests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants