From c7a05b49a665dcca1ab5f52e2f00c7642178d150 Mon Sep 17 00:00:00 2001 From: Zike Yang Date: Tue, 9 Aug 2022 11:13:43 +0800 Subject: [PATCH] [fix][doc] Fix wrong description of `pulsar.allocator.leak_detection` and remove Client memory allocator configuration from the old version doc Signed-off-by: Zike Yang --- site2/docs/client-libraries-java.md | 2 +- .../client-libraries-java.md | 21 ------------------- .../version-2.10.0/client-libraries-java.md | 2 +- .../version-2.10.1/client-libraries-java.md | 2 +- .../version-2.2.0/client-libraries-java.md | 21 ------------------- .../version-2.3.0/client-libraries-java.md | 21 ------------------- .../version-2.3.2/client-libraries-java.md | 21 ------------------- 7 files changed, 3 insertions(+), 87 deletions(-) diff --git a/site2/docs/client-libraries-java.md b/site2/docs/client-libraries-java.md index 670736ad3adf1..eab3446a349fc 100644 --- a/site2/docs/client-libraries-java.md +++ b/site2/docs/client-libraries-java.md @@ -168,7 +168,7 @@ You can set the client memory allocator configurations through Java properties.< |---|---|---|---|--- `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.leak_detection` | String | The leak detection policy for Pulsar bytebuf allocator.
  • **Disabled**: No leak detection and no overhead.
  • **Simple**: Instruments 1% of the allocated buffer to track for leaks.
  • **Advanced**: Instruments 1% of the allocated buffer to track for leaks, reporting stack traces of places where the buffer is used.
  • **Paranoid**: Instruments 100% of the allocated buffer to track for leaks, reporting stack traces of places where the buffer is used and introduces a significant overhead.
    • | 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**: diff --git a/site2/website/versioned_docs/version-2.1.1-incubating/client-libraries-java.md b/site2/website/versioned_docs/version-2.1.1-incubating/client-libraries-java.md index b201e8573e8cc..386bc5ef4da4c 100644 --- a/site2/website/versioned_docs/version-2.1.1-incubating/client-libraries-java.md +++ b/site2/website/versioned_docs/version-2.1.1-incubating/client-libraries-java.md @@ -160,27 +160,6 @@ 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 - -``` - ### Cluster-level failover This chapter describes the concept, benefits, use cases, constraints, usage, working principles, and more information about the cluster-level failover. It contains the following sections: diff --git a/site2/website/versioned_docs/version-2.10.0/client-libraries-java.md b/site2/website/versioned_docs/version-2.10.0/client-libraries-java.md index 030d9f6f9d5fe..0b402f1cc456d 100644 --- a/site2/website/versioned_docs/version-2.10.0/client-libraries-java.md +++ b/site2/website/versioned_docs/version-2.10.0/client-libraries-java.md @@ -168,7 +168,7 @@ You can set the client memory allocator configurations through Java properties.< |---|---|---|---|--- `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.leak_detection` | String | The leak detection policy for Pulsar bytebuf allocator.
  • **Disabled**: No leak detection and no overhead.
  • **Simple**: Instruments 1% of the allocated buffer to track for leaks.
  • **Advanced**: Instruments 1% of the allocated buffer to track for leaks, reporting stack traces of places where the buffer is used.
  • **Paranoid**: Instruments 100% of the allocated buffer to track for leaks, reporting stack traces of places where the buffer is used and introduces a significant overhead.
    • | 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**: diff --git a/site2/website/versioned_docs/version-2.10.1/client-libraries-java.md b/site2/website/versioned_docs/version-2.10.1/client-libraries-java.md index efba798e6b2da..b2aa8f815d1f6 100644 --- a/site2/website/versioned_docs/version-2.10.1/client-libraries-java.md +++ b/site2/website/versioned_docs/version-2.10.1/client-libraries-java.md @@ -168,7 +168,7 @@ You can set the client memory allocator configurations through Java properties.< |---|---|---|---|--- `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.leak_detection` | String | The leak detection policy for Pulsar bytebuf allocator.
  • **Disabled**: No leak detection and no overhead.
  • **Simple**: Instruments 1% of the allocated buffer to track for leaks.
  • **Advanced**: Instruments 1% of the allocated buffer to track for leaks, reporting stack traces of places where the buffer is used.
  • **Paranoid**: Instruments 100% of the allocated buffer to track for leaks, reporting stack traces of places where the buffer is used and introduces a significant overhead.
    • | 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**: diff --git a/site2/website/versioned_docs/version-2.2.0/client-libraries-java.md b/site2/website/versioned_docs/version-2.2.0/client-libraries-java.md index b201e8573e8cc..386bc5ef4da4c 100644 --- a/site2/website/versioned_docs/version-2.2.0/client-libraries-java.md +++ b/site2/website/versioned_docs/version-2.2.0/client-libraries-java.md @@ -160,27 +160,6 @@ 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 - -``` - ### Cluster-level failover This chapter describes the concept, benefits, use cases, constraints, usage, working principles, and more information about the cluster-level failover. It contains the following sections: diff --git a/site2/website/versioned_docs/version-2.3.0/client-libraries-java.md b/site2/website/versioned_docs/version-2.3.0/client-libraries-java.md index b201e8573e8cc..386bc5ef4da4c 100644 --- a/site2/website/versioned_docs/version-2.3.0/client-libraries-java.md +++ b/site2/website/versioned_docs/version-2.3.0/client-libraries-java.md @@ -160,27 +160,6 @@ 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 - -``` - ### Cluster-level failover This chapter describes the concept, benefits, use cases, constraints, usage, working principles, and more information about the cluster-level failover. It contains the following sections: diff --git a/site2/website/versioned_docs/version-2.3.2/client-libraries-java.md b/site2/website/versioned_docs/version-2.3.2/client-libraries-java.md index b201e8573e8cc..386bc5ef4da4c 100644 --- a/site2/website/versioned_docs/version-2.3.2/client-libraries-java.md +++ b/site2/website/versioned_docs/version-2.3.2/client-libraries-java.md @@ -160,27 +160,6 @@ 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 - -``` - ### Cluster-level failover This chapter describes the concept, benefits, use cases, constraints, usage, working principles, and more information about the cluster-level failover. It contains the following sections: