REST API. Доступные команды диспетчера. Health

Доступные команды модуля «health»

Доступные администратору URL-команды перечислены в таблице.

Перечень URL-команд модуля «health»

URL-командаТипОписание

/api/health/check

GET

Проверка состояния сервера. Собираются общие показатели и набор числовых метрик. 

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

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

Для разных конфигураций системы один и тот же показатель в абсолютном выражении может соответствовать состоянию и «PASS», и «FAIL».

Формат запроса:

curl --insecure -v -s -X 'GET' \
  'https://${HOSTNAME}:${HEALTH_PORT}/api/health/check' \
  -H 'accept: application/json' \
  -H 'Authorization: Token ${HEALTH_CHECK_ACCESS_KEY}'

где:

--insecure - отключение проверки валидности сертификатов. Выполнение запроса без использования проверки SSL допустимо только на тестовых стендах. В производственной среде необходимо установить валидные сертификаты;

${HOSTNAME} - сетевой адрес или полное доменное имя узла;

${HEALTH_PORT} - порт для запросов проверки состояния. По умолчанию используется порт веб-сервера, 443;

${HEALTH_CHECK_ACCESS_KEY} - токен, определенный в переменной HEALTH_CHECK_ACCESS_KEY файла /etc/opt/termidesk-vdi/termidesk.conf

/api/health/metrics

GET

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

Формат запроса:

curl --insecure -v -s -X 'GET' \
  'https://${HOSTNAME}:${HEALTH_PORT}/api/health/metrics' \
  -H 'accept: application/json' \
  -H 'Authorization: Token ${METRICS_ACCESS_KEY}'

где:

--insecure - отключение проверки валидности сертификатов. Выполнение запроса без использования проверки SSL допустимо только на тестовых стендах. В производственной среде необходимо установить валидные сертификаты;

${HOSTNAME} - сетевой адрес или полное доменное имя узла;

${HEALTH_PORT} - порт для запросов проверки состояния. По умолчанию используется порт веб-сервера, 443;

${METRICS_ACCESS_KEY} - токен, определенный в переменной METRICS_ACCESS_KEY файла /etc/opt/termidesk-vdi/termidesk.conf.

Информацию по всем возвращаемым значениям можно получить в документации библиотеки psutil на сайте: https://psutil.readthedocs.io/en/latest.

Вид возвращаемого списка метрик:

# Версия компонента
version_info{version="5.1-dev-HEAD-20240614064304-c1d6651db"} 1.0
# Версия ОС
system_info{machine="x86_64",os="Linux 5.10.190-1-hardened",version="#astra1+ci6 SMP Fri Oct 6 14:47:06 UTC 2023"} 1.0
# Период в секундах, в течение которого система функционирует без проблем
uptime_seconds 66686.97834658623
# Общая загрузка процессора в процентах
cpu_total_percent 4.8
# Общее использование физической памяти в процентах
virtual_memory_total_percent 40.5
# Количество операций чтения с диска
disk_read_count 68201.0
# Количество операций записи на диск
disk_write_count 729848.0
# Число прочитанных с диска байт
disk_read_bytes 2.094142464e+09
# Число записанных на диск байт
disk_write_bytes 7.54249728e+09
# Общий размер физической памяти в байтах
virtual_memory_total_bytes 4.117311488e+09
# Размер доступной физической памяти в байтах
virtual_memory_available_bytes 2.447736832e+09
# Размер используемой физической памяти в байтах
virtual_memory_used_bytes 1.303724032e+09
# Размер свободной физической памяти в байтах
virtual_memory_free_bytes 3.78679296e+08
# Общий размер диска в байтах
disk_total_bytes 1.5742214144e+010
# Используемый размер диска в байтах
disk_used_bytes 1.4512279552e+010
# Свободный размер диска в байтах
disk_free_bytes 4.07957504e+08
# Количество авторизованных пользователей в портале пользователя
user_session_count 1.0
# Количество авторизованных администраторов в портале администратора
admin_session_count 17.0
# Количество сеансов пользователей РМ
VM_users_sessions{type="in_use"} 1.0
VM_users_sessions{type="vacant"} 4.0
# Количество сеансов пользователей терминальных сессий
RDS_STAL_users_sessions{type="in_use"} 1.0
RDS_STAL_users_sessions{type="vacant"} 0.0
# Общее количество виртуальных машин
total_vms 48.0
# Количество виртуальных машин с ошибкой запуска
failed_to_start_vms 38.0
# Количество зависших виртуальных машин
stuck_vms 0.0
# Количество незарегистрированных на «Универсальном диспетчере» «Агентов»
unregistered_agents 41.0