[Docs][LoadBalancing] Add/Improve Javadocs for LoadSheddingStrategy impls #12180
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
|
@hangc0276 - PTAL, since you were the original author of the |
Anonymitaet
reviewed
Sep 26, 2021
pulsar-broker/src/main/java/org/apache/pulsar/broker/loadbalance/impl/OverloadShedder.java
Outdated
Show resolved
Hide resolved
pulsar-broker/src/main/java/org/apache/pulsar/broker/loadbalance/impl/OverloadShedder.java
Outdated
Show resolved
Hide resolved
pulsar-broker/src/main/java/org/apache/pulsar/broker/loadbalance/impl/ThresholdShedder.java
Outdated
Show resolved
Hide resolved
pulsar-broker/src/main/java/org/apache/pulsar/broker/loadbalance/impl/ThresholdShedder.java
Outdated
Show resolved
Hide resolved
pulsar-broker/src/main/java/org/apache/pulsar/broker/loadbalance/impl/ThresholdShedder.java
Outdated
Show resolved
Hide resolved
Anonymitaet
added
the
doc
Co-authored-by: Anonymitaet <50226895+Anonymitaet@users.noreply.github.com>
|
/pulsarbot run-failure-checks |
|
@Anonymitaet - PTAL. The tests are passing now. Thanks! |
Anonymitaet
approved these changes
Sep 29, 2021
bharanic-dev
pushed a commit
to bharanic-dev/pulsar
that referenced
this pull request
Mar 18, 2022
…mpls (apache#12180) * [LoadBalancing] Add/Improve Javadocs for LoadSheddingStrategy impls * Use present tense Co-authored-by: Anonymitaet <50226895+Anonymitaet@users.noreply.github.com> Co-authored-by: Anonymitaet <50226895+Anonymitaet@users.noreply.github.com>
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.
Motivation
I recently researched the implementations of the
LoadSheddingStrategyinterface. I thought the Javadocs could be improved to make it easier for users/developers to better understand the classes.Modifications
ThresholdShedder. I got some of my understanding for the code and some from Add ThresholdShedder Strategy for loadbalancer and expose loadbalance metric to prometheus #6772.OverloadShedderVerifying this change
I read through the code to write this documentation. It is possible that I misunderstood it, so I will request reviews from contributors that have written these classes.
Does this pull request potentially affect one of the following parts:
No public/breaking changes.
Documentation
This is an update to the docs.