Мониторинг#

Для получения событий мониторинга в Platform V SOWA используются системы SIEM и Zabbix. Процесс интеграции SOWA с системами SIEM и Zabbix подробно рассмотрен в разделах Интеграция с SIEM и Интеграция с Zabbix соответственно.

Метрики агента мониторинга SOWA для Zabbix и Prometheus приведены в соответствующих разделах.

Настройка#

Интеграция с SIEM#

SIEM — это система для анализа безопасности, которая повышает точность обнаружения угроз. Технология SIEM в реальном времени обеспечивает анализ событий безопасности, которые исходят от сетевых устройств и приложений, и позволяет вовремя на них реагировать.

Система SIEM решает следующие задачи:

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

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

Для интеграции с SIEM необходимо выполнить следующие действия:

Выставить тип логирования syslog.
Перенаправить логирование в хранилище при помощи файла конфигурации Rsyslog:
```
/etc/rsyslog.conf
```
Если используется протокол udp, то рекомендуется снять комментарии со следующих строк в секции MODULES:
```
$ModLoad imudp
$UDPServerRun 514
```
Необходимо снять комментарии со следующих строк:
```
$ModLoad imtcp
$InputTCPServerRun 514
```

Важно соблюдать порядок расположения настроек в rsyslog.conf. В варианте, представленном ниже, сообщения вначале попадают в хранилище, а затем в локальный syslog. Syslog обрабатывает записи в конфигурационном файле в порядке их указания.

В секции RULES описаны действия для логирования:

#### RULES ####
  
# Log sowa-config messages to a local specific file.
...
if $programname == 'sowa-config' then @@XXX.XXX.XXX.XXX:XXX
# Log messages from all sowa-* apps to Qradar.
if $programname == 'sowa_nginx' or $programname == 'sowa-modsecurity' then @@XXX.XXX.XXX.XXX:XXX
  
...

@ - udp-протокол;
@@ - tcp-протокол;
sowa_config - логирование сообщений о конфигурировании;
sowa_nginx - логирование служебных сообщений nginx;
sowa-modsecurity - логирование сообщений об атаках и/или срабатываниях детектора вредоносного контента.

После внесения изменений в rsyslog.conf обязательно требуется перезагрузить rsyslog с помощью команды:

sudo systemctl restart rsyslog

Интеграция с Zabbix#

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

Этот инструмент позволяет реализовать 2 модели доставки метрик до серверов Zabbix:

PUSH, в котором субъект мониторинга самостоятельно отправляет необходимые метрики;
PULL, в котором субъект мониторинга отдает метрики по запросу центрального сервера.

В SOWA используется PUSH-механизм отправки метрик, при котором специально установленный на сервере агент отправляет нужные метрики с заданной частотой.

Установка Zabbix агента#

Для успешной установки sowa-zabbix-agent требуется zabbix-agent версии 3.0. и выше.

Инструкция по установке Zabbix агента доступна на официальном сайте.

Мониторинг в Zabbix#

После развертывания ППО SOWA автоматически в каталоге /sowa/<profile>/services/ будет создан сервис service_profile_status, который используется Zabbix агентом.

Система состоит из четырех основных компонентов:

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

Настройка области собираемых метрик осуществляется в интерфейсе Zabbix. Для этого необходимо перейти на вкладку «Последние данные» и выбрать «Группы узлов сети».

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

Далее необходимо выбрать соответствующие узлы сети и нажать кнопку Выбрать.

В открывшемся окне необходимо установить чекбоксы Показывать элементы данных без истории и Показывать детали.

Проверка состояния осуществляется с помощью параметра Profile control item (sowa.profile.control):

Если значение представляет собой следующее, то происходит сбор статистики с профиля и узла zabbix-agent:

info from server: "processed: 10; failed: 0; total: 10; seconds spent: 0.000165"
sent: 10; skipped: 0; total: 10

После этого в «Группе элементов данных» необходимо выбрать ту метрику, статистику по которой хотелось бы получить.

Проверка состояния готовности профиля#

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

Далее необходимо узнать, установлен ли на сервисе мониторинга Zabbix шаблон Template SOWA (если ранее администраторам сервиса мониторинга не передавался шаблон для установки, то скорее всего, шаблон отсутствует). Шаблон устанавливают администраторы сервиса мониторинга Zabbix.

После загрузки базового шаблона, настоятельно рекомендуется к имени файла добавить имя профиля, например: zbx_sowa_template_<profile>.xml, и только после этого передавать шаблон для установки на сервис мониторинга.

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

Если шаблон установлен (или после установки), необходимо сделать заявку на подключение к серверу или группе серверов шаблона Template SOWA.

Метрики#

Метрики агента мониторинга SOWA для Zabbix#

Список макросов#

Название	Описание	Основные атрибуты	Комментарий
`#RPROFILE`	Имя профиля	-	1
`#RSERVICE`	Имя сервиса	-	2, уникален в рамках `#RPROFILE`
`#RENTRY`	Имя точки входа в сервис	-	3, уникален в рамках `#RPROFILE`, уникален в рамках `#RSERVICE`
`#RUPSTREAM`	Имя upstream	-	3, уникален в рамках `RPROFILE`, единственный в рамках `#RSERVICE`
`#RUPSTREAMENTRY`	Имя точки входа	-	3, уникален в рамках `#RUPSTREAM`, `#RSERVICE`, `#RPROFILE`
`#RCERTIFICATE`	Имя сертификата	-	2, уникален в рамках `#RPROFILE`
`#RLIMITREQZONE`	Имя зоны лимитирования запросов	-	3, уникален в рамках `#RPROFILE`, уникален в рамках `#RSERVICE`

Список приложений (групп элементов)#

Название	Описание	Основные атрибуты	Элементы данных
SOWA profile stat	Включает все прототипы элементов данных уровня «Профиль» всех профилей.	-	`sowa.profile.control`
SOWA profile services stat	Включает все прототипы элементов данных уровня «Сервис профиля» всех сервисов всех профилей.	-	`sowa.profile.service.control`
SOWA entries stat	Включает все прототипы элементов данных уровня «Точка входа в сервис» всех точек входа всех сервисов всех профилей.	-	`sowa.profile.service.entry.control`
SOWA profile upstreams stat	Включает все прототипы элементов данных уровня «Upstream сервиса профиля» всех сервисов всех профилей.	-	`sowa.profile.service.upstream.control`
SOWA upstream entries stat	Включает все прототипы элементов данных уровня «Точка входа в upstream» всех сервисов всех профилей.	-	`sowa.profile.service.upstream.entry.control`
SOWA profile certificates stat	Включает все прототипы элементов данных уровня «Cертификат» всех профилей.	-	`sowa.profile.certificate.control`
SOWA profile service limit req zone stat	Включает все прототипы элементов данных уровня «Зоны лимитирования запросов» всех сервисов всех профилей.	-	`sowa.profile.service.limitreqzone.control`

Список прототипов приложений (групп элементов данных)#

Название	Описание	Основные атрибуты	Комментарий
SOWA profile {#RPROFILE}	Выборка всех элементов данных уровня «Профиль» в разрезе профиль.	-	Разбивает выборку данных по профилю для конкретного профиля.
SOWA profile {#RPROFILE} service {#RSERVICE}	Выборка всех элементов данных уровня «Сервис» в разрезе сервиса профиля.	-	Разбивает выборку данных по сервису для конкретного сервиса профиля.
SOWA profile {#RPROFILE} service {#RSERVICE} full stat	Выборка всех элементов данных уровня «Сервис» в разрезе сервиса профиля + всех данных по точкам входа + всем upstream’ам + всем точкам upstream’ов.	-	Разбивает выборку данных по сервису для конкретного сервиса профиля, включая данные по всех входящим в сервис элементам.
SOWA profile {#RPROFILE} service {#RSERVICE} entry {#RENTRY}	Выборка всех элементов данных уровня «Точка входа в сервис» в разрезе точка входа в сервис профиля.	-	`sowa.profile.service.upstream.control`
SOWA upstream entries stat	Включает все прототипы элементов данных уровня «Точка входа в upstream» всех сервисов всех профилей.	-	`sowa.profile.service.upstream.entry.control`
SOWA profile certificates stat	Включает все прототипы элементов данных уровня «Cертификат» всех профилей.	-	`sowa.profile.certificate.control`
SOWA profile {#RPROFILE} service {#RSERVICE} limitreq zone {#RLIMITREQZONE}	Включает все прототипы элементов данных уровня «Зоны лимитирования запросов» всех сервисов всех профилей.	-	`sowa.profile.service.limitreqzone.control`

Список LLD правил#

Название	Описание	Основные атрибуты	Ключ	Интервал обновления
Entry discovering rule	Формирует список доступных точек входа сервисов профилей хоста.	-	`sowa.entry.discovery`	30 c
Profile discovering rule	Формирует список доступных профилей хоста.	-	`sowa.profile.discovery`	30 c
Service discovering rule	Формирует список доступных сервисов хоста.	-	`sowa.service.discovery`	30 c
Upstream discovering rule	Формирует список всех upstream, используемых сервисами профилей, зарегистрированных на наблюдаемом хосте.	-	`sowa.upstream.discovery`	30 c
Service upstream entry discovering rule	Формирует список точек входов upstream, используемых сервисами профилей, зарегистрированных на наблюдаемом хосте.	-	`sowa.service.upstream.entry.discovery`	30 c
Certificate discovering rule	Формирует список сертификатов профилей хоста.	-	`sowa.certificate.discovery`	30 с
Service limit req zone discovering rule	Формирует список зон лимитирования запросов.	-	`sowa.profile.service.limitreqzone.discovery`	60 с

Элементы данных#

Название	Описание	Основные атрибуты	Ключ	Интервал обновления
Profile control item	Инициирует отправку элементов данных уровня «Профиль» клиентом на сервер Zabbix.	-	`sowa.profile.control`	30 c
Service control item	Инициирует отправку элементов данных уровня «Сервис» клиентом на сервер Zabbix.	-	`sowa.profile.service.control`	30 c
Entry service control item	Инициирует отправку элементов данных уровня « Точка входа сервиса» клиентом на сервер Zabbix.	-	`sowa.profile.service.entry.control`	30 c
Upstream control item	Инициирует отправку элементов данных уровня «Upstream» клиентом на сервер Zabbix.	-	`sowa.profile.upstream.control`	30 c
Service upstream control item	Инициирует отправку элементов данных уровня «Точка входа upstream’а» клиентом на сервер Zabbix.	-	`sowa.profile.service.upstream.entry.control`	30 c
Certificate control item	Инициирует отправку элементов данных уровня «Сертификат» клиентом на сервер Zabbix.	-	`sowa.profile.certificate.control`	30 с
Service limit req zone item	Инициирует отправку элементов данных уровня «Зоны лимитирования запросов» клиентом на сервер Zabbix.	-	`sowa.profile.service.limitreqzone.control`	30 с

Список прототипов параметров уровня «Профиль»#

Название	Описание	Размерность	Основные атрибуты
Общее состояние профиля
`sowa.profile[{#RPROFILE},active]`	Текущий статус профиля (0 – недоступен, 1 – доступен).	Число [0,1]	-
`sowa.profile[{#RPROFILE},startup_time]`	Дата и время запуска профиля.	Строка	-
`sowa.profile[{#RPROFILE},uptime_time]`	Время прошедшее с момента запуска профиля.	Строка	-
`sowa.profile[{#RPROFILE},response_time]`	Время ответа профиля (фактически время получения ответа на запрос статистики со стороны агента профилю SOWA).	Целое число	-
`sowa.profile[{#RPROFILE},connection_active]`	Текущее количество активных соединений.	Целое число	-
`sowa.profile[{#RPROFILE},connection_waiting]`	Кол-во соединений ожидающих обработки.	Целое число	-
`sowa.profile[{#RPROFILE},connection_writing]`	Кол-во соединений, осуществляющих запись в данный момент времени.	Целое число	-
`sowa.profile[{#RPROFILE},request_accepted]`	Общее число принятых соединений (с момента запуска).	Целое число	-
`sowa.profile[{#RPROFILE},request_handled]`	Общее число обработанных соединений с момента запуска.	Целое число	-
`sowa.profile[{#RPROFILE},connection_reading]`	Текущее кол-во соединений осуществляющих чтение.	Целое число	-
`sowa.profile[{#RPROFILE},ext_connection_active]`	Количество внешних активных соединений.	Целое число	-
`sowa.profile[{#RPROFILE},ext_connection_waiting]`	Количество внешних соединений, ожидающих обработки.	Целое число	-
`sowa.profile[{#RPROFILE},ext_connection_writing]`	Количество внешних соединений, осуществляющих запись в данный момент времени.	Целое число	-
`sowa.profile[{#RPROFILE},ext_connection_accepted]`	Общее число принятых внешних соединений (с момента запуска).	Целое число	-
`sowa.profile[{#RPROFILE},ext_connection_handled]`	Общее число обработанных внешних соединений с момента запускаю.	Целое число	-
`sowa.profile[{#RPROFILE},ext_connection_reading]`	Текущее кол-во внешних соединений, осуществляющих чтение.	Целое число	-
`sowa.profile[{#RPROFILE},open_ports]`	Список портов, доступных для внешнего подключения.	Строка	-
`sowa.profile[{#RPROFILE},entry_wam_int_latency]`	Средневзвешенное время обработки запроса на SOWA (без учета взаимодействия с upstream) с группировкой по портам.	Целое число	-
`sowa.profile[{#RPROFILE},max_service_int_latency_name]`	Имя сервиса с максимальным значением времени внутренней обработки.	Строка	-
`sowa.profile[{#RPROFILE},max_service_int_latency]`	Время внутренней обработки на сервисе с максимальным значением.	Строка	-
`sowa.profile[{#RPROFILE},service_wam_int_latency]`	Средневзвешенное время обработки запроса на SOWA (без учета взаимодействия с upstream) с группировкой по сервисам.	Целое число	-
`sowa.profile[{#RPROFILE},max_entry_int_latency_name]`	Имя точки входа с максимальным значением времени внутренней обработки.	Строка	-
`sowa.profile[{#RPROFILE},max_entry_int_latency]`	Время внутренней обработки на точке входа с максимальным значением.	Строка	-
`sowa.profile[{#RPROFILE},total_sent]`	Всего отправлено (байт).	Целое число	-
`sowa.profile[{#RPROFILE},received]`	Всего получено (байт).	Целое число	-
`sowa.profile[{#RPROFILE},response_1xx]`	Кол-во ответов со статусом вида 1xx.	Целое число	-
`sowa.profile[{#RPROFILE},response_2xx]`	Кол-во ответов со статусом вида 2xx.	Целое число	-
`sowa.profile[{#RPROFILE},response_3xx]`	Кол-во ответов со статусом вида 3xx.	Целое число	-
`sowa.profile[{#RPROFILE},response_4xx]`	Кол-во ответов со статусом вида 4xx.	Целое число	-
`sowa.profile[{#RPROFILE},response_5xx]`	Кол-во ответов со статусом вида 5xx.	Целое число	-
`sowa.profile[{#RPROFILE},total_response_processing]`	Общее кол-во отданных ответов клиенту.	Целое число	-
`sowa.profile[{#RPROFILE},total_rps]`	Кол-во запросов обрабатываемых в секунду.	Целое число	-
`sowa.profile[{#RPROFILE},sent_per_sec]`	Кол-во байт отправляемых в секунду.	Число с плавающей точкой	-
`sowa.profile[{#RPROFILE},rcvd_per_sec]`	Кол-во байт принимаемых в секунду.	Число с плавающей точкой	-
`sowa.profile[{#RPROFILE},open_ports]`	Список открытых для подключения внешних клиентов портов профиля. В качестве разделителя используется пробел.	Последовательность целых чисел	-
Средневзвешенные значения по элементам профиля (сервисы)
`sowa.profile[{#RPROFILE},lowest_service_inbound_name]`	Имя сервиса профиля с наименьшей скоростью приема данных.	Строка	-
`sowa.profile[{#RPROFILE},lowest_service_inbound_speed]`	Скорость приема данных (байт/сек) сервиса профиля с наименьшей скоростью приема данных.	Число с плавающей точкой	-
`sowa.profile[{#RPROFILE},lowest_service_outbound_name]`	Имя сервиса профиля с наименьшей скоростью отдачи данных.	Строка	-
`sowa.profile[{#RPROFILE},lowest_service_outbound_speed]`	Скорость отдачи данных (байт/сек) сервиса профиля с наименьшей скоростью отдачи данных.	Число с плавающей точкой	-
`sowa.profile[{#RPROFILE},max_service_latency_name]`	Сервис с максимальным значением латентности.	Строка	-
`sowa.profile[{#RPROFILE},max_service_latency]`	Значение латентности в миллисекундах для сервиса с максимальным значением латентности.	Число с плавающей точкой	-
`sowa.profile[{#RPROFILE},service_wam_received]`	Средневзвешенное значение скорости получения данных сервисами.	Число с плавающей точкой	-
`sowa.profile[{#RPROFILE},service_wam_sent]`	Средневзвешенное значение скорости отправки данных сервисами.	Число с плавающей точкой	-
`sowa.profile[{#RPROFILE},service_wam_rps]`	Средневзвешенное значение кол-ва запросов в секунду обрабатываемых сервисами.	Число с плавающей точкой	-
`sowa.profile[{#RPROFILE},service_wam_latency]`	Средневзвешенное значение латентности для сервисов.	Число с плавающей точкой	-
Средневзвешенные значения по элементам профиля (точки входа сервисов)
`sowa.profile[{#RPROFILE},lowest_entry_inbound_name]`	Точка входа сервиса профиля с наименьшей скоростью приема данных.	Строка	-
`sowa.profile[{#RPROFILE},lowest_entry_inbound_speed]`	Скорость приема данных (байт/сек) точки входа сервиса профиля с наименьшей скоростью приема данных.	Число с плавающей точкой	-
`sowa.profile[{#RPROFILE},lowest_entry_outbound_name]`	Точка входа сервиса профиля с наименьшей скоростью отправки данных.	Строка	-
`sowa.profile[{#RPROFILE},lowest_entry_outbound_speed]`	Скорость отдачи данных (байт/сек) точки входа сервиса профиля с наименьшей скоростью приема данных.	Число с плавающей точкой	-
`sowa.profile[{#RPROFILE},max_entry_latency_name]`	Точка входа с максимальным значением латентности.	Строка	-
`sowa.profile[{#RPROFILE},max_entry_latency]`	Значение латентности в миллисекундах для точки входа сервиса с максимальным значением латентности.	Число с плавающей точкой	-
`sowa.profile[{#RPROFILE},entry_wam_sent]`	Средневзвешенное значение скорости отправки данных для точек входа сервисов.	Число с плавающей точкой	-
`sowa.profile[{#RPROFILE},entry_wam_received]`	Средневзвешенное значение скорости получения данных для точек входа сервисов.	Число с плавающей точкой	-
`sowa.profile[{#RPROFILE},entry_wam_latency]`	Средневзвешенное значение латентности для точек входа.	Число с плавающей точкойм	-
`sowa.profile[{#RPROFILE},entry_wam_rps]`	Средневзвешенное значение числа обрабатываемых в секунду запросов.	Число с плавающей точкой	-
Общие данные по upstream
`sowa.profile[{#RPROFILE},upstream_response_1xx]`	Кол-во ответов от upstream с кодом 1xx.	Целое число	-
`sowa.profile[{#RPROFILE},upstream_response_2xx]`	Кол-во ответов от upstream с кодом 2xx.	Целое число	-
`sowa.profile[{#RPROFILE},upstream_response_3xx]`	Кол-во ответов от upstream с кодом 3xx.	Целое число	-
`sowa.profile[{#RPROFILE},upstream_response_4xx]`	Кол-во ответов от upstream с кодом 4xx.	Целое число	-
`sowa.profile[{#RPROFILE},upstream_response_5xx]`	Кол-во ответов от upstream с кодом 5xx.	Целое число	-
`sowa.profile[{#RPROFILE},upstream_with_problem]`	Кол-во upstream, у которых как минимум один из серверов недоступен.	Целое число	-
`sowa.profile[{#RPROFILE},down_upstream_count]`	Кол-во upstream в состоянии down.	Целое число	-
`sowa.profile[{#RPROFILE},active_upstream_count]`	Кол-во upstream в состоянии “active”.	Целое число	-
`sowa.profile[{#RPROFILE},registered_upstream_count]`	Кол-во зарегистрированных upstream в профиле.	Целое число	-
`sowa.profile[{#RPROFILE},upstream_conns]`	Кол-во активных соединений с upstream.	Целое число	-
Параметры кеш
`sowa.profile[{#RPROFILE},cache_total]`	Всего элементов в кеше.	Целое число	-
`sowa.profile[{#RPROFILE},cache_revalidated]`	Кол-во ревалидированных элементов кеш.	Целое число	-
`sowa.profile[{#RPROFILE},cache_miss]`	Кол-во пропущенных элементов кеш.	Целое число	-
`sowa.profile[{#RPROFILE},cache_bypass]`	Кол-во элементов кеш неотправленных клиентов.	Целое число	-
`sowa.profile[{#RPROFILE},cache_stale]`	Кол-во устаревших элементов в кеше.	Целое число	-
`sowa.profile[{#RPROFILE},cache_hit]`	Кол-во попаданий в кеш.	Целое число	-
`sowa.profile[{#RPROFILE},cache_expired]`	Кол-во элементов в кеше с истекшем сроком хранения.	Целое число	-
`sowa.profile[{#RPROFILE},cache_updating]`	Кол-во обновленных элементов в кеше.	Целое число	-

Список прототипов параметров уровня «Точка входа»#

Название	Описание	Размерность	Основные атрибуты
Общее состояние сервиса
`sowa.profile.service[{#RPROFILE}.{#RSERVICE}.{#RENTRY},total_sent]`	Всего отправлено байт.	Целое число	-
`sowa.profile.service[{#RPROFILE}.{#RSERVICE}.{#RENTRY},received]`	Всего получено байт.	Целое число	-
`sowa.profile.service[{#RPROFILE}.{#RSERVICE}.{#RENTRY},latency]`	Латентность (время отклика в миллисекундах).	Целое число	-
`sowa.profile.service[{#RPROFILE}.{#RSERVICE}.{#RENTRY},rcvd_per_sec]`	Скорость (байт/секунду) приема данных.	Число с плавающей точкой	-
`sowa.profile.service[{#RPROFILE}.{#RSERVICE}.{#RENTRY},sent_per_sec]`	Скорость (байт/секунду) отправки данных.	Число с плавающей точкой	-
`sowa.profile.service[{#RPROFILE}.{#RSERVICE}.{#RENTRY},rps_sum]`	Кол-во запросов в секунду обрабатываемых сервисом.	Число с плавающей точкой	-
`sowa.profile.service[{#RPROFILE}.{#RSERVICE}.{#RENTRY},total_request_processing]`	Всего запросов принято.	Целое число	-
`sowa.profile.service[{#RPROFILE}.{#RSERVICE}.{#RENTRY},total_response_processing]`	Всего ответов отправлено.	Целое число	-
`sowa.profile.service[{#RPROFILE}.{#RSERVICE}.{#RENTRY},response_1xx]`	Кол-во ответов с кодом состояния 1xx.	Целое число	-
`sowa.profile.service[{#RPROFILE}.{#RSERVICE}.{#RENTRY},response_2xx]`	Кол-во ответов с кодом состояния 2xx.	Целое число	-
`sowa.profile.service[{#RPROFILE}.{#RSERVICE}.{#RENTRY},response_3xx]`	Кол-во ответов с кодом состояния 3xx.	Целое число	-
`sowa.profile.service[{#RPROFILE}.{#RSERVICE}.{#RENTRY},response_4xx]`	Кол-во ответов с кодом состояния 4xx.	Целое число	-
`sowa.profile.service[{#RPROFILE}.{#RSERVICE}.{#RENTRY},response_5xx]`	Кол-во ответов с кодом состояния 5xx	Целое число	-
`sowa.profile.service[{#RPROFILE}.{#RSERVICE},entry_wam_int_latency]`	Средневзвешенное значение времени внутренней обработки запроса.	Целое число	-
Параметры кеширования
`sowa.profile.service[{#RPROFILE}.{#RSERVICE}.{#RENTRY},cache_total]`	Всего в кеше.	Целое число	-
`sowa.profile.service[{#RPROFILE}.{#RSERVICE}.{#RENTRY},cache_updating]`	Обновлено элементов.	Целое число	-
`sowa.profile.service[{#RPROFILE}.{#RSERVICE}.{#RENTRY},cache_expired]`	Кол-во элементов с истекшим сроком действий.	Целое число	-
`sowa.profile.service[{#RPROFILE}.{#RSERVICE}.{#RENTRY},cache_hit]`	Кол-во попаданий в cache.	Целое число	-
`sowa.profile.service[{#RPROFILE}.{#RSERVICE}.{#RENTRY}cache_bypass]`	Кол-во не отданных клиенту элементов.	Целое число	-
`sowa.profile.service[{#RPROFILE}.{#RSERVICE}.{#RENTRY},cache_revalidated]`	Кол-во ревалидированных элементов.	Целое число	-
`sowa.profile.service[{#RPROFILE}.{#RSERVICE}.{#RENTRY},cache_miss]`	Кол-во отсутствующих элементов cache’а.	Целое число	-
`sowa.profile.service[{#RPROFILE}.{#RSERVICE}.{#RENTRY},cache_stale]`	Кол-во просроченных элементов.	Целое число	-

Список прототипов параметров уровня «Upstream»#

Название	Описание	Размерность	Основные атрибуты
Общее состояние
`sowa.profile.service.upstream[{#RPROFILE}.{#RSERVICE}.{#RUPSTREAM},active]`	Признак активности [0, 1].	Целое число	-
`sowa.profile.service.upstream[{#RPROFILE}.{#RSERVICE}.{#RUPSTREAM},problem]`	Количество серверов в статусе «down».	Целое число	-
`sowa.profile.service.upstream[{#RPROFILE}.{#RSERVICE}.{#RUPSTREAM},total_request_count]`	Общее количество полученных запросов.	Целое число	-
`sowa.profile.service.upstream[{#RPROFILE}.{#RSERVICE}.{#RUPSTREAM},total_responses]`	Общее количество отданных ответов.	Целое число	-
`sowa.profile.service.upstream[{#RPROFILE}.{#RSERVICE}.{#RUPSTREAM},received]`	Всего байт принято.	Целое число	-
`sowa.profile.service.upstream[{#RPROFILE}.{#RSERVICE}.{#RUPSTREAM},sent]`	Всего байт отправлено.	Целое число	-
`sowa.profile.service.upstream[{#RPROFILE}.{#RSERVICE}.{#RUPSTREAM},sent_speed]`	Скорость отправки байт/секунду.	Число с плавающей точкой	-
`sowa.profile.service.upstream[{#RPROFILE}.{#RSERVICE}.{#RUPSTREAM},rcvd_speed]`	Скорость получения байт/секунду.	Число с плавающей точкой	-
`sowa.profile.service.upstream[{#RPROFILE}.{#RSERVICE}.{#RUPSTREAM},total_rps]`	Количество обрабатываемых запросов в секунду.	Целое число	-
`sowa.profile.service.upstream[{#RPROFILE}.{#RSERVICE}.{#RUPSTREAM},upstream_response_1xx]`	Количество ответов со статусом 1xx.	Целое число	-
`sowa.profile.service.upstream[{#RPROFILE}.{#RSERVICE}.{#RUPSTREAM},upstream_response_2xx]`	Количество ответов со статусом 2xx.	Целое число	-
`sowa.profile.service.upstream[{#RPROFILE}.{#RSERVICE}.{#RUPSTREAM},upstream_response_3xx]`	Количество ответов со статусом 3xx.	Целое число	-
`sowa.profile.service.upstream[{#RPROFILE}.{#RSERVICE}.{#RUPSTREAM},upstream_response_4xx]`	Количество ответов со статусом 4xx.	Целое число	-
`sowa.profile.service.upstream[{#RPROFILE}.{#RSERVICE}.{#RUPSTREAM},upstream_response_5xx]`	Количество ответов со статусом 5xx.	Целое число	-
`sowa.profile.service.upstream[{#RPROFILE}.{#RSERVICE}.{#RUPSTREAM},conns_count]`	Количество активных соединений.	Целое число	-
Средневзвешенные значения по серверам
`sowa.profile.service.upstream[{#RPROFILE}.{#RSERVICE}.{#RUPSTREAM},avg_mean_sent_speed]`	Средневзвешенная скорость отправки байт в секунду (в расчете на сервер).	Целое число	-
`sowa.profile.service.upstream[{#RPROFILE}.{#RSERVICE}.{#RUPSTREAM},avg_mean_rcvd_speed]`	Средневзвешенная скорость получения байт в секунду (в расчете на сервер).	Целое число	-
`sowa.profile.service.upstream[{#RPROFILE}.{#RSERVICE}.{#RUPSTREAM},avg_mean_resp_latency]`	Средневзвешенное время отклика для ответа.	Целое число	-
`sowa.profile.service.upstream[{#RPROFILE}.{#RSERVICE}.{#RUPSTREAM},avg_mean_req_latency]`	Средневзвешенное время отклика для запроса.	Целое число	-

Список прототипов параметров уровня «Точка входа в upstream (сервер)»#

Название	Описание	Размерность	Основные атрибуты
Общее состояние
`sowa.profile.service.upstream.entry[{#RPROFILE}.{#RSERVICE}.{#RUPSTREAM}.{#RUPSTREAMENTRY},active]`	Состояние, 1 - активен, 0 - нет.	Целое число	-
`sowa.profile.service.upstream.entry[{#RPROFILE}.{#RSERVICE}.{#RUPSTREAM}.{#RUPSTREAMENTRY},total_request_count]`	Общее число обрабатываемых запросов.	Целое число	-
`sowa.profile.service.upstream.entry[{#RPROFILE}.{#RSERVICE}.{#RUPSTREAM}.{#RUPSTREAMENTRY},total_responses]`	Общее число отданных ответов.	Целое число	-
`sowa.profile.service.upstream.entry[{#RPROFILE}.{#RSERVICE}.{#RUPSTREAM}.{#RUPSTREAMENTRY},sent]`	Количество байт отправлено.	Целое число	-
`sowa.profile.service.upstream.entry[{#RPROFILE}.{#RSERVICE}.{#RUPSTREAM}.{#RUPSTREAMENTRY},received]`	Количество байт получено.	Целое число	-
`sowa.profile.service.upstream.entry[{#RPROFILE}.{#RSERVICE}.{#RUPSTREAM}.{#RUPSTREAMENTRY},total_rps]`	Количество запросов в секунду.	Целое число	-
`sowa.profile.service.upstream.entry[{#RPROFILE}.{#RSERVICE}.{#RUPSTREAM}.{#RUPSTREAMENTRY},sent_speed]`	Скорость отправки данных байт/секунд.	Число с плавающей точкой	-
`sowa.profile.service.upstream.entry[{#RPROFILE}.{#RSERVICE}.{#RUPSTREAM}.{#RUPSTREAMENTRY},rcvd_speed]`	Скорость получения данных, байт/секунд.	Число с плавающей точкой	-
`sowa.profile.service.upstream.entry[{#RPROFILE}.{#RSERVICE}.{#RUPSTREAM}.{#RUPSTREAMENTRY},upstream_response_1xx]`	Количество ответов со статусом 1xx.	Целое число	-
`sowa.profile.service.upstream.entry[{#RPROFILE}.{#RSERVICE}.{#RUPSTREAM}.{#RUPSTREAMENTRY},upstream_response_2xx]`	Количество ответов со статусом 2xx.	Целое число	-
`sowa.profile.service.upstream.entry[{#RPROFILE}.{#RSERVICE}.{#RUPSTREAM}.{#RUPSTREAMENTRY},upstream_response_3xx]`	Количество ответов со статусом 3xx.	Целое число	-
`sowa.profile.service.upstream.entry[{#RPROFILE}.{#RSERVICE}.{#RUPSTREAM}.{#RUPSTREAMENTRY},upstream_response_4xx]`	Количество ответов со статусом 4xx.	Целое число	-
`sowa.profile.service.upstream.entry[{#RPROFILE}.{#RSERVICE}.{#RUPSTREAM}.{#RUPSTREAMENTRY},upstream_response_5xx]`	Количество ответов со статусом 5xx.	Целое число	-
`sowa.profile.service.upstream.entry[{#RPROFILE}.{#RSERVICE}.{#RUPSTREAM}.{#RUPSTREAMENTRY},resp_latency]`	Время отклика для ответа.	Целое число	-
`sowa.profile.service.upstream.entry[{#RPROFILE}.{#RSERVICE}.{#RUPSTREAM}.{#RUPSTREAMENTRY},req_latency]`	Время отклика для запроса.	Целое число	-
`sowa.profile.service.upstream.entry[{#RPROFILE}.{#RSERVICE}.{#RUPSTREAM}.{#RUPSTREAMENTRY},conns_count]`	Кол-во активных соединений.	Целое число	-

Список прототипов параметров уровня «Точка входа в upstream (сервер)»#

Название	Описание	Размерность	Основные атрибуты
`sowa.profile.certificate[{#RPROFILE}.{#RCERTIFICATE},valid_throw]`	Timestamp, отражающий дату окончания срока действия сертификата.	timestamp	-

Список прототипов параметров уровня «Зоны лимитирования запросов»#

Название	Описание	Размерность	Основные атрибуты
Общее состояние
`sowa.profile.service.limitreqzone[{#RPROFILE}.{#RSERVICE}.{#RLIMITREQZONE},passed]`	Количество запросов, пропущенных после проверки на лимиты зоны.	Целое число	-
`sowa.profile.service.limitreqzone[{#RPROFILE}.{#RSERVICE}.{#RLIMITREQZONE},rejected]`	Количество запросов, отклоненных после проверки на лимиты зоны.	Целое число	-
`sowa.profile.service.limitreqzone[{#RPROFILE}.{#RSERVICE}.{#RLIMITREQZONE},delayed]`	Количество запросов, задержанных после проверки на лимиты зоны.	Целое число	-
`sowa.profile.service.limitreqzone[{#RPROFILE}.{#RSERVICE}.{#RLIMITREQZONE},rejectedDryRun]`	Количество запросов, которые были бы отклонены после проверки на лимиты зоны, но не отклонены, так как задан режим dry_run.	Целое число	-
`sowa.profile.service.limitreqzone[{#RPROFILE}.{#RSERVICE}.{#RLIMITREQZONE},delayedDryRun]`	Количество запросов, которые были бы задержаны после проверки на лимиты зоны, но не задержаны, так как задан режим dry_run.	Целое число	-
`sowa.profile.service.limitreqzone[{#RPROFILE}.{#RSERVICE}.{#RLIMITREQZONE},rate]`	Количество запросов в интервал времени. Например 15r/s	Текст	-

Список метрик по мониторингу Kafka#

Название	Описание	Основные атрибуты
`sowa.profile.service.entry[{#RPROFILE}.{#RSERVICE}.{#RENTRY},kafka_active_con_cnt]`	Количество активных соединений с брокерами.	-
`sowa.profile.service.entry[{#RPROFILE}.{#RSERVICE}.{#RENTRY},kafka_total_con_cnt]`	Общее количество брокеров для доставки.	-
`sowa.profile.service.entry[{#RPROFILE}.{#RENTRY},kafka_err_msg_cnt]`	Количество сообщений, не доставленных из за ошибок (ошибки сова - брокер).	-
`sowa.profile.service.entry[{#RPROFILE}.{#RENTRY},kafka_ok_msg_cnt]`	Количество успешно доставленных сообщений.	-
`sowa.profile.service.entry[{#RPROFILE}.{#RSERVICE}.{#RENTRY},kafka_uncommited_msg_cnt]`	Количество сообщений, не попавших в очередь доставки (ошибки на шлюзе).	-
`sowa.profile.service.entry[{#RPROFILE}.{#RSERVICE}.{#RENTRY},kafka_commited_msg_cnt]`	Сообщения в очереди на доставку.	-

Метрики simple_rate_limit#

Название	Описание	Основные атрибуты
sowa.profile.simpleratelimiterzone[{#RPROFILE}.{{#RSIMPLERATELIMITZONE}, blocked]	Общее количество заблокированных запросов.	-
sowa.profile.simpleratelimiterzone[{#RPROFILE}.{{#RSIMPLERATELIMITZONE}, count]	Текущее количество запросов в зоне. Максимальное значение равное значению лимита (показатель заполненности зоны)	-
sowa.profile.simpleratelimiterzone[{#RPROFILE}.{{#RSIMPLERATELIMITZONE}, exceeded]	Текущее количество запросов, превышающих лимит.	-
sowa.profile.simpleratelimiterzone[{#RPROFILE}.{{#RSIMPLERATELIMITZONE}, limit]	Текущее значение лимита.	-
sowa.profile.simpleratelimiterzone[{#RPROFILE}.{{#RSIMPLERATELIMITZONE}, passed]	Общее количество запросов, переданных в зоне.	-
sowa.profile.simpleratelimiterzone[{#RPROFILE}.{{#RSIMPLERATELIMITZONE}, period]	Период времени для данной зоны.	-
sowa.profile.simpleratelimiterzone.discovery	Правило определения зоны ограничения.	-
sowa.profile.simpleratelimiterzone.control	Элемент управления зоной ограничения.	-

Метрики агента мониторинга SOWA для Prometheus#

Общее состояние профиля#

Название	Описание	Основные атрибуты
`sowa_nginx_vts_info{hostname,version,profileVersion,configuratorVersion,sowaRunningVersion}`	Общая информация о версионности (профиля/конфигуратора/СПО).	hostname,version,profileVersion,configuratorVersion,sowaRunningVersion
`sowa_nginx_vts_start_time`	Время запуска профиля.
`sowa_nginx_vts_time_since_start`	Время, прошедшее с момента запуска профиля.
`sowa_nginx_vts_main_connections{status="requests"}`	Общее число запросов.	status
`sowa_nginx_vts_main_connections{status="active"}`	Текущее количество активных соединений.	status
`sowa_nginx_vts_main_connections{status="waiting"}`	Количество соединений, ожидающих обработки.	status
`sowa_nginx_vts_main_connections{status="writing"}`	Количество соединений, осуществляющих запись в данный момент времени.	status
`sowa_nginx_vts_main_connections{status="accepted"}`	Общее число принятых соединений (с момента запуска).	status
`sowa_nginx_vts_main_connections{status="handled"}`	Общее число обработанных соединений с момента запуска.	status
`sowa_nginx_vts_main_connections{status="reading"}`	Текущее количество соединений, осуществляющих чтение.	status
`sowa_nginx_vts_main_connections_external{status="requests"}`	Количество внешних запросов.	status
`sowa_nginx_vts_main_connections_external{status="active"}`	Количество внешних активных соединений.	status
`sowa_nginx_vts_main_connections_external{status="waiting"}`	Количество внешних соединений, ожидающих обработки.	status
`sowa_nginx_vts_main_connections_external{status="writing"}`	Количество внешних соединений, осуществляющих запись в данный момент времени.	status
`sowa_nginx_vts_main_connections_external{status="accepted"}`	Общее число принятых внешних соединений (с момента запуска).	status
`sowa_nginx_vts_main_connections_external{status="handled"}`	Общее число обработанных внешних соединений с момента запуска.	status
`sowa_nginx_vts_main_connections_external{status="reading"}`	Текущее количество внешних соединений, осуществляющих чтение.	status
`sowa_nginx_vts_main_shm_usage_bytes{shared="max_size"}`	Общий размер в байтах shared memory.	max_size
`sowa_nginx_vts_main_shm_usage_bytes{shared="used_size"}`	Использовано байт shared memory.	used_size
`sowa_nginx_vts_main_shm_usage_bytes{shared="used_node"}`	Использовано node из shared memory.	used_node
`sowa_nginx_vts_server_bytes_total{host,direction="out"}`	Всего отправлено (байт).	host,direction
`sowa_nginx_vts_server_bytes_total{host,direction="in"}`	Всего получено (байт).	host,direction
`sowa_nginx_vts_server_requests_total{host,key="responses",code="1xx"}`	Количество запросов со статусом вида 1xx.	host,key,code
`sowa_nginx_vts_server_requests_total{host,key="responses",code="2xx"}`	Количество запросов со статусом вида 2xx.	host,key,code
`sowa_nginx_vts_server_requests_total{host,key="responses",code="3xx"}`	Количество запросов со статусом вида 3xx.	host,key,code
`sowa_nginx_vts_server_requests_total{host,key="responses",code="4xx"}`	Количество запросов со статусом вида 4xx.	host,key,code
`sowa_nginx_vts_server_requests_total{host,key="responses",code="5xx"}`	Количество запросов со статусом вида 5xx.	host,key,code
`sowa_nginx_vts_server_requests_total{host,key="responses",code="sec"}`	Количество запросов, заблокированных с кодом 403.	host,key,code
`sowa_nginx_vts_server_requests_total{host,key="responses",code="kafka_ok"}`	Количество запросов, успешно доставленных на брокер kafka.	host,key,code
`sowa_nginx_vts_server_requests_total{host,key="responses",code="kafka_err"}`	Количество запросов, не доставленных на брокер kafka из-за ошибки.	host,key,code
`sowa_nginx_vts_server_requests_total{host,key="responses",code="kafka_commited"}`	Количество запросов, добавленных в очередь доставки.	host,key,code
`sowa_nginx_vts_server_requests_total{host,key="responses",code="kafka_uncommited"}`	Количество запросов в обработке и еще не добавленных в очередь доставки.	host,key,code
`sowa_nginx_vts_server_requests_total{host,key="responses",code="kafka_active_con"}`	Количество активных соединений с брокерами kafka.	host,key,code
`sowa_nginx_vts_server_requests_total{host,key="responses",code="kafka_total_con"}`	Общее количество брокеров kafka в конфигурации.	host,key,code
`sowa_nginx_vts_server_requests_total{host,key="responses",code="mq_ok"}`	Количество запросов, успешно доставленных на MQ.	host,key,code
`sowa_nginx_vts_server_requests_total{host,key="responses",code="mq_err"}`	Количество запросов, не доставленных на MQ из-за ошибки.	host,key,code
`sowa_nginx_vts_server_requests_total{host,key="responses",code="mq_commited"}`	Количество запросов, добавленных в очередь доставки.	host,key,code
`sowa_nginx_vts_server_requests_total{host,key="responses",code="mq_uncommited"}`	Количество запросов в обработке и еще не добавленных в очередь доставки.	host,key,code
`sowa_nginx_vts_server_requests_total{host,key="responses",code="mq_active_con"}`	Количество активных соединений с MQ.	host,key,code
`sowa_nginx_vts_server_requests_total{host,key="responses",code="mq_total_con"}`	Общее количество серверов MQ в конфигурации.	host,key,code

Общие данные по upstream#

Название	Описание	Основные атрибуты
`sowa_nginx_vts_upstream_requests_total{upstream,backend,code="1xx"}`	Количество ответов от upstram с кодом 1xx.	upstream,backend,code
`sowa_nginx_vts_upstream_requests_total{upstream,backend,code="2xx"}`	Количество ответов от upstram с кодом 2xx.	upstream,backend,code
`sowa_nginx_vts_upstream_requests_total{upstream,backend,code="3xx"}`	Количество ответов от upstram с кодом 3xx.	upstream,backend,code
`sowa_nginx_vts_upstream_requests_total{upstream,backend,code="4xx"}`	Количество ответов от upstram с кодом 4xx.	upstream,backend,code
`sowa_nginx_vts_upstream_requests_total{upstream,backend,code="5xx"}`	Количество ответов от upstram с кодом 5xx.	upstream,backend,code
`sowa_nginx_vts_upstream_requests_total{upstream,backend,code="total"}`	Общее количество ответов.	upstream,backend,code
`sowa_nginx_vts_upstream_requests_sent_speed{upstream,backend}`	Скорость отправки на upstram.	upstream,backend
`sowa_nginx_vts_upstream_requests_rcvd_speed{upstream,backend}`	Скорость приема от upstramа.	upstream,backend
`sowa_nginx_vts_upstream_status_down{upstream,backend}`	Статус хоста из upstramа.	upstream,backend

Параметры кеш#

Название	Описание	Основные атрибуты
`sowa_nginx_vts_server_cache_total{host,status="hit"}`	Всего элементов в кеше.	host,status
`sowa_nginx_vts_server_cache_total{host,status="revalidated"}`	Количество ревалидированных элементов кеш.	host,status
`sowa_nginx_vts_server_cache_total{host,status="miss"}`	Количество пропущенных элементов кеш.	host,status
`sowa_nginx_vts_server_cache_total{host,status="bypass"}`	Количество элементов кеш, не отправленных клиенту.	host,status
`sowa_nginx_vts_server_cache_total{host,status="expired"}`	Количество устаревших элементов в кеше.	host,status
`sowa_nginx_vts_server_cache_total{host,status="stale"}`	Количество попаданий в кеш.	host,status
`sowa_nginx_vts_server_cache_total{host,status="scarce"}`	Количество элементов в кеше с истекшем сроком хранения.	host,status
`sowa_nginx_vts_server_cache_total{host,status="updating"}`	Количество обновленных элементов в кеше.	host,status

Метрики rate_limit#

Название	Описание	Размерность	Основные атрибуты
`sowa_nginx_vts_limit_request_passed`	Количество запросов, пропущенных после проверки на лимиты зоны, указанной в параметре.
`sowa_nginx_vts_limit_request_delayed`	Количество запросов, задержанных после проверки на лимиты зоны, указанной в параметре.
`sowa_nginx_vts_limit_request_rejected`	Количество запросов, отклоненных после проверки на лимиты зоны, указанной в параметре.
`sowa_nginx_vts_limit_request_delayed_dry_run`	Количество запросов, которые были бы задержаны после проверки на лимиты зоны, указанной в параметре, но не задержаны, так как задан режим dry_run.
`sowa_nginx_vts_limit_request_rejected_dry_run`	Количество запросов, которые были бы отклонены после проверки на лимиты зоны, указанной в параметре, но не отклонены, так как задан режим dry_run.
`sowa_nginx_vts_limit_request_rate`	Заданное значение rate для зоны.
`sowa_nginx_vts_limit_request_rate_scale`	Шкала (1 - запросы в секунду, 60 - запросы в минуту, 100 - проценты (для cpu/mem)).

Кроме того, все счетчики уровня сервер sowa_nginx_vts_server_ *, описанные выше, имеют аналог sowa_nginx_vts_filter_ *, с аналогичными метриками, но для конкретного сервиса.

Метрики simple_rate_limit#

Название	Описание	Размерность	Основные атрибуты
sowa_nginx_vts_simple_rate_limiter_passed	Общее количество запросов, переданных через данную зону simple rate limiter.
sowa_nginx_vts_simple_rate_limiter_blocked	Общее количество запросов, отклоненных simple rate limiter.
sowa_nginx_vts_simple_rate_limiter_count	Текущее количество запросов в зоне simple rate limiter. Максимальное значение равно лимиту (показатель заполненности зоны)
sowa_nginx_vts_simple_rate_limiter_exceeded	Текущее количество запросов превысивших лимит в зоне simple rate limiter.
sowa_nginx_vts_simple_rate_limiter_rate_scale	Текущая шкала скорости (0-ms,1-s,2-m,3-h,4-d,5-w,6-M,7-y) в ограничителе скорости.
sowa_nginx_vts_simple_rate_limiter_rate_ajusted	Текущая шкала скорости запросов в секунду.

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