Сбор статистики

Общие сведения о сборе статистики

Для сбора статистики и получения метрик Шлюза настраивается управляющий сервер Шлюза Termidesk Connect.

Настройка управляющего сервера Шлюза выполняется одним из способов:

Настройка управляющего сервера Шлюза осуществляется через объект gw (см. подраздел Объект gw).

Настройка управляющего сервера Шлюза из CLI

Для настройки управляющего сервера Шлюза используются команды:

  • указание существующего IP-адреса для получения статистики Шлюза:

set gw mgt listen ip <IP-адрес>

  • указание номера порта для получения статистики Шлюза:

set gw mgt listen port <порт>

  • указание существующего Серверного SSL-Профиля:

set gw mgt ssl-profile-id <SSL-Профиль>

  • указание пути для получения статистики Шлюза (по умолчанию – /api/health):

set gw mgt path <путь>

  • указание токена доступа для получения статистики Шлюза:

set gw mgt token <токен>

Для интеграции с Termidesk (Termidesk VDI) значение может быть получено из параметра HEALTH_CHECK_ACCESS_KEY, определенного в конфигурационном файле /etc/opt/termidesk-vdi/termidesk.conf узла компонента «Универсальный диспетчер» Termidesk.

Так же токен может быть получен из Хранилища секретов. Пример значения параметра:

  • kv://secret/gw#token – для kv версии 1;

  • kv://secret/data/gw#token – для kv версии 2.

  • указание пути для получения метрик Шлюза (по умолчанию – /api/health/metrics):

set gw mgt metrics path <путь>

  • указание токена доступа для получения метрик Шлюза:

set gw mgt metrics token <токен>

Для интеграции с Termidesk значение может быть получено из параметра METRICS_ACCESS_KEY, определенного в конфигурационном файле /etc/opt/termidesk-vdi/termidesk.conf узла компонента «Универсальный диспетчер» Termidesk.

Так же токен может быть получен из Хранилища секретов. Пример значения параметра:

  • kv://secret/gw#token – для kv версии 1;

  • kv://secret/data/gw#token – для kv версии 2.

  • применение заданных настроек:

commit

  • сохранение настроек:

write

Настройка управляющего сервера Шлюза из WUI

Для отображения настроек управляющего сервера Шлюза следует перейти «Настройки – Termidesk Шлюз – Сбор статистики».

Основные параметры настроек управляющего сервера Шлюза приведены в таблице (см. таблицу Основные параметры настроек управляющего сервера Шлюза).

Таблица 1. Основные параметры настроек управляющего сервера Шлюза
Параметр Описание

«Путь»

Путь для получения статистики Шлюза

«IP-адрес»

IP-адрес для получения статистики Шлюза

Для изменения настроек управляющего сервера Шлюза следует нажать экранную кнопу [Изменить].

Далее заполнить данные, перечисленные в столбце «Параметр» следующей таблицы(см. таблицу Основные параметры изменения настроек управляющего сервера Шлюза).

Таблица 2. Основные параметры изменения настроек управляющего сервера Шлюза
Параметр Описание

«IP-адрес»

Выбор IP-адреса для получения статистики Шлюза

«Порт»

Порт для получения статистики Шлюза

«TLS Профиль»

Серверный SSL-Профиль

«Метрики»

Путь для получения статистики Шлюза.

Значение по умолчанию: «/api/health»

«OpenMetrics»

Путь для получения метрик Шлюза.

Значение по умолчанию: «/api/health/metrics»

«Токен получения статистики Шлюза»

Токен доступа для получения статистики Шлюза.

Так же токен может быть получен из Хранилища секретов. Пример значения параметра:

  • «kv://secret/gw#token» – для kv версии 1;

  • «kv://secret/data/gw#token» – для kv версии 2

«Токен получения OpenMetrics»

Токен доступа для получения метрик Шлюза.

Так же токен может быть получен из Хранилища секретов. Пример значения параметра:

  • «kv://secret/gw#token» – для kv версии 1;

  • «kv://secret/data/gw#token» – для kv версии 2

Для удаления настроек управляющего сервера Шлюза нужно:

  • нажать экранную кнопку [Удалить];

  • подтвердить удаление, нажав экранную кнопку [Удалить] на запрос об удалении.

Объект gw

Доступные команды объекта gw приведены в таблице (см. таблицу Доступные команды объекта gw).

Таблица 3. Доступные команды объекта gw
Команда Описание

Создание Шлюза

set gw server <имя>

Имя Шлюза

Настройка Шлюза

set gw server <имя> checktoken <значение>

Настройка взаимодействия с компонентом «Универсальный диспетчер» Termidesk.

Для параметра checktoken могут быть указаны следующие параметры:

  • ipset-id – IP-Фонд, используемый для взаимодействия с компонентом «Универсальный диспетчер» Termidesk;

  • ssl-profile-id – Клиентский SSL-Профиль (по умолчанию – backend-default);

  • url – URL, поддерживаемый компонентом «Универсальный диспетчер» Termidesk с ролью «Портал пользователя» для обслуживания API-запросов по валидации подключений, запрашиваемых через Шлюз

    Следует использовать актуальные значения версий API для соответствующей версии компонента «Универсальный диспетчер» Termidesk.

set gw server <имя> description <значение>

Комментарий для сервера

set gw server <имя> rabbitmq <значение>

Настройка клиента RabbitMQ.

Для параметра rabbitmq могут быть указаны следующие параметры:

  • exchange – координатор маршрутизации сообщений, определенный в RabbitMQ. Отвечает за маршрутизацию сообщений в разные очереди;

  • ipset-id – IP-Фонд для взаимодействия с RabbitMQ;

  • pass – пароль пользователя для подключения к серверу RabbitMQ;

  • refreshtime – интервал (в секундах) обновления регистрационной информации (URL и другие данные) Шлюза (значение от 10 до 100000, по умолчанию – 60);

  • routingkey – ключ маршрутизации RabbitMQ, используемый для маршрутизации задачи в очереди (по умолчанию – termidesk_appnode);

  • single – способ передачи данных (по умолчанию – false). Возможные значения:

    • true – передача данных до первого подтверждения;

    • false – передача данных по циклу (бесконечно);

  • ssl-profile-id – Клиентский SSL-Профиль (по умолчанию – backend-default);

  • timeout – время (в секундах) ожидания ответа от сервера RabbitMQ (значение от 1 до 60, по умолчанию – 10);

  • url – URL-адрес для подключения к серверу RabbitMQ;

  • user – имя пользователя для подключения к серверу RabbitMQ

set gw server <имя> ssl-profile-id <значение>

Серверный SSL-Профиль

set gw server <имя> tcp-downstream <значение>

Настройка переподключения Шлюза к рабочим местам Termidesk.

Для параметра tcp-downstream могут быть указаны следующие параметры:

  • ipset-id – IP-Фонд для взаимодействия с рабочим местом Termidesk;

  • reconnect – количество разрешенных переподключений сессии пользователя (значение от 0 до 10, по умолчанию – 0);

    Разные протоколы удаленного доступа могут требовать разных значений параметра:

    • для RDP нужно использовать ненулевое значение, поскольку некоторые функции (например, перенаправление USB в гостевую ОС рабочего места по протоколу RDP) могут требовать переподключения;

    • для TERA и SPICE нужно использовать значение по умолчанию (0).

  • ssl-profile-id – Клиентский SSL-Профиль (по умолчанию – backend-default)

set gw server <имя> tera-udp <значение>

Настройка поддержки протокола UDP для протокола TERA на Шлюзе.

Для параметра tera-udp могут быть указаны следующие параметры:

  • src ip – IP-адрес источника, т.е. адрес, с которого Шлюз устанавливает UDP-соединение с рабочим местом Termidesk;

    Для параметра src ip значение 0.0.0.0 указывает на использование всех IP-адресов.

  • src port – порт источника (по умолчанию – 0);

  • src vrf – VRF источника (по умолчанию – default);

  • vip ip – IP-адрес Виртуального Сервера для TERA;

    Параметр vip ip может принимать любое значение, т.е. IP-адрес может отличаться от IP-адреса Шлюза или может быть таким же. Указывается IP-адрес именно Виртуального Сервера, если Шлюз скрывается за Виртуальным Сервером.

  • vip port – порт Виртуального Сервера для TERA (по умолчанию – 443);

  • vrf – VRF для TERA (по умолчанию – default)

set gw server <имя> vip <значение>

Настройка Виртуального Сервера.

Для параметра vip могут быть указаны следующие параметры:

  • ip – IP-адрес Виртуального Сервера;

  • port – порт Виртуального Сервера

set gw server <имя> vrf <значение>

Имя VRF (по умолчанию – default)

set gw server <имя> websocket <значение>

Настройка подключения к компоненту «Клиент» Termidesk.

Для параметра websocket могут быть указаны следующие параметры:

  • pingtimeout – время ожидания (в секундах) соединения (значение от 0 до 100000, по умолчанию – 30)

Настройка клиента RabbitMQ

set gw rabbitmq exchange <значение>

Координатор маршрутизации сообщений, определенный в RabbitMQ. Отвечает за маршрутизацию сообщений в разные очереди

set gw rabbitmq ipset-id <значение>

IP-Фонд для взаимодействия с RabbitMQ

set gw rabbitmq pass <значение>

Пароль пользователя для подключения к серверу RabbitMQ.

Так же пароль пользователя может быть получен из Хранилища секретов

set gw rabbitmq refreshtime <значение>

Интервал (в секундах) обновления регистрационной информации (URL и другие данные) Шлюза (значение от 10 до 100000, по умолчанию – 60)

set gw rabbitmq routingkey <значение>

Ключ маршрутизации RabbitMQ, используемый для маршрутизации задачи в очереди (по умолчанию – termidesk_appnode)

set gw rabbitmq single <значение>

Способ передачи данных (по умолчанию – false).

Возможные значения:

  • true – передача данных до первого подтверждения;

  • false – передача данных по циклу (бесконечно)

set gw rabbitmq ssl-profile-id <значение>

Клиентский SSL-Профиль (по умолчанию – backend-default)

set gw rabbitmq timeout <значение>

Время (в секундах) ожидания ответа от сервера RabbitMQ (значение от 1 до 60, по умолчанию – 10)

set gw rabbitmq url <значение>

URL-адрес для подключения к серверу RabbitMQ

set gw rabbitmq user <значение>

Имя пользователя для подключения к серверу RabbitMQ.

Так же имя пользователя может быть получено из Хранилища секретов

Настройка управляющего сервера Шлюза

set gw mgt listen <значение>

Настройка прослушивания входящих подключений.

Для параметра listen могут быть указаны следующие параметры:

  • ip – IP-адрес прослушивания входящих подключений;

  • port – порт прослушивания входящих подключений

set gw mgt metrics <значение>

Настройка получения метрик Шлюза.

Для параметра metrics могут быть указаны следующие параметры:

  • path – путь для получения метрик Шлюза (по умолчанию – /api/health/metrics);

  • token – токен доступа для получения метрик Шлюза (так же токен может быть получен из Хранилища секретов)

    Для интеграции с Termidesk значение может быть получено из параметра METRICS_ACCESS_KEY, определенного в конфигурационном файле /etc/opt/termidesk-vdi/termidesk.conf узла компонента «Универсальный диспетчер» Termidesk.

set gw mgt path <значение>

Путь для получения статистики Шлюза (по умолчанию – /api/health)

set gw mgt ssl-profile-id <значение>

Серверный SSL-Профиль

set gw mgt token <значение>

Токен доступа для получения статистики Шлюза.

Для интеграции с Termidesk значение может быть получено из параметра HEALTH_CHECK_ACCESS_KEY, определенного в конфигурационном файле /etc/opt/termidesk-vdi/termidesk.conf узла компонента «Универсальный диспетчер» Termidesk.

Так же токен может быть получен из Хранилища секретов