Установка ПроAPI Структура¶
ПроAPI Структура поставляется со всеми формами ноды Вебмониторэкс версии 3.2 и выше (кроме Debian 11.x, Debian 12.x, Ubuntu 22.04 и RedOS) и автоматически устанавливается при деплое, но по умолчанию не анализирует трафик.
-
Если у вас уже установлена нода Вебмониторэкс, переходите к подключению.
-
Если вы еще не использовали решения Вебмониторэкс, рекомендуем установку Меганоды Вебмониторэкс для автоматического определения версии операционной системы и зависимостей. После установки Меганоды Вебмониторэкс переходите к подключению ПроAPI Структура.
Подключение¶
Для работы с ПроAPI Структура:
-
Добавьте план подписки для ПроAPI Структура: для этого отправьте запрос на sales@webmonitorx.ru.
-
Если вы хотите включить ПроAPI Структура только для определенных приложений, убедитесь, что эти приложения настроены.
Если приложения не настроены, структуры API всех приложений будут сгруппированы в одно дерево.
-
Отправьте запрос на включение анализа трафика с помощью ПроAPI Структура в техническую поддержку Вебмониторэкс. В запросе необходимо передать следующие данные:
- Имя аккаунта вашей компании, зарегистрированного в Консоли управления Вебмониторэкс.
- Название Вычислительного кластера Вебмониторэкс, которое вы используете (RU-Вычислительный кластер).
- Идентификаторы приложений, для которых вы хотите построить структуру API.
После включения ПО начнет анализ трафика ваших приложений и построение структуры API. Построенная структура будет визуализирована в секции ПроAPI Структура в Консоли управления Вебмониторэкс.
Обратите внимание
Если ПроAPI Структура включено, то построение структуры API также будет включено по умолчанию для нового приложения.
Настройка¶
Вы можете включить/выключить анализ трафика в Консоли управления → Настройки → ПроAPI Структура.
Права администратора
Только пользователи со следующими ролями имеют доступ к разделу Настройки → ПроAPI Структура:
- Администратор аккаунта Вебмониторэкс вашей компании
- Глобальный администратор вашего партнера Вебмониторэкс
Включение или выключение существующих приложений¶
Вы можете включить/выключить анализ трафика с помощью ПроAPI Структура для всех или только для выбранных приложений.
Добавление новых приложений¶
При добавлении нового приложения в секции Настройки → Приложения оно автоматически добавляется в список в секции Настройки → ПроAPI Структура. Если ПроAPI Структура включен, построение структуры API будет по умолчанию включено для нового приложения.
Отладка¶
Для просмотра и анализа логов ПроAPI Структура вы можете использовать следующие методы:
-
Если нода установлена из из DEB‑ или RPM‑пакетов: использовать стандартную утилиту journalctl или systemctl внутри инстанса с нодой Вебмониторэкс.
journalctl -u wallarm-appstructure
systemctl status wallarm-appstructure
-
Если нода развернута как Docker‑контейнер: прочитать лог
/var/log/wallarm/appstructure.log
в контейнере. -
Если нода развернута как Ingress‑контроллер Вебмониторэкс: проверить статус пода с контейнерами Tarantool и
wallarm-appstructure
. Под должен находиться в статусе Running.kubectl get po -l app=nginx-ingress,component=controller-wallarm-tarantool
Прочитать логи контейнера с
wallarm-appstructure
:kubectl logs -l app=nginx-ingress,component=controller-wallarm-tarantool -c wallarm-appstructure