Skip to content

Add Cluster-Level Instance Operation Count Metrics#58

Merged
LZD-PratyushBhatt merged 3 commits intodevfrom
lzd/clusterLevelInstanceOpCount
Oct 27, 2025
Merged

Add Cluster-Level Instance Operation Count Metrics#58
LZD-PratyushBhatt merged 3 commits intodevfrom
lzd/clusterLevelInstanceOpCount

Conversation

@LZD-PratyushBhatt
Copy link
Collaborator

Issues

  • My PR addresses the following Helix issues and references them in the PR description:
    This PR adds cluster-level metrics to count how many instances are currently in each Instance Operation state.

(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)
This Change introduces cluster-wide metrics to count instances in each Instance Operation state (ENABLE, DISABLE, EVACUATE, SWAP_IN, UNKNOWN).

Metrics exposed (cluster-level):

  • InstancesInOperationEnableGauge
  • InstancesInOperationDisableGauge
  • InstancesInOperationEvacuateGauge
  • InstancesInOperationSwapInGauge
  • InstancesInOperationUnknownGauge

Tests

  • The following tests are written for this issue:
    testClusterLevelInstanceOperationCounts

Manually tested with real Helix Cluster, works fine!
image

(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)

_totalPastDueMsgSize.set(totalPastDueMsgSize);

// Count instances by operation type (cluster-level metrics)
long enableCount = 0;
Copy link
Collaborator

Choose a reason for hiding this comment

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

create a map of perOperationInstanceCount. Then do
long count = perOperationInstanceCount.get(config.getInstanceOperation().getOperation())
perOperationInstanceCount.put(config.getInstanceOperation().getOperation(), count+1)

From the getInstancesInOperationEnableGauge return perOperationInstanceCount[ENABLE]

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Done

if (instanceConfigMap != null) {
for (Map.Entry<String, InstanceConfig> entry : instanceConfigMap.entrySet()) {
InstanceConfig config = entry.getValue();
InstanceConstants.InstanceOperation operation;
Copy link
Collaborator

Choose a reason for hiding this comment

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

nit: set the instance operation to ENABLE here, that way you won't require to add the else block

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Done

Copy link
Collaborator

@proud-parselmouth proud-parselmouth left a comment

Choose a reason for hiding this comment

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

LGTM. Added a nit comment.

@LZD-PratyushBhatt LZD-PratyushBhatt merged commit 18a8990 into dev Oct 27, 2025
1 of 2 checks passed
ashiijo pushed a commit that referenced this pull request Oct 30, 2025
* Add Cluster-Level Instance Operation Count Metrics

* Address review comments

* Address review comments3
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants