SOWA Monitor

Материал из Документация Ключ-АСТРОМ

SOWA Monitor

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

Идентификатор: ru.ruscomtech.sowa-monitor

Возможности

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

  • чтение метрик профилей SOWA;
  • сбор состояния сервисов;
  • расчёт количества дней до окончания срока действия сертификатов;
  • преобразование логических значений true и false в числовые значения;
  • добавление источника, профиля, сервиса и имени метрики в измерения.

Расширение запускается локально на хосте и не устанавливает сетевые подключения к SOWA.

Требования

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

  • файл статистики создаётся на том же хосте, на котором запускается расширение;
  • файл сохранён в кодировке UTF-8;
  • для файла используется абсолютный путь;
  • процесс ЕдиногоАгента или EEC имеет права на чтение файла;
  • каждая метрика записывается отдельной строкой в поддерживаемом формате.

Формат файла статистики

Каждая строка должна иметь следующий формат:

<источник> <область_метрики>[<объект>,<метрика>] <значение>

Пример:

sowa-host-01 sowa.profile[MainProfile,availability] 1
sowa-host-01 sowa.profile[MainProfile,errors] 0
sowa-host-01 sowa.profile.certificate[api.example.local,valid_throw] 1798761600
sowa-host-01 sowa.profile.service.http[frontend,response_time] 125.7
Элемент Описание
источник Имя системы или хоста, сформировавшего метрику.
область_метрики Тип метрики: sowa.profile, sowa.profile.certificate или область, начинающаяся с sowa.profile.service.
объект Имя профиля, сертификата или сервиса.
метрика Имя показателя.
значение Число либо логическое значение true или false.

Значение true преобразуется в 1, а false — в 0.

Для метрики valid_throw необходимо передавать дату окончания действия сертификата в виде временной метки Unix в секундах. Расширение преобразует её в количество оставшихся дней.

Пустые строки и строки неподдерживаемого формата пропускаются.

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

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

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

Параметр Описание Значение по умолчанию
Stats file path Абсолютный путь к файлу статистики SOWA. /tmp/zabbix/all_stat.data
Include sowa.profile.service* metrics Включает сбор областей метрик, начинающихся с sowa.profile.service. Отключено

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

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

Метрика Описание Единица измерения
sowa.zabbix.profile.value Значение метрики профиля SOWA. Количество
sowa.zabbix.profile.certificate.value Значение метрики сертификата, включая количество дней до окончания его действия. Дни
sowa.zabbix.profile.service.value Значение метрики сервиса SOWA. Количество

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

На контролируемом хосте проверьте доступность файла:

test -r /tmp/zabbix/all_stat.data

После активации конфигурации убедитесь, что в Ключ-АСТРОМ поступают метрики с префиксом sowa.zabbix.

Успешное сохранение конфигурации не подтверждает доступность файла. Если метрики отсутствуют, проверьте журнал выполнения расширения.

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

Проблема Возможная причина и решение
Метрики не поступают Проверьте путь к файлу и права процесса ЕдиногоАгента или EEC на его чтение.
Обрабатываются не все строки Проверьте формат строк, наличие запятой между именем объекта и метрики, а также числовой формат значения.
Не поступают метрики сервисов Включите параметр Include sowa.profile.service* metrics.
Неверно рассчитан срок действия сертификата Передавайте для метрики valid_throw временную метку Unix в секундах, а не в миллисекундах.

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

Версия Изменения
0.1.0
  • Добавлен локальный сбор метрик профилей SOWA из файла статистики.
  • Добавлен сбор метрик сервисов.
  • Добавлен расчёт количества дней до окончания срока действия сертификатов.
  • Добавлена поддержка логических и числовых значений.