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

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

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

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

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

/aggregator/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}/aggregator/health/check' \
  -H 'accept: application/json' \
  -H 'Authorization: Token ${HEALTH_CHECK_ACCESS_KEY}'

где:

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

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

${HEALTH_PORT} - порт для запросов проверки состояния;

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

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

{"version":"5.1","description":"termidesk-aggregator","status":"pass","checks":
	{
	"celery:connectionTest":
		[{"componentId":"celery(common)","componentType":"component","status":"pass"},
			{"componentId":"celery@test(worker)","componentType":"component","status":"pass"}],
	"database:responseTime":
		[{"componentId":"default","componentType":"datastore","observedValue":0.00040602684020996094,"observedUnit":"s","status":"pass"}],
	"messages_broker:connectionTest":
		[{"componentId":"amqp://termidesk:**@localhost:5672/termidesk","componentType":"component","status":"pass"}],
	"fluentd:connectionTest":[],
	"sites:connectionTest":
		[{"componentId":"site2","componentType":"component","status":"pass"},
			{"componentId":"stal","componentType":"component","status":"pass"},
			{"componentId":"еуые-site","componentType":"component","status":"pass"},
			{"componentId":"site1-1","componentType":"component","status":"pass"},
			{"componentId":"site99","componentType":"component","status":"pass"}
		]}
}

/aggregator/health/metrics

GET

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

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

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

где:

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

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

${HEALTH_PORT} - порт для запросов проверки состояния;

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

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

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

# Версия портала «Агрегатор»
version_info{version="5.1"} 1.0
# Версия ОС
system_info{machine="x86_64",os="Linux 6.1.90-1-generic",version="#astra3+ci20 SMP PREEMPT_DYNAMIC Mon Jul 22 14:15:46 UTC 2024"} 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 11.0
# Количество доменов аутентификации
auth_domain_count 4.0
# Количество ферм поставщиков ресурсов
# TYPE farms_count gauge
farms_count 4.0
# Количество узлов
servers_count 4.0
# Количество сайтов
sites_count 4.0