Настройка Syslog в Альфа платформе: сбор данных и трансляция логов

Протокол Syslog является ключевым стандартом для передачи информации о событиях и журналах в сетевой инфраструктуре. В Альфа платформе реализована полноценная поддержка Syslog как для сбора диагностических данных с сетевых устройств (режим сервера), так и для трансляции собственных событий и логов во внешние системы (режим клиента).

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

1. Сбор данных. Настройка Syslog Server (Alpha.Server)

Модуль Syslog Server в составе Alpha.Server предназначен для приема текстовых сообщений от сетевых устройств. Модуль поддерживает работу с форматами RFC 5424 и RFC 3164.

Сообщения могут передаваться как в открытом виде по UDP (стандартный порт 514), так и в зашифрованном виде по TLS (порт 6514). При использовании TLS модуль принимает сообщения только от тех устройств, чьи сертификаты добавлены в папку доверенных сертификатов сервера.

1.1. Базовая настройка модуля

• ›В среде разработки Alpha.DevStudio перейдите к элементу, описывающему ваш Alpha.Server, и добавьте в него модуль Syslog Server.

Модуль Syslog Server и основные параметры приема сообщений

• ›В свойствах модуля в параметре «Активность» установите значение «Да».
• ›В параметрах конфигурации выберите Транспортный протокол (TLS или UDP) и укажите соответствующий порт приема данных (параметр Номер TCP порта). Если выбран TLS, также укажите пути к сертификату и приватному ключу сервера.

Настройте параметр «Генерировать события»:

• ›«Нет» — сообщения будут записываться в строковые сигналы в исходном виде. Этот вариант подходит для любых форматов сообщений.
• ›«Да» — сообщения известного формата будут преобразованы в XML-конструкцию для автоматической генерации событий сервером.
✓

Примечание

Подробнее см. в документации:
«Alpha.DevStudio 4.2 (ред. 1. Предварительная) > Справочник > Элементы > Сети Syslog > Служебные модули > Syslog Сервер».

1.2. Фильтрация и запись сообщений в сигналы

В Alpha.DevStudio распределение входящих логов по различным объектам выполняется через карту адресов:

• ›В вашем приложении (Application) создайте логические объекты и добавьте в них информационные сигналы типа string с помощью элементов Параметр или Событие.
• ›Добавьте в Приложение элемент Карта адресов Syslog.

Элемент карты адресов Syslog в приложении
• ›Откройте редактор добавленной карты адресов и выполните привязку созданных строковых сигналов.
• ›Для каждой привязки задайте критерии фильтрации (параметры адреса): Адрес отправителя, Facility, Severity, APPNAME, PROCID, MSGID.
Обратите внимание

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

• ›Маршрутизация сообщений внутри сервера работает по приоритетам совпадения полей: от «Адреса отправителя» до «MSGID». Если под условия подходят несколько привязанных сигналов, сообщение будет записано в тот сигнал, у которого совпало больше высокоприоритетных фильтров.
✓

Примечание

Подробнее см. в документации:
«Alpha.Server 6.4 (ред. 8. Предварительная) > Модули > Служебные модули > Модули Syslog > Приложения > Формат сообщений Syslog».

1.3. Автоматическая генерация тревог (интеграция с OPC AE Server)

• ›Откройте панель События через меню Вид → События.
• ›Найдите в таблице строковый сигнал, в который поступают логи Syslog.
• ›Установите для него флаг «Генерировать события».
• ›В появившейся строке настроек укажите параметры тревоги: шаблон текста Сообщения, Важность (Severity), необходимость Квитирования и файл Звука.

При построении решения Alpha.DevStudio сама сгенерирует необходимые условия, автоматически создаст служебные свойства и свяжет сигнал с OPC AE Server.

2. Локальный сбор: служба Syslog (Alpha.Diagnostics)

Помимо классического модуля в Alpha.Server, в состав утилит диагностики входит независимая Служба Syslog. Она позволяет организовать локальный сервер Syslog для сбора сообщений в локальное файловое хранилище. Дополнительно в этой службе можно настроить клиентов для маршрутизации полученных сообщений в системы верхнего уровня, такие как WinCC OA TCP и OPC.


Настройки локального сервера Syslog в Alpha.Diagnostics Configurator
✓

Примечание

Подробнее см. в документации:
«Alpha.Diagnostics 2.2 > Назначение и состав».

3. Трансляция логов: настройка Syslog-клиента

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

3.1. Syslog Client в Alpha.Server

Модуль Syslog Client обеспечивает генерацию сообщений Syslog на основе изменений строковых сигналов Alpha.Server. Он накапливает сформированные логи и централизованно отправляет их заданным получателям. В статистике этого модуля можно отслеживать данные получателя.

3.2. Syslog-клиент в Alpha.AuditReport

Для трансляции системных журналов Windows и журналов безопасности применяется программа Alpha.AuditReport.

• ›Alpha.AuditReport отслеживает локальные журналы, например файлы .evtx или журнал Security. Сообщения проходят парсинг и проверку через заданные фильтры.
• ›Для отправки отфильтрованных логов добавляется Syslog-клиент, который передает сообщения по протоколу TCP/IP или UDP в формате Syslog.
• ›При конфигурации в настройках клиента необходимо задать Имя клиента, а также IP адрес и Порт удаленного Syslog-сервера-получателя.
✓

Примечание

Подробнее см. в документации:
«Alpha.Diagnostics 2.2 > Alpha.AuditReport».

4. Диагностика и устранение проблем

При настройке инфраструктуры Syslog важно контролировать ее работоспособность:

• ›Журнал работы (aplog): логи работы самого модуля Syslog Server сохраняются в файл Syslog Server.aplog в папке Logs на Windows или /opt/Automiq/Alpha.Server/Logs на Linux. Для их анализа применяется сервисное приложение «Просмотрщик лога кадров».
• ›Если сообщение отброшено фильтром, в .aplog-файле появится предупреждение об отсутствии в сервере сигнала, подходящего для записи. Для расширенного поиска проблем можно активировать детальное логирование (уровень «Отладочные сообщения») через свойство SystemLogTraceLevel.Set.