[SPARK-46644] Change add and merge in SQLMetric to use isZero #44649
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
davintjong-db
changed the title
cloud-fan
reviewed
Jan 10, 2024
sql/core/src/main/scala/org/apache/spark/sql/execution/metric/SQLMetrics.scala
Show resolved
Hide resolved
cloud-fan
reviewed
Jan 12, 2024
| // and instead return defaultValidValue. | ||
| override def value: Long = if (!isValid) defaultValidValue else _value | ||
| // and instead return 0. | ||
| override def value: Long = if (!isValid) 0 else _value |
Contributor
There was a problem hiding this comment.
can we do if (isZero) 0 else _value? or we are worried about negative values due to bugs?
Contributor
Author
There was a problem hiding this comment.
Hm, it seems like tests fail because of a test with a positive initValue.
assert(SQLMetrics.createNanoTimingMetric(sparkContext, name = "m", initValue = 5).value === 5)
I don't think we ever use a positive initValue so we could either remove this or stick with the original check if(_value < 0).
cloud-fan
approved these changes
Jan 18, 2024
Contributor
|
thanks, merging to master! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
What changes were proposed in this pull request?
A previous refactor mistakenly used
isValidfor add. SincedefaultValidValuewas always0, this didn't cause any correctness issues.What we really want to do for add (and merge) is
if (isZero) _value = 0.Also removing
isValidsince its redundant, ifdefaultValidValueis always0.Why are the changes needed?
There are no correctness errors, but this is confusing and error-prone.
A negative
defaultValidValuewas intended to allow creating optional metrics. With the previous behavior this would incorrectly add the sentinel value.defaultValidValueis supposed to determine what value is exposed to the user.Does this PR introduce any user-facing change?
No.
How was this patch tested?
Running the tests.
Was this patch authored or co-authored using generative AI tooling?
No.