Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

PIP-120 : Enable client memory limit controller by default #13344

Merged
merged 2 commits into from
Jan 22, 2022
Merged

PIP-120 : Enable client memory limit controller by default #13344

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a754347
Enable client memory limit controller by default
HQebupt Dec 15, 2021
f4e6d2d
Deprecate maxPendingMessagesAcrossPartitions
HQebupt Dec 16, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions pulsar-client-api/src/main/java/org/apache/pulsar/client/api/ProducerBuilder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,7 @@ public interface ProducerBuilder<T> extends Cloneable {
* the client application. Until, the producer gets a successful acknowledgment back from the broker,
* it will keep in memory (direct memory pool) all the messages in the pending queue.
*
* <p>Default is 1000.
* <p>Default is 0, disable the pending messages check.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should also deprecate maxPendingMessagesAcrossPartitions() (and setting it to 0 by default), because memory limit is a better approach to limit the max amount of memory.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done. The maxPendingMessagesAcrossPartitions and maxPendingMessages are deprecated.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh, but let's not deprecate this one (maxPendingMessages), since there will still be legitimate reasons to set a max number of messages.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK, done.

*
* @param maxPendingMessages
* the max size of the pending messages queue for the producer
Expand All @@ -188,7 +188,7 @@ public interface ProducerBuilder<T> extends Cloneable {
* The purpose of this setting is to have an upper-limit on the number
* of pending messages when publishing on a partitioned topic.
*
* <p>Default is 50000.
* <p>Default is 0, disable the pending messages across partitions check.
*
* <p>If publishing at high rate over a topic with many partitions (especially when publishing messages without a
* partitioning key), it might be beneficial to increase this parameter to allow for more pipelining within the
Expand All @@ -198,6 +198,7 @@ public interface ProducerBuilder<T> extends Cloneable {
* max pending messages across all the partitions
* @return the producer builder instance
*/
@Deprecated
ProducerBuilder<T> maxPendingMessagesAcrossPartitions(int maxPendingMessagesAcrossPartitions);

/**
Expand Down
1 change: 1 addition & 0 deletions pulsar-client/src/main/java/org/apache/pulsar/client/impl/ProducerBuilderImpl.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,6 +145,7 @@ public ProducerBuilder<T> maxPendingMessages(int maxPendingMessages) {
return this;
}

@Deprecated
@Override
public ProducerBuilder<T> maxPendingMessagesAcrossPartitions(int maxPendingMessagesAcrossPartitions) {
conf.setMaxPendingMessagesAcrossPartitions(maxPendingMessagesAcrossPartitions);
Expand Down
4 changes: 2 additions & 2 deletions pulsar-client/src/main/java/org/apache/pulsar/client/impl/conf/ClientConfigurationData.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -270,9 +270,9 @@ public class ClientConfigurationData implements Serializable, Cloneable {

@ApiModelProperty(
name = "memoryLimitBytes",
value = "Limit of client memory usage (in byte)."
value = "Limit of client memory usage (in byte). The 64M default can guarantee a high producer throughput."
)
private long memoryLimitBytes = 0;
private long memoryLimitBytes = 64 * 1024 * 1024;

@ApiModelProperty(
name = "proxyServiceUrl",
Expand Down
4 changes: 2 additions & 2 deletions ...ar-client/src/main/java/org/apache/pulsar/client/impl/conf/ProducerConfigurationData.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,8 @@ public class ProducerConfigurationData implements Serializable, Cloneable {
private static final long serialVersionUID = 1L;

public static final int DEFAULT_BATCHING_MAX_MESSAGES = 1000;
public static final int DEFAULT_MAX_PENDING_MESSAGES = 1000;
public static final int DEFAULT_MAX_PENDING_MESSAGES_ACROSS_PARTITIONS = 50000;
public static final int DEFAULT_MAX_PENDING_MESSAGES = 0;
public static final int DEFAULT_MAX_PENDING_MESSAGES_ACROSS_PARTITIONS = 0;

private String topicName = null;
private String producerName = null;
Expand Down
4 changes: 2 additions & 2 deletions pulsar-client/src/test/java/org/apache/pulsar/client/impl/ProducerBuilderImplTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -346,12 +346,12 @@ public void testProducerBuilderImplWhenSendTimeoutPropertyIsNegative() {

@Test(expectedExceptions = IllegalArgumentException.class)
public void testProducerBuilderImplWhenMaxPendingMessagesAcrossPartitionsPropertyIsInvalid() {
producerBuilderImpl.maxPendingMessagesAcrossPartitions(999);
producerBuilderImpl.maxPendingMessagesAcrossPartitions(-1);
}

@Test(expectedExceptions = IllegalArgumentException.class, expectedExceptionsMessageRegExp = "maxPendingMessagesAcrossPartitions needs to be >= maxPendingMessages")
public void testProducerBuilderImplWhenMaxPendingMessagesAcrossPartitionsPropertyIsInvalidErrorMessages() {
producerBuilderImpl.maxPendingMessagesAcrossPartitions(999);
producerBuilderImpl.maxPendingMessagesAcrossPartitions(-1);
}

@Test
Expand Down