RABBITMQ-STREAMS(8)

🌸 NAME 🌸

okay so bestie, this is the System Manager's Manual page for rabbitmq-streams — RabbitMQ stream management tools. That’s the whole vibe: stream management tools, and she’s serving. 🫶

✨ SYNOPSIS ✨

Here’s the shape of it, exactly:

rabbitmq-streams [-q] [-s] [-l] [-n node] [-t timeout] command [command_options]

🦋 DESCRIPTION 🦋

rabbitmq-streams is a command line tool that provides commands used to manage streams, for example, add or delete stream replicas. See the RabbitMQ streams overview: https://www.rabbitmq.com/docs/streams.

💅 OPTIONS 💅

flags flags flags, let’s go 🕺

• -n node — Default node is "rabbit@target-hostname", where target-hostname is the local host. On a host named "myserver.example.com", the node name will usually be "rabbit@myserver" (unless RABBITMQ_NODENAME has been overridden). The output of "hostname -s" is usually the correct suffix to use after the "@" sign. See rabbitmq-server(8) for details of configuring a RabbitMQ node. That’s the whole lore, no cap. 💅
• -q, --quiet — Quiet output mode is selected. Informational messages are reduced when quiet mode is in effect. Lowkey less chatter. 🙈
• -s, --silent — Silent output mode is selected. Informational messages are reduced and table headers are suppressed when silent mode is in effect. Iconic for clean output. ✨
• -t timeout, --timeout timeout — Operation timeout in seconds. Not all commands support timeouts. Default is infinity. Ngl infinity is a long time 🫠
• -l, --longnames — Must be specified when the cluster is configured to use long (FQDN) node names. To learn more, see the RabbitMQ Clustering guide: https://www.rabbitmq.com/docs/clustering
• --erlang-cookie cookie — Shared secret to use to authenticate to the target node. Prefer using a local file or the RABBITMQ_ERLANG_COOKIE environment variable instead of specifying this option on the command line. To learn more, see the RabbitMQ CLI Tools guide: https://www.rabbitmq.com/docs/cli

real talk: prefer using a local file or the RABBITMQ_ERLANG_COOKIE environment variable instead of specifying this option on the command line — keep secrets secret, bestie 🫶

👑 COMMANDS 👑

Here’s the command menu, main character energy only.

help

Displays general help and commands supported by rabbitmq-streams. ✨

🎀 Replication 🎀

add_replica queue node --vhost virtual-host

Adds a stream replica on the given node.

Example:

rabbitmq-streams add_replica --vhost "a-vhost" "a-queue" "rabbit@new-node"

delete_replica queue node --vhost virtual-host

Removes a stream replica on the given node.

Example:

rabbitmq-streams delete_replica --vhost "a-vhost" "a-queue" "rabbit@decomissioned-node"

transfer_leadership stream node --vhost virtual-host

Transfers the leadership of a stream to the given node.

Example:

rabbitmq-streams transfer_leadership --vhost "a-vhost" "a-stream" "rabbit@new-leader-node"

🌈 Monitoring, observability and health checks 🌈

stream_status stream --vhost virtual-host

Displays the status of a stream.

Example:

rabbitmq-streams stream_status --vhost "a-vhost" "a-stream"

restart_stream stream --vhost virtual-host --preferred-leader-node node

Restarts a stream including all of it's replicas. The optional preferred node flag instructs the command to try to place the leader on a specific node during the restart.

Example:

rabbitmq-streams restart_stream --vhost "a-vhost"

---

okay that’s the page, bestie 🫶🌸 — System Manager's Manual energy, top to bottom. The source/version and date footer got cut off in the copy I got, so no cap, I’m not making one up; consider this the cute sign-off, periodt 💅