Alpha.Community

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

Настройка формирования и отправки сообщений

Чтобы настроить формирование и отправку сообщений получателям по протоколу Syslog:

Порядок создания проекта и добавление Alpha.Server в проект описаны в документации на Alpha.DevStudio (раздел Знакомство с Alpha.DevStudio руководства пользователя).

Далее приведено описание настройки отправки сообщений уже сконфигурированного Alpha.Server в существующем проекте.

Настройка логических типов

  1. Добавьте в проект элемент Пространство имен и задайте Имя, например, Types. Это будет папка с логическими типами, используемыми в проекте.

  2. Перейдите в добавленное Пространство имен, добавьте ещё один элемент Пространство имен и задайте Имя, например, ServerTypes. Это будут папка с логическими типами Alpha.Server.
  3. Перейдите в Пространство имен для логических типов Alpha.ServerServerTypes.
  4. Добавьте элемент Аспект и задайте Имя, например, Server.

  5. Добавьте элементы Логический тип для каждого логического типа Alpha.Server. Для примера, пусть Alpha.Server содержит один логический тип, представляющий тип Сообщения.

  6. Укажите свойства логического типа:

    • Имя - например, Message;
    • Аспект - добавленный ранее аспект Server.

  7. Перейдите в Логический тип Message и опишите его структуру: добавьте в логический тип сигналы типа string и задайте им направление выход. Например, пусть тип Message содержит сигналы:

    Сигнал Тип Направление Описание
    State1

    string

    выход Состояние 1
    State2

    string

    выход Состояние 2

Логический тип описан.

Настройка модуля Syslog Клиент

  1. Перейдите в Alpha.Domain.

  2. Перейдите в узел домена host, а затем в Alpha.Server, и добавьте Приложение.

  3. Перейдите в добавленное Приложение и добавьте экземпляр ранее созданного логического типа.

  4. Добавьте Карту адресов Syslog.

  5. На элементе Карта адресов Syslog:

    1. Нажмите кнопку .
    2. Укажите место хранения карты адресов на диске.
    3. Задайте имя карты адресов.
    4. Нажмите кнопку Открыть.

      Карта адресов будет создана. Если требуется открыть существующую карту адресов, то выберите файл карты адресов на диске и нажмите кнопку Открыть.

  6. Вернитесь в Alpha.Server и добавьте Syslog Клиент.

  7. Настройте модуль Syslog Клиент – в свойстве Карта адресов укажите ранее добавленную Карту адресов Syslog. Для остальных свойств можно оставить значения по умолчанию.

    Свойства модуля Syslog Клиент:

    Свойство Описание

    Общие

    Имя

    Идентификатор модуля в конфигурации Alpha.Server, значение служебного сигнала Id.

    Карта адресов Расположение в проекте карты адресов с настройками сигналов.
    Параметры модуля
    Активность

    Активность модуля при запуске/перезапуске Alpha.Server:

    • Да – модуль запущен;
    • Нет – модуль остановлен.

    Управляется служебным сигналом Active.Set.

    Отображаемое имя

    Название модуля, которое отображается в тегах служебных сигналов.

    Параметры журналирования

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

    Ведение записи сообщений о работе модуля в журнал работы:

    • Да – вести журнал работы;
    • Нет – журнал работы не ведётся.

    Управляется служебным сигналом FrameLogEnable.Set.

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

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

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

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

    • минимальное количество – 1;
    • максимальное количество – 255.

    Уровень трассировки в журнал приложений

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

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

    Управляется служебным сигналом SystemLogTraceLevel.Set.

Формирование списка получателей

  1. Чтобы добавить получателя в список получателей сообщений, на модуле Syslog Клиент нажмите кнопку .

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

    Укажите параметры, с которыми получателю будут отправляться сообщения.

    Свойство Описание
    Общие
    Имя

    Имя получателя.

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

    Транспортный протокол, по которому сообщения будут отправляться на Syslog-сервер.

    Значение по умолчанию – UDP.

    IP адрес

    IP-адрес Syslog-сервера.

    Порт

    Порт Syslog-сервера.

    Значение по умолчанию – 514.

    Формат сообщения

    Формат сообщения.

    Значение по умолчанию – RFC 3164.

    Размер сообщения

    Максимальный размер сообщения для отправки в байтах. Если размер сообщения превышает заданный, то сообщение будет обрезано до максимально разрешенного количества символов. При значении 0 размер сообщения не контролируется.

    Значение по умолчанию – 1024.

    Период отправки сообщений, мс

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

    Значение по умолчанию – 100.

    Размер очереди сообщений

    Максимальное количество сообщений, которое может накапливаться в очереди. При достижении этого значения наступает переполнение очереди. При значении 0 размер очереди не контролируется.

    Значение по умолчанию – 100.

    Процент стираемых сообщений

    Количество сообщений в процентах от общего числа сообщений, которое удаляется из начала очереди при ее переполнении. Значение в диапазон от 0 до 100:

    • 0 – из начала очереди удаляется одно сообщение, а одно поступившее сообщение добавляется в конец очереди;
    • 100 – очередь сообщений полностью очищается, при этом Флаг переполнения очереди сбрасывается и принимает значение False.
    • иное значение между 0 и 100 – из начала очереди удаляется N сообщений. Количество удаляемых сообщений определяется по формуле: N = (Размер очереди сообщений * Процент стираемых сообщений / 100). Вычисленное значение округляется в меньшую сторону до целого значения, однако числа меньше 1 всегда округляются до 1.

    Значение по умолчанию – 10.

Формирование и отправка сообщений

Чтобы модуль получал значения сигналов Alpha.Server и отправлял их получателям, перейдите в Карту адресов Syslog и настройте параметры адресов сигналов.

Параметр Значение

Привязка

непосредственно.

Получатель сообщения

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

Формат

Формат сообщения – параметр, который определяет способ формирования сообщения:

  • RFC – модуль формирует сообщение по формату RFC, используя значение сигнала и другие параметры, указанные в карте адресов;
  • Manual – модуль считает, что значение сигнала – готовое Syslog-сообщение, и отправляет его в неизменном виде. В этом случае параметры Адрес отправителя, Тип оборудования, Важность, Приложение и Процесс модулем не используются.

Значение по умолчанию – RFC.

Адрес отправителя

Имя или IP-адрес отправителя – устройства, сгенерировавшего сообщение; значение поля HOSTNAME Syslog-сообщения. Возможные значения:

  • %NodeNameAuto% – в сообщение происходит подстановка имени устройства;
  • %FQDNAuto% – в сообщение происходит подстановка полного доменного имени устройства;
  • любое другое значение – будет использовано в соответствующем поле Syslog-сообщения в неизменном виде.

Свойство не используется, если:

  • значение не указано;
  • для параметра Формат задано значениеManual.

Тип оборудования

Источник сообщения Facility. Значение участвует в расчете приоритета сообщения (поле PRI сообщения Syslog). Возможные значения определены стандартом RFC 3164.

Если значение не указано, то при расчете приоритета принимается за 0.

Если не указано и значение свойства Важность, то значение приоритета не отправляется.

Свойство не используется, если для параметра Формат задано значениеManual.

Важность

Важность сообщения Severity. Значение участвует в расчете приоритета сообщения (поле PRI сообщения Syslog). Возможные значения определены стандартом RFC 3164.

Если значение не указано, то при расчете приоритета принимается за 0.

Если не указано и значение свойства Тип оборудования, то значение приоритета не отправляется.

Свойство не используется, если для параметра Формат задано значениеManual.

Приложение

Имя приложения, сгенерировавшего сообщение; значение поля APP-NAME Syslog-сообщения. Возможные значения:

  • %AppNameAuto% – имя процесса Alpha.Server;
  • любое другое значение – будет использовано в соответствующем поле Syslog-сообщения в неизменном виде.

Свойство не используется, если:

  • значение не указано;
  • для параметра Формат задано значениеManual.

Процесс

Идентификатор процесса, сгенерировавшего сообщение; значение поля PROCID Syslog-сообщения. Возможные значения:

  • %ProcIdAuto% – идентификатор процесса Alpha.Server;
  • любое другое значение – будет использовано в соответствующем поле Syslog-сообщения в неизменном виде.

Свойство не используется, если:

  • значение не указано;
  • для параметра Формат задано значениеManual.

Прочие параметры модулем не используются.

Заполненная карта адресов при выбранном формате сообщения – RFC:

Заполненная карта адресов при выбранном формате сообщения – Manual:

Применение конфигурации Alpha.Server

  1. Постройте решение. Конфигурация Alpha.Server будет построена.

  2. Перейдите в Мастер развёртывания.

    Для успешного применения построенных конфигураций должен быть настроен Alpha.Domain. Описание настройки приведено в документации на Alpha.Domain (см. раздел Конфигурирование руководства администратора).

  3. Примените конфигурацию к Alpha.Server.