Skip to content

Include cluster name in WAGED async rebalance thread names#189

Open
LZD-PratyushBhatt wants to merge 2 commits into
devfrom
lzd/waged-thread-name-cluster-context
Open

Include cluster name in WAGED async rebalance thread names#189
LZD-PratyushBhatt wants to merge 2 commits into
devfrom
lzd/waged-thread-name-cluster-context

Conversation

@LZD-PratyushBhatt
Copy link
Copy Markdown
Collaborator

The async baseline and best-possible calculation tasks run on single-thread executors with default JVM thread names (pool-N-thread-1), so WAGED rebalance failure logs lose cluster context when a single controller JVM hosts multiple WAGED-managed clusters. This makes correlating errors across clusters in shared log stores difficult.

Rename the executor thread to WagedGlobalRebalance- / WagedPartialRebalance- for the duration of each task and restore the original name in a finally block (the executor's single thread is reused across submissions, so restoration prevents stale names from leaking into the next task). Also include the cluster name explicitly in the LOG.error messages for easier grep.

Issues

  • My PR addresses the following Helix issues and references them in the PR description:

(apache#200 - Link your issue number here: You can write "Fixes #XXX". Please use the proper keyword so that the issue gets closed automatically. See https://docs.github.com/en/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue
Any of the following keywords can be used: close, closes, closed, fix, fixes, fixed, resolve, resolves, resolved)

Description

  • Here are some details about my PR, including screenshots of any UI changes:

(Write a concise description including what, why, how)

Tests

  • The following tests are written for this issue:

(List the names of added unit/integration tests)

  • The following is the result of the "mvn test" command on the appropriate module:

(If CI test fails due to known issue, please specify the issue and test PR locally. Then copy & paste the result of "mvn test" to here.)

Changes that Break Backward Compatibility (Optional)

  • My PR contains changes that break backward compatibility or previous assumptions for certain methods or API. They include:

(Consider including all behavior changes for public methods or API. Also include these changes in merge description so that other developers are aware of these changes. This allows them to make relevant code changes in feature branches accounting for the new method/API behavior.)

Documentation (Optional)

  • In case of new functionality, my PR adds documentation in the following wiki page:

(Link the GitHub wiki you added)

Commits

  • My commits all reference appropriate Apache Helix GitHub issues in their subject lines. In addition, my commits follow the guidelines from "How to write a good git commit message":
    1. Subject is separated from body by a blank line
    2. Subject is limited to 50 characters (not including Jira issue reference)
    3. Subject does not end with a period
    4. Subject uses the imperative mood ("add", not "adding")
    5. Body wraps at 72 characters
    6. Body explains "what" and "why", not "how"

Code Quality

  • My diff has been formatted using helix-style.xml
    (helix-style-intellij.xml if IntelliJ IDE is used)

prabhatt added 2 commits May 28, 2026 00:36
The async baseline and best-possible calculation tasks run on
single-thread executors with default JVM thread names (pool-N-thread-1),
so WAGED rebalance failure logs lose cluster context when a single
controller JVM hosts multiple WAGED-managed clusters. This makes
correlating errors across clusters in shared log stores difficult.

Rename the executor thread to WagedGlobalRebalance-<cluster> /
WagedPartialRebalance-<cluster> for the duration of each task and
restore the original name in a finally block (the executor's single
thread is reused across submissions, so restoration prevents stale
names from leaking into the next task). Also include the cluster name
explicitly in the LOG.error messages for easier grep.
TestWagedRebalanceThreadNaming exercises GlobalRebalanceRunner and
PartialRebalanceRunner through the synchronous WagedRebalancer test
constructor. Two cases:

- testThreadNameContainsClusterNameAndIsRestored: happy path. The
  injected RebalanceAlgorithm records Thread.currentThread() and its
  name on each calculate() invocation. We assert at least one global
  and one partial call were observed, every observed name matches
  WagedGlobalRebalance-<cluster> or WagedPartialRebalance-<cluster>,
  and the captured Thread refs have no WAGED prefix after the rebalance
  returns (proving the finally block restored).

- testThreadNameRestoredEvenWhenAlgorithmThrows: failure path. A
  throwing algorithm captures the thread name during calculate() and
  then raises HelixRebalanceException. We assert names captured during
  the failing call still contain the cluster name, and the executor
  thread name is still restored after the exception propagates. This
  is the scenario where missing restoration would cause the most
  damage (next baseline calc logging under the wrong cluster).
@LZD-PratyushBhatt LZD-PratyushBhatt force-pushed the lzd/waged-thread-name-cluster-context branch from 6728c9c to 9d99098 Compare May 27, 2026 19:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant