Параметр healthcheck_dynamic#

Настройка динамической генерации ответов на запросы о текущем состоянии экземпляра или сервиса, объявленного в конфигурации. Подробно настройка динамической генерации ответов на запросы о текущем состоянии рассмотрена в разделе «Настройка динамической генерации ответа о текущем состоянии экземпляра Platform V SOWA».

Название

Обязательность

Описание

Возможные значения

Значение по умолчанию

initial_state_param_file

Опциональный

Имя файла, содержащего параметры генерации ответа на запрос о состоянии и расположенного в custom каталоге ресурсов. Данные параметры могут использоваться в правилах определения состояния и шаблонах ответов. Значения параметров, содержащихся в файле, используются для начальной инициализации в момент конфигурирования и в дальнейшем могут переопределяться в runtime через вызов опции конфигуратора –set-healthcheck-params @имя файла. Содержимое должно иметь вид <ключ>: <значение>. В дальнейшем, для обращения к параметрам из функциональности генерации ответа, адресация осуществляется как к стандартной переменной, т.е. $<ключ>. Может быть задан только на уровне system/optional/healthcheck_dynamic

Строковое значение

—

manual_state_var_refresh_interval

Опциональный

Частота обновления данных из файла с параметрами в runtime. Если установлено значение 0, обновления данных в runtime не производится. Может быть задан только на уровне system/optional/healthcheck_dynamic

Число с суффиксом: ms (миллисекунды), s (секунды), m (минуты), h (часы), d (дни), w (недели), M (месяцы, 30 дней), y (годы, 365 дней)

—

endpoints

Опциональный

Определяет доступные точки входа для предоставления информации о состоянии данного экземпляра. Каждая точка входа, объявленная в данном параметре, доступна для обращения через порт сервиса c типом main_proxy и сервисов с объявленной секцией listen (кроме случаев, когда в сервисе объявлен собственный параметр healthcheck_dynamic). Каждый элемент перечисления определяет собственные настройки генерации ответа на запрос состояния

Перечисление элементов с настройками генерации ответа

—

endpoints.url

Обязательный

URL для healthcheck-запросов. Указывается как строка, а не регулярное выражение — для поиска полного соответствия и минимального пересечения с основными сервисами

Строковое значение

—

endpoints.disable_access_log

Обязательный

Отключает запись access-логов

true, false

false

endpoints.disable_error_log

Обязательный

Отключает запись error-логов

true, false

false

endpoints.disable_gathering_stats

Обязательный

Отключает сбор статистики

true, false

false

endpoints.upstream_check_type

Обязательный

Условие вычисления комбинированного статуса для нескольких групп апстримов. Используется при вычислении переменных, связанных с доступностью групп апстримов, в том случае если в результате определения привязок их к сервису, их получено несколько. Группа апстримов считается доступной, если в ней хотя бы один сервер доступный; находящейся в состоянии DRAIN, если в ней нет доступных серверов и есть сервера находящиеся в состоянии DRAIN, и группа считается недоступной, если в ней все сервера находятся в состоянии DOWN

ANY_UPSTREAM_UP — если хотя бы одна группа считается доступной, то совокупность групп считается доступной; ALL_UPSTREAM_UP — если все группы апстримов в совокупности считаются доступными, то совокупность считается доступной; ANY_UPSTREAM_UP_OR_DRAIN — если существует хотя бы одна группа не в состоянии down (т.е. или UP или DRAIN), совокупность групп считается доступной; ALL_UPSTREAM_UP_OR_DRAIN — если все группы апстримов находятся в состоянии DRAIN или UP, то совокупность считается доступной

ANY_UPSTREAM_UP_OR_DRAIN

endpoints.response

Обязательный

Параметры генерации ответа

—

—

endpoints.response.pattern_file

Обязательный

Файл шаблона, который будет использован в качестве тела ответа. При добавлении нового профиля данные шаблоны добавляются в профиль и находятся в директории: /sowa/[имя профиля]/common/hc-templates. На основе данных шаблонов можно создавать необходимые файлы и использовать в ресурсах через custom_pattern_file

Строковое значение, например: hc_pattern_default.json

—

endpoints.response.custom_pattern_file

Обязательный

Путь к файлу шаблона (относительно директории с custom ресурсами), который будет использован в качестве тела ответа

Строковое значение, например: templates/hc_schema.json

—

endpoints.response.rules_file

Обязательный

Файл с правилами, описывающий, как заполнять файл шаблона. Подробнее в разделе «Создание файла с правилами»

Строковое значение, например: rules.yml

Файл hc_rules.yml

endpoints.response.content_type

Обязательный

Тип содержимого для заголовка ответа

Строковое значение, например: application/json;charset=UTF-8

—