All Pulsar command-line tools can be run from the bin directory of your installed Pulsar package. The following tools are currently documented:

$ bin/pulsar broker —help

Commands:

  • bookie
  • broker
  • compact-topic
  • discovery
  • configuration-store
  • initialize-cluster-metadata
  • proxy
  • standalone
  • websocket
  • zookeeper
  • zookeeper-shell

例子：

  1. $ PULSAR_BROKER_CONF=/path/to/broker.conf pulsar broker

下表列出了你可以用来配置 pulsar 工具的环境变量。

bookie

启动 bookie 服务器

用法：

  1. $ pulsar bookie options

选项

选项Description默认值
-readOnlyForce start a read-only bookie serverfalse
-withAutoRecovery启动带自动恢复服务的 bookie 服务器false

示例

  1. $ PULSAR_BOOKKEEPER_CONF=/path/to/bookkeeper.conf pulsar bookie \
  2.   -readOnly \
  3.   -withAutoRecovery

broker

启动一个 Pulsar broker

用法

  1. $ pulsar broker options

选项

选项Description默认值
-bc , —bookie-confBookKeeper 的配置文件
-rb , —run-bookie在 Pulsar broker 的同一主机上运行 Bookeeper bookiefalse
-ra , —run-bookie-autorecovery在 Pulsar broker 的同一主机上运行 BooKeeper 自动恢复守护进程。false

示例

  1. $ PULSAR_BROKER_CONF=/path/to/broker.conf pulsar broker

compact-topic

对 Pulsar 主题执行压缩（在新进程里）

用法

  1. $ pulsar compact-topic options

选项

标记Description默认值
-t , —topic你想压缩的 Pulsar 主题

示例

  1. $ pulsar compact-topic --topic topic-to-compact

discovery

运行发现服务器

用法

  1. $ pulsar discovery

示例

  1. $ PULSAR_DISCOVERY_CONF=/path/to/discovery.conf pulsar discovery

configuration-store

启动 Pulsar 配置存储

用法

  1. $ pulsar configuration-store

示例

  1. $ PULSAR_CONFIGURATION_STORE_CONF=/path/to/configuration_store.conf pulsar configuration-store

initialize-cluster-metadata

一次性集群元数据初始化

用法

  1. $ pulsar initialize-cluster-metadata options

选项

标记Description默认值
-ub , —broker-service-url新集群的 broker 服务 URL
-tb , —broker-service-url-tls新集群的broker 服务 URL（带 TLS 加密）
-c , —cluster集群名称
—configuration-store配置存储的 quorum 连接字符串
-uw , —web-service-url新集群的 web 服务 URL
-tw , —web-service-url-tls新集群的 web 服务 URL（带 TLS 加密）
-zk , —zookeeper本地 ZooKeeper 的 quorum 连接字符串

proxy

管理 Pulsar 代理

用法

  1. $ pulsar proxy options

选项

标记Description默认值
—configuration-store配置存储连接字符串
-zk , —zookeeper-servers本地 ZooKeeper 连接字符串

示例

  1. $ PULSAR_PROXY_CONF=/path/to/proxy.conf pulsar proxy \
  2.   --zookeeper-servers zk-0,zk-1,zk2 \
  3.   --configuration-store zk-0,zk-1,zk-2

standalone

运行使用本地 bookies 和 本地 ZooKeeper 的 broker 服务

用法

选项

标记Description默认值
-a , —advertised-addressstandalone broker 广告的地址
—bookkeeper-dir本地 bookie 的基本数据目录data/standalone/bookeeper
—bookkeeper-port本地 bookie 的基本端口目录3181
—no-broker只启动 ZooKeeper 和 BookKeeper 服务，而不启动 brokerfalse
—num-bookies本地 bookies 的数量1
—only-broker只启动 Pulsar broker 服务（而不启动 ZooKeeper 或 BookKeeper）
—wipe-data清除之前的 ZooKeeper/BookKeeper 数据
—zookeeper-dir本地 ZooKeeper 的数据目录data/standalone/zookeeper
—zookeeper-port本地 ZooKeeper 的端口2181

示例

websocket

用法

  1. $ pulsar websocket

示例

  1. $ PULSAR_WEBSOCKET_CONF=/path/to/websocket.conf pulsar websocket

启动 ZooKeeper 集群

  1. $ pulsar zookeeper

示例

  1. $ PULSAR_ZK_CONF=/path/to/zookeeper.conf pulsar zookeeper

zookeeper-shell

使用 ZooKeeper shell 来连接到一个正在运行的 ZooKeeper 集群

用法

  1. $ pulsar zookeeper-shell options

选项

标记Description默认值
-c, —confZooKeeper 的配置文件

The pulsar-client tool

用法

  1. $ pulsar-client command

Commands

  • produce
  • consume

选项

produce

发送单条或多条消息给指定的 broker 和主题

用法

    选项

    标记Description默认值
    -f, —files将要发送的以逗号分隔的文件路径，必须指定 -m 或 -f[]
    -m, —messages将要发送的以逗号分隔的消息字符串，必须指定 -m 或 -f[]
    -n, —num-produce发送单条或多条消息的次数；消息/文件 * 生产次数 应小于 10001
    -r, —rate生产消息的频率（单位是消息/秒），值为 0 表示尽可能快地生产消息0.0

    consume

    从指定的 broker 和 主题 消费消息

    用法

    1. $ pulsar-client consume topic options

    选项

    标记Description默认值
    —hex以十六进制格式显示二进制消息。false
    -n, —num-messages要消费的消息数量，0 表示一直消费。1
    -r, —rate消费消息的频率（单位是消息/秒），值为 0 表示尽可能快地消费消息0.0
    —regex表明主题名称为正则表达式false
    -s, —subscription-nameSubscription name
    -t, —subscription-typeThe type of the subscription. Possible values: Exclusive, Shared, Failover, Key_Shared.Exclusive
    -p, —subscription-positionThe position of the subscription. Possible values: Latest, Earliest.Latest

    围绕着 pulsar 工具的包装，用于在后台用 nohup 启动和停止进程，比如 ZooKeeper，bookies 和 Pulsar brokers。

    pulsar-daemon 有一个与 pulsar 命令相似的接口，但是为各种服务添加了启动和停止命令。 如果需要这些服务的列表，运行 pulsar-daemon 来查看帮助文档的输出或查看 pulsar 命令的文档。

    用法

    1. $ pulsar-daemon command

    Commands

    • start
    • stop

    start

    使用 nohup 在后台启动服务

    用法

    1. $ pulsar-daemon start service

    stop

    停止一个已经使用 start 命令启动了的服务

    用法

    1. $ pulsar-daemon stop service options

    选项

    标记Description默认值
    -force如果无法正常停止则强制停止服务false

    用于性能测试 Pulsar broker 的工具。

    用法

    1. $ pulsar-perf command

    Commands

    • consume
    • produce
    • read
    • websocket-producer
    • managed-ledger
    • monitor-brokers
    • simulation-client
    • simulation-controller
    • help

    环境变量

    下表列出了你可以用来配置 pulsar-perf 工具的环境变量。

    变量Description默认值
    PULSAR_LOG_CONFLog4j 的配置文件conf/log4j2.yaml
    PULSAR_CLIENT_CONF客户端的配置文件conf/client.conf
    PULSAR_EXTRA_OPTS传递给 JVM 的额外选项
    PULSAR_EXTRA_CLASSPATHPulsar classpath 的额外路径

    consume

    Run a consumer

    用法

    1. $ pulsar-perf consume options

    选项

    标记Description默认值
    —auth_params认证参数，其格式取决于认证插件类中 configure 方法的实现，例如 “key1:val1,key2:val2” 或 “{“key1”:”val1”,”key2”:”val2”}.
    —auth_plugin认证插件类名称
    —acks-delay-millisAcknowlegments grouping delay in millis100
    -k, —encryption-key-nameThe private key name to decrypt payload
    -v, —encryption-key-value-fileThe file which contains the private key to decrypt payload
    -h, —help帮助信息false
    —conf-fileConfiguration file
    -c, —max-connectionsMax number of TCP connections to a single broker100
    -n, —num-consumersNumber of consumers (per topic)1
    -t, —num-topicThe number of topics1
    -r, —rateSimulate a slow message consumer (rate in msg/s)0
    -q, —receiver-queue-sizeSize of the receiver queue1000
    -u, —service-urlPulsar service URL
    -i, —stats-interval-secondsStatistics interval seconds. If 0, statistics will be disabled0
    -s, —subscriber-nameSubscriber name prefixsub
    -st, —subscription-typeSubscriber type. Possible values are Exclusive, Shared, Failover, Key_Shared.Exclusive
    -sp, —subscription-positionSubscriber position. Possible values are Latest, Earliest.Latest
    —trust-cert-filePath for the trusted TLS certificate file

    produce

    Run a producer

    用法

    选项

    标记Description默认值
    —auth_params认证参数，其格式取决于认证插件类中 configure 方法的实现，例如 “key1:val1,key2:val2” 或 “{“key1”:”val1”,”key2”:”val2”}.
    —auth_plugin认证插件类名称
    -b, —batch-time-windowBatch messages in a window of the specified number of milliseconds1
    -z, —compressionCompress messages’ payload. Possible values are NONE, LZ4, ZLIB, ZSTD or SNAPPY.
    —conf-fileConfiguration file
    -k, —encryption-key-nameThe public key name to encrypt payload
    -v, —encryption-key-value-fileThe file which contains the public key to encrypt payload
    -h, —help帮助信息false
    -c, —max-connectionsMax number of TCP connections to a single broker100
    -o, —max-outstandingMax number of outstanding messages1000
    -p, —max-outstanding-across-partitionsMax number of outstanding messages across partitions50000
    -m, —num-messagesNumber of messages to publish in total. If set to 0, it will keep publishing.0
    -n, —num-producersThe number of producers (per topic)1
    -t, —num-topicThe number of topics1
    -f, —payload-fileUse payload from an UTF-8 encoded text file and a payload will be randomly selected when publishing messages
    -e, —payload-delimiterThe delimiter used to split lines when using payload from a file\n
    -r, —ratePublish rate msg/s across topics100
    -u, —service-urlPulsar service URL
    -s, —sizeMessage size (in bytes)1024
    -i, Statistics interval seconds. If 0, statistics will be disabled.0
    -time, —test-durationTest duration in secs. If set to 0, it will keep publishing.0
    —trust-cert-filePath for the trusted TLS certificate file
    —warmup-timeWarm-up time in seconds1

    read

    运行主题读者

    用法

    1. $ pulsar-perf read options

    选项

    标记Description默认值
    —auth_params认证参数，其格式取决于认证插件类中 configure 方法的实现，例如 “key1:val1,key2:val2” 或 “{“key1”:”val1”,”key2”:”val2”}.
    —auth_plugin认证插件类名称
    —conf-fileConfiguration file
    -h, —help帮助信息false
    -c, —max-connectionsMax number of TCP connections to a single broker100
    -t, —num-topicThe number of topics1
    -r, —rateSimulate a slow message reader (rate in msg/s)0
    -q, —receiver-queue-sizeSize of the receiver queue1000
    -u, —service-urlPulsar service URL
    -m, —start-message-idStart message id. This can be either ‘earliest’, ‘latest’ or a specific message id by using ‘lid:eid’earliest
    -i, —stats-interval-secondsStatistics interval seconds. If 0, statistics will be disabled.0
    —trust-cert-filePath for the trusted TLS certificate file
    —use-tlsUse TLS encryption on the connectionfalse

    websocket-producer

    启动 websocket 生产者

    1. $ pulsar-perf websocket-producer options

    选项

    直接写入 managed-ledgers

    用法

    1. $ pulsar-perf managed-ledger options

    选项

    标记Description默认值
    -a, —ack-quorumLedger ack quorum1
    -dt, —digest-typeBookKeeper digest type. Possible Values: [CRC32, MAC, CRC32C, DUMMY]CRC32C
    -e, —ensemble-sizeLedger 整体大小1
    -h, —help帮助信息false
    -c, —max-connections单个 bookie 的最大 TCP 连接数1
    -o, —max-outstanding未处理请求的最大数量1000
    -m, —num-messagesNumber of messages to publish in total. If 0, it will keep publishing0
    -t, —num-topicmanaged ledger 的数量1
    -r, —rate在managed ledger中的写入速率（消息/秒）100
    -s, —size消息大小（字节）1024
    -time, —test-durationTest duration in secs. If 0, it will keep publishing0
    —threads正在写入的线程数1
    -w, —write-quorumLedger write quorum1
    -zk, —zookeeperServersZooKeeper 连接字符串

    monitor-brokers

    Continuously receive broker data and/or load reports

    用法

    1. $ pulsar-perf monitor-brokers options

    选项

    标记Description默认值
    —connect-stringA connection string for one or more ZooKeeper servers
    -h, —help帮助信息false

    simulation-client

    Run a simulation server acting as a Pulsar client. Uses the client configuration specified in conf/client.conf.

    用法

    1. $ pulsar-perf simulation-client options

    选项

    标记Description默认值
    —port用于监听控制器的端口0
    —service-urlPulsar 服务 URL
    -h, —help帮助信息false

    simulation-controller

    Run a simulation controller to give commands to servers

    用法

    1. $ pulsar-perf simulation-controller options

    选项

    标记Description默认值
    —client-portThe port that the clients are listening on0
    —clientsComma-separated list of client hostnames
    —clusterThe cluster to test on
    -h, —help帮助信息false

    help

    帮助消息

    用法

    1. $ pulsar-perf help

    A tool for managing BookKeeper.

    用法

    1. $ bookkeeper command

    Commands

    • auto-recovery
    • bookie
    • localbookie
    • upgrade
    • shell

    环境变量

    The table below lists the environment variables that you can use to configure the bookkeeper tool.

    变量Description默认值
    BOOKIE_LOG_CONFLog4j 的配置文件conf/log4j2.yaml
    BOOKIE_CONFBookKeeper configuration fileconf/bk_server.conf
    BOOKIE_EXTRA_OPTS传递给 JVM 的额外选项
    BOOKIE_EXTRA_CLASSPATHExtra paths for BookKeeper’s classpath
    ENTRY_FORMATTER_CLASSThe Java class used to format entries
    BOOKIE_PID_DIRFolder where the BookKeeper server PID file should be stored
    BOOKIE_STOP_TIMEOUT当尝试停止 Bookie 服务器失败时，在强制杀死它之前的等待时间。

    auto-recovery

    Runs an auto-recovery service daemon

    用法

    1. $ bookkeeper auto-recovery options

    选项

    标记Description默认值
    -c, —confConfiguration for the auto-recovery daemon

    bookie

    Starts up a BookKeeper server (aka bookie)

    用法

    1. $ bookkeeper bookie options

    选项

    标记Description默认值
    -c, —confConfiguration for the auto-recovery daemon
    -readOnlyForce start a read-only bookie serverfalse
    -withAutoRecoveryStart auto-recovery service bookie serverfalse

    localbookie

    Runs a test ensemble of N bookies locally

    用法

    1. $ bookkeeper localbookie N

    upgrade

    Upgrade the bookie’s filesystem

    用法

    1. $ bookkeeper upgrade options

    选项

    shell

    Run shell for admin commands. To see a full listing of those commands, run bookkeeper shell without an argument.

    用法

    1. $ bookkeeper shell

    示例

    1. $ bookkeeper shell bookiesanity

    broker- tool 用于在指定的 broker 上进行操作

    用法

    Commands

    • load-report
    • help

    示例 获取关于某条命令的更多信息的两种方式：

    1. $ broker-tool help command

    选项

    标记Description默认值
    -i, —interval收集负载报告的间隔（毫秒）
    -h, —help显示帮助信息