Top.Mail.Ru
Admin-функции | Tarantool
Tarantool
Узнайте содержание релиза 2.8

Admin-функции

Используя команду cartridge admin, можно вызывать функции администрирования, зарегистрированные с помощью расширения admin.

cartridge admin [ИМЯ_ADMIN-ФУНКЦИИ] [flags]

--name Имя приложения (обязательно)
--list Вывод списка доступных admin-функций
--help Вывод справки для admin-функции
--instance Имя экземпляра, к которому выполняется подключение
--conn, -c Адрес для подключения
--run-dir Директория для сокетов экземпляра, по умолчанию — /var/run/tarantool

Команда admin также поддерживает глобальные параметры.

Вы можете добавить к приложению собственные admin-функции. Для начала зарегистрируйте их с помощью расширения admin. В шаблонном приложении представлена admin-функция probe, которая проверяет связь с экземпляром по указанному URI.

Примечание

Если ваша функция выводит сообщения с помощью print, эти сообщения будут появляться в терминале при вызове функции через cartridge admin. Такое поведение реализовано начиная с версии cartridge-cli-extensions 1.1.0).

Примечание

Admin-функции вашего приложения не должны принимать аргументы, имена которых могут вызвать конфликт с именами параметров cartridge admin:

  • name
  • list
  • help
  • instance
  • run_dir
  • debug
  • quiet
  • verbose

Если указан параметр --conn, CLI подключается по заданному адресу.

Если указан параметр --instance, CLI в первую очередь проверяет, доступен ли сокет <run-dir>/<имя>.<экземпляр>.control. Если сокет доступен, admin-функция вызывается через него. В противном случае CLI проверяет все сокеты <run-dir>/<имя>.*.control и использует для вызова функции первый доступный сокет.

Под доступным подразумевается сокет, к которому можно выполнить подключение. Чтобы увидеть подробную информацию о поиске доступного сокета, используйте параметр --verbose.

Ознакомьтесь с примером использования функции probe, включенной в шаблонное приложение.

Чтобы вывести список доступных admin-функций, выполните следующую команду:

cartridge admin --name ИМЯ_ПРИЛОЖЕНИЯ --list

   • Available admin functions:

probe  Probe instance

Чтобы вывести справку по отдельной функции, выполните следующую команду:

cartridge admin --name ИМЯ_ПРИЛОЖЕНИЯ probe --help

   • Admin function "probe" usage:

Probe instance

Args:
  --uri string  Instance URI

Пример вызова функции с аргументом:

cartridge admin --name ИМЯ_ПРИЛОЖЕНИЯ probe --uri localhost:3301

   • Probe "localhost:3301": OK