Тип сервиса HealthCheck#

В контексте service объявляется тип сервиса, соответствующий service_healthcheck:

service:
  service_healthcheck:

id

Обязательный параметр. Идентификатор сервиса в контексте всего профиля. Используется, например, в названии директории и других системных файлах, хранящих информацию о сервисе.

Значение параметра id должно быть уникальным.

Идентификатор может быть строкой, числом, или их комбинацией. В качестве разделителя слов необходимо использовать знак нижнее подчеркивание «_».

Количество сервисов не ограничено конфигуратором явно.
```
- id: 1
  ...
- id: my_service_one
  ...
```
Тип параметра: текстовое значение.

По умолчанию: не имеет значения по умолчанию.
name

Технологическое название сервиса, используемое для идентификации сервиса в логах транзакций.

Значение параметра name должно быть уникальным.

Обязательно в случае:
```
optional:
  event_hook:
    ...
```
Тип параметра: строковое значение.

По умолчанию: не имеет значения по умолчанию.
profile_version

В значении параметра определяется версия профиля данного сервиса.

Тип параметра: текстовое значение.

По умолчанию: не имеет значения по умолчанию.
description

Параметр предназначен для хранения строки с описанием сервиса.

Значение параметра description не является уникальным.

Тип параметра: текстовое значение.

По умолчанию: не имеет значения по умолчанию.
listen

Параметр listen является обязательным для сервисов типа service_main_proxy и service_healthcheck. Для сервисов иных типов параметр listen опционален.

В случае, если параметр listen не указан (имеется ввиду наличие данного параметра в сервисе типа service_main_proxy и отсутствие в сервисах иных типов), для взаимодействия между сервисами используются unix-сокеты.

Последовательность, включающая в себя параметры, описанные в разделе Параметр listen.

Тип параметра: последовательность параметров и их значения.

По умолчанию: не имеет значения по умолчанию.
healthcheck_dynamic - группа параметров healthcheck_dynamic предназначена для настройки динамической генерации ответов на запросы о текущем состоянии экземпляра или сервиса, объявленного в конфигурации.

Группа параметров, описанных в разделе Пaраметр healthcheck_dynamic.

Возможные значения: последовательность параметров и их значения.

По умолчанию: не имеет значения по умолчанию.
filters

Группа, включающая в себя следующие параметры:
- фильтр modsecurity — позволяет проверить download/upload трафик на наличие угроз (например sql-injection), содержащихся в методе, заголовках, теле и др.;
- фильтр icap — позволяет проверить download/upload трафик на наличие вирусов. Проверка на вирусы осуществляется путем отправки вложения внешнему антивирусу.
Тип параметра: группа параметров и их значения.

По умолчанию: не имеет значения по умолчанию.
allowed_queries

Группа параметров, описанных в разделе «Параметр allowed_queries», используемых для указания разрешенных методов запроса и параметров запроса.

Тип параметра: группа параметров и их значения.

По умолчанию: значения группы задаются пользователем.`
optional

Возможные значения: последовательность параметров и их значения.

По умолчанию: не имеет значения по умолчанию.
- opentelemetry
  
  Секция параметров телеметрии.
  
  Секция, включающая в себя параметры, рассмотренные в разделе «Параметр opentelemetry_tracing».
  
  Тип параметра: секция параметров и их значения.
  
  По умолчанию: значения группы задаются пользователем.
- log_level
  
  В значении параметра переопределяется уровень логирования для сервиса.
  
  Тип параметра:
  - debug;
  - info;
  - notice;
  - warn;
  - error;
  - crit;
  - alert;
  - off.
  По умолчанию: Значение параметра наследуется от значения в system.
- group_access_log
  
  В значении параметра указывается, группировать или нет access журналы по кодам состояния (2xx, 3xx, 4xx, 5xx, 404, 413, 429, 499, 500).
  
  Тип параметра: логическое значение:
  - true;
  - false.
  По умолчанию:
```
group_access_log: false
```
- log_format
  
  В значении параметра указывается формат логирования.
  
  Тип параметра: текстовое значение.
  
  По умолчанию: значение по умолчанию отсутствует.
- client_header_timeout
  
  В значении параметра указывается таймаут при чтении заголовка запроса клиента.
  
  Тип параметра: текстовое значение с суффиксом:
  - ms — миллисекунда;
  - s — секунда;
  - m — минута;
  - h — час;
  - d — день;
  - w — неделя;
  - M — месяц (30 дней);
  - y — год (365 дней).
  По умолчанию:
```
client_header_timeout: 60s
```
- client_body_timeout
  
  В значении параметра указывается таймаут при чтении тела запроса клиента.
  
  Тип параметра: текстовое значение с суффиксом:
  - ms — миллисекунда;
  - s — секунда;
  - m — минута;
  - h — час;
  - d — день;
  - w — неделя;
  - M — месяц (30 дней);
  - y — год (365 дней).
  По умолчанию:
```
client_body_timeout: 60s
```
- keepalive_timeout
  
  В значении параметра указывается таймаут, в течение которого keep-alive соединение с клиентом не будет закрыто со стороны сервера.
  
  Тип параметра: текстовое значение с суффиксом:
  - ms — миллисекунда;
  - s — секунда;
  - m — минута;
  - h — час;
  - d — день;
  - w — неделя;
  - M — месяц (30 дней);
  - y — год (365 дней).
  По умолчанию:
```
keepalive_timeout: 75s
```
- keepalive_time - ограничивает максимальное время, в течение которого могут обрабатываться запросы в рамках keep-alive соединения. По достижении заданного времени соединение закрывается после обработки очередного запроса.
  
  Возможные значения: текстовое значение с суффиксом:
  - ms — миллисекунда;
  - s — секунда;
  - m — минута;
  - h — час;
  - d — день;
  - w — неделя;
  - M — месяц (30 дней);
  - y — год (365 дней).
  По умолчанию: 1h.
- keepalive_requests
  
  В значении параметра указывается максимальное число запросов, которые можно сделать по одному keep-alive соединению.
  
  Тип параметра: целочисленное значение.
  
  По умолчанию:
```
keepalive_requests: 10000
```
- send_timeout_to_client
  
  В значении параметра указывается таймаут при передаче ответа клиенту.
  
  Таймаут устанавливается не на всю передачу ответа, а только между двумя операциями записями.
  
  Если по истечении этого времени клиент ничего не примет, соединение будет закрыто.
  
  Тип параметра: текстовое значение с суффиксом:
  - ms — миллисекунда;
  - s — секунда;
  - m — минута;
  - h — час;
  - d — день;
  - w — неделя;
  - M — месяц (30 дней);
  - y — год (365 дней).
  По умолчанию:
```
send_timeout_to_client: 60s
```
- pipelined_requests - в значении параметра указывается признак запрета использования HTTP pipelined requests для входящих запросов клиента. Если установлено значение off, то в случае получения нескольких pipelined запросов будет обработан только первый, после чего соединение будет закрыто и в логах появится сообщение об ошибке.
  
  Возможные значения:
  - on;
  - off.
  По умолчанию: on.
- http2_only - включение ограничения приема входящих соединений только по протоколу http2.
  
  Возможные значения:
  - on;
  - off.
  По умолчанию: off.
- upload_size_limit
  
  В значении параметра определяется ограничение размера тела запроса.
  
  Тип параметра: группа параметров и их значения.
  
  По умолчанию:
```
size: 1Mb
```
  - size
    
    Обязательный параметр. В значении параметра задается максимальный размер тела запроса.
    
    Тип параметра: текстовое значение с суффиксом:
    - число без суффикса — байты;
    - k / K — килобайты;
    - m / M — мегабайты.
    По умолчанию: не имеет значения по умолчанию.
  - drop
    
    В значении параметра определяется, нужно ли сбрасывать соединение при превышении size.
    
    Тип параметра:
    - «on»;
    - «off».
    По умолчанию: не имеет значения по умолчанию.
  - enable
    
    В значении параметра определяется, включать ли ограничение размера тела запроса.
    
    Тип параметра: логическое значение:
    - true;
    - false.
    По умолчанию:
    enable: true
```
upload_size_limit:
  size: 40M
  drop: 'on'
  enable: true
```
- set_variable
  
  В значении параметра могут быть определены имена переменных и их значения.
  
  Тип параметра: последовательность параметров и их значения.
  
  По умолчанию: не имеет значения по умолчанию.
  - name
    
    Обязательный параметр. В значении параметра указывается имя переменной.
    
    Тип параметра: текстовое значение.
  - value
    
    В значении параметра указывается значение переменной.
    
    Тип параметра: текстовое значение.
- limit_req
  
  Группа параметров limit_req предназначена для ограничения скорости обработки запросов. В ней определяется, требуется ли пропускать избыточные запросы в пределах всплеска без задержки.
  
  Группа, включающая в себя параметры, рассмотренные в разделе Параметр limit_req.
  
  Тип параметра: группа параметров и их значения.
  
  По умолчанию: не имеет значения по умолчанию.
- limit_requests — группа параметров, описанных в разделе Пaраметр limit_requests.
  
  Возможные значения: последовательность параметров и их значения.
  
  По умолчанию: не имеет значения по умолчанию.
- robot_mitigation
  
  Группа параметров robot_mitigation предназначена для противодействия роботам отправляющим HTTP запросы, а также сканированию портов. Принцип работы основан на отправке клиенту ответов на его запросы, которые должны быть интерпретированы клиентом требуемым образом, для того чтобы модуль мог определить допустимую активность.
  
  Группа, включающая в себя параметры, рассмотренные в разделе Параметр robot_mitigation.
  
  Тип параметра: группа параметров и их значения.
  
  По умолчанию: не имеет значения по умолчанию.
- ip_behavior
  
  Группа параметров ip_behavior предназначена для мониторинга поведения пользователей при доступе к серверу. ip_behavior в основном используется с другими группами параметров безопасности, такими как limit_req и robot_mitigation. ip_behavior поддерживает обнаружение доступа только через url.
  
  Группа, включающая в себя параметры, рассмотренные в разделе Параметр ip_behavior.
  
  Тип параметра: группа параметров и их значения.
  
  По умолчанию: не имеет значения по умолчанию.
- cookie_poisoning
  
  Группа параметров cookie_poisoning отслеживает заголовки Set-Cookies и значения cookie в ответе со стороны сервера. Если отслеживаемые значения файлов cookie изменяются на стороне клиента, cookie_poisoning обнаруживает это и выполняет действия в соответствии с настройками пользователя. Группа параметров зависит от session_module (параметры: session, session_timeout, session_cookie_name, session_redirect_timeout, session_show), поэтому перед использованием директив cookie_poisoning необходимо сначала включить session_module.
  
  Группа, включающая в себя параметры, рассмотренные в разделе Параметр cookie_poisoning.
  
  Тип параметра: группа параметров и их значения.
  
  По умолчанию: не имеет значения по умолчанию.
- limit_conn — группа параметров limit_conn ограничивает число соединений по заданному ключу.
  
  Группа параметров, описанных в разделе Параметр limit_conn.
  
  Возможные значения: последовательность параметров и их значения.
  
  По умолчанию: не имеет значения по умолчанию.
- buffers - группа параметров buffers предназначена для задания параметров отправки событий конфигуратора.
  
  Группа параметров, описанных в разделе «Параметр buffers».
  
  Возможные значения: последовательность параметров и их значения.
  
  По умолчанию: не имеет значения по умолчанию.
- logging - группа параметров logging предназначена для задания параметров отправки событий конфигуратора.
  
  Группа параметров, описанных в разделе «Параметр logging».
  
  Возможные значения: последовательность параметров и их значения.
  
  По умолчанию: не имеет значения по умолчанию.