This is an automated email from the ASF dual-hosted git repository. lhotari pushed a commit to branch main in repository https://gitbox.apache.org/repos/asf/pulsar-site.git
commit 03068b2de7b45c9c3426fad9477134e573146dd3 Author: Lari Hotari <[email protected]> AuthorDate: Wed Apr 9 12:24:35 2025 +0300 update reference for 4.0.4 --- .../4.0.x/client/client-configuration-client.md | 4 +- .../4.0.x/client/client-configuration-consumer.md | 14 ++- .../4.0.x/config/reference-configuration-broker.md | 101 ++++++++++++++++++--- .../4.0.x/config/reference-configuration-client.md | 4 +- .../config/reference-configuration-pulsar-proxy.md | 15 ++- .../config/reference-configuration-standalone.md | 101 ++++++++++++++++++--- .../config/reference-configuration-websocket.md | 6 +- .../4.0.x/pulsar/delete-cluster-metadata.md | 3 + 8 files changed, 213 insertions(+), 35 deletions(-) diff --git a/static/reference/4.0.x/client/client-configuration-client.md b/static/reference/4.0.x/client/client-configuration-client.md index 8dc58d553f2..ba5b5fa211c 100644 --- a/static/reference/4.0.x/client/client-configuration-client.md +++ b/static/reference/4.0.x/client/client-configuration-client.md @@ -182,14 +182,14 @@ Number of IO threads. **Type**: `int` -**Default**: `14` +**Default**: `1` ### numListenerThreads Number of consumer listener threads. **Type**: `int` -**Default**: `14` +**Default**: `1` ### operationTimeoutMs Client operation timeout (in milliseconds). diff --git a/static/reference/4.0.x/client/client-configuration-consumer.md b/static/reference/4.0.x/client/client-configuration-consumer.md index f54a86c61f9..8a9a7ecc170 100644 --- a/static/reference/4.0.x/client/client-configuration-consumer.md +++ b/static/reference/4.0.x/client/client-configuration-consumer.md @@ -135,6 +135,16 @@ This setting reduces the receiver queue size for individual partitions if the to **Default**: `50000` +### negativeAckPrecisionBitCnt +The redelivery time precision bit count. The lower bits of the redelivery time will betrimmed to reduce the memory occupation. +The default value is 8, which means theredelivery time will be bucketed by 256ms, the redelivery time could be earlier(no later)than the expected time, but no more than 256ms. +If set to k, the redelivery time will bebucketed by 2^k ms. +If the value is 0, the redelivery time will be accurate to ms. + +**Type**: `int` + +**Default**: `8` + ### negativeAckRedeliveryBackoff Interface for custom message is negativeAcked policy. You can specify `RedeliveryBackoff` for a consumer. @@ -233,9 +243,9 @@ When subscribing to a topic using a regular expression, you can pick a certain t ### replicateSubscriptionState If `replicateSubscriptionState` is enabled, a subscription state is replicated to geo-replicated clusters. -**Type**: `boolean` +**Type**: `java.lang.Boolean` -**Default**: `false` +**Default**: `null` ### subscriptionInitialPosition Initial position at which to set cursor when subscribing to a topic at first time. diff --git a/static/reference/4.0.x/config/reference-configuration-broker.md b/static/reference/4.0.x/config/reference-configuration-broker.md index 9fd5b499843..17f1957f108 100644 --- a/static/reference/4.0.x/config/reference-configuration-broker.md +++ b/static/reference/4.0.x/config/reference-configuration-broker.md @@ -1535,6 +1535,17 @@ control the number of replicas for storing the package **Category**: Packages Management +### activeConsumerFailoverConsistentHashing +Enable consistent hashing for selecting the active consumer in partitioned topics with Failover subscription type.For non-partitioned topics, consistent hashing is used by default. + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Policies + ### activeConsumerFailoverDelayTimeMillis How long to delay rewinding cursor and dispatching messages when active consumer is changed @@ -2651,6 +2662,17 @@ Used to specify multiple advertised listeners for the broker. The value must for **Category**: Server +### allowAclChangesOnNonExistentTopics +Opt-out of topic-existence check when setting permissions + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Server + ### allowOverrideEntryFilters Whether allow topic level entry filters policies overrides broker configuration. @@ -3039,6 +3061,17 @@ If value is "org.apache.pulsar.broker.delayed.BucketDelayedDeliveryTrackerFactor **Category**: Server +### dispatchRateLimiterFactoryClassName +The class name of the factory that creates DispatchRateLimiter implementations. Current options are org.apache.pulsar.broker.service.persistent.DispatchRateLimiterFactoryAsyncTokenBucket (default, PIP-322 implementation) org.apache.pulsar.broker.service.persistent.DispatchRateLimiterFactoryClassic (legacy implementation) + +**Type**: `java.lang.String` + +**Default**: `org.apache.pulsar.broker.service.persistent.DispatchRateLimiterFactoryAsyncTokenBucket` + +**Dynamic**: `false` + +**Category**: Server + ### dispatchThrottlingForFilteredEntriesEnabled Whether the broker should count filtered entries in dispatch rate limit calculations. When disabled, only messages sent to a consumer count towards a dispatch rate limit at the broker, topic, and subscription level. When enabled, messages filtered out due to entry filter logic are counted towards each relevant rate limit. @@ -3503,7 +3536,7 @@ Max memory size for broker handling messages sending from producers. **Type**: `int` -**Default**: `4608` +**Default**: `4454` **Dynamic**: `true` @@ -3783,7 +3816,7 @@ Number of threads to use for pulsar broker service. The executor in thread pool **Type**: `int` -**Default**: `14` +**Default**: `1` **Dynamic**: `false` @@ -3794,7 +3827,7 @@ Number of threads to use for HTTP requests processing Default is set to `2 * Run **Type**: `int` -**Default**: `28` +**Default**: `8` **Dynamic**: `false` @@ -3805,7 +3838,7 @@ Number of threads to use for Netty IO. Default is set to `2 * Runtime.getRuntime **Type**: `int` -**Default**: `28` +**Default**: `2` **Dynamic**: `false` @@ -4033,7 +4066,7 @@ Number of worker threads to serve topic ordered executor **Type**: `int` -**Default**: `14` +**Default**: `1` **Dynamic**: `false` @@ -4373,7 +4406,7 @@ Number of BookKeeper client IO threads. Default is Runtime.getRuntime().availabl **Type**: `int` -**Default**: `28` +**Default**: `2` **Dynamic**: `false` @@ -4384,7 +4417,7 @@ Number of BookKeeper client worker threads. Default is Runtime.getRuntime().avai **Type**: `int` -**Default**: `14` +**Default**: `1` **Dynamic**: `false` @@ -4957,7 +4990,7 @@ This memory is allocated from JVM direct memory and it's shared across all the t **Type**: `int` -**Default**: `1843` +**Default**: `1781` **Dynamic**: `true` @@ -4996,6 +5029,17 @@ How frequently to flush the cursor positions that were accumulated due to rate l **Category**: Storage (Managed Ledger) +### managedLedgerCursorResetLedgerCloseTimestampMaxClockSkewMillis +When resetting a subscription by timestamp, the broker will use the ledger closing timestamp metadata to determine the range of ledgers to search for the message where the subscription position is reset to. Since by default, the search condition is based on the message publish time provided by the client at the publish time, there will be some clock skew between the ledger closing timestamp metadata and the publish time. This configuration is used to set the max clock skew between the [...] + +**Type**: `int` + +**Default**: `60000` + +**Dynamic**: `true` + +**Category**: Storage (Managed Ledger) + ### managedLedgerCursorRolloverTimeInSeconds Max time before triggering a rollover on a cursor ledger @@ -5180,6 +5224,28 @@ Maximum time before forcing a ledger rollover for a topic **Category**: Storage (Managed Ledger) +### managedLedgerMaxReadsInFlightPermitsAcquireQueueSize +Maximum number of reads that can be queued for acquiring permits for max reads in flight when managedLedgerMaxReadsInFlightSizeInMB is set (\>0) and the limit is reached. + +**Type**: `int` + +**Default**: `50000` + +**Dynamic**: `false` + +**Category**: Storage (Managed Ledger) + +### managedLedgerMaxReadsInFlightPermitsAcquireTimeoutMillis +Maximum time to wait for acquiring permits for max reads in flight when managedLedgerMaxReadsInFlightSizeInMB is set (\>0) and the limit is reached. + +**Type**: `long` + +**Default**: `60000` + +**Dynamic**: `false` + +**Category**: Storage (Managed Ledger) + ### managedLedgerMaxReadsInFlightSizeInMB Maximum buffer size for bytes read from storage. This is the memory retained by data read from storage (or cache) until it has been delivered to the Consumer Netty channel. Use O to disable @@ -5302,7 +5368,7 @@ Number of threads to be used for managed ledger scheduled tasks **Type**: `int` -**Default**: `14` +**Default**: `1` **Dynamic**: `false` @@ -5321,6 +5387,17 @@ Default is ``. **Category**: Storage (Managed Ledger) +### managedLedgerPersistIndividualAckAsLongArray +Whether persist cursor ack stats as long arrays, which will compress the data and reduce GC rate + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Storage (Managed Ledger) + ### managedLedgerPrometheusStatsLatencyRolloverSeconds Managed ledger prometheus stats latency rollover seconds @@ -5599,7 +5676,7 @@ Number of threads to use for pulsar transaction replay PendingAckStore or Transa **Type**: `int` -**Default**: `14` +**Default**: `1` **Dynamic**: `false` @@ -5742,7 +5819,7 @@ Number of connections per Broker in Pulsar Client used in WebSocket proxy **Type**: `int` -**Default**: `14` +**Default**: `1` **Dynamic**: `false` @@ -5764,7 +5841,7 @@ Number of IO threads in Pulsar Client used in WebSocket proxy **Type**: `int` -**Default**: `14` +**Default**: `1` **Dynamic**: `false` diff --git a/static/reference/4.0.x/config/reference-configuration-client.md b/static/reference/4.0.x/config/reference-configuration-client.md index 8dc58d553f2..ba5b5fa211c 100644 --- a/static/reference/4.0.x/config/reference-configuration-client.md +++ b/static/reference/4.0.x/config/reference-configuration-client.md @@ -182,14 +182,14 @@ Number of IO threads. **Type**: `int` -**Default**: `14` +**Default**: `1` ### numListenerThreads Number of consumer listener threads. **Type**: `int` -**Default**: `14` +**Default**: `1` ### operationTimeoutMs Client operation timeout (in milliseconds). diff --git a/static/reference/4.0.x/config/reference-configuration-pulsar-proxy.md b/static/reference/4.0.x/config/reference-configuration-pulsar-proxy.md index f0ffabfaaf1..2c7121624a5 100644 --- a/static/reference/4.0.x/config/reference-configuration-pulsar-proxy.md +++ b/static/reference/4.0.x/config/reference-configuration-pulsar-proxy.md @@ -273,7 +273,7 @@ Number of threads to use for HTTP requests processing **Type**: `int` -**Default**: `28` +**Default**: `8` **Dynamic**: `false` @@ -801,6 +801,17 @@ Capacity for thread pool queue in the HTTP server Default is set to 8192. **Category**: Server +### keepAliveIntervalSeconds +Specifies the interval (in seconds) for sending ping messages to the client. Set to 0 to disable ping messages. This setting applies to client connections used for topic lookups and partition metadata requests. When a client establishes a broker connection via the proxy, the client and broker will communicate directly without the proxy intercepting the messages. In that case, the broker's keepAliveIntervalSeconds configuration becomes relevant. + +**Type**: `int` + +**Default**: `30` + +**Dynamic**: `false` + +**Category**: Server + ### maxConcurrentHttpRequests Max concurrent web requests @@ -894,7 +905,7 @@ Number of threads used for Netty IO. Default is set to `2 * Runtime.getRuntime() **Type**: `int` -**Default**: `28` +**Default**: `2` **Dynamic**: `false` diff --git a/static/reference/4.0.x/config/reference-configuration-standalone.md b/static/reference/4.0.x/config/reference-configuration-standalone.md index 9fd5b499843..17f1957f108 100644 --- a/static/reference/4.0.x/config/reference-configuration-standalone.md +++ b/static/reference/4.0.x/config/reference-configuration-standalone.md @@ -1535,6 +1535,17 @@ control the number of replicas for storing the package **Category**: Packages Management +### activeConsumerFailoverConsistentHashing +Enable consistent hashing for selecting the active consumer in partitioned topics with Failover subscription type.For non-partitioned topics, consistent hashing is used by default. + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Policies + ### activeConsumerFailoverDelayTimeMillis How long to delay rewinding cursor and dispatching messages when active consumer is changed @@ -2651,6 +2662,17 @@ Used to specify multiple advertised listeners for the broker. The value must for **Category**: Server +### allowAclChangesOnNonExistentTopics +Opt-out of topic-existence check when setting permissions + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Server + ### allowOverrideEntryFilters Whether allow topic level entry filters policies overrides broker configuration. @@ -3039,6 +3061,17 @@ If value is "org.apache.pulsar.broker.delayed.BucketDelayedDeliveryTrackerFactor **Category**: Server +### dispatchRateLimiterFactoryClassName +The class name of the factory that creates DispatchRateLimiter implementations. Current options are org.apache.pulsar.broker.service.persistent.DispatchRateLimiterFactoryAsyncTokenBucket (default, PIP-322 implementation) org.apache.pulsar.broker.service.persistent.DispatchRateLimiterFactoryClassic (legacy implementation) + +**Type**: `java.lang.String` + +**Default**: `org.apache.pulsar.broker.service.persistent.DispatchRateLimiterFactoryAsyncTokenBucket` + +**Dynamic**: `false` + +**Category**: Server + ### dispatchThrottlingForFilteredEntriesEnabled Whether the broker should count filtered entries in dispatch rate limit calculations. When disabled, only messages sent to a consumer count towards a dispatch rate limit at the broker, topic, and subscription level. When enabled, messages filtered out due to entry filter logic are counted towards each relevant rate limit. @@ -3503,7 +3536,7 @@ Max memory size for broker handling messages sending from producers. **Type**: `int` -**Default**: `4608` +**Default**: `4454` **Dynamic**: `true` @@ -3783,7 +3816,7 @@ Number of threads to use for pulsar broker service. The executor in thread pool **Type**: `int` -**Default**: `14` +**Default**: `1` **Dynamic**: `false` @@ -3794,7 +3827,7 @@ Number of threads to use for HTTP requests processing Default is set to `2 * Run **Type**: `int` -**Default**: `28` +**Default**: `8` **Dynamic**: `false` @@ -3805,7 +3838,7 @@ Number of threads to use for Netty IO. Default is set to `2 * Runtime.getRuntime **Type**: `int` -**Default**: `28` +**Default**: `2` **Dynamic**: `false` @@ -4033,7 +4066,7 @@ Number of worker threads to serve topic ordered executor **Type**: `int` -**Default**: `14` +**Default**: `1` **Dynamic**: `false` @@ -4373,7 +4406,7 @@ Number of BookKeeper client IO threads. Default is Runtime.getRuntime().availabl **Type**: `int` -**Default**: `28` +**Default**: `2` **Dynamic**: `false` @@ -4384,7 +4417,7 @@ Number of BookKeeper client worker threads. Default is Runtime.getRuntime().avai **Type**: `int` -**Default**: `14` +**Default**: `1` **Dynamic**: `false` @@ -4957,7 +4990,7 @@ This memory is allocated from JVM direct memory and it's shared across all the t **Type**: `int` -**Default**: `1843` +**Default**: `1781` **Dynamic**: `true` @@ -4996,6 +5029,17 @@ How frequently to flush the cursor positions that were accumulated due to rate l **Category**: Storage (Managed Ledger) +### managedLedgerCursorResetLedgerCloseTimestampMaxClockSkewMillis +When resetting a subscription by timestamp, the broker will use the ledger closing timestamp metadata to determine the range of ledgers to search for the message where the subscription position is reset to. Since by default, the search condition is based on the message publish time provided by the client at the publish time, there will be some clock skew between the ledger closing timestamp metadata and the publish time. This configuration is used to set the max clock skew between the [...] + +**Type**: `int` + +**Default**: `60000` + +**Dynamic**: `true` + +**Category**: Storage (Managed Ledger) + ### managedLedgerCursorRolloverTimeInSeconds Max time before triggering a rollover on a cursor ledger @@ -5180,6 +5224,28 @@ Maximum time before forcing a ledger rollover for a topic **Category**: Storage (Managed Ledger) +### managedLedgerMaxReadsInFlightPermitsAcquireQueueSize +Maximum number of reads that can be queued for acquiring permits for max reads in flight when managedLedgerMaxReadsInFlightSizeInMB is set (\>0) and the limit is reached. + +**Type**: `int` + +**Default**: `50000` + +**Dynamic**: `false` + +**Category**: Storage (Managed Ledger) + +### managedLedgerMaxReadsInFlightPermitsAcquireTimeoutMillis +Maximum time to wait for acquiring permits for max reads in flight when managedLedgerMaxReadsInFlightSizeInMB is set (\>0) and the limit is reached. + +**Type**: `long` + +**Default**: `60000` + +**Dynamic**: `false` + +**Category**: Storage (Managed Ledger) + ### managedLedgerMaxReadsInFlightSizeInMB Maximum buffer size for bytes read from storage. This is the memory retained by data read from storage (or cache) until it has been delivered to the Consumer Netty channel. Use O to disable @@ -5302,7 +5368,7 @@ Number of threads to be used for managed ledger scheduled tasks **Type**: `int` -**Default**: `14` +**Default**: `1` **Dynamic**: `false` @@ -5321,6 +5387,17 @@ Default is ``. **Category**: Storage (Managed Ledger) +### managedLedgerPersistIndividualAckAsLongArray +Whether persist cursor ack stats as long arrays, which will compress the data and reduce GC rate + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Storage (Managed Ledger) + ### managedLedgerPrometheusStatsLatencyRolloverSeconds Managed ledger prometheus stats latency rollover seconds @@ -5599,7 +5676,7 @@ Number of threads to use for pulsar transaction replay PendingAckStore or Transa **Type**: `int` -**Default**: `14` +**Default**: `1` **Dynamic**: `false` @@ -5742,7 +5819,7 @@ Number of connections per Broker in Pulsar Client used in WebSocket proxy **Type**: `int` -**Default**: `14` +**Default**: `1` **Dynamic**: `false` @@ -5764,7 +5841,7 @@ Number of IO threads in Pulsar Client used in WebSocket proxy **Type**: `int` -**Default**: `14` +**Default**: `1` **Dynamic**: `false` diff --git a/static/reference/4.0.x/config/reference-configuration-websocket.md b/static/reference/4.0.x/config/reference-configuration-websocket.md index 4f1ed4571f0..97a45a36263 100644 --- a/static/reference/4.0.x/config/reference-configuration-websocket.md +++ b/static/reference/4.0.x/config/reference-configuration-websocket.md @@ -249,7 +249,7 @@ Number of threads to used in HTTP server **Type**: `int` -**Default**: `14` +**Default**: `6` **Dynamic**: `false` @@ -563,7 +563,7 @@ Number of connections per broker in Pulsar client used in WebSocket proxy **Type**: `int` -**Default**: `14` +**Default**: `1` **Dynamic**: `false` @@ -585,7 +585,7 @@ Number of IO threads in Pulsar client used in WebSocket proxy **Type**: `int` -**Default**: `14` +**Default**: `1` **Dynamic**: `false` diff --git a/static/reference/4.0.x/pulsar/delete-cluster-metadata.md b/static/reference/4.0.x/pulsar/delete-cluster-metadata.md index 0957b96c6c8..99d4a1b3e03 100644 --- a/static/reference/4.0.x/pulsar/delete-cluster-metadata.md +++ b/static/reference/4.0.x/pulsar/delete-cluster-metadata.md @@ -9,9 +9,12 @@ $ pulsar delete-cluster-metadata options |Flag|Description|Default| |---|---|---| | `-zk, --zookeeper` | Local ZooKeeper quorum connection string|null| +| `-md, --metadata-store` | Metadata Store service url. eg: zk:my-zk:2181|null| +| `-mscp, --metadata-store-config-path` | Metadata Store config path|null| | `--zookeeper-session-timeout-ms` | Local zookeeper session timeout ms|30000| | `-c, -cluster, --cluster` | Cluster name|null| | `-cs, --configuration-store` | Configuration Store connection string|null| +| `-cmscp, --configuration-metadata-store-config-path` | Configuration Metadata Store config path|null| | `--bookkeeper-metadata-service-uri` | Metadata service uri of BookKeeper|null| | `-h, --help` | Show this help message|false| | `-g, --generate-docs` | Generate docs|false|
