Alpha.Community

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

Конфигурирование

Для конфигурирования модуля и сигналов потребуется следующая информация:

  • список сетевых устройств, от которых нужно принимать сообщения Syslog;
  • для каждого сетевого устройства – в каком виде сообщения будут записаны: в исходном или в преобразованном для генерации событий;
  • для каждого сетевого устройства – сообщения передаются по протоколу UDP (в открытом виде) или TLS (в зашифрованном виде);
  • (опционально) для сетевых устройств, передающих сообщения по TLS – сертификат устройства.

Список сетевых устройств нужно разбить на группы, по признакам:

  • в каком виде сообщения будут записаны: в исходном/преобразованном;
  • сообщения передаются в открытом/зашифрованном виде.
  Сообщения записываются в исходном виде Сообщения записываются в преобразованном виде
UPD Группа 1 Группа 2
TCL Группа 3 Группа 4

Для каждой группы нужно добавить свой экземпляр модуля Syslog Сервер и конфигурировать его независимо от остальных (включая конфигурирование сигналов).

Конфигурирование модуля

  1. Добавьте в состав конфигурации Alpha.Server модуль Syslog Сервер.

  2. В группе Общие параметру Активность установите значение Да, чтобы модуль запускался при запуске/перезапуске Alpha.Server. Для остальных параметров можно оставить значения по умолчанию.

    Общие параметры
    Параметр Описание
    Имя модуля Название модуля
    Идентификатор модуля Идентификатор модуля
    Активность

    Активность модуля:

    • Да – модуль запущен
    • Нет – модуль остановлен
    Уровень трассировки в журнал приложений

    Типы сообщений, которые фиксируются в журнал приложений:

    • Предупреждения и аварийные сообщения – логические ошибки, ошибки работы модуля. Предупреждения содержат некритичные ошибки. Аварийные сообщения информируют об ошибках, которые влияют на работоспособность службы
    • Информационные сообщения – сообщения, которые показывают основную информацию о работе модуля
    • Отладочные сообщения – сообщения, которые наиболее детально отражают информацию о работе модуля

    Вышестоящий уровень входит в состав нижестоящего: если выбрано Информационные сообщения, то в журнал фиксируются Предупреждения и аварийные сообщения и Информационные сообщения

    Вести журнал работы модуля

    Ведётся ли журнал работы модуля:

    • Да
    • Нет
    Размер журнала работы модуля, МБ

    Ограничение на размер файла журнала работы модуля в мегабайтах.

    При достижении максимального размера создается новый файл, копия старого файла хранится на рабочем диске

    Количество дополнительных журналов работы

    Количество файлов заполненных журналов работы модуля.

    Минимальное значение – 1, максимальное – 255

  3. В группе Дополнительные:
    1. Установите необходимое значение параметра Генерировать события:

      • Да - сообщения Syslog будут преобразованы к виду конструкции для генерации динамического события. Это применимо только для сообщений, которые имеют известный модулю формат.

      • Нет - сообщения Syslog будут записаны в исходном виде. Это применимо для любых форматов сообщений.

    2. Укажите Транспортный протокол и Порт:

      • для протокола UDP – порт 514;
      • для протокола TLS – порт 6514.

      Если в конфигурацию Alpha.Server добавлено несколько экземпляров модуля Syslog Сервер, то каждому необходимо указать уникальный порт.

    3. Если выбран транспортный протокол TLS, то укажите сертификат сервера и приватный ключ. Для этого укажите абсолютный путь к файлу или только имя файла, если он находится в папке Alpha.Server:

      • сертификат сервера: <папка Alpha.Server>\Certificates\certs
      • приватный ключ сервера: <папка Alpha.Server>\Certificates\private

      Сертификат сервера и приватный ключ создаются в процессе установки Alpha.Server.

    ПараметрОписание
    Генерировать события

    Записывать значение в виде, пригодном для генерации событий:

    • Нет - сообщение будет записано в том виде, в котором получено (со всеми полями);
    • Да - сообщение будет записано в формате:

      <Subcondition Type="Dynamic" Message="MSG" />

      где MSG – поле MSG в полученном сообщении.

      Формат предназначен для автоматической генерации события при его записи в сигнал.

    Транспортный протокол

    Тип транспортного протокола, используемого для передачи сообщений Syslog:

    • TLS
    • UDP
    ПортПорт приема данных
    Путь к сертификату сервераАбсолютный путь к сертификату сервера или имя сертификата сервера. Используется только при работе по протоколу TLS
    Путь к приватному ключу сервераАбсолютный путь к приватному ключу сервера или имя приватного ключа сервера. Используется только при работе по протоколу TLS

Добавление сертификатов устройств

Добавлять сертификаты нужно только при работе с транспортным протоколом TLS.

При работе с транспортным протоколом TLS, чтобы сервер принимал сообщения от сетевого устройства, нужно добавить сертификат этого устройства в папку доверенных сертификатов <папка Alpha.Server>\Certificates\TrustedPeers\certs. Добавлять сертификаты можно при конфигурировании или в процессе работы сервера.

При попытке установить соединение устройство отправляет серверу свой сертификат. Если сертификат не будет найден в папке доверенных сертификатов, он будет сохранён в папке отклонённых сертификатов <папка Alpha.Server>\Certificates\Rejected\certs. При каждой попытке соединения будет сохранена новая копия сертификата. Чтобы сделать устройство доверенным, переместите любую копию его сертификата в папку доверенных сертификатов.

Конфигурирование сигналов

Конфигурирование сигналов различается в зависимости от того, включена настройка модуля Генерировать события или нет.

Генерация событий включена

Для каждого сетевого устройства, от которого нужно принимать сообщения:

  1. Создайте в дереве сигналов сигнал типа String.

    Сигнал может находиться в любом месте дерева сигналов.

  2. Для сигнала настройте получение сообщений Syslog от устройства:

    1. Добавьте сигналу свойство 5000 (Address) типа String.
    2. В открывшемся окне Редактор адреса добавьте модуль Syslog Сервер.
    3. В параметре Адрес отправителя укажите адрес сетевого устройства.

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

  3. Для сигнала настройте генерацию динамических событий.

Сообщения можно фильтровать. Это нужно, например, чтобы отделить сообщения об ошибках от прочих сообщений. Для этого:

  1. Добавьте в дерево сигналов новый сигнал типа String.

  2. Для сигнала настройте получение сообщений Syslog от устройства:

    1. Добавьте сигналу свойство 5000 (Address) типа String.
    2. В открывшемся окне Редактор адреса добавьте модуль Syslog Сервер.
    3. В параметре Адрес отправителя укажите адрес сетевого устройства.

    4. В остальных полях укажите значения необходимых параметров фильтрации:

      • Facility
      • Severity
      • APPNAME
      • PROCID
      • MSGID

Каждое сообщение записывается в один сигнал. Если для записи сообщения подходит несколько сигналов, проверяется, какие поля указаны у каждого сигнала. Приоритет полей (от наибольшего к наименьшему):

  • Адрес отправителя;
  • Facility;
  • Severity;
  • APPNAME;
  • PROCID;
  • MSGID.

Для каждого поля проверяется:

  • если поле указано или не указано у всех сигналов → переходим к следующему полю;
  • если поле указано не у всех сигналов → выбираем из сигналов, у которых поле указано.

Пусть есть два подходящих сигнала для записи сообщения:

  • у первого задано поле Адрес отправителя;
  • у второго указаны поля Адрес отправителя и Severity.

Сообщение будет записано во второй сигнал, т.к. у него указано больше полей.

Пусть есть два подходящих сигнала для записи сообщения:

  • у первого задано поле Адрес отправителя;
  • у второго указаны поля Facility и Severity.

Сообщение будет записано в первый сигнал, т.к. поле Адрес отправителя имеет наибольший приоритет.

Пусть есть два подходящих сигнала для записи сообщения:

  • у первого указаны поля Адрес отправителя и Facility;
  • у второго указаны поля Адрес отправителя и Severity и APPNAME.

Сообщение будет записано в первый сигнал, т.к. поле Facility имеет больший приоритет, чем поля Severity и APPNAME.

Генерация событий отключена

  1. Создайте сигнал для генерации событий:

    1. Создайте сигнал типа string.
    2. Для сигнала настройте генерацию динамических событий.
  2. Создайте сигнал для записи принятых сообщений:

    1. Создайте сигнал типа string.
    2. Добавьте сигналу свойство 5000 (Address) типа string.
    3. В открывшемся окне Редактор адреса добавьте модуль Syslog Сервер. Значения полей указывать не нужно
  3. Настройте разбор принятых сообщений с помощью модуля логики.

    Один из способов разбора:

    1. Сигналу, в который записываются сообщения, добавьте свойство 777012 типа string. Код, описанный в свойстве, выполняется при изменении значения сигнала.

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

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

      <Subcondition Type="Dynamic" Message="MSG" />

      Чтобы код выполнялся, добавьте и активируйте модуль логики.