[pulsar] branch master updated: Update command-line tools doc for v2.3.1. (#4226)

[mm...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

mmerli pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/pulsar.git


The following commit(s) were added to refs/heads/master by this push:
     new 0899b22  Update command-line tools doc for v2.3.1. (#4226)
0899b22 is described below

commit 0899b22df0eccd315e03282bca2e99f74395b20c
Author: Fangbin Sun <su...@gmail.com>
AuthorDate: Wed May 8 07:20:04 2019 +0800

    Update command-line tools doc for v2.3.1. (#4226)
---
 .../version-2.3.1/reference-cli-tools.md           | 117 +++++++++++++++++++--
 1 file changed, 109 insertions(+), 8 deletions(-)

diff --git a/site2/website/versioned_docs/version-2.3.1/reference-cli-tools.md b/site2/website/versioned_docs/version-2.3.1/reference-cli-tools.md
index 3c5c601..619d3b9 100644
--- a/site2/website/versioned_docs/version-2.3.1/reference-cli-tools.md
+++ b/site2/website/versioned_docs/version-2.3.1/reference-cli-tools.md
@@ -379,9 +379,13 @@ $ pulsar-perf command
 Commands
 * `consume`
 * `produce`
+* `read`
+* `websocket-producer`
+* `managed-ledger`
 * `monitor-brokers`
 * `simulation-client`
 * `simulation-controller`
+* `help`
 
 Environment variables
 
@@ -404,14 +408,15 @@ $ pulsar-perf consume options
 ```
 
 Options
+
 |Flag|Description|Default|
 |---|---|---|
-|`--auth_params`|Authentication parameters in the form of 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||
-|`-b`, `--batch-time-window`|Batch messages in a window of the specified number of milliseconds|1|
 |`--acks-delay-millis`|Acknowlegments grouping delay in millis|100|
 |`-k`, `--encryption-key-name`|The private key name to decrypt payload||
 |`-v`, `--encryption-key-value-file`|The file which contains the private key to decrypt payload||
+|`-h`, `--help`|Help message|false|
 |`--conf-file`|Configuration file||
 |`-c`, `--max-connections`|Max number of TCP connections to a single broker|100|
 |`-n`, `--num-consumers`|Number of consumers (per topic)|1|
@@ -423,7 +428,6 @@ Options
 |`-s`, `--subscriber-name`|Subscriber name prefix|sub|
 |`-st`, `--subscription-type`|Subscriber name prefix. Possible values are Exclusive, Shared, Failover.|Exclusive|
 |`--trust-cert-file`|Path for the trusted TLS certificate file||
-|`--use-tls`|Use TLS encryption on the connection|false|
 
 
 ### `produce`
@@ -435,15 +439,20 @@ $ pulsar-perf produce options
 ```
 
 Options
+
 |Flag|Description|Default|
 |---|---|---|
-|`--auth_params`|Authentication parameters in the form of 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||
 |`-b`, `--batch-time-window`|Batch messages in a window of the specified number of milliseconds|1|
 |`-z`, `--compression`|Compress messages’ payload. Possible values are NONE, LZ4, ZLIB or ZSTD.||
 |`--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||
+|`-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|
 |`-n`, `--num-producers`|The number of producers (per topic)|1|
 |`-t`, `--num-topic`|The number of topics|1|
@@ -454,10 +463,85 @@ Options
 |`-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|
 |`--trust-cert-file`|Path for the trusted TLS certificate file||
+|`--warmup-time`|Warm-up time in seconds|1|
+
+
+### `read`
+Run a topic reader
+
+Usage
+```bash
+$ 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_plugin`|Authentication plugin class name||
+|`--conf-file`|Configuration file||
+|`-h`, `--help`|Help message|false|
+|`-c`, `--max-connections`|Max number of TCP connections to a single broker|100|
+|`-t`, `--num-topic`|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|
+|`--trust-cert-file`|Path for the trusted TLS certificate file||
 |`--use-tls`|Use TLS encryption on the connection|false|
-|`--warmup-time`|Warm-up time in seconds |1|
 
 
+### `websocket-producer`
+Run a websocket producer
+
+Usage
+```bash
+$ 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_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|
+|`-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|
+
+
+### `managed-ledger`
+Write directly on managed-ledgers
+
+Usage
+```bash
+$ pulsar-perf managed-ledger options
+```
+
+Options
+|Flag|Description|Default|
+|---|---|---|
+|`-a`, `--ack-quorum`|Ledger ack quorum|1|
+|`-dt`, `--digest-type`|BookKeeper digest type. Possible Values: [CRC32, MAC, CRC32C, DUMMY]|CRC32C|
+|`-e`, `--ensemble-size`|Ledger ensemble size|1|
+|`-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|
+|`-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|
+|`--threads`|Number of threads writing|1|
+|`-w`, `--write-quorum`|Ledger write quorum|1|
+|`-zk`, `--zookeeperServers`|ZooKeeper connection string||
+
 
 ### `monitor-brokers`
 Continuously receive broker data and/or load reports
@@ -471,16 +555,23 @@ Options
 |Flag|Description|Default|
 |---|---|---|
 |`--connect-string`|A connection string for one or more ZooKeeper servers||
+|`-h`, `--help`|Help message|false|
 
 
 ### `simulation-client`
-Run a simulation server acting as a Pulsar client. Uses the client configuration specified in conf/client.conf.
+Run a simulation server acting as a Pulsar client. Uses the client configuration specified in `conf/client.conf`.
 
 Usage
 ```bash
-$ pulsar-perf simulation-client
+$ pulsar-perf simulation-client options
 ```
 
+Options
+|Flag|Description|Default|
+|---|---|---|
+|`--port`|Port to listen on for controller|0|
+|`--service-url`|Pulsar Service URL||
+|`-h`, `--help`|Help message|false|
 
 ### `simulation-controller`
 Run a simulation controller to give commands to servers
@@ -496,6 +587,16 @@ Options
 |`--client-port`|The port that the clients are listening on|0|
 |`--clients`|Comma-separated list of client hostnames||
 |`--cluster`|The cluster to test on||
+|`-h`, `--help`|Help message|false|
+
+
+### `help`
+This help message
+
+Usage
+```bash
+$ pulsar-perf help
+```
 
 
 ## `bookkeeper`
@@ -523,7 +624,7 @@ The table below lists the environment variables that you can use to configure th
 |BOOKIE_LOG_CONF|Log4j configuration file|conf/log4j2.yaml|
 |BOOKIE_CONF|BookKeeper configuration file|conf/bk_server.conf|
 |BOOKIE_EXTRA_OPTS|Extra options to be passed to the JVM||
-|BOOKIE_EXTRA_CLASSPATH|Extra paths for BookKeeper's classpath||  
+|BOOKIE_EXTRA_CLASSPATH|Extra paths for BookKeeper's classpath||
 |ENTRY_FORMATTER_CLASS|The Java class used to format entries||
 |BOOKIE_PID_DIR|Folder where the BookKeeper server PID file should be stored||
 |BOOKIE_STOP_TIMEOUT|Wait time before forcefully killing the Bookie server instance if attempts to stop it are not successful||