SOWA

SOWA

Расширение предназначено для мониторинга профилей SOWA через локальный интерфейс состояния.

Идентификатор: custom:sowa.

Возможности

Расширение выполняет:

• сбор статистики соединений SOWA;
• мониторинг внешних соединений;
• сбор показателей серверных зон и фильтров;
• сбор статистики ответов HTTP, MQ, Kafka и кеша;
• расчёт средней, минимальной и максимальной продолжительности запросов;
• создание сущностей хостов и профилей SOWA;
• установление связи между профилем и соответствующим хостом;
• формирование готовой обзорной панели.

Требования

Расширение запускается локально на контролируемом хосте.

Перед настройкой убедитесь, что:

• локальный интерфейс состояния SOWA доступен через TCP-порт или Unix-сокет;
• интерфейс состояния возвращает данные в формате JSON;
• процесс ЕдиногоАгента или EEC имеет доступ к Unix-сокету SOWA;
• время на хостах синхронизировано;
• для каждого контролируемого профиля известно его имя.

Подключение к SOWA

Способ подключения зависит от версии SOWA.

Версия SOWA	Способ подключения	Настройка
Ранее 5.2.1	Локальный HTTP-интерфейс	Укажите порт интерфейса /status.
5.2.1 и новее	Unix-сокет	Оставьте поле порта пустым.

При указании порта расширение обращается по адресу:

http://127.0.0.1:<порт>/status

Если порт не указан, используется Unix-сокет:

/sowarun/<имя_профиля>/service_profile_status.sock

Установка и настройка

1. Загрузите пакет расширения в Ключ-АСТРОМ.
2. Создайте локальную конфигурацию расширения.
3. Выберите хост, группу хостов или зону управления, на которых должно выполняться расширение.
4. Добавьте конечную точку SOWA.
5. Укажите имя профиля.
6. Для версий SOWA ранее 5.2.1 укажите порт интерфейса состояния.
7. Для подключения через Unix-сокет оставьте поле порта пустым.
8. Сохраните и активируйте конфигурацию.

Параметры конфигурации

Параметр	Обязательный	Описание
Profile name	Да	Имя контролируемого профиля SOWA. Оно также используется для формирования пути к Unix-сокету и как измерение метрик.
port	Нет	Порт локального интерфейса /status. Используется для версий SOWA ранее 5.2.1. Если поле пустое, расширение подключается через Unix-сокет.

В одной конфигурации можно добавить несколько профилей SOWA.

Пример для подключения через TCP-порт:

Profile name: production
port: 8080

Для подключения через Unix-сокет укажите имя профиля production, а поле port оставьте пустым.

Наборы метрик

Набор	Описание
Profile Metrics	Текущие и суммарные показатели внутренних и внешних соединений SOWA.
Server Zone Metrics	Запросы, входящий и исходящий трафик, ответы и продолжительность запросов серверных зон.
Filter Zone Metrics	Запросы, трафик, ответы и продолжительность запросов для фильтров и их экземпляров.

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

Группа	Примеры метрик	Описание
Соединения	ru.ruscomtech.sowa.connections.active ru.ruscomtech.sowa.connections.requests.total	Активные соединения и общее количество запросов.
Внешние соединения	ru.ruscomtech.sowa.connections_external.active ru.ruscomtech.sowa.connections_external.requests.total	Состояние соединений внешнего интерфейса.
Серверные зоны	ru.ruscomtech.sowa.server_zone.request_counter ru.ruscomtech.sowa.server_zone.in_bytes ru.ruscomtech.sowa.server_zone.out_bytes	Количество запросов и объём трафика серверной зоны.
Ответы серверных зон	ru.ruscomtech.sowa.server_zone.responses.2xx ru.ruscomtech.sowa.server_zone.responses.5xx	HTTP-ответы, результаты работы MQ, Kafka и кеша.
Продолжительность запросов	ru.ruscomtech.sowa.server_zone.request_msecs.avg ru.ruscomtech.sowa.server_zone.request_msecs.high	Средняя, максимальная, минимальная продолжительность и количество запросов.
Фильтры	ru.ruscomtech.sowa.filter_zone.request_counter ru.ruscomtech.sowa.filter_zone.responses.5xx	Показатели отдельных фильтров и их экземпляров.

Метрики содержат измерения с именем хоста, профилем, версиями SOWA и NGINX. Для зон и фильтров дополнительно передаются их имена.

Обнаруживаемые сущности

Расширение создаёт следующие типы сущностей:

• Sowa Host — контролируемый хост SOWA;
• Sowa profile — отдельный профиль SOWA.

Между профилем и хостом автоматически создаётся связь RUNS_ON.

Обзорная панель

В состав расширения входит панель SOWA Extension Overview. Она содержит список обнаруженных профилей и основные показатели соединений и запросов.

Проверка работы

Для подключения через TCP-порт проверьте доступность интерфейса состояния непосредственно на хосте:

curl http://127.0.0.1:<порт>/status

Для подключения через Unix-сокет проверьте наличие файла:

ls -l /sowarun/<имя_профиля>/service_profile_status.sock

После активации конфигурации убедитесь, что:

• созданы сущности хоста и профиля SOWA;
• поступают метрики с префиксом ru.ruscomtech.sowa;
• на обзорной панели отображается настроенный профиль.

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

Проблема	Возможная причина и решение
Ошибка подключения к порту	Проверьте номер порта и доступность адреса http://127.0.0.1:<порт>/status.
Ошибка подключения к Unix-сокету	Проверьте имя профиля, наличие сокета и права процесса ЕдиногоАгента или EEC.
Интерфейс доступен, но метрики отсутствуют	Убедитесь, что интерфейс состояния возвращает корректный JSON.
Не собирается продолжительность запросов	Проверьте синхронизацию времени на контролируемом хосте.
Не отображается профиль	Проверьте значение поля Profile name и наличие основных метрик соединений.

История изменений

Версия	Изменения
0.0.86	Добавлен мониторинг профилей SOWA через локальный интерфейс состояния. Добавлена поддержка подключения через TCP-порт и Unix-сокет. Добавлен сбор метрик соединений, серверных зон и фильтров. Добавлены сущности хостов и профилей SOWA. Добавлена готовая обзорная панель.