Anonymitaet commented on a change in pull request #12481:
URL: https://github.com/apache/pulsar/pull/12481#discussion_r736073231
##########
File path: site2/website-next/docs/client-libraries-java.md
##########
@@ -151,6 +151,16 @@ Check out the Javadoc for the {@inject:
javadoc:PulsarClient:/client/org/apache/
> In addition to client-level configuration, you can also apply
> [producer](#configure-producer) and [consumer](#configure-consumer) specific
> configuration as described in sections below.
+### client memory allocator settings
Review comment:
```suggestion
### Client memory allocator configuration
```
##########
File path: site2/website-next/docs/client-libraries-java.md
##########
@@ -151,6 +151,16 @@ Check out the Javadoc for the {@inject:
javadoc:PulsarClient:/client/org/apache/
> In addition to client-level configuration, you can also apply
> [producer](#configure-producer) and [consumer](#configure-consumer) specific
> configuration as described in sections below.
+### client memory allocator settings
+The client memory allocator parameters are config through java property.<br/>
+example: `-Dpulsar.allocator.pooled=true -Dpulsar.allocator.exit_on_oom=false
-Dpulsar.allocator.leak_detection=Disabled
-Dpulsar.allocator.out_of_memory_policy=ThrowException`
+| Property | Type | <div>Description</div> | Default
+|---|---|---|---
+`pulsar.allocator.pooled` | String | If set to true, the client use direct
memory pool. False use the heap memory without pool | true
+`pulsar.allocator.exit_on_oom` | String | Whether to exit the jvm when OOM
happen | false
+`pulsar.allocator.leak_detection` | String | Service URL provider for Pulsar
service | Disabled
+`pulsar.allocator.out_of_memory_policy` | String | When OOM, throw exception
or fallback to heap | FallbackToHeap
+
Review comment:
**Example**
```
-Dpulsar.allocator.pooled=true
-Dpulsar.allocator.exit_on_oom=false
-Dpulsar.allocator.leak_detection=Disabled
-Dpulsar.allocator.out_of_memory_policy=ThrowException
```
##########
File path: site2/website-next/docs/client-libraries-java.md
##########
@@ -151,6 +151,16 @@ Check out the Javadoc for the {@inject:
javadoc:PulsarClient:/client/org/apache/
> In addition to client-level configuration, you can also apply
> [producer](#configure-producer) and [consumer](#configure-consumer) specific
> configuration as described in sections below.
+### client memory allocator settings
+The client memory allocator parameters are config through java property.<br/>
+example: `-Dpulsar.allocator.pooled=true -Dpulsar.allocator.exit_on_oom=false
-Dpulsar.allocator.leak_detection=Disabled
-Dpulsar.allocator.out_of_memory_policy=ThrowException`
+| Property | Type | <div>Description</div> | Default
Review comment:
I think we need to add a column named "available values" to tell uses
what kind of values they can set. For example, the available values of
`pulsar.allocator.out_of_memory_policy` are `ThrowException` and
`FallbackToHeap`.
##########
File path: site2/website-next/docs/client-libraries-java.md
##########
@@ -151,6 +151,16 @@ Check out the Javadoc for the {@inject:
javadoc:PulsarClient:/client/org/apache/
> In addition to client-level configuration, you can also apply
> [producer](#configure-producer) and [consumer](#configure-consumer) specific
> configuration as described in sections below.
+### client memory allocator settings
+The client memory allocator parameters are config through java property.<br/>
+example: `-Dpulsar.allocator.pooled=true -Dpulsar.allocator.exit_on_oom=false
-Dpulsar.allocator.leak_detection=Disabled
-Dpulsar.allocator.out_of_memory_policy=ThrowException`
+| Property | Type | <div>Description</div> | Default
+|---|---|---|---
+`pulsar.allocator.pooled` | String | If set to true, the client use direct
memory pool. False use the heap memory without pool | true
+`pulsar.allocator.exit_on_oom` | String | Whether to exit the jvm when OOM
happen | false
+`pulsar.allocator.leak_detection` | String | Service URL provider for Pulsar
service | Disabled
+`pulsar.allocator.out_of_memory_policy` | String | When OOM, throw exception
or fallback to heap | FallbackToHeap
Review comment:
```suggestion
`pulsar.allocator.out_of_memory_policy` | String | When an OOM occurs, the
client throws an exception or fallbacks to heap | FallbackToHeap
```
##########
File path: site2/website-next/docs/client-libraries-java.md
##########
@@ -151,6 +151,16 @@ Check out the Javadoc for the {@inject:
javadoc:PulsarClient:/client/org/apache/
> In addition to client-level configuration, you can also apply
> [producer](#configure-producer) and [consumer](#configure-consumer) specific
> configuration as described in sections below.
+### client memory allocator settings
+The client memory allocator parameters are config through java property.<br/>
Review comment:
```suggestion
You can set the client memory allocator configurations through Java
properties.<br/>
```
##########
File path: site2/website-next/docs/client-libraries-java.md
##########
@@ -151,6 +151,16 @@ Check out the Javadoc for the {@inject:
javadoc:PulsarClient:/client/org/apache/
> In addition to client-level configuration, you can also apply
> [producer](#configure-producer) and [consumer](#configure-consumer) specific
> configuration as described in sections below.
+### client memory allocator settings
+The client memory allocator parameters are config through java property.<br/>
+example: `-Dpulsar.allocator.pooled=true -Dpulsar.allocator.exit_on_oom=false
-Dpulsar.allocator.leak_detection=Disabled
-Dpulsar.allocator.out_of_memory_policy=ThrowException`
Review comment:
```suggestion
```
Move the example to the end
##########
File path: site2/website-next/docs/client-libraries-java.md
##########
@@ -151,6 +151,16 @@ Check out the Javadoc for the {@inject:
javadoc:PulsarClient:/client/org/apache/
> In addition to client-level configuration, you can also apply
> [producer](#configure-producer) and [consumer](#configure-consumer) specific
> configuration as described in sections below.
+### client memory allocator settings
+The client memory allocator parameters are config through java property.<br/>
+example: `-Dpulsar.allocator.pooled=true -Dpulsar.allocator.exit_on_oom=false
-Dpulsar.allocator.leak_detection=Disabled
-Dpulsar.allocator.out_of_memory_policy=ThrowException`
+| Property | Type | <div>Description</div> | Default
Review comment:
##########
File path: site2/website-next/docs/client-libraries-java.md
##########
@@ -151,6 +151,16 @@ Check out the Javadoc for the {@inject:
javadoc:PulsarClient:/client/org/apache/
> In addition to client-level configuration, you can also apply
> [producer](#configure-producer) and [consumer](#configure-consumer) specific
> configuration as described in sections below.
+### client memory allocator settings
+The client memory allocator parameters are config through java property.<br/>
+example: `-Dpulsar.allocator.pooled=true -Dpulsar.allocator.exit_on_oom=false
-Dpulsar.allocator.leak_detection=Disabled
-Dpulsar.allocator.out_of_memory_policy=ThrowException`
+| Property | Type | <div>Description</div> | Default
+|---|---|---|---
+`pulsar.allocator.pooled` | String | If set to true, the client use direct
memory pool. False use the heap memory without pool | true
+`pulsar.allocator.exit_on_oom` | String | Whether to exit the jvm when OOM
happen | false
Review comment:
```suggestion
`pulsar.allocator.exit_on_oom` | String | Whether to exit the JVM when OOM
happens | false
```
##########
File path: site2/website-next/docs/client-libraries-java.md
##########
@@ -151,6 +151,16 @@ Check out the Javadoc for the {@inject:
javadoc:PulsarClient:/client/org/apache/
> In addition to client-level configuration, you can also apply
> [producer](#configure-producer) and [consumer](#configure-consumer) specific
> configuration as described in sections below.
+### client memory allocator settings
+The client memory allocator parameters are config through java property.<br/>
+example: `-Dpulsar.allocator.pooled=true -Dpulsar.allocator.exit_on_oom=false
-Dpulsar.allocator.leak_detection=Disabled
-Dpulsar.allocator.out_of_memory_policy=ThrowException`
+| Property | Type | <div>Description</div> | Default
+|---|---|---|---
+`pulsar.allocator.pooled` | String | If set to true, the client use direct
memory pool. False use the heap memory without pool | true
Review comment:
```suggestion
`pulsar.allocator.pooled` | String | If set to `true`, the client uses a
direct memory pool. </br> If set to `false`, the client uses a heap memory
without pool | true
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
