REST API. Доступные команды модуля «health» компонента «Сессионный агент»

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

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

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

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

/health/check

GET

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

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

curl -X 'GET' \
  'http://${HOSTNAME}:${HEALTH_PORT}/health/check' \
  -H 'accept: application/json' \
  -H 'Authorization: Token ${HEALTH_CHECK_ACCESS_KEY}'

где:

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

${HEALTH_PORT} - порт для запросов проверки состояния, для компонента «Сессионный агент» - 31000;

${HEALTH_CHECK_ACCESS_KEY} - токен, определенный в переменной HEALTH_CHECK_ACCESS_KEY конфигурационного файла «Сессионного агента».

Сразу после установки токен HEALTH_CHECK_ACCESS_KEY имеет значение None (не задано), в этом случае проверка токена не производится и запрос можно выполнять без конструкции Authorization: Token.

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

{
  "status": "pass",
  "version": "5.0.0.24118",
  "output": "",
  "description": "termidesk-session-agent"
}

/health/metrics

GET

Возвращает список метрик узла компонента. 

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

curl -X 'GET' \
  'http://${HOSTNAME}:${HEALTH_PORT}/health/metrics' \
  -H 'accept: application/json' \
  -H 'Authorization: Token ${METRICS_ACCESS_KEY}'

где:

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

${HEALTH_PORT} - порт для запросов проверки состояния, для компонента «Сессионный агент» - 31000;

${METRICS_ACCESS_KEY} - токен, определенный в переменной METRICS_ACCESS_KEY конфигурационного файла «Сессионного агента».

Сразу после установки токен METRICS_ACCESS_KEY имеет значение None (не задано), в этом случае проверка токена не производится и запрос можно выполнять без конструкции Authorization: Token. 

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

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

# Версия компонента
version_info{version="5.0.24152"} 1.0
# Версия ОС
system_info{machine="x86_64",os="Linux 5.15.0-33-generic",version="#astra2+ci96 SMP Fri Oct 28 18:23:37 UTC 2022"} 1.0
# Общая загрузка процессора в процентах
cpu_total_percent 4.0
# Общее использование физической памяти в процентах
virtual_memory_total_percent 70.3
# Общий размер физической памяти в байтах
virtual_memory_total_bytes 2.070183936e+09
# Размер доступной физической памяти в байтах
virtual_memory_available_bytes 6.1464576e+08
# Размер используемой физической памяти в байтах
virtual_memory_used_bytes 1.26932992e+09
# Размер свободной физической памяти в байтах
virtual_memory_free_bytes 3.23608576e+08
# Общий размер диска в байтах
disk_total_bytes 1.9994066944e+010
# Используемый размер диска в байтах
disk_used_bytes 1.005756416e+010
# Свободный размер диска в байтах
disk_free_bytes 8.897261568e+09
# Период в секундах, в течение которого система функционирует без проблем
uptime_seconds 2.256339795133114e+06
# Количество операций чтения с диска
disk_read_count 271249.0
# Количество операций записи на диск
disk_write_count 865272.0
# Число прочитанных с диска байт
disk_read_bytes 7.215997952e+09
# Число записанных на диск байт
disk_write_bytes 9.192820736e+09
# Состояние сессии - активна (А), бездействует или любое другое состояние (I)
sessions_info 1.0