Support negative threshold for bigger-is-better in other tools #149
Conversation
This file contains 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
ningziwen
reviewed
May 10, 2023
| @@ -210,7 +210,7 @@ function validateAlertThreshold(alertThreshold: number | null, failThreshold: nu | |||
| if (alertThreshold === null) { | |||
| throw new Error("'alert-threshold' input must not be empty"); | |||
| } | |||
| if (failThreshold && alertThreshold > failThreshold) { | |||
| if (failThreshold && Math.abs(alertThreshold) > Math.abs(failThreshold)) { | |||
There was a problem hiding this comment.
Is this a breaking change as it adds another scenario that can alert?
The breaking change may be prevented if we add an additional configrable field to toggle this. (as you stated in PR description)
WDYT? How strict are we treating breaking change? @ktrz
There was a problem hiding this comment.
I'm not super fond of the current solution. I would much rather modify the biggerIsBetter function to determine the value based on the units as well.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Hi, I'd like to request support for using existing tools with a bigger-is-better ratio for alerts. My use case is for JMH which has both a throughput and an execution time mode, I'd like to be able to specify if bigger or smaller is better without dealing with a custom benchmark.
The idea in this PR is that by specifying a negative threshold, you would be indicating that a decrease is something to alert on, but otherwise operates the same. Ideally, we would be able to specify bigger or smaller is better on a per-benchmark case, but that looks like it would require more thought, so in the meantime I thought I'd suggest a quick fix so we can use it asap :)