Пaраметр 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 не производится.

Тип значения: число с суффиксом:
- ms - миллисекунды;
- s - секунды;
- m - минуты;
- h - часы;
- d - дни;
- w - недели;
- M - месяцы, 30 дней;
- y - годы, 365 дней.
Может быть задан только на уровне system/optional/healthcheck_dynamic
endpoints

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

Каждый элемент перечисления определяет собственные настройки генерации ответа на запрос состояния и содержит следующие параметры:

Обязательные параметры:
- url
  
  В значении параметра определяется url для healthcheck-запросов. Указывается как строка, а не регулярное выражение — для поиска полного соответствия и минимального пересечения с основными сервисами.
- disable_access_log
  
  Отключает запись access-логов.
  
  Тип параметра:
  - true;
  - false.
  Значение по умолчанию:
```
disable_access_log: false
```
- disable_error_log
  
  Отключает запись error-логов.
  
  Тип параметра:
  - true;
  - false.
  Значение по умолчанию:
```
disable_error_log: false
```
- disable_gathering_stats
  
  Отключает сбор статистики.
  
  Тип параметра:
  - true;
  - false.
  Значение по умолчанию:
```
disable_gathering_stats: false  
```
- 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
- response
  
  Параметры генерации ответа.
  - pattern_file
    
    В значении параметра указывается файл шаблона, который будет использован в качестве тела ответа.
    pattern_file: hc_pattern_default.json
    При добавлении нового профиля данные шаблоны добавляются в профиль и находятся в директории: /sowa/[имя профиля]/common/hc-templates. На основе данных шаблонов можно создавать необходимые файлы и использовать в ресурсах через custom_pattern_file.
    
    Возможные типы параметра:
    - pattern_file: hc_pattern_default.json.
    По умолчанию: не имеет значения по умолчанию.
  - custom_pattern_file
    
    В значении параметра указывается путь к файлу шаблона (относительно директории с custom ресурсами), который будет использован в качестве тела ответа.
    custom_pattern_file: templates/hc_schema.json
    Тип параметра: строковое значение.
    
    По умолчанию: не имеет значения по умолчанию.
  - rules_file
    
    В значении параметра задается файл с правилами, описывающий, как заполнять файл шаблона. По умолчанию — файл правил из системных ресурсов.
    rules_file: rules.yml
    Подробнее в разделе «Создание файла с правилами».
    
    Тип параметра: строковое значение.
    
    По умолчанию: Файл hc_rules.yml.
    - content_type
      
      В значении параметра определяется тип содержимого для заголовка ответа.
      content_type: application/json;charset=UTF-8
      Тип параметра: строковое значение.
      
      По умолчанию: не имеет значения по умолчанию.