1RABBITMQ-STREAMS(8) BSD System Manager's Manual RABBITMQ-STREAMS(8)
2
4 rabbitmq-streams — RabbitMQ stream management tools
5
7 rabbitmq-streams [-q] [-s] [-l] [-n node] [-t timeout] command
8 [command_options]
9
11 rabbitmq-streams is a command line tool that provides commands used to
12 manage streams, for example, add or delete stream replicas. See the
13 RabbitMQ streams overview: https://www.rabbitmq.com/streams.html
14
16 -n node
17 Default node is "rabbit@target-hostname", where target-hostname
18 is the local host. On a host named "myserver.example.com", the
19 node name will usually be "rabbit@myserver" (unless
20 RABBITMQ_NODENAME has been overridden). The output of "hostname
21 -s" is usually the correct suffix to use after the "@" sign. See
22 rabbitmq-server(8) for details of configuring a RabbitMQ node.
23 -q, --quiet
25 Quiet output mode is selected. Informational messages are re‐
26 duced when quiet mode is in effect.
27 -s, --silent
29 Silent output mode is selected. Informational messages are re‐
30 duced and table headers are suppressed when silent mode is in ef‐
31 fect.
32 -t timeout, --timeout timeout
34 Operation timeout in seconds. Not all commands support timeouts.
35 Default is infinity.
36 -l, --longnames
38 Must be specified when the cluster is configured to use long
39 (FQDN) node names. To learn more, see the RabbitMQ Clustering
40 guide: https://www.rabbitmq.com/clustering.html
41 --erlang-cookie cookie
43 Shared secret to use to authenticate to the target node. Prefer
44 using a local file or the RABBITMQ_ERLANG_COOKIE environment
45 variable instead of specifying this option on the command line.
46 To learn more, see the RabbitMQ CLI Tools guide:
47 https://www.rabbitmq.com/cli.html
48
50 help
51 Displays general help and commands supported by rabbitmq-streams.
53 Replication
55 add_replica queue node --vhost virtual-host
56 Adds a stream replica on the given node.
58 Example:
60 rabbitmq-streams add_replica --vhost "a-vhost" "a-queue"
61 "rabbit@new-node"
62 delete_replica queue node --vhost virtual-host
64 Removes a stream replica on the given node.
66 Example:
68 rabbitmq-streams delete_replica --vhost "a-vhost" "a-queue"
69 "rabbit@decomissioned-node"
70 Monitoring, observability and health checks
72 stream_status stream --vhost virtual-host
73 Displays the status of a stream.
75 Example:
77 rabbitmq-streams stream_status --vhost "a-vhost" "a-stream"
78 Policies
80 set_stream_retention_policy stream policy --vhost virtual-host
81 Set the retention policy of a stream.
83 Example:
85 rabbitmq-streams set_stream_retention_policy --vhost
86 "a-vhost" "a-stream" "a-policy"
87 Stream plugin
89 list_stream_connections [connectioninfoitem ...]
90 Returns stream protocol connection statistics.
92 The connectioninfoitem parameter is used to indicate which con‐
94 nection information items to include in the results. The column
95 order in the results will match the order of the parameters.
96 connectioninfoitem can take any value from the list that follows:
97 auth_mechanism
99 SASL authentication mechanism used, such as "PLAIN".
100 client_properties
102 Informational properties transmitted by the client during
103 connection establishment.
104 conn_name
106 Readable name for the connection.
107 connected_at
109 Date and time this connection was established, as time‐
110 stamp.
111 connection_state
113 Connection state; one of:
114 • running
115 • blocked
116 frame_max
118 Maximum frame size (bytes).
119 heartbeat
121 Negotiated heartbeat interval, in seconds.
122 host Server hostname obtained via reverse DNS, or its IP ad‐
124 dress if reverse DNS failed or was disabled.
125 peer_cert_issuer
127 The issuer of the peer's SSL certificate, in RFC4514
128 form.
129 peer_cert_subject
131 The subject of the peer's SSL certificate, in RFC4514
132 form.
133 peer_cert_validity
135 The period for which the peer's SSL certificate is valid.
136 peer_host
138 Peer hostname obtained via reverse DNS, or its IP address
139 if reverse DNS failed or was not enabled.
140 peer_port
142 Peer port.
143 port Server port.
145 ssl Boolean indicating whether the connection is secured with
147 SSL.
148 ssl_cipher
150 SSL cipher algorithm (e.g. "aes_256_cbc").
151 ssl_hash
153 SSL hash function (e.g. "sha").
154 ssl_key_exchange
156 SSL key exchange algorithm (e.g. "rsa").
157 ssl_protocol
159 SSL protocol (e.g. "tlsv1").
160 subscriptions
162 Number of subscriptions (consumers) on the connection.
163 user Username associated with the connection.
165 vhost Virtual host name with non-ASCII characters escaped as in
167 C.
168 If no connectioninfoitem are specified then only conn_name is
170 displayed.
171 For example, this command displays the connection name and user
173 for each connection:
174 rabbitmq-streams list_stream_connections conn_name user
176 list_stream_consumers [-p vhost] [consumerinfoitem ...]
178 Returns consumers attached to a stream.
180 The consumerinfoitem parameter is used to indicate which consumer
182 information items to include in the results. The column order in
183 the results will match the order of the parameters.
184 consumerinfoitem can take any value from the list that follows:
185 connection_pid
187 Id of the Erlang process associated with the consumer
188 connection.
189 credits
191 Available credits for the consumer.
192 messages_consumed
194 Number of messages the consumer consumed.
195 offset The offset (location in the stream) the consumer is at.
197 offset_lag
199 The difference between the last stored offset and the
200 last dispatched offset for the consumer.
201 properties
203 The properties of the consumer subscription.
204 stream The stream the consumer is attached to.
206 subscription_id
208 The connection-scoped ID of the consumer.
209 If no consumerinfoitem are specified then connection_pid, sub‐
211 scription_id, stream, messages_consumed, offset, offset_lag,
212 credits, properties are displayed.
213 For example, this command displays the connection PID, subscrip‐
215 tion ID and stream for each consumer:
216 rabbitmq-streams list_stream_consumers connection_pid
218 subscription_id stream
219 list_stream_publishers [-p vhost] [publisherinfoitem ...]
222 Returns registered publishers.
224 The publisherinfoitem parameter is used to indicate which pub‐
226 lisher information items to include in the results. The column
227 order in the results will match the order of the parameters.
228 publisherinfoitem can take any value from the list that follows:
229 connection_pid
231 Id of the Erlang process associated with the consumer
232 connection.
233 messages_confirmed
235 The number of confirmed messages for the publisher.
236 messages_errored
238 The number of errored messages for the publisher.
239 messages_published
241 The overall number of messages the publisher published.
242 publisher_id
244 The connection-scoped ID of the publisher.
245 reference
247 The deduplication reference of the publisher.
248 stream The stream the publisher publishes to.
250 If no publisherinfoitem are specified then connection_pid, pub‐
252 lisher_id, stream, reference, messages_published, messages_con‐
253 firmed, and messages_errored are displayed.
254 For example, this command displays the connection PID, publisher
256 ID and stream for each producer:
257 rabbitmq-streams list_stream_publishers connection_pid
259 publisher_id stream
260
262 rabbitmqctl(8), rabbitmq-diagnostics(8), rabbitmq-server(8),
263 rabbitmq-queues(8), rabbitmq-upgrade(8), rabbitmq-service(8),
264 rabbitmq-env.conf(5), rabbitmq-echopid(8)
265
267 The RabbitMQ Team <info@rabbitmq.com>
268RabbitMQ Server September 20, 2022 RabbitMQ Server