.\" vim:ft=nroff:
.\" This Source Code Form is subject to the terms of the Mozilla Public
.\" License, v. 2.0. If a copy of the MPL was not distributed with this
.\" file, You can obtain one at https://mozilla.org/MPL/2.0
.\"
.\" Copyright (c) 2007-2026 Broadcom. All Rights Reserved. The term “Broadcom” refers to Broadcom Inc. and/or its subsidiaries.  All rights reserved.
.\"
.Dd July 1, 2025
.Dt RABBITMQ-STREAMS 8
.Os "RabbitMQ Server"
.Sh "نام (NAME)"
.Nm rabbitmq-streams
.Nd ابزارهای مدیریت استریم در RabbitMQ
.\" ------------------------------------------------------------------
.Sh "خلاصه دستور (SYNOPSIS)"
.\" ------------------------------------------------------------------
.Nm
.Op Fl q
.Op Fl s
.Op Fl l
.Op Fl n Ar node
.Op Fl t Ar timeout
.Ar command
.Op Ar command_options
.\" ------------------------------------------------------------------
.Sh "توضیحات (DESCRIPTION)"
.\" ------------------------------------------------------------------
.Nm
ابزاری خط فرمانی است که دستوراتی برای مدیریت استریم‌ها ارائه می‌دهد،
برای نمونه افزودن یا حذف نسخه‌های تکثیرشده (replicas) از استریم.
ببینید:
.Lk https://www.rabbitmq.com/docs/streams "مروری بر استریم‌های RabbitMQ" .
.\" ------------------------------------------------------------------
.Sh "گزینه‌ها (OPTIONS)"
.\" ------------------------------------------------------------------
.Bl -tag -width Ds
.It Fl n Ar node
گره پیش‌فرض عبارت است از
.Qq Pf rabbit@ Ar target-hostname ،
که در آن
.Ar target-hostname
میزبان محلی است.
روی میزبانی به نام
.Qq myserver.example.com ،
نام گره معمولاً
.Qq rabbit@myserver
خواهد بود
(مگر اینکه
.Ev RABBITMQ_NODENAME
بازنویسی شده باشد).
خروجی دستور
.Qq hostname -s
معمولاً پسوند صحیح برای استفاده پس از علامت
.Qq @
است.
برای جزئیات پیکربندی گره RabbitMQ به
.Xr rabbitmq-server 8
مراجعه کنید.
.It Fl q , -quiet
حالت خروجی ساکت (quiet) انتخاب می‌شود.
در زمان فعال بودن این حالت، پیام‌های اطلاع‌رسانی کاهش می‌یابند.
.It Fl s , -silent
حالت خروجی خاموش (silent) انتخاب می‌شود.
در زمان فعال بودن این حالت، پیام‌های اطلاع‌رسانی کاهش یافته و سرصفحه جداول حذف می‌شوند.
.It Fl t Ar timeout , Fl -timeout Ar timeout
مهلت زمانی عملیات بر حسب ثانیه.
تمام دستورات از مهلت زمانی پشتیبانی نمی‌کنند.
مقدار پیش‌فرض
.Cm infinity
است.
.It Fl l , Fl -longnames
زمانی که کلاستر برای استفاده از نام‌های بلند گره (FQDN) پیکربندی شده باشد، باید مشخص شود.
برای اطلاعات بیشتر به
.Lk https://www.rabbitmq.com/docs/clustering "راهنمای کلاسترینگ RabbitMQ"
مراجعه کنید.
.It Fl -erlang-cookie Ar cookie
راز مشترک (shared secret) مورد استفاده برای احراز هویت در گره هدف.
توصیه می‌شود به جای مشخص کردن این گزینه در خط فرمان، از یک فایل محلی یا متغیر محیطی
.Ev RABBITMQ_ERLANG_COOKIE
استفاده شود.
برای اطلاعات بیشتر به
.Lk https://www.rabbitmq.com/docs/cli "راهنمای ابزارهای خط فرمان RabbitMQ"
مراجعه کنید.
.El
.\" ------------------------------------------------------------------
.Sh "دستورات (COMMANDS)"
.\" ------------------------------------
.Bl -tag -width Ds
.\" ------------------------------------
.It Cm help
.Pp
راهنمای عمومی و دستورات پشتیبانی‌شده توسط
.Nm
را نمایش می‌دهد.
.El
.Ss "تکثیر (Replication)"
.Bl -tag -width Ds
.\" ------------------------------------
.It Cm add_replica Ar queue Ar node Fl -vhost Ar virtual-host
.Pp
یک نسخه رونوشت (replica) از استریم را روی گره داده‌شده اضافه می‌کند.
.Pp
مثال:
.Sp
.Dl rabbitmq-streams add_replica --vhost Qo a-vhost Qc Qo a-queue Qc Qo rabbit@new-node Qc
.\" ------------------------------------
.It Cm delete_replica Ar queue Ar node Fl -vhost Ar virtual-host
.Pp
نسخه رونوشت (replica) استریم را از روی گره داده‌شده حذف می‌کند.
.Pp
مثال:
.Sp
.Dl rabbitmq-streams delete_replica --vhost Qo a-vhost Qc Qo a-queue Qc Qo rabbit@decomissioned-node Qc
.\" ------------------------------------
.El
.Ss "پایش، مشاهده‌پذیری و بررسی‌های سلامت (Monitoring, observability and health checks)"
.Bl -tag -width Ds
.\" ------------------------------------
.It Cm stream_status Ar stream Fl -vhost Ar virtual-host
.Pp
وضعیت یک استریم را نمایش می‌دهد.
.Pp
مثال:
.Sp
.Dl rabbitmq-streams stream_status --vhost Qo a-vhost Qc Qo a-stream Qc
.\" ------------------------------------
.It Cm restart_stream Ar stream Fl -vhost Ar virtual-host Fl -preferred-leader-node Ar node
.Pp
یک استریم را به همراه تمام رونوشت‌های آن مجدداً راه‌اندازی می‌کند. فلگ اختیاری گره ترجیحی
به دستور می‌گوید تلاش کند رهبر (leader) را حین راه‌اندازی مجدد روی گره خاصی قرار دهد.
.Pp
مثال:
.Sp
.Dl rabbitmq-streams restart_stream --vhost Qo a-vhost Qc Qo a-stream Qc --preferred-leader-node Qo node
.\" ------------------------------------
.El
.Ss "پلاگین استریم (Stream plugin)"
.Bl -tag -width Ds
.\" ------------------------------------------------------------------
.It Cm activate_stream_consumer Fl -stream Ar stream Fl -reference Ar reference Oo Fl -vhost Ar vhost Oc
.Pp
یک بازتوزیع (rebalancing) را برای فعال‌سازی مصرف‌کننده در یک گروه مصرف‌کننده تک‌فعال فعال می‌سازد.
.Pp
مثال:
.Sp
.Dl rabbitmq-streams activate_stream_consumer --stream stream --reference app-1
.\" ------------------------------------------------------------------
.It Cm list_stream_connections Op Ar connectioninfoitem ...
.Pp
آمارهای اتصال پروتکل استریم را بازمی‌گرداند.
.Pp
پارامتر
.Ar connectioninfoitem
برای مشخص کردن آیتم‌های اطلاعات اتصال جهت گنجاندن در نتایج استفاده می‌شود.
ترتیب ستون‌ها در نتایج مطابق با ترتیب پارامترها خواهد بود.
.Ar connectioninfoitem
می‌تواند هر مقداری از فهرست زیر داشته باشد:
.Bl -tag -width Ds
.It Cm auth_mechanism
سازوکار احراز هویت SASL استفاده‌شده، مانند
.Qq PLAIN .
.It Cm client_properties
ویژگی‌های اطلاعاتی ارسال‌شده توسط کلاینت هنگام برقراری اتصال.
.It Cm conn_name
نام خوانا برای اتصال.
.It Cm connected_at
تاریخ و زمان برقراری این اتصال، به صورت برچسب زمانی (timestamp).
.It Cm connection_state
وضعیت اتصال؛ یکی از موارد:
.Bl -bullet -compact
.It
running
.It
blocked
.El
.It Cm frame_max
حداکثر اندازه فریم (بایت).
.It Cm heartbeat
بازه زمانی توافق‌شده تپش قلب (heartbeat) بر حسب ثانیه.
.It Cm host
نام میزبان سرور به‌دست‌آمده از DNS معکوس، یا آدرس IP آن در صورت شکست یا غیرفعال بودن DNS معکوس.
.It Cm peer_cert_issuer
صادرکننده گواهی SSL طرف مقابل (peer)، در قالب RFC4514.
.It Cm peer_cert_subject
موضوع گواهی SSL طرف مقابل، در قالب RFC4514.
.It Cm peer_cert_serial_number
شماره سریال گواهی SSL طرف مقابل، در قالب هگزادسیمال.
.It Cm peer_cert_validity
مدت زمانی که گواهی SSL طرف مقابل معتبر است.
.It Cm peer_host
نام میزبان طرف مقابل به‌دست‌آمده از DNS معکوس، یا آدرس IP آن در صورت شکست یا فعال نبودن DNS معکوس.
.It Cm peer_port
پورت طرف مقابل.
.It Cm port
پورت سرور.
.It Cm ssl
مقدار بولی که نشان می‌دهد آیا اتصال با SSL امن شده است یا خیر.
.It Cm ssl_cipher
الگوریتم رمزنگاری SSL (مانند
.Qq aes_256_cbc ) .
.It Cm ssl_hash
تابع درهم‌سازی SSL (مانند
.Qq sha ) .
.It Cm ssl_key_exchange
الگوریتم تبادل کلید SSL (مانند
.Qq rsa ) .
.It Cm ssl_protocol
پروتکل SSL (مانند
.Qq tlsv1 ) .
.It Cm subscriptions
تعداد اشتراک‌ها (مصرف‌کنندگان) روی اتصال.
.It Cm user
نام کاربری مرتبط با اتصال.
.It Cm vhost
نام میزبان مجازی (vhost) که نویسه‌های غیر ASCII آن به سبک زبان C اسکیپ شده‌اند.
.El
.Pp
اگر هیچ
.Ar connectioninfoitem
مشخص نشده باشد، فقط conn_name نمایش داده می‌شود.
.Pp
برای نمونه، این دستور نام اتصال و کاربر را برای هر اتصال نمایش می‌دهد:
.sp
.Dl rabbitmq-streams list_stream_connections conn_name user
.\" ------------------------------------------------------------------
.It Cm list_stream_consumers Oo Fl p Ar vhost Oc Op Ar consumerinfoitem ...
.Pp
مصرف‌کنندگان متصل به یک استریم را بازمی‌گرداند.
.Pp
پارامتر
.Ar consumerinfoitem
برای مشخص کردن آیتم‌های اطلاعات مصرف‌کننده جهت گنجاندن در نتایج استفاده می‌شود.
ترتیب ستون‌ها در نتایج با ترتیب پارامترها مطابقت خواهد داشت.
.Ar consumerinfoitem
می‌تواند هر مقداری از فهرست زیر داشته باشد:
.Bl -tag -width Ds
.It Ar active
مقدار بولی که مشخص می‌کند آیا مصرف‌کننده فعال است یا خیر.
.It Ar activity_status
وضعیت فعالیت مصرف‌کننده؛ یکی از موارد:
.Bl -bullet -compact
.It
up
.It
single_active
.It
waiting
.El
.It Ar connection_pid
شناسه فرایند ارلنگ (Erlang process ID) مرتبط با اتصال مصرف‌کننده.
.It Ar credits
اعتبارهای موجود برای مصرف‌کننده.
.It Ar messages_consumed
تعداد پیام‌های مصرف‌شده توسط مصرف‌کننده.
.It Ar offset
آفست (موقعیت درون استریم) که مصرف‌کننده در آن قرار دارد.
.It Ar offset_lag
اختلاف بین آخرین آفست ذخیره‌شده و آخرین آفست ارسال‌شده برای مصرف‌کننده.
.It Ar properties
ویژگی‌های اشتراک مصرف‌کننده.
.It Ar stream
استریمی که مصرف‌کننده به آن متصل است.
.It Ar subscription_id
شناسه در سطح اتصال (connection-scoped ID) برای مصرف‌کننده.
.El
.Pp
اگر هیچ
.Ar consumerinfoitem
مشخص نشود، مقادیر connection_pid، subscription_id، stream، messages_consumed، offset، offset_lag، credits، active، activity_status و properties نمایش داده می‌شوند.
.Pp
برای نمونه، این دستور PID اتصال، شناسه اشتراک و استریم را برای هر مصرف‌کننده نمایش می‌دهد:
.sp
.Dl rabbitmq-streams list_stream_consumers connection_pid subscription_id stream
.\" ------------------------------------------------------------------
.It Cm list_stream_publishers Oo Fl p Ar vhost Oc Op Ar publisherinfoitem ...
.Pp
ناشران (publishers) ثبت‌شده را بازمی‌گرداند.
.Pp
پارامتر
.Ar publisherinfoitem
برای مشخص کردن آیتم‌های اطلاعات ناشر جهت گنجاندن در نتایج استفاده می‌شود.
ترتیب ستون‌ها در نتایج مطابق با ترتیب پارامترها خواهد بود.
.Ar publisherinfoitem
می‌تواند هر مقداری از فهرست زیر داشته باشد:
.Bl -tag -width Ds
.It Ar connection_pid
شناسه فرایند ارلنگ مرتبط با اتصال مصرف‌کننده.
.It Ar messages_confirmed
تعداد پیام‌های تأییدشده برای ناشر.
.It Ar messages_errored
تعداد پیام‌های خطادار برای ناشر.
.It Ar messages_published
تعداد کل پیام‌های منتشرشده توسط ناشر.
.It Ar publisher_id
شناسه در سطح اتصال برای ناشر.
.It Ar reference
مرجع یکتا‌سازی (deduplication reference) ناشر.
.It Ar stream
استریمی که ناشر روی آن منتشر می‌کند.
.El
.Pp
اگر هیچ
.Ar publisherinfoitem
مشخص نشود، مقادیر connection_pid، publisher_id، stream، reference، messages_published، messages_confirmed و messages_errored نمایش داده می‌شوند.
.Pp
برای نمونه، این دستور PID اتصال، شناسه ناشر و استریم را برای هر تولیدکننده نمایش می‌دهد:
.sp
.Dl rabbitmq-streams list_stream_publishers connection_pid publisher_id stream
.\" ------------------------------------------------------------------
.It Cm add_super_stream Ar super-stream Oo Fl -vhost Ar vhost Oc Oo Fl -partitions Ar partitions Oc Oo Fl -binding-keys Ar binding-keys Oc Oo Fl -max-length-bytes Ar max-length-bytes Oc Oo Fl -max-age Ar max-age Oc Oo Fl -stream-max-segment-size-bytes Ar stream-max-segment-size-bytes Oc Oo Fl -leader-locator Ar leader-locator Oc Oo Fl -initial-cluster-size Ar initial-cluster-size Oc
.Bl -tag -width Ds
.It Ar super-stream
نام سوپراستریم (super stream) برای ایجاد.
.It Ar vhost
نام میزبان مجازی که سوپراستریم در آن ایجاد می‌شود.
.It Ar partitions
تعداد پارتیشن‌هایی که سوپراستریم خواهد داشت.
.It Ar binding-keys
فهرست جداشده با کاما از کلیدهای اتصال (binding keys).
.It Ar max-length-bytes
حداکثر اندازه استریم‌های پارتیشن، مقادیر نمونه: 20gb, 500mb.
.It Ar max-age
حداکثر سن سگمنت‌های استریم پارتیشن، با استفاده از قالب مدت زمان ISO 8601، مانند PT10M30S برای ۱۰ دقیقه و ۳۰ ثانیه، یا P5DT8H برای ۵ روز و ۸ ساعت.
.It Ar stream-max-segment-size-bytes
حداکثر اندازه سگمنت‌های استریم پارتیشن، مقادیر نمونه: 500mb, 1gb.
.It Ar leader-locator
راهبرد مکان‌یابی رهبر (leader locator) برای استریم‌های پارتیشن.
مقادیر مجاز عبارتند از:
.Bl -bullet -compact
.It
client-local
.It
balanced
.El
مقدار پیش‌فرض
.Cm balanced
است.
.It Ar initial-cluster-size
اندازه کلاستر اولیه برای استریم‌های پارتیشن.
.El
.Pp
ایجاد یک سوپراستریم.
.\" ------------------------------------------------------------------
.It Cm delete_super_stream Ar super-stream Oo Fl -vhost Ar vhost Oc
.Pp
حذف یک سوپراستریم.
.Bl -tag -width Ds
.It Ar super-stream
نام سوپراستریم برای حذف.
.It Ar vhost
میزبان مجازی سوپراستریم.
.El
.\" ------------------------------------------------------------------
.It Cm list_stream_consumer_groups Oo Fl p Ar vhost Oc Op Ar groupinfoitem ...
.Pp
گروه‌های مصرف‌کننده تک‌فعال استریم را برای یک vhost فهرست می‌کند.
.Pp
پارامتر
.Ar groupinfoitem
برای مشخص کردن آیتم‌های اطلاعات گروه جهت گنجاندن در نتایج استفاده می‌شود.
ترتیب ستون‌ها در نتایج با ترتیب پارامترها مطابقت خواهد داشت.
.Ar groupinfoitem
می‌تواند هر مقداری از فهرست زیر داشته باشد:
.Bl -tag -width Ds
.It Ar consumers
تعداد مصرف‌کنندگان در گروه.
.It Ar partition_index
اندیس پارتیشن استریم اگر بخشی از یک سوپراستریم باشد، و 1- اگر نباشد.
.It Ar reference
مرجع گروه (نام آن).
.It Ar stream
استریمی که مصرف‌کنندگان به آن متصل هستند.
.El
.Pp
اگر هیچ
.Ar groupinfoitem
مشخص نشده باشد، stream، reference، partition_index و consumers نمایش داده می‌شوند.
.Pp
برای نمونه، این دستور استریم، مرجع و تعداد مصرف‌کنندگان را برای هر گروه نمایش می‌دهد:
.sp
.Dl rabbitmq-streams list_stream_consumer_groups stream reference consumers
.\" ------------------------------------------------------------------
.It Cm list_stream_group_consumers Fl -stream Ar stream Fl -reference Ar reference Oo Fl -vhost Ar vhost Oc Op Ar consumerinfoitem ...
.Pp
مصرف‌کنندگان یک گروه مصرف‌کننده استریم در یک vhost را فهرست می‌کند.
.Bl -tag -width Ds
.It Ar stream
استریمی که مصرف‌کنندگان به آن متصل هستند.
.It Ar reference
مرجع گروه (نام آن).
.It Ar vhost
میزبان مجازی استریم.
.El
.Pp
پارامتر
.Ar consumerinfoitem
برای مشخص کردن آیتم‌های اطلاعات مصرف‌کننده جهت گنجاندن در نتایج استفاده می‌شود.
ترتیب ستون‌ها در نتایج مطابق با ترتیب پارامترها خواهد بود.
.Ar consumerinfoitem
می‌تواند هر مقداری از فهرست زیر داشته باشد:
.Bl -tag -width Ds
.It Ar connection_name
نام خوانای اتصال مصرف‌کننده.
.It Ar state
وضعیت مصرف‌کننده؛ یکی از موارد:
.Bl -bullet -compact
.It
active
.It
inactive
.El
.It Ar subscription_id
شناسه در سطح اتصال مصرف‌کننده.
.El
.Pp
اگر هیچ
.Ar consumerinfoitem
مشخص نشده باشد، subscription_id، connection_name و state نمایش داده می‌شوند.
.Pp
برای نمونه، این دستور نام اتصال و وضعیت را برای هر مصرف‌کننده متصل به استریم stream-1 و متعلق به گروه stream-1 نمایش می‌دهد:
.sp
.Dl rabbitmq-streams list_stream_group_consumers --stream stream-1 --reference stream-1 connection_name state
.\" ------------------------------------------------------------------
.It Cm list_stream_tracking Ar stream Oo Fl -all | Fl -offset | Fl -writer Oc Oo Fl -vhost Ar vhost Oc
.Pp
اطلاعات ردگیری یک استریم را فهرست می‌کند.
.Pp
.Bl -tag -width Ds
.It Ar stream
نام استریم.
.El
.Pp
اطلاعات ردگیری را می‌توان بر اساس نوع آن‌ها با استفاده از یکی از گزینه‌های ناسازگار زیر فیلتر کرد:
.Bl -tag -width Ds
.It Fl -all
فهرست کردن ردگیری آفست و اطلاعات یکتا‌سازی نویسنده (writer deduplication).
.It Fl -offset
فهرست کردن فقط اطلاعات ردگیری آفست.
.It Fl -writer
فهرست کردن فقط اطلاعات ردگیری یکتا‌سازی نویسنده.
.El
.Pp
مثال:
.Sp
.Dl rabbitmq-streams list_stream_tracking stream-1 --offset
.\" ------------------------------------------------------------------
.It Cm reset_offset Fl -stream Ar stream Fl -reference Ar reference Oo Fl -vhost Ar vhost Oc
.Pp
بازنشانی آفست ذخیره‌شده برای نام یک مصرف‌کننده روی یک استریم.
.Pp
مثال:
.Sp
.Dl rabbitmq-streams reset_offset --stream stream --reference app-1
.El
.\" ------------------------------------------------------------------
.Sh "همچنین ببینید (SEE ALSO)"
.\" ------------------------------------------------------------------
.Xr rabbitmqctl 8 ,
.Xr rabbitmq-diagnostics 8 ,
.Xr rabbitmq-server 8 ,
.Xr rabbitmq-queues 8 ,
.Xr rabbitmq-upgrade 8 ,
.Xr rabbitmq-service 8 ,
.Xr rabbitmq-env.conf 5
.\" ------------------------------------------------------------------
.Sh "نویسندگان (AUTHORS)"
.\" ------------------------------------------------------------------
.An The RabbitMQ Team Aq Mt contact-tanzu-data.pdl@broadcom.com