Healthchecks

Введение

Каждый модуль системы Accelera имеет механизм проверки готовности (readiness) и работоспособности (liveness).

Проверка готовности (readiness)
Выполняются для определения готовности приложения к работе/приему задач. Проверяется доступность основных компонент.

Проверка работоспособности (liveness)
Выполняется во время работы приложения чтобы определить, работает ли приложение и убедиться, что оно не находится в состоянии, когда контейнер все еще работает, но приложение не может функционировать. Проверяется доступность основных компонент, наличие доступов к конечным узлам и тд.

Настройка

Для активации healthcheck интерфейса необходимо указать переменную среды ENABLE_METRICS=true.

Параметр активирует REST интерфейс для запроса heatlcheck. Номер порта по умолчанию для каждого модуля - 3010. Если вам нужно указать собственный порт задайте его в переменной среды METRICS_PORT.

Интерфейс

Каждый модуль имеет REST-api для получения информации о готовности/доступности системы.

Модули обрабатывают следующие endpoint:

• Readiness endpoint: http://hostname:3010/ready Пример ответа:

{
  "status": "UP",
  "checks": [
    {
      "name": "Operational DB availability",
      "state": "UP",
      "data": {
        "reason": ""
      }
    }
  ]
}

• Liveness endpoint: http://hostname:3010/live Пример ответа:

{
  "status": "UP",
  "checks": [
    {
      "name": "Operational DB connection alive",
      "state": "UP",
      "data": {
        "reason": ""
      }
    }
  ]
}

• Health endpoint: http://hostname:3010/health Комплексная проверка, включающая в себя как readiness так и liveness пробы. Пример ответа:

{
  "status": "UP",
  "checks": [
    {
      "name": "Operational DB availability",
      "state": "UP",
      "data": {
        "reason": ""
      }
    },
    {
      "name": "Operational DB connection alive",
      "state": "UP",
      "data": {
        "reason": ""
      }
    }
  ]
}

Набор проверок индивидуален для каждого модуля и перечислен в таблице ниже.

Проверки в модулях

flows_backoffice

readiness пробы

liveness пробы

bulk_worker

readiness пробы

liveness пробы

flows_frontend

Данный модуль - единственный, который имеет одну проверку и на readiness и на liveness, по сути давая понять, что веб-сервер внутри контейнера жив и работоспособен.

пробы

GET /health
Response:
200 OK {"status":"UP"}

flows_timers

readiness пробы

liveness пробы

flows_actions

readiness пробы

liveness пробы

flows_engine

readiness пробы

liveness пробы

flows_segments

readiness пробы

liveness пробы

sql_adapter

readiness пробы

liveness пробы