XROAD
Управление системой

Запуск системы

Для запуска системы из консоли необходимо выполнить:

./start.sh

при этом, перед запуском системы будет запущен check_cfg.sh скрипт, для проверки валидности конфигурации системы. Если конфигурация не валидна, то система не будет запущена, о чем будет выдано предупреждение

Остановка системы

Для остановки системы из консоли необходимо выполнить:

./stop.sh

или

./stop.sh -s

во втором случае скрипт не будет требовать подтверждения ваших действий (silent mode)

Очистка системы (подготовка к повторному запуску)

Предположим, что необходимо запустить систему с чистого листа, удалив состояние и логи. Для этого необходимо остановить систему и выполнить скрипт:

./clear.sh -sd

в данном случае, скрипт не будет запрашивать подтверждения и удалит те таблицы из кэша системы, которые подлежат очистке.

Просмотр состояния системы

Для мониторинга состояния системы из консоли, используется скрипт

./view.sh
Рис. 1

view показывает в табличном виде, какие процессы (ноды) запущены в данный момент и в каком они состоянии. Колонки в таблице имеют следующие значения:

  • id - уникальный номер ноды. См. Конфигурирование
  • pid - уникальный id процесса в OS. См. Управление нодами
  • name - уникальное имя ноды. См. Конфигурирование
  • status - статус ноды. Возможные значения:
    • active - нода активна и работает
    • offline - нода не активна (текущее время находится вне рабочего интервала, не установлено соединение с удаленным сервером и т.д.)
    • inactive - нода успешно стартовала и все соединения установлены, но находится в неактивном режиме из которого она может перейти в active состояние по сигналу activate. См. Управление нодами
    • DEAD - нода остановлена (или остановилась аварийно) или не запускалась (требует ручного запуска)
      Warning
      Ноды в состоянии DEAD или offline требуют внимания, если только это не типичное состояние ноды в данные момент времени
  • msg_in - количество входящих сообщений
  • msg_out - количество исходящих сообщений
  • err - количество возникших ошибок во время работы ноды
  • warns - количество возникших предупреждений во время работы ноды
  • flags - флаги запуска ноды. Возможные значения:
    • S - stand alone нода
    • H - hidden нода
  • uptime - показывает, сколько времени работает нода
  • version - версия ноды

Интерфейс командной строки

Система имеет интерфейс командной строки представленной утилитой xroad_ctl.py расположенной в директории pbin. Запустив ее без аргументов или c ключём -h, можно получить полный список поддерживаемых команд:

Рис. 2
  • version - возвращает версию SDK
  • view - показывает состояние системы. На самом деле скрипт view.sh всего лишь вызывает xroad_ctl.py view
  • reconfig - посылает reconfig сообщение ноде или нодам
  • activate - посылает activate сообщение ноде или нодам
  • deactivate - посылает deactivate сообщение ноде или нодам
  • start - посылает start сообщение ноде или нодам
  • stop - посылает stop сообщение ноде или нодам
  • subscribe - посылает сообщение subscribe ноде, которая отвечает за поставку рыночных данных в систему
  • unsubscribe - посылает сообщение unsubscribe ноде, которая отвечает за поставку рыночных данных в систему
  • reset - посылает reset сообщение ноде или нодам. В зависимости от дополнительных параметров reset сообщение приводит к сбросу состояния или статистики ноды
  • restart - перезапускает ноды (посылается kill signal)
  • list - позволяет посмотреть содержимое таблиц кэша. Например: pbin/xroad_ctl.py list –table order
  • edit - позволяет редактировать записи таблиц
  • field - позволяет смотреть/редактировать записи в таблице field, которая используется для конфигурирования ноды как из консоли, так и через WebUI Например: pbin/xroad_ctl.py field field –table order –id 10 –field account –set ACC1 редактирует запись под номером 10 таблицы order и устанавливает поле account в ACC1
  • edit - позволяет редактировать записи таблиц
  • add - позволяет добавлять новые пустые записи в таблицу
  • check - проверяет записи таблиц на валидность - все обязательные поля заполнены
  • send - позволяет отправить записи таблицы какой-нибудь ноде
  • backup - сохраняет таблицу в виде json файла
  • restore - восстанавливает таблицу из json файла
  • cache - всевозможные сервисные операции для управления таблицами кеша
  • order - управление заявками. Используется для управления заявками crosser’a
  • system - переключение роли системы primary/backup
  • node - клонирование, переименование и удаление нод
  • alarm - включение/отключение отправки алармов нодой
    Note
    Для получения более полной информации по ключам доступным для каждой из команд нужно выполнить команду pbin/xroad_ctl.py <command> –help