[MINOR] Publish HUDI version metrics as integers #17466
Open
+220
−0
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…rs via the metric system. These metrics can be used to track the versions of HUDI in production. Added HoodieVersion class and its unit test, The HoodieVersion class provides semantic versioning information for HUDI code.
prashantwason
changed the title
Collaborator
yihua
reviewed
Dec 3, 2025
Comment on lines
+179
to
+187
| if (config.isMetricsOn()) { | ||
| // report userName and hudi version | ||
| final String version = HoodieVersion.get(); | ||
| metrics.getMetrics().registerGauge(metrics.getMetricsName("userName", System.getProperty("user.name")), 1); | ||
| metrics.getMetrics().registerGauge(metrics.getMetricsName("version", StringUtils.isNullOrEmpty(version) ? "0.14.x" : version), 1); | ||
| metrics.getMetrics().registerGauge("version.major", HoodieVersion.majorAsInt()); | ||
| metrics.getMetrics().registerGauge("version.minor", HoodieVersion.minorAsInt()); | ||
| metrics.getMetrics().registerGauge("version.patch", HoodieVersion.patchAsInt()); | ||
| } |
Contributor
There was a problem hiding this comment.
Could the logic be put into HoodieMetrics class, similar to HoodieMetrics#emitIndexTypeMetrics?
Comment on lines
+184
to
+186
| metrics.getMetrics().registerGauge("version.major", HoodieVersion.majorAsInt()); | ||
| metrics.getMetrics().registerGauge("version.minor", HoodieVersion.minorAsInt()); | ||
| metrics.getMetrics().registerGauge("version.patch", HoodieVersion.patchAsInt()); |
Contributor
There was a problem hiding this comment.
Are these still needed if the full version is published?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Describe the issue this Pull Request addresses
This PR provides the HoodieVersion class and publishes the major, minor, and patch version of HUDI as integers via the metric system. These metrics can be used to track the versions of HUDI running in production.
Summary and Changelog
Summary:
HoodieVersionclass that provides semantic versioning information for HUDI codeChangelog:
New HoodieVersion class (hudi-common/src/main/java/org/apache/hudi/HoodieVersion.java):
get()major(),minor(),patch()majorAsInt(),minorAsInt(),patchAsInt()New TestHoodieVersion test class (hudi-common/src/test/java/org/apache/hudi/TestHoodieVersion.java):
Updated BaseHoodieWriteClient (hudi-client/hudi-client-common/src/main/java/org/apache/hudi/client/BaseHoodieWriteClient.java):
Impact
Public API Changes: None - This is additive only
User-Facing Changes:
version.major,version.minor,version.patch(as integers)Performance Impact: Negligible - metrics are registered once during client initialization
Risk Level
Low
The changes are additive and do not modify existing behavior. The HoodieVersion class is straightforward with comprehensive unit tests. Metrics registration happens during client initialization and has minimal overhead.
Verification:
Documentation Update
None required. This is an internal metrics improvement. The version information is already documented as part of commit metadata.
Contributor's checklist