Перейти к основному содержимому
Версия: 4.5.X

NATS

account - информация об учетной записи и статус

  • account info - информация об учетной записи
  • account report - отчет о показателях учетной записи
  • account backup - создание резервной копии всех потоков JetStream по сети NATS
  • account restore - восстановление резервной копии учетной записи по сети NATS

bench - утилита Benchmark

Флаги:

  • --pub=0 - количество одновременных издателей
  • --sub=0 - количество одновременных подписчиков
  • --js - используйте JetStream
  • --request - режим запроса-ответа: издатели отправляют запросы в ожидании ответа
  • --reply - режим запроса-ответа: подписчики отправляют ответы
  • --kv - в режиме KV подписчики получают доступ из корзины, а издатели помещают в корзину
  • --msgs=100000 - количество сообщений для публикации
  • --size="128" - размер тестовых сообщений
  • --no-progress - отключите индикатор выполнения во время публикации
  • --csv=CSV - сохраните контрольные данные в CSV-файл
  • --purge - очистите поток перед запуском
  • --storage=memory - хранилище JetStream (память/файл) для потока benchstream
  • --replicas=1 - количество реплик потока для потока benchstream
  • --maxbytes="1GB" - максимальный размер потока или сегмента KV в байтах
  • --stream="benchstream" - если установлено значение, отличное от benchstream, то используйте указанный поток при создании постоянных подписчиков. В противном случае определите и используйте поток benchstream
  • --bucket="benchbucket" - если установлено значение, отличное от benchbucket, то используйте указанную корзину в режиме KV. В противном случае определите и используйте корзину benchbucket
  • --consumer="natscli-bench" - укажите имя долговременного потребителя, которое будет использоваться
  • --jstimeout=30s - тайм-аут для операций JS
  • --syncpub - синхронная публикация в потоке
  • --pubbatch=100 - устанавливает размер пакета для асинхронной публикации JS
  • --pull - используйте общий долговременный явно подтвержденный pull-потребитель JS, а не отдельных эфемерных потребителей
  • --push - используйте общий долговременный явно подтвержденный push-потребитель JS с группой очередей, а не с отдельными эфемерными потребителями
  • --consumerbatch=100 - устанавливает размер пакета для долговременного pull-потребителя JS или максимальное значение ожидания подтверждения для долговременного push-потребителя JS
  • --subsleep=0s - спящий режим в течение указанного интервала перед отправкой подтверждения подписчика обратно в режиме --js, или отправкой ответа обратно в режиме --reply, или выполнением следующего получения в режиме --kv
  • --pubsleep=0s - cпящий режим в течение указанного интервала после публикации каждого сообщения
  • --history=1 - глубина истории для корзины в режиме KV
  • --multisubject - в режиме с несколькими темами каждое сообщение публикуется в теме, которая включает порядковый номер сообщения издателя в качестве маркера
  • --multisubjectmax=0 - максимальное количество объектов для использования в мультисубъектном режиме (0 означает отсутствие максимального количества)
  • --retries=3 - максимальное количество повторных попыток в операциях JS
  • --dedup - задает идентификатор сообщения в заголовке для использования дедупликации публикации JS
  • --dedupwindow=2m - устанавливает продолжительность действия функции дедупликации потока

consumer - управление потребителями JetStream

  • consumer ls - список известных потребителей
  • consumer report - отчеты по статистике потребителей
  • consumer info - информация для потребителей
  • consumer add - создает нового потребителя
  • consumer edit - редактирует конфигурацию потребителя
  • consumer rm - удаляет потребителя
  • consumer copy - создает нового потребителя на основе конфигурации другого
  • consumer next - извлекает сообщения от pull-потребителей без интерактивных подсказок
  • consumer sub - извлекает сообщения от потребителей
  • consumer cluster - управляет кластеризованным потребителем

Флаги:

  • -a, --all - работать со всеми потоками, включая системные

context - управление контекстами конфигурации NATS

  • context save - обновите или создайте контекст
  • context copy - копирует существующий контекст
  • context edit - отредактируйте контекст в вашем редакторе
  • context ls - перечислите известные контексты
  • context rm - удалить контекст
  • context select - выберите контекст по умолчанию
  • context info - отображает информацию о текущем или именованном контексте
  • context validate - проверка одного или всех контекстов

errors - документация по кодам ошибок

  • errors ls - перечислите все известные коды ошибок
  • errors lookup - ищет ошибку по ее коду
  • errors edit - отредактируйте или добавьте код ошибки с помощью вашего редактор
  • errors validate - проверяет правильность определения ошибок

Флаги:

  • --errors=FILE - файл errors.json для использования в качестве входных данных

events - показать советы и события

Флаги:

  • -a, --all - показать все события
  • -j, --json - создать вывод в формате JSON
  • --cloudevent - создать выходные данные CloudEvents v1
  • --short - короткий формат события
  • --filter="." - фильтруйте по всему событию с помощью регулярных выражений
  • --js-metric - показывает события метрики JetStream (false)
  • --js-advisory - показывает рекомендуемые события (false)
  • --[no-]srv-advisory - показывает рекомендации сервера NATS (true)
  • --subjects=SUBJECTS - показывать рекомендации и показатели, полученные по конкретным темам

kv - взаимодействует с хранилищем ключей и значений на основе JetStream

  • kv add - добавляет новую корзину хранилища KV
  • kv put - помещает значение в ключ
  • kv get - получает значение для ключа
  • kv create - помещает значение в ключ только в том случае, если ключ новый или его последней операцией было удаление
  • kv update - обновляет ключ новым значением, если предыдущее значение соответствует данной редакции
  • kv del - удаляет ключ или всю корзину целиком
  • kv purge - удаляет ключ из корзины, очищая историю перед созданием маркера удаления
  • kv history - показывает полную историю для ключа
  • kv revert - возвращает значение к предыдущей редакции с помощью put
  • kv info - просмотр статуса магазина KV
  • kv watch - следите за обновлениями в корзине или определенном ключе
  • kv ls - перечислите доступные корзины или ключи в корзине
  • kb kv compact - удаляет все исторические значения из хранилища, где последним значением является удаление

latency - выполнение тестов задержки между двумя серверами NATS

Флаги:

  • --server-b=SERVER-B - второй сервер, на который нужно подписаться
  • --size=8 - размер сообщения
  • --rate=1000 - скорость передачи сообщений в секунду
  • --duration=5s - продолжительность теста
  • --histogram=HISTOGRAM - выходной файл для сохранения гистограммы

object - взаимодействует с хранилищем объектов на основе JetStream

  • object add - добавляет новую корзину хранилища объектов
  • object put - помещает файл в хранилище
  • object del - удаляет файл или корзину из хранилища
  • object get - извлекает файл из хранилища
  • object info - получение информации о корзине или объекте
  • object ls - перечислите сегменты или содержимое определенного сегмента
  • object seal - герметизирует корзину, предотвращая дальнейшие обновления
  • object watch - следите за изменениями в корзине

publish - общая утилита публикации данных

request - универсальная утилита запроса-ответа

  • Count - номер сообщения
  • TimeStamp - текущее время в формате RFC3339
  • Unix - секунды с 1970 по UTC
  • UnixNano - наносекунды с 1970 по UTC
  • Time - текущее время
  • ID - уникальный идентификатор
  • Random(min, max) - случайная строка длиной не менее min, не более max

Флаги:

  • -r, --raw - показывать только полученный результат
  • -H, --header=HEADER - добавляет заголовки к сообщению
  • --count=1 - публиковать несколько сообщений
  • --replies=1 - дождитесь нескольких ответов от служб. 0 ожидает истечения времени ожидания
  • --reply-timeout=300ms - максимальное время ожидания между входящими ответами

reply - универсальная утилита ответа службы

  • Count - номер сообщения
  • TimeStamp - текущее время в формате RFC3339
  • Unix - секунды с 1970 по UTC
  • UnixNano - наносекунды с 1970 по UTC
  • Time - текущее время
  • ID - уникальный идентификатор
  • Request - полезная нагрузка запроса
  • Random(min, max) - случайная строка длиной не менее min, не более max

Флаги:

  • --echo - отразите то, что получено
  • --command=COMMAND - запускает команду и выдает результат, если код выхода равен 0
  • -q, --queue="NATS-RPLY-22" - имя группы очередей
  • --sleep=MAX - введите случайную задержку перехода в спящий режим между ответами до этой максимальной продолжительности
  • -H, --header=HEADER - добавляет заголовки к сообщению
  • --count=COUNT - выйти после получения такого количества сообщений

rtt - вычисление времени приема-передачи до сервера NATS

Флаги:

  • -j, --json - создать вывод в формате JSON

schema - инструменты схемы

  • schema search - поиск схем с использованием шаблона
  • schema info - отображать содержимое схемы
  • schema validate - проверяет соответствие файла JSON схеме

server - информация о сервере

  • server info - показывать информацию об одном сервере
  • server ls - список известных серверов
  • server ping - пропинговать все серверы
  • server report - отчет о различных показателях сервера
  • server request - запросить данные мониторинга с определенного сервера
  • server raft - управление кластеризацией JetStream
  • server mappings - шаблоны отображения испытуемого
  • server passwd - создает зашифрованные пароли для использования на сервере NATS
  • server check - проверка работоспособности серверов NATS
  • server purge - удаление активов из кластеров JetStream

stream - управление потоком JetStream Stream

  • stream add - создайте новый поток
  • stream ls - перечислите все известные потоки
  • stream report - отчеты по статистике потоков
  • stream find - находит потоки, соответствующие определенным критериям
  • stream info - потоковая информация
  • stream state - состояние потока
  • stream subjects - объекты запроса, хранящиеся в потоке
  • stream edit - редактирует существующий поток
  • stream rm - удаляет поток
  • stream purge - очистить поток, не удаляя его
  • stream copy - создает новый поток на основе конфигурации другого, не копирует данные
  • stream rmm - безопасное удаление отдельного сообщения из потока
  • stream view - просмотр сообщений в потоке
  • stream get - извлекает определенное сообщение из потока
  • stream backup - создает резервную копию потока по сети NATS
  • stream restore - восстановите поток по сети NATS
  • stream seal - блокирует поток, предотвращая дальнейшие обновления
  • stream cluster - управляет кластеризованным потоком

Флаги:

  • -a, --all - при перечислении или выборе потоков отображаются все потоки, включая системные

subscribe - универсальный клиент подписки

Флаги:

  • --queue=QUEUE - подпишитесь на именованную группу очередей
  • --durable=DURABLE - используйте устройство длительного пользования (требуется JetStream)
  • -r, --raw - показать полученные необработанные данные
  • --[no-]ack - подтвердите сообщение JetStream, содержащее правильные метаданные
  • --match-replies - сопоставляет ответы на запросы
  • -i, --inbox - подписывается на созданный почтовый ящик входящих сообщений
  • --count=COUNT - выйти после получения такого количества сообщений
  • --dump=DIRECTORY - сохраняет полученные сообщения в файлы, по 1 файлу на сообщение
  • --headers-only - не отображает никаких данных, показывает только заголовки
  • --start-sequence=SEQUENCE - запускается в определенной последовательности потоков (требуется JetStream)
  • --all - доставляет все сообщения, найденные в потоке (требуется JetStream)
  • --new - доставляет только будущие сообщения (требуется JetStream)
  • --last - доставляет самые последние и все будущие сообщения (требуется JetStream)
  • --since=DURATION - доставляет сообщения, полученные с промежутком времени, равным 1d3h5m2s (требуется JetStream)
  • --last-per-subject - доставляет самые последние сообщения для каждой темы в потоке (требуется JetStream)
  • --stream=STREAM - подпишитесь на определенный поток (требуется JetStream)
  • -I, --ignore-subject=SUBJECT - темы, для которых соответствующие сообщения будут проигнорированы и, следовательно, не будут показаны в выходных данных