[Segment Replication] Introduce primary weight factor for primary shards distribution

[dreamer-89]

Description

This change introduces the mechanism to balance primary shards across cluster

• Introduce new weight factor PRIMARY_BALANCE_FACTOR_SETTING setting which defines the constant for primary shards; used to calculate the weight on node. This factor defines the tendency to balance the primary shards; higher the value more chances of even distribution. This setting's default is initially set to 0.0f to avoid rebalance disruption in existing clusters. The other settings used in weight calculation are INDEX_BALANCE_FACTOR_SETTING govern shards/node specific to index and SHARD_BALANCE_FACTOR_SETTING shards/node.
• This needed changes in utilities classes ModelIndex, ModelNode; used for weight calculation.
• It changes existing TriConsumer to conform to existing Java Consumer interface definition and related unit tests changes. It used as consumer to reflect settings changes to WeightFunction.
• Unit tests in BalanceConfigurationTests to verify shard distribution with new setting.
• Integration tests

Default setting consideration

PRIMARY_BALANCE_FACTOR_SETTING is initially set to 0 to prevent unnecessary disruption in doc rep indices. One improvement is to use some sane default when there are segrep enabled indices to automatically balance cluster based on primary shard. This is difficult as

1. There is no single default which works for all cluster configuration. Added a task in [Segment Replication] Update shard allocation to evenly distribute primaries. #5240 to perform analysis on shard distribution for different configuration so that we can come up with some guidance.
2. Giving control to customer is better over automatic primary shard allocation; to allow primary allocation to be performed when needed based on resource consumption and consent.

Issues Resolved

#5240

Check List

• New functionality includes testing.
  • All tests pass
• New functionality has been documented.
  • New functionality has javadoc added
• Commits are signed per the DCO using --signoff
• Commit changes are listed out in CHANGELOG.md file (See: Changelog)

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

[github-actions]

Gradle Check (Jenkins) Run Completed with:

• RESULT: FAILURE ❌
• URL: https://build.ci.opensearch.org/job/gradle-check/9935/
• CommitID: 00e8900
  Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green.
  Is the failure a flaky test unrelated to your change?

[github-actions]

Gradle Check (Jenkins) Run Completed with:

• RESULT: SUCCESS ✅
• URL: https://build.ci.opensearch.org/job/gradle-check/10254/
• CommitID: 92e9713

[codecov-commenter]

Codecov Report

Merging #6017 (11b0c80) into main (c5a1bdf) will decrease coverage by 0.15%.
The diff coverage is 72.22%.

📣 This organization is not using Codecov’s GitHub App Integration. We recommend you install it so Codecov can continue to function properly for your repositories. Learn more

@@             Coverage Diff              @@
##               main    #6017      +/-   ##
============================================
- Coverage     70.87%   70.72%   -0.15%     
+ Complexity    58830    58752      -78     
============================================
  Files          4776     4778       +2     
  Lines        280993   281074      +81     
  Branches      40598    40617      +19     
============================================
- Hits         199141   198794     -347     
- Misses        65488    65852     +364     
- Partials      16364    16428      +64     

Impacted Files	Coverage Δ
...r/routing/allocation/allocator/ShardsBalancer.java	25.00% <0.00%> (-8.34%)	⬇️
...c/main/java/org/opensearch/common/TriConsumer.java	0.00% <0.00%> (ø)
...rg/opensearch/common/settings/ClusterSettings.java	91.89% <ø> (ø)
...search/common/settings/AbstractScopedSettings.java	86.91% <25.00%> (-1.25%)	⬇️
...in/java/org/opensearch/common/collect/Triplet.java	53.33% <53.33%> (ø)
...va/org/opensearch/cluster/routing/RoutingNode.java	78.78% <85.71%> (+0.25%)	⬆️
.../allocation/allocator/BalancedShardsAllocator.java	90.57% <85.71%> (-1.78%)	⬇️
...n/java/org/opensearch/common/settings/Setting.java	90.09% <95.23%> (+0.16%)	⬆️
...ting/allocation/allocator/LocalShardsBalancer.java	85.01% <100.00%> (+0.32%)	⬆️
...egations/support/MultiTermsValuesSourceConfig.java	80.32% <100.00%> (ø)
... and 483 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

[github-actions]

Gradle Check (Jenkins) Run Completed with:

• RESULT: SUCCESS ✅
• URL: https://build.ci.opensearch.org/job/gradle-check/10502/
• CommitID: 11b0c80

[mch2]

LGTM, thanks @dreamer-89 for this change!