maelstrom-admin
The maelstrom-admin program can be used to monitor and control the broker
from the command-line. It can be run on any machine as it communicates with the
broker over the network.
Command-Line Options
maelstrom-admin supports the common command-line options, as
well as two configuration values, which are covered in
the next section.
Configuration Values
maelstrom-admin supports the following configuration values:
| Value | Short Option | Type | Description | Default |
|---|---|---|---|---|
broker | -b | string | address of broker | must be provided |
log-level | -L | string | minimum log level | "info" |
broker
The broker configuration value specifies the socket address of the broker.
This configuration value must be provided.
Here are some example value socket addresses:
broker.example.org:1234192.0.2.3:1234[2001:db8::3]:1234
log-level
See here.
maelstrom-admin always prints log messages to stderr.
Subcommands
maelstrom-admin has two subcommands: status and stop. One of these must be specified.
status
maelstrom-admin status
This subcommand will gather cluster status information from the broker and print it to standard output.
stop
maelstrom-admin stop
This subcommand will tell the broker and all of the connected workers to exit. This is useful in CI workflows when it’s not possible to just send a signal to the broker.