REST API. Доступные команды модуля «health» компонента «Агент виртуального рабочего места»

Доступные команды модуля «health» компонента «Агент виртуального рабочего места»

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

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

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

/health/check

GET

Проверка состояния компонента. 

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

curl -k -X 'GET' \
  'https://${HOSTNAME}:${HEALTH_PORT}/${UUID}/health/check' \
  -H 'accept: application/json'

где:

${HOSTNAME} - сетевой адрес или полное доменное имя узла компонента «Агент виртуального рабочего места»;

${PORT} - порт компонента «Агент виртуального рабочего места». Значение порта можно получить из журнала работы компонента «Клиент»;

${UUID} - случайное значение, генерируемое компонентом «Агент виртуального рабочего места». Значение можно получить из журнала работы компонента «Клиент».

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

{
  "status": "pass",
  "version": "5.1.0.24177",
  "output": "",
  "description": "Termidesk Agent"
}

/health/metrics

-

Возвращает список метрик узла компонента. По умолчанию получение/обновление метрик происходит с интервалом в 3 секунды, однако через REST API получить метрики можно в любой момент.

При этом интервал получения и обновления метрик можно изменить через переменную окружения TDSK_METRIC_INTERVAL на узле компонента «Агент виртуального рабочего места».

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

сurl -k https://${HOSTNAME}:${PORT}/${UUID}/health/metrics

где:

${HOSTNAME} - сетевой адрес или полное доменное имя узла компонента «Агент виртуального рабочего места»;

${PORT} - порт компонента «Агент виртуального рабочего места». Значение порта можно получить из журнала работы компонента «Клиент»;

${UUID} - случайное значение, генерируемое компонентом «Агент виртуального рабочего места». Значение можно получить из журнала работы компонента «Клиент».

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

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

# Версия компонента «Агент виртуального рабочего места»
version_info{version="5.1.0.24176"} 1.0
# Версия ОС
system_info{comp_name="17sls-a17o-001",machine="x86_64",os_name="Linux 5.10.176-1-hardened",version="#astra1 SMP Thu Mar 30 16:11:58 UTC 2023"} 1.0
# Общая загрузка процессора в процентах
cpu_total_percent 0.8
# Общий размер физической памяти в байтах
virtual_memory_total_bytes 2074025984
# Размер доступной физической памяти в байтах
virtual_memory_available_bytes 1323507712
# Размер используемой физической памяти в байтах
virtual_memory_used_bytes 550551552
# Размер свободной физической памяти в байтах
virtual_memory_free_bytes 80166912
# Период в секундах, в течение которого система функционирует без проблем
uptime_seconds 77650
# Общий размер диска в байтах
disk_total_bytes 15742214144
# Используемый размер диска в байтах
disk_used_bytes 12199178240
# Свободный размер диска в байтах
disk_free_bytes 2721058816
# Количество операций чтения с диска
disk_read_count 48247
# Количество операций записи на диск
disk_write_count 49692
# Число прочитанных с диска байт
disk_read_bytes 1661751296
# Число записанных на диск байт
disk_write_bytes 1661751296
# Информация о состоянии компонента «Агент виртуального рабочего места». А - активен, I - простаивает/неактивен
agent_info{version="5.1.0.24176", status="A"} 1.0
# Состояние сессии - активна (А), отключена (D), ошибка (E), бездействует или неактивна (I)
sessions_info{1="I"} 1.0