[threadstats] Ensure ThreadStats and DogStatsd event() signatures match
#712
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
…es match Since 0.43, statsd has renamed a positional argument `text` to `message`. When a user is invoking the API of this method with kwargs for named parameters it no longer can be used to swap seamlessly between ThreadStats and DogStatsd. This change ensures that both positional args have the same names. Closes: #707
sgnn7
added
resource/dogstatsd
resource/threadstats
backward-incompatible
|
/azp run |
|
Azure Pipelines successfully started running 2 pipeline(s). |
|
/azp run |
|
Azure Pipelines successfully started running 2 pipeline(s). |
|
/azp run |
|
Azure Pipelines successfully started running 2 pipeline(s). |
therve
approved these changes
Feb 3, 2022
hush-hush
approved these changes
Feb 3, 2022
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.
What does this PR do?
Changes
textpositional arg in threadstats tomessageCloses: #707
Description of the Change
Since 0.43,
statsdhas renamed a positional argumenttexttomessage. When a user is invoking the API of this method withkwargsfor namedparameters it no longer can be used to swap seamlessly between
ThreadStatsandDogStatsd. This change ensures that both positional argshave the same names.
For more info: #707 (comment)
Alternate Designs
Possible Drawbacks
Potentially a breaking change for users of ThreadStats if they use
event()withnamed positional args. Release notes are updated to make that clear.
Verification Process
CI/CD tests
Additional Notes
Release Notes
ThreadStats().event()andDogStatsd.event()now both usemessageinstead oftextas the name of the second positional argumentReview checklist (to be filled by reviewers)
changelog/label attached. If applicable it should have thebackward-incompatiblelabel attached.do-not-merge/label attached.kind/andseverity/labels attached at least.