Alpha.Community

В разделе Документация вы найдете все для уверенного старта и работы с Альфа платформой: от пошаговых инструкций по установке и конфигурированию до подробного описания работы компонентов и подсистем. Для поиска необходимых тем и вопросов в документации, воспользуйтесь поиском и фильтрацией результатов.

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

Интерфейс командной строки позволяет получать диагностическую информацию по Alpha.Historian и базам данных, а также запускать некоторые команды управления.

Для выполнения консольных команд используется утилита командной строки: alpha.historian.cli – файл alpha.historian.cli.exe в папке установки Alpha.Historian.

Чтобы выполнить консольную команду:

  1. Откройте командную строку.

    Например, в Windows для этого можно нажать комбинацию клавиш Win + R, в появившееся окно ввести cmd и нажать Enter.

  2. Перейдите в папку установки Alpha.Historian.

    • Windows: cd "C:\Program Files\Automiq\Alpha.Historian"
    • Linux: cd "/opt/Automiq/Alpha.Historian"
  3. Выполните консольную команду.

    Общий синтаксис консольных команд:

    alpha.historian.cli [ПАРАМЕТРЫ] КОМАНДА

    Возможные команды и их параметры приведены ниже.

Команды можно передавать как локальному экземпляру Alpha.Historian, так и удалённому, см. ниже подраздел Указание адресата.

Консольный вывод

Вся информация выводится в стандартный поток вывода stdout.

Поток вывода stderr не используется: сообщения об ошибках выводятся в поток stdout. Сделано это, чтобы сохранить порядок вывода сообщений для удобства анализа.

Формат вывода зависит от значения параметра --output-format, переданного команде (доступен не для всех команд):

  • plain – простой текст, используется по умолчанию
  • csv – в формате CSV

Указание адресата

С помощью параметра --target можно указать целевую базу данных или экземпляр Alpha.Historian, к которому будет применена команда.

Значение параметра должно иметь вид: [db@][host[:port]], где:

  • db – имя базы данных
  • host – ip-адрес или сетевое имя компьютера с экземпляром Alpha.Historian, если не указан – локальный компьютер
  • port – порт интерфейса мониторинга Alpha.Historian, если не указан – 4600

Возможны следующие комбинации полей:

  • db@host:port – обращение к базе данных с именем db в экземпляре Alpha.Historian, расположенном по адресу host:port
  • db@host – обращение к базе данных с именем db в экземпляре Alpha.Historian, расположенном по адресу host:4600
  • db@ – обращение к базе данных с именем db локального экземпляра Alpha.Historian
  • host:port – обращение к экземпляру Alpha.Historian, расположенном по адресу host:port
  • host – обращение к экземпляру Alpha.Historian, расположенному по адресу host:4600

Команды

Вывести статистику

alpha.historian.cli [ПАРАМЕТРЫ] stat

Возвращает статистику по указанной базе данных или по всему серверу истории, включая его базы данных.

Параметры
Параметр Описание
--output-format Формат вывода.
--target База данных и/или экземпляр сервера истории. Подробнее смотри выше.

Вывести состояние конфигурации

alpha.historian.cli [ПАРАМЕТРЫ] config_status

Команда выводит в консоль json-строку, содержащую ответ на запрос. Формат вывода предназначен для передачи сторонней программе для дальнейшей обработки.

Параметры
Параметр Описание
--target База данных и/или экземпляр сервера истории. Подробнее смотри выше.

Вывод выполняется одной строкой для передачи результата стороннему средству.

Перезагрузить конфигурацию

alpha.historian.cli [ПАРАМЕТРЫ] config_reload
Параметры
Параметр Описание
--target База данных и/или экземпляр сервера истории. Подробнее смотри выше.

Команда не выводит результат за исключением неудачного завершения выполнения.