diff --git a/site2/docs/client-libraries-java.md b/site2/docs/client-libraries-java.md index 55bb130f07012..a56f12d0b10f2 100644 --- a/site2/docs/client-libraries-java.md +++ b/site2/docs/client-libraries-java.md @@ -130,6 +130,24 @@ 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 configuration +You can set the client memory allocator configurations through Java properties.
+ +| Property | Type |
Description
| Default | Available values +|---|---|---|---|--- +`pulsar.allocator.pooled` | String | If set to `true`, the client uses a direct memory pool.
If set to `false`, the client uses a heap memory without pool | true |
  • true
  • false
  • +`pulsar.allocator.exit_on_oom` | String | Whether to exit the JVM when OOM happens | false |
  • true
  • false
  • +`pulsar.allocator.leak_detection` | String | Service URL provider for Pulsar service | Disabled |
  • Disabled
  • Simple
  • Advanced
  • Paranoid
  • +`pulsar.allocator.out_of_memory_policy` | String | When an OOM occurs, the client throws an exception or fallbacks to heap | FallbackToHeap |
  • ThrowException
  • FallbackToHeap
  • + +**Example**: +``` +-Dpulsar.allocator.pooled=true +-Dpulsar.allocator.exit_on_oom=false +-Dpulsar.allocator.leak_detection=Disabled +-Dpulsar.allocator.out_of_memory_policy=ThrowException +``` + ## Producer In Pulsar, producers write messages to topics. Once you've instantiated a {@inject: javadoc:PulsarClient:/client/org/apache/pulsar/client/api/PulsarClient} object (as in the section [above](#client-configuration)), you can create a {@inject: javadoc:Producer:/client/org/apache/pulsar/client/api/Producer} for a specific Pulsar [topic](reference-terminology.md#topic). diff --git a/site2/website-next/docs/client-libraries-java.md b/site2/website-next/docs/client-libraries-java.md index 8c4fda1465652..dc54b794baf13 100644 --- a/site2/website-next/docs/client-libraries-java.md +++ b/site2/website-next/docs/client-libraries-java.md @@ -151,6 +151,24 @@ 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 configuration +You can set the client memory allocator configurations through Java properties.
    + +| Property | Type |
    Description
    | Default | Available values +|---|---|---|---|--- +`pulsar.allocator.pooled` | String | If set to `true`, the client uses a direct memory pool.
    If set to `false`, the client uses a heap memory without pool | true |
  • true
  • false
  • +`pulsar.allocator.exit_on_oom` | String | Whether to exit the JVM when OOM happens | false |
  • true
  • false
  • +`pulsar.allocator.leak_detection` | String | Service URL provider for Pulsar service | Disabled |
  • Disabled
  • Simple
  • Advanced
  • Paranoid
  • +`pulsar.allocator.out_of_memory_policy` | String | When an OOM occurs, the client throws an exception or fallbacks to heap | FallbackToHeap |
  • ThrowException
  • FallbackToHeap
  • + +**Example**: +``` +-Dpulsar.allocator.pooled=true +-Dpulsar.allocator.exit_on_oom=false +-Dpulsar.allocator.leak_detection=Disabled +-Dpulsar.allocator.out_of_memory_policy=ThrowException +``` + ## Producer In Pulsar, producers write messages to topics. Once you've instantiated a {@inject: javadoc:PulsarClient:/client/org/apache/pulsar/client/api/PulsarClient} object (as in the section [above](#client-configuration)), you can create a {@inject: javadoc:Producer:/client/org/apache/pulsar/client/api/Producer} for a specific Pulsar [topic](reference-terminology.md#topic).