You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pulsar.apache.org by si...@apache.org on 2019/04/25 05:33:43 UTC
[pulsar] branch master updated: Update command-line tools doc to
catch up the work. (#4116)
This is an automated email from the ASF dual-hosted git repository.
sijie 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 49b3772 Update command-line tools doc to catch up the work. (#4116)
49b3772 is described below
commit 49b37726bd09bbe02f91ac223f3ab4910b5a3f30
Author: Fangbin Sun <su...@gmail.com>
AuthorDate: Thu Apr 25 13:33:38 2019 +0800
Update command-line tools doc to catch up the work. (#4116)
### Motivation
Catch up the command-line tools doc.
### Modifications
Add some missing subcommands and other updates.
---
site2/docs/reference-cli-tools.md | 112 +++++++++++++++++++++++++++++++++++---
1 file changed, 105 insertions(+), 7 deletions(-)
diff --git a/site2/docs/reference-cli-tools.md b/site2/docs/reference-cli-tools.md
index 60ae360..5b016b9 100644
--- a/site2/docs/reference-cli-tools.md
+++ b/site2/docs/reference-cli-tools.md
@@ -378,9 +378,13 @@ $ pulsar-perf command
Commands
* `consume`
* `produce`
+* `read`
+* `websocket-producer`
+* `managed-ledger`
* `monitor-brokers`
* `simulation-client`
* `simulation-controller`
+* `help`
Environment variables
@@ -405,12 +409,12 @@ $ 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|
@@ -422,7 +426,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`
@@ -436,11 +439,14 @@ $ 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|
|`-m`, `--num-messages`|Number of messages to publish in total. If set to 0, it will keep publishing.|0|
@@ -453,10 +459,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
@@ -470,16 +551,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
@@ -495,6 +583,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`