You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pulsar.apache.org by GitBox <gi...@apache.org> on 2021/09/10 03:16:24 UTC
[GitHub] [pulsar] Anonymitaet commented on a change in pull request #11980: [website] Update cli-tools document
Anonymitaet commented on a change in pull request #11980:
URL: https://github.com/apache/pulsar/pull/11980#discussion_r705862218
##########
File path: site2/docs/performance-pulsar-perf.md
##########
@@ -42,34 +42,48 @@ The following table lists configuration options available for the `pulsar-perf p
| Option | Description | Default value|
|----|----|----|
+| access-mode | Set the producer access mode, valid values: [Shared, Exclusive, WaitForExclusive]. | Shared |
+| admin-url | Set the pulsar admin url. | N/A |
Review comment:
```suggestion
| admin-url | Set the Pulsar admin URL. | N/A |
```
##########
File path: site2/docs/performance-pulsar-perf.md
##########
@@ -42,34 +42,48 @@ The following table lists configuration options available for the `pulsar-perf p
| Option | Description | Default value|
|----|----|----|
+| access-mode | Set the producer access mode, valid values: [Shared, Exclusive, WaitForExclusive]. | Shared |
Review comment:
```suggestion
| access-mode | Set the producer access mode. Valid values are `Shared`, `Exclusive`, and `WaitForExclusive`]. | Shared |
```
##########
File path: site2/docs/performance-pulsar-perf.md
##########
@@ -42,34 +42,48 @@ The following table lists configuration options available for the `pulsar-perf p
| Option | Description | Default value|
|----|----|----|
+| access-mode | Set the producer access mode, valid values: [Shared, Exclusive, WaitForExclusive]. | Shared |
+| admin-url | Set the pulsar admin url. | N/A |
| auth-params | Set the authentication parameters, whose format is determined by the implementation of the `configure` method in the authentication plugin class, such as "key1:val1,key2:val2" or "{"key1":"val1","key2":"val2"}". | N/A |
| auth_plugin | Set the authentication plugin class name. | N/A |
+| listener-name | Set the listener name for the broker. | N/A |
| batch-max-bytes | Set the maximum number of bytes for each batch. | 4194304 |
| batch-max-messages | Set the maximum number of messages for each batch. | 1000 |
| batch-time-window | Set a window for a batch of messages. | 1 ms |
+| busy-wait | Enable or disable Busy-Wait on the Pulsar client. | false |
+| chunking | Configure whether to split the message and publish in chunks if message size is larger than allowed max size. | false |
| compression | Compress the message payload. | N/A |
| conf-file | Set the configuration file. | N/A |
| delay | Mark messages with a given delay. | 0s |
| encryption-key-name | Set the name of the public key used to encrypt the payload. | N/A |
| encryption-key-value-file | Set the file which contains the public key used to encrypt the payload. | N/A |
| exit-on-failure | Configure whether to exit from the process on publish failure. | false |
+| format-class | Set the custom formatter class name. | org.apache.pulsar.testclient.DefaultMessageFormatter |
+| format-payload | Configure whether to format %i as a message index in the stream from producer and/or %t as the timestamp nanoseconds. | false |
| help | Configure the help message. | false |
| max-connections | Set the maximum number of TCP connections to a single broker. | 100 |
| max-outstanding | Set the maximum number of outstanding messages. | 1000 |
| max-outstanding-across-partitions | Set the maximum number of outstanding messages across partitions. | 50000 |
+| message-key-generation-mode | Set the generation mode of message key, valid options: [autoIncrement, random]. | N/A |
+| num-io-threads | Set the number of threads to be used for handling connections to brokers. | 1 |
| num-messages | Set the number of messages to be published in total. If it is set to 0, it keeps publishing messages. | 0 |
| num-producers | Set the number of producers for each topic. | 1 |
| num-test-threads | Set the number of test threads. | 1 |
| num-topic | Set the number of topics. | 1 |
+| partitions | Configure whether to create partitioned topics with the given number of partitions. | N/A |
| payload-delimiter | Set the delimiter used to split lines when using payload from a file. | \n |
| payload-file | Use the payload from an UTF-8 encoded text file and a payload is randomly selected when messages are published. | N/A |
+| producer-name | Set the producer name. | N/A |
| rate | Set the publish rate of messages across topics. | 100 |
+| send-timeout | Set the sendTimeout. | 0 |
+| separator | Set the separator between the topic and topic number. | - |
| service-url | Set the Pulsar service URL. | |
| size | Set the message size. | 1024 bytes |
| stats-interval-seconds | Set the statistics interval. If it is set to 0, statistics is disabled. | 0 |
| test-duration | Set the test duration. If it is set to 0, it keeps publishing tests. | 0s |
| trust-cert-file | Set the path for the trusted TLS certificate file. | <empty string> |
| warmup-time | Set the warm-up time. | 1s |
+| tls-allow-insecure | Set the allow insecure TLS connection. | N/A |
Review comment:
```suggestion
| tls-allow-insecure | Set the allowed insecure TLS connection. | N/A |
```
##########
File path: site2/docs/performance-pulsar-perf.md
##########
@@ -109,21 +123,33 @@ The following table lists configuration options available for the `pulsar-perf c
| acks-delay-millis | Set the acknowledgment grouping delay in milliseconds. | 100 ms |
| auth-params | Set the authentication parameters, whose format is determined by the implementation of the `configure` method in the authentication plugin class, such as "key1:val1,key2:val2" or "{"key1":"val1","key2":"val2"}". | N/A |
| auth_plugin | Set the authentication plugin class name. | N/A |
+| auto_ack_chunk_q_full | Configure whether to auto ack for oldest message on queue is full. | false |
Review comment:
Sorry, this is a grammar mistake in this sentence, can you rewrite it?
##########
File path: site2/docs/performance-pulsar-perf.md
##########
@@ -109,21 +123,33 @@ The following table lists configuration options available for the `pulsar-perf c
| acks-delay-millis | Set the acknowledgment grouping delay in milliseconds. | 100 ms |
| auth-params | Set the authentication parameters, whose format is determined by the implementation of the `configure` method in the authentication plugin class, such as "key1:val1,key2:val2" or "{"key1":"val1","key2":"val2"}". | N/A |
| auth_plugin | Set the authentication plugin class name. | N/A |
+| auto_ack_chunk_q_full | Configure whether to auto ack for oldest message on queue is full. | false |
+| listener-name | Set the listener name for the broker. | N/A |
+| acks-delay-millis | Set the acknowledgements grouping delay in millis. | 100 |
+| batch-index-ack | Enable or disable the batch index acknowledgment. | false |
+| busy-wait | Enable or disable Busy-Wait on the Pulsar client. | false |
| conf-file | Set the configuration file. | N/A |
| encryption-key-name | Set the name of the public key used to encrypt the payload. | N/A |
| encryption-key-value-file | Set the file which contains the public key used to encrypt the payload. | N/A |
| help | Configure the help message. | false |
+| expire_time_incomplete_chunked_messages | Set the expire time in ms for incomplete chunk messages. | 0 |
Review comment:
```suggestion
| expire_time_incomplete_chunked_messages | Set the expiration time for incomplete chunk messages (in milliseconds). | 0 |
```
Do you mean this?
##########
File path: site2/docs/performance-pulsar-perf.md
##########
@@ -109,21 +123,33 @@ The following table lists configuration options available for the `pulsar-perf c
| acks-delay-millis | Set the acknowledgment grouping delay in milliseconds. | 100 ms |
| auth-params | Set the authentication parameters, whose format is determined by the implementation of the `configure` method in the authentication plugin class, such as "key1:val1,key2:val2" or "{"key1":"val1","key2":"val2"}". | N/A |
| auth_plugin | Set the authentication plugin class name. | N/A |
+| auto_ack_chunk_q_full | Configure whether to auto ack for oldest message on queue is full. | false |
+| listener-name | Set the listener name for the broker. | N/A |
+| acks-delay-millis | Set the acknowledgements grouping delay in millis. | 100 |
Review comment:
```suggestion
| acks-delay-millis | Set the acknowledgments grouping delay (in milliseconds). | 100 |
```
Do you mean this
##########
File path: site2/docs/performance-pulsar-perf.md
##########
@@ -42,34 +42,48 @@ The following table lists configuration options available for the `pulsar-perf p
| Option | Description | Default value|
|----|----|----|
+| access-mode | Set the producer access mode, valid values: [Shared, Exclusive, WaitForExclusive]. | Shared |
+| admin-url | Set the pulsar admin url. | N/A |
| auth-params | Set the authentication parameters, whose format is determined by the implementation of the `configure` method in the authentication plugin class, such as "key1:val1,key2:val2" or "{"key1":"val1","key2":"val2"}". | N/A |
| auth_plugin | Set the authentication plugin class name. | N/A |
+| listener-name | Set the listener name for the broker. | N/A |
| batch-max-bytes | Set the maximum number of bytes for each batch. | 4194304 |
| batch-max-messages | Set the maximum number of messages for each batch. | 1000 |
| batch-time-window | Set a window for a batch of messages. | 1 ms |
+| busy-wait | Enable or disable Busy-Wait on the Pulsar client. | false |
+| chunking | Configure whether to split the message and publish in chunks if message size is larger than allowed max size. | false |
| compression | Compress the message payload. | N/A |
| conf-file | Set the configuration file. | N/A |
| delay | Mark messages with a given delay. | 0s |
| encryption-key-name | Set the name of the public key used to encrypt the payload. | N/A |
| encryption-key-value-file | Set the file which contains the public key used to encrypt the payload. | N/A |
| exit-on-failure | Configure whether to exit from the process on publish failure. | false |
+| format-class | Set the custom formatter class name. | org.apache.pulsar.testclient.DefaultMessageFormatter |
+| format-payload | Configure whether to format %i as a message index in the stream from producer and/or %t as the timestamp nanoseconds. | false |
| help | Configure the help message. | false |
| max-connections | Set the maximum number of TCP connections to a single broker. | 100 |
| max-outstanding | Set the maximum number of outstanding messages. | 1000 |
| max-outstanding-across-partitions | Set the maximum number of outstanding messages across partitions. | 50000 |
+| message-key-generation-mode | Set the generation mode of message key, valid options: [autoIncrement, random]. | N/A |
Review comment:
same comment
##########
File path: site2/docs/reference-cli-tools.md
##########
@@ -321,6 +332,8 @@ Options
|`-s`, `--separator`|Character to split messages string with.|","|
|`-k`, `--key`|Message key to add|key=value string, like k1=v1,k2=v2.|
|`-p`, `--properties`|Properties to add. If you want to add multiple properties, use the comma as the separator, e.g. `k1=v1,k2=v2`.| |
+|`-ekn`, `--encryption-key-name`|The public key name to encrypt payload.| |
+|`-ekv`, `--encryption-key-value`|The URI of public key to encrypt payload, for example file:///path/to/public.key or data:application/x-pem-file;base64,*****.| |
Review comment:
```suggestion
|`-ekv`, `--encryption-key-value`|The URI of public key to encrypt payload. For example, `file:///path/to/public.key or data:application/x-pem-file;base64,*****`.| |
```
##########
File path: site2/docs/reference-cli-tools.md
##########
@@ -347,6 +361,8 @@ Options
|`-ac`, `--auto_ack_chunk_q_full`|Auto ack for the oldest message in consumer's receiver queue if the queue full.|false|
|`--hide-content`|Do not print the message to the console.|false|
|`-st`, `--schema-type`|Set the schema type. Use `auto_consume` to dump AVRO and other structured data types. Possible values: bytes, auto_consume.|bytes|
+|`-ekv`, `--encryption-key-value`|The URI of public key to encrypt payload, for example file:///path/to/public.key or data:application/x-pem-file;base64,*****.| |
Review comment:
same
##########
File path: site2/docs/reference-cli-tools.md
##########
@@ -429,25 +446,35 @@ Options
|Flag|Description|Default|
|---|---|---|
-|`--auth_params`|Authentication parameters, whose format is determined by the implementation of method `configure` in authentication plugin class, for example "key1:val1,key2:val2" or "{"key1":"val1","key2":"val2"}.||
+|`--auth-params`|Authentication parameters, whose format is determined by the implementation of method `configure` in authentication plugin class, for example "key1:val1,key2:val2" or "{"key1":"val1","key2":"val2"}.||
Review comment:
same comment as previously
##########
File path: site2/docs/reference-cli-tools.md
##########
@@ -429,25 +446,35 @@ Options
|Flag|Description|Default|
|---|---|---|
-|`--auth_params`|Authentication parameters, whose format is determined by the implementation of method `configure` in authentication plugin class, for example "key1:val1,key2:val2" or "{"key1":"val1","key2":"val2"}.||
+|`--auth-params`|Authentication parameters, whose format is determined by the implementation of method `configure` in authentication plugin class, for example "key1:val1,key2:val2" or "{"key1":"val1","key2":"val2"}.||
|`--auth_plugin`|Authentication plugin class name||
+|`-ac`, `--auto_ack_chunk_q_full`|Auto ack for oldest message on queue is full|false|
|`--listener-name`|Listener name for the broker||
|`--acks-delay-millis`|Acknowledgements grouping delay in millis|100|
-|`-k`, `--encryption-key-name`|The private key name to decrypt payload||
+|`--batch-index-ack`|Enable or disable the batch index acknowledgment|false|
+|`-bw`, `--busy-wait`|Enable Busy-Wait on the Pulsar client|false|
|`-v`, `--encryption-key-value-file`|The file which contains the private key to decrypt payload||
|`-h`, `--help`|Help message|false|
|`--conf-file`|Configuration file||
+|`-e`, `--expire_time_incomplete_chunked_messages`|Expire time in ms for incomplete chunk messages|0|
Review comment:
same comment as previously
##########
File path: site2/docs/reference-cli-tools.md
##########
@@ -464,29 +491,45 @@ Options
|Flag|Description|Default|
|---|---|---|
-|`--auth_params`|Authentication parameters, whose format is determined by the implementation of method `configure` in authentication plugin class, for example "key1:val1,key2:val2" or "{"key1":"val1","key2":"val2"}.||
+|`-am`, `--access-mode`|Producer access mode, valid values: [Shared, Exclusive, WaitForExclusive]|Shared|
+|`-au`, `--admin-url`|Pulsar Admin URL||
+|`--auth-params`|Authentication parameters, whose format is determined by the implementation of method `configure` in authentication plugin class, for example "key1:val1,key2:val2" or "{"key1":"val1","key2":"val2"}.||
Review comment:
same comment as previously
##########
File path: site2/docs/reference-cli-tools.md
##########
@@ -464,29 +491,45 @@ Options
|Flag|Description|Default|
|---|---|---|
-|`--auth_params`|Authentication parameters, whose format is determined by the implementation of method `configure` in authentication plugin class, for example "key1:val1,key2:val2" or "{"key1":"val1","key2":"val2"}.||
+|`-am`, `--access-mode`|Producer access mode, valid values: [Shared, Exclusive, WaitForExclusive]|Shared|
+|`-au`, `--admin-url`|Pulsar Admin URL||
+|`--auth-params`|Authentication parameters, whose format is determined by the implementation of method `configure` in authentication plugin class, for example "key1:val1,key2:val2" or "{"key1":"val1","key2":"val2"}.||
|`--auth_plugin`|Authentication plugin class name||
|`--listener-name`|Listener name for the broker||
|`-b`, `--batch-time-window`|Batch messages in a window of the specified number of milliseconds|1|
+|`-bb`, `--batch-max-bytes`|Maximum number of bytes per batch|4194304|
+|`-bm`, `--batch-max-messages`|Maximum number of messages per batch|1000|
+|`-bw`, `--busy-wait`|Enable Busy-Wait on the Pulsar client|false|
+|`-ch`, `--chunking`|Should split the message and publish in chunks if message size is larger than allowed max size|false|
|`-d`, `--delay`|Mark messages with a given delay in seconds|0s|
|`-z`, `--compression`|Compress messages’ payload. Possible values are NONE, LZ4, ZLIB, ZSTD or SNAPPY.||
|`--conf-file`|Configuration file||
|`-k`, `--encryption-key-name`|The public key name to encrypt payload||
|`-v`, `--encryption-key-value-file`|The file which contains the public key to encrypt payload||
+|`-ef`, `--exit-on-failure`|Exit from the process on publish failure|false|
+|`-fc`, `--format-class`|Custom Formatter class name|org.apache.pulsar.testclient.DefaultMessageFormatter|
+|`-fp`, `--format-payload`|Format %i as a message index in the stream from producer and/or %t as the timestamp nanoseconds|false|
|`-h`, `--help`|Help message|false|
|`-c`, `--max-connections`|Max number of TCP connections to a single broker|100|
|`-o`, `--max-outstanding`|Max number of outstanding messages|1000|
|`-p`, `--max-outstanding-across-partitions`|Max number of outstanding messages across partitions|50000|
-|`-m`, `--num-messages`|Number of messages to publish in total. If set to 0, it will keep publishing.|0|
+|`-mk`, `--message-key-generation-mode`|The generation mode of message key, valid options: [autoIncrement, random]||
+|`-ioThreads`, `--num-io-threads`|Set the number of threads to be used for handling connections to brokers|1|
+|`-m`, `--num-messages`|Number of messages to publish in total. If <= 0, it will keep publishing.|0|
|`-n`, `--num-producers`|The number of producers (per topic)|1|
+|`-threads`, `--num-test-threads`|Number of test threads|1|
|`-t`, `--num-topic`|The number of topics|1|
+|`-np`, `--partitions`|Create partitioned topics with the given number of partitions, set 0 to not try to create the topic||
Review comment:
```suggestion
|`-np`, `--partitions`|Create partitioned topics with the given number of partitions. Setting this value to 0 means not trying to create a topic||
```
##########
File path: site2/docs/reference-cli-tools.md
##########
@@ -464,29 +491,45 @@ Options
|Flag|Description|Default|
|---|---|---|
-|`--auth_params`|Authentication parameters, whose format is determined by the implementation of method `configure` in authentication plugin class, for example "key1:val1,key2:val2" or "{"key1":"val1","key2":"val2"}.||
+|`-am`, `--access-mode`|Producer access mode, valid values: [Shared, Exclusive, WaitForExclusive]|Shared|
+|`-au`, `--admin-url`|Pulsar Admin URL||
+|`--auth-params`|Authentication parameters, whose format is determined by the implementation of method `configure` in authentication plugin class, for example "key1:val1,key2:val2" or "{"key1":"val1","key2":"val2"}.||
|`--auth_plugin`|Authentication plugin class name||
|`--listener-name`|Listener name for the broker||
|`-b`, `--batch-time-window`|Batch messages in a window of the specified number of milliseconds|1|
+|`-bb`, `--batch-max-bytes`|Maximum number of bytes per batch|4194304|
+|`-bm`, `--batch-max-messages`|Maximum number of messages per batch|1000|
+|`-bw`, `--busy-wait`|Enable Busy-Wait on the Pulsar client|false|
+|`-ch`, `--chunking`|Should split the message and publish in chunks if message size is larger than allowed max size|false|
|`-d`, `--delay`|Mark messages with a given delay in seconds|0s|
|`-z`, `--compression`|Compress messages’ payload. Possible values are NONE, LZ4, ZLIB, ZSTD or SNAPPY.||
|`--conf-file`|Configuration file||
|`-k`, `--encryption-key-name`|The public key name to encrypt payload||
|`-v`, `--encryption-key-value-file`|The file which contains the public key to encrypt payload||
+|`-ef`, `--exit-on-failure`|Exit from the process on publish failure|false|
+|`-fc`, `--format-class`|Custom Formatter class name|org.apache.pulsar.testclient.DefaultMessageFormatter|
+|`-fp`, `--format-payload`|Format %i as a message index in the stream from producer and/or %t as the timestamp nanoseconds|false|
|`-h`, `--help`|Help message|false|
|`-c`, `--max-connections`|Max number of TCP connections to a single broker|100|
|`-o`, `--max-outstanding`|Max number of outstanding messages|1000|
|`-p`, `--max-outstanding-across-partitions`|Max number of outstanding messages across partitions|50000|
-|`-m`, `--num-messages`|Number of messages to publish in total. If set to 0, it will keep publishing.|0|
+|`-mk`, `--message-key-generation-mode`|The generation mode of message key, valid options: [autoIncrement, random]||
+|`-ioThreads`, `--num-io-threads`|Set the number of threads to be used for handling connections to brokers|1|
+|`-m`, `--num-messages`|Number of messages to publish in total. If <= 0, it will keep publishing.|0|
Review comment:
same comment as previously
##########
File path: site2/docs/reference-cli-tools.md
##########
@@ -528,19 +574,20 @@ $ pulsar-perf websocket-producer options
```
Options
+
|Flag|Description|Default|
|---|---|---|
-|`--auth_params`|Authentication parameters, whose format is determined by the implementation of method `configure` in authentication plugin class, for example "key1:val1,key2:val2" or "{"key1":"val1","key2":"val2"}.||
+|`--auth-params`|Authentication parameters, whose format is determined by the implementation of method `configure` in authentication plugin class, for example "key1:val1,key2:val2" or "{"key1":"val1","key2":"val2"}.||
|`--auth_plugin`|Authentication plugin class name||
|`--conf-file`|Configuration file||
|`-h`, `--help`|Help message|false|
-|`-m`, `--num-messages`|Number of messages to publish in total. If 0, it will keep publishing|0|
+|`-m`, `--num-messages`|Number of messages to publish in total. If <= 0, it will keep publishing|0|
|`-t`, `--num-topic`|The number of topics|1|
|`-f`, `--payload-file`|Use payload from a file instead of empty buffer||
|`-u`, `--proxy-url`|Pulsar Proxy URL, e.g., "ws://localhost:8080/"||
|`-r`, `--rate`|Publish rate msg/s across topics|100|
|`-s`, `--size`|Message size in byte|1024|
-|`-time`, `--test-duration`|Test duration in secs. If 0, it will keep publishing|0|
+|`-time`, `--test-duration`|Test duration in secs. If <=0, it will keep publishing|0|
Review comment:
same comment as previously
##########
File path: site2/docs/reference-cli-tools.md
##########
@@ -464,29 +491,45 @@ Options
|Flag|Description|Default|
|---|---|---|
-|`--auth_params`|Authentication parameters, whose format is determined by the implementation of method `configure` in authentication plugin class, for example "key1:val1,key2:val2" or "{"key1":"val1","key2":"val2"}.||
+|`-am`, `--access-mode`|Producer access mode, valid values: [Shared, Exclusive, WaitForExclusive]|Shared|
+|`-au`, `--admin-url`|Pulsar Admin URL||
+|`--auth-params`|Authentication parameters, whose format is determined by the implementation of method `configure` in authentication plugin class, for example "key1:val1,key2:val2" or "{"key1":"val1","key2":"val2"}.||
|`--auth_plugin`|Authentication plugin class name||
|`--listener-name`|Listener name for the broker||
|`-b`, `--batch-time-window`|Batch messages in a window of the specified number of milliseconds|1|
+|`-bb`, `--batch-max-bytes`|Maximum number of bytes per batch|4194304|
+|`-bm`, `--batch-max-messages`|Maximum number of messages per batch|1000|
+|`-bw`, `--busy-wait`|Enable Busy-Wait on the Pulsar client|false|
+|`-ch`, `--chunking`|Should split the message and publish in chunks if message size is larger than allowed max size|false|
Review comment:
```suggestion
|`-ch`, `--chunking`|Split the message and publish in chunks if the message size is larger than allowed max size|false|
```
##########
File path: site2/docs/reference-cli-tools.md
##########
@@ -501,20 +544,23 @@ $ pulsar-perf read options
```
Options
+
|Flag|Description|Default|
|---|---|---|
-|`--auth_params`|Authentication parameters, whose format is determined by the implementation of method `configure` in authentication plugin class, for example "key1:val1,key2:val2" or "{"key1":"val1","key2":"val2"}.||
+|`--auth-params`|Authentication parameters, whose format is determined by the implementation of method `configure` in authentication plugin class, for example "key1:val1,key2:val2" or "{"key1":"val1","key2":"val2"}.||
Review comment:
same comment as previously
##########
File path: site2/docs/reference-cli-tools.md
##########
@@ -528,19 +574,20 @@ $ pulsar-perf websocket-producer options
```
Options
+
|Flag|Description|Default|
|---|---|---|
-|`--auth_params`|Authentication parameters, whose format is determined by the implementation of method `configure` in authentication plugin class, for example "key1:val1,key2:val2" or "{"key1":"val1","key2":"val2"}.||
+|`--auth-params`|Authentication parameters, whose format is determined by the implementation of method `configure` in authentication plugin class, for example "key1:val1,key2:val2" or "{"key1":"val1","key2":"val2"}.||
Review comment:
same comment as previously
##########
File path: site2/docs/reference-cli-tools.md
##########
@@ -501,20 +544,23 @@ $ pulsar-perf read options
```
Options
+
|Flag|Description|Default|
|---|---|---|
-|`--auth_params`|Authentication parameters, whose format is determined by the implementation of method `configure` in authentication plugin class, for example "key1:val1,key2:val2" or "{"key1":"val1","key2":"val2"}.||
+|`--auth-params`|Authentication parameters, whose format is determined by the implementation of method `configure` in authentication plugin class, for example "key1:val1,key2:val2" or "{"key1":"val1","key2":"val2"}.||
|`--auth_plugin`|Authentication plugin class name||
|`--listener-name`|Listener name for the broker||
|`--conf-file`|Configuration file||
|`-h`, `--help`|Help message|false|
|`-c`, `--max-connections`|Max number of TCP connections to a single broker|100|
+|`-ioThreads`, `--num-io-threads`|Set the number of threads to be used for handling connections to brokers|1|
|`-t`, `--num-topics`|The number of topics|1|
|`-r`, `--rate`|Simulate a slow message reader (rate in msg/s)|0|
|`-q`, `--receiver-queue-size`|Size of the receiver queue|1000|
|`-u`, `--service-url`|Pulsar service URL||
|`-m`, `--start-message-id`|Start message id. This can be either 'earliest', 'latest' or a specific message id by using 'lid:eid'|earliest|
|`-i`, `--stats-interval-seconds`|Statistics interval seconds. If 0, statistics will be disabled.|0|
+|`-time`, `--test-duration`|Test duration in secs. If <= 0, it will keep consuming|0|
Review comment:
same comment as previously
##########
File path: site2/docs/reference-cli-tools.md
##########
@@ -528,19 +574,20 @@ $ pulsar-perf websocket-producer options
```
Options
+
|Flag|Description|Default|
|---|---|---|
-|`--auth_params`|Authentication parameters, whose format is determined by the implementation of method `configure` in authentication plugin class, for example "key1:val1,key2:val2" or "{"key1":"val1","key2":"val2"}.||
+|`--auth-params`|Authentication parameters, whose format is determined by the implementation of method `configure` in authentication plugin class, for example "key1:val1,key2:val2" or "{"key1":"val1","key2":"val2"}.||
|`--auth_plugin`|Authentication plugin class name||
|`--conf-file`|Configuration file||
|`-h`, `--help`|Help message|false|
-|`-m`, `--num-messages`|Number of messages to publish in total. If 0, it will keep publishing|0|
+|`-m`, `--num-messages`|Number of messages to publish in total. If <= 0, it will keep publishing|0|
Review comment:
same comment as previously
##########
File path: site2/docs/reference-cli-tools.md
##########
@@ -560,11 +608,11 @@ Options
|`-h`, `--help`|Help message|false|
|`-c`, `--max-connections`|Max number of TCP connections to a single bookie|1|
|`-o`, `--max-outstanding`|Max number of outstanding requests|1000|
-|`-m`, `--num-messages`|Number of messages to publish in total. If 0, it will keep publishing|0|
+|`-m`, `--num-messages`|Number of messages to publish in total. If <= 0, it will keep publishing|0|
|`-t`, `--num-topic`|Number of managed ledgers|1|
|`-r`, `--rate`|Write rate msg/s across managed ledgers|100|
|`-s`, `--size`|Message size in byte|1024|
-|`-time`, `--test-duration`|Test duration in secs. If 0, it will keep publishing|0|
+|`-time`, `--test-duration`|Test duration in secs. If <= 0, it will keep publishing|0|
Review comment:
same comment as previously
##########
File path: site2/docs/reference-cli-tools.md
##########
@@ -464,29 +491,45 @@ Options
|Flag|Description|Default|
|---|---|---|
-|`--auth_params`|Authentication parameters, whose format is determined by the implementation of method `configure` in authentication plugin class, for example "key1:val1,key2:val2" or "{"key1":"val1","key2":"val2"}.||
+|`-am`, `--access-mode`|Producer access mode, valid values: [Shared, Exclusive, WaitForExclusive]|Shared|
Review comment:
same comment as previously
##########
File path: site2/docs/reference-cli-tools.md
##########
@@ -464,29 +491,45 @@ Options
|Flag|Description|Default|
|---|---|---|
-|`--auth_params`|Authentication parameters, whose format is determined by the implementation of method `configure` in authentication plugin class, for example "key1:val1,key2:val2" or "{"key1":"val1","key2":"val2"}.||
+|`-am`, `--access-mode`|Producer access mode, valid values: [Shared, Exclusive, WaitForExclusive]|Shared|
+|`-au`, `--admin-url`|Pulsar Admin URL||
+|`--auth-params`|Authentication parameters, whose format is determined by the implementation of method `configure` in authentication plugin class, for example "key1:val1,key2:val2" or "{"key1":"val1","key2":"val2"}.||
|`--auth_plugin`|Authentication plugin class name||
|`--listener-name`|Listener name for the broker||
|`-b`, `--batch-time-window`|Batch messages in a window of the specified number of milliseconds|1|
+|`-bb`, `--batch-max-bytes`|Maximum number of bytes per batch|4194304|
+|`-bm`, `--batch-max-messages`|Maximum number of messages per batch|1000|
+|`-bw`, `--busy-wait`|Enable Busy-Wait on the Pulsar client|false|
+|`-ch`, `--chunking`|Should split the message and publish in chunks if message size is larger than allowed max size|false|
|`-d`, `--delay`|Mark messages with a given delay in seconds|0s|
|`-z`, `--compression`|Compress messages’ payload. Possible values are NONE, LZ4, ZLIB, ZSTD or SNAPPY.||
|`--conf-file`|Configuration file||
|`-k`, `--encryption-key-name`|The public key name to encrypt payload||
|`-v`, `--encryption-key-value-file`|The file which contains the public key to encrypt payload||
+|`-ef`, `--exit-on-failure`|Exit from the process on publish failure|false|
+|`-fc`, `--format-class`|Custom Formatter class name|org.apache.pulsar.testclient.DefaultMessageFormatter|
+|`-fp`, `--format-payload`|Format %i as a message index in the stream from producer and/or %t as the timestamp nanoseconds|false|
|`-h`, `--help`|Help message|false|
|`-c`, `--max-connections`|Max number of TCP connections to a single broker|100|
|`-o`, `--max-outstanding`|Max number of outstanding messages|1000|
|`-p`, `--max-outstanding-across-partitions`|Max number of outstanding messages across partitions|50000|
-|`-m`, `--num-messages`|Number of messages to publish in total. If set to 0, it will keep publishing.|0|
+|`-mk`, `--message-key-generation-mode`|The generation mode of message key, valid options: [autoIncrement, random]||
Review comment:
same comment as previously
##########
File path: site2/docs/reference-cli-tools.md
##########
@@ -429,25 +446,35 @@ Options
|Flag|Description|Default|
|---|---|---|
-|`--auth_params`|Authentication parameters, whose format is determined by the implementation of method `configure` in authentication plugin class, for example "key1:val1,key2:val2" or "{"key1":"val1","key2":"val2"}.||
+|`--auth-params`|Authentication parameters, whose format is determined by the implementation of method `configure` in authentication plugin class, for example "key1:val1,key2:val2" or "{"key1":"val1","key2":"val2"}.||
|`--auth_plugin`|Authentication plugin class name||
+|`-ac`, `--auto_ack_chunk_q_full`|Auto ack for oldest message on queue is full|false|
|`--listener-name`|Listener name for the broker||
|`--acks-delay-millis`|Acknowledgements grouping delay in millis|100|
-|`-k`, `--encryption-key-name`|The private key name to decrypt payload||
+|`--batch-index-ack`|Enable or disable the batch index acknowledgment|false|
+|`-bw`, `--busy-wait`|Enable Busy-Wait on the Pulsar client|false|
|`-v`, `--encryption-key-value-file`|The file which contains the private key to decrypt payload||
|`-h`, `--help`|Help message|false|
|`--conf-file`|Configuration file||
+|`-e`, `--expire_time_incomplete_chunked_messages`|Expire time in ms for incomplete chunk messages|0|
|`-c`, `--max-connections`|Max number of TCP connections to a single broker|100|
+|`-mc`, `--max_chunked_msg`|Max pending chunk messages|0|
|`-n`, `--num-consumers`|Number of consumers (per topic)|1|
+|`-ioThreads`, `--num-io-threads`|Set the number of threads to be used for handling connections to brokers|1|
+|`-ns`, `--num-subscriptions`|Number of subscriptions (per topic)|1|
|`-t`, `--num-topics`|The number of topics|1|
+|`-pm`, `--pool-messages`|Use the pooled message|true|
|`-r`, `--rate`|Simulate a slow message consumer (rate in msg/s)|0|
|`-q`, `--receiver-queue-size`|Size of the receiver queue|1000|
+|`-p`, `--receiver-queue-size-across-partitions`|Max total size of the receiver queue across partitions|50000|
+|`--replicated`|Whether the subscription status should be replicated|false|
|`-u`, `--service-url`|Pulsar service URL||
|`-i`, `--stats-interval-seconds`|Statistics interval seconds. If 0, statistics will be disabled|0|
|`-s`, `--subscriber-name`|Subscriber name prefix||
|`-ss`, `--subscriptions`|A list of subscriptions to consume on (e.g. sub1,sub2)|sub|
|`-st`, `--subscription-type`|Subscriber type. Possible values are Exclusive, Shared, Failover, Key_Shared.|Exclusive|
|`-sp`, `--subscription-position`|Subscriber position. Possible values are Latest, Earliest.|Latest|
+|`-time`, `--test-duration`|Test duration in secs. If <= 0, it will keep consuming|0|
Review comment:
same comment as previously
##########
File path: site2/docs/performance-pulsar-perf.md
##########
@@ -109,21 +123,33 @@ The following table lists configuration options available for the `pulsar-perf c
| acks-delay-millis | Set the acknowledgment grouping delay in milliseconds. | 100 ms |
| auth-params | Set the authentication parameters, whose format is determined by the implementation of the `configure` method in the authentication plugin class, such as "key1:val1,key2:val2" or "{"key1":"val1","key2":"val2"}". | N/A |
| auth_plugin | Set the authentication plugin class name. | N/A |
+| auto_ack_chunk_q_full | Configure whether to auto ack for oldest message on queue is full. | false |
+| listener-name | Set the listener name for the broker. | N/A |
+| acks-delay-millis | Set the acknowledgements grouping delay in millis. | 100 |
+| batch-index-ack | Enable or disable the batch index acknowledgment. | false |
+| busy-wait | Enable or disable Busy-Wait on the Pulsar client. | false |
| conf-file | Set the configuration file. | N/A |
| encryption-key-name | Set the name of the public key used to encrypt the payload. | N/A |
| encryption-key-value-file | Set the file which contains the public key used to encrypt the payload. | N/A |
| help | Configure the help message. | false |
+| expire_time_incomplete_chunked_messages | Set the expire time in ms for incomplete chunk messages. | 0 |
| max-connections | Set the maximum number of TCP connections to a single broker. | 100 |
+| max_chunked_msg | Set the max pending chunk messages. | 0 |
| num-consumers | Set the number of consumers for each topic. | 1 |
+| num-io-threads |Set the number of threads to be used for handling connections to brokers. | 1 |
+| num-subscriptions | Set the number of subscriptions (per topic). | 1 |
| num-topic | Set the number of topics. | 1 |
+| pool-messages | Configure whether to use the pooled message. | true |
| rate | Simulate a slow message consumer (rate in msg/s). | 0.0 |
| receiver-queue-size | Set the size of the receiver queue. | 1000 |
+| receiver-queue-size-across-partitions | Set the max total size of the receiver queue across partitions. | 50000 |
| replicated | Configure whether the subscription status should be replicated. | false |
| service-url | Set the Pulsar service URL. | |
| stats-interval-seconds | Set the statistics interval. If it is set to 0, statistics is disabled. | 0 |
| subscriber-name | Set the subscriber name prefix. | sub |
| subscription-type | Set the subscription type. <li> Exclusive <li> Shared <li> Failover <li> Key_Shared | Exclusive |
| trust-cert-file | Set the path for the trusted TLS certificate file. | <empty string> |
+| test-duration | Set the test duration in secs. If <= 0 it will keep consuming. | 0 |
Review comment:
```suggestion
| test-duration | Set the test duration (in seconds). If the value is 0 or smaller than 0, it keeps consuming messages. | 0 |
```
Do you mean this?
##########
File path: site2/docs/reference-cli-tools.md
##########
@@ -464,29 +491,45 @@ Options
|Flag|Description|Default|
|---|---|---|
-|`--auth_params`|Authentication parameters, whose format is determined by the implementation of method `configure` in authentication plugin class, for example "key1:val1,key2:val2" or "{"key1":"val1","key2":"val2"}.||
+|`-am`, `--access-mode`|Producer access mode, valid values: [Shared, Exclusive, WaitForExclusive]|Shared|
+|`-au`, `--admin-url`|Pulsar Admin URL||
+|`--auth-params`|Authentication parameters, whose format is determined by the implementation of method `configure` in authentication plugin class, for example "key1:val1,key2:val2" or "{"key1":"val1","key2":"val2"}.||
|`--auth_plugin`|Authentication plugin class name||
|`--listener-name`|Listener name for the broker||
|`-b`, `--batch-time-window`|Batch messages in a window of the specified number of milliseconds|1|
+|`-bb`, `--batch-max-bytes`|Maximum number of bytes per batch|4194304|
+|`-bm`, `--batch-max-messages`|Maximum number of messages per batch|1000|
+|`-bw`, `--busy-wait`|Enable Busy-Wait on the Pulsar client|false|
+|`-ch`, `--chunking`|Should split the message and publish in chunks if message size is larger than allowed max size|false|
|`-d`, `--delay`|Mark messages with a given delay in seconds|0s|
|`-z`, `--compression`|Compress messages’ payload. Possible values are NONE, LZ4, ZLIB, ZSTD or SNAPPY.||
|`--conf-file`|Configuration file||
|`-k`, `--encryption-key-name`|The public key name to encrypt payload||
|`-v`, `--encryption-key-value-file`|The file which contains the public key to encrypt payload||
+|`-ef`, `--exit-on-failure`|Exit from the process on publish failure|false|
+|`-fc`, `--format-class`|Custom Formatter class name|org.apache.pulsar.testclient.DefaultMessageFormatter|
+|`-fp`, `--format-payload`|Format %i as a message index in the stream from producer and/or %t as the timestamp nanoseconds|false|
|`-h`, `--help`|Help message|false|
|`-c`, `--max-connections`|Max number of TCP connections to a single broker|100|
|`-o`, `--max-outstanding`|Max number of outstanding messages|1000|
|`-p`, `--max-outstanding-across-partitions`|Max number of outstanding messages across partitions|50000|
-|`-m`, `--num-messages`|Number of messages to publish in total. If set to 0, it will keep publishing.|0|
+|`-mk`, `--message-key-generation-mode`|The generation mode of message key, valid options: [autoIncrement, random]||
+|`-ioThreads`, `--num-io-threads`|Set the number of threads to be used for handling connections to brokers|1|
+|`-m`, `--num-messages`|Number of messages to publish in total. If <= 0, it will keep publishing.|0|
|`-n`, `--num-producers`|The number of producers (per topic)|1|
+|`-threads`, `--num-test-threads`|Number of test threads|1|
|`-t`, `--num-topic`|The number of topics|1|
+|`-np`, `--partitions`|Create partitioned topics with the given number of partitions, set 0 to not try to create the topic||
|`-f`, `--payload-file`|Use payload from an UTF-8 encoded text file and a payload will be randomly selected when publishing messages||
|`-e`, `--payload-delimiter`|The delimiter used to split lines when using payload from a file|\n|
+|`-pn`, `--producer-name`|Producer Name||
|`-r`, `--rate`|Publish rate msg/s across topics|100|
+|`--send-timeout`|Set the sendTimeout|0|
+|`--separator`|Separator between the topic and topic number|-|
|`-u`, `--service-url`|Pulsar service URL||
|`-s`, `--size`|Message size (in bytes)|1024|
|`-i`, `--stats-interval-seconds`|Statistics interval seconds. If 0, statistics will be disabled.|0|
-|`-time`, `--test-duration`|Test duration in secs. If set to 0, it will keep publishing.|0|
+|`-time`, `--test-duration`|Test duration in secs. If <= 0, it will keep publishing.|0|
Review comment:
same comment as previously
##########
File path: site2/docs/reference-cli-tools.md
##########
@@ -560,11 +608,11 @@ Options
|`-h`, `--help`|Help message|false|
|`-c`, `--max-connections`|Max number of TCP connections to a single bookie|1|
|`-o`, `--max-outstanding`|Max number of outstanding requests|1000|
-|`-m`, `--num-messages`|Number of messages to publish in total. If 0, it will keep publishing|0|
+|`-m`, `--num-messages`|Number of messages to publish in total. If <= 0, it will keep publishing|0|
Review comment:
same comment as previously
--
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: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org