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

Тип сервиса service_http_kafka_proxy предназначен для передачи http запросов в kafka.

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

service:
  service_http_kafka_proxy:

Сервис представляет собой группу, включающую в себя следующие параметры.

Обязательные параметры:

  • settings

    Общие настройки для подключения к kafka.

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

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

    Обязательные параметры:

    • brokers

    В значении параметра определяется список брокеров kafka в формате хост:порт. Для разделения нескольких значений необходимо использовать запятую.

    Пример: 10.x.x.x:9092, 10.x.x.x:9092

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

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

  • allowed_queries

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

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

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

Опциональные параметры:

  • client_id

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

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

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

  • compression

    В значении параметра определяется метод сжатия сообщения.

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

    • none;

    • gzip;

    • snappy;

    • lz4;

    • zstd.

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

  • partition

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

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

    По умолчанию: значение параметра автоматически устанавливается в соответствии с идентификатором сообщения.

  • partitioner

    В значении параметра определяется используемый алгоритм для распределения сообщений по разделам.

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

    • random;

    • consistent - CRC32 hash of key (Empty and NULL keys are mapped to single partition);

    • consistent_random - CRC32 hash of key (Empty and NULL keys are randomly partitioned);

    • murmur2 - Java Producer compatible Murmur2 hash of key (NULL keys are mapped to single partition);

    • murmur2_random - Java Producer compatible Murmur2 hash of key (NULL keys are randomly partitioned. This is functionally equivalent to the default partitioner in the Java Producer);

    • fnv1a - FNV-1a hash of key (NULL keys are mapped to single partition);

    • fnv1a_random - FNV-1a hash of key (NULL keys are randomly partitioned)…

    По умолчанию: consistent_random.

  • log_level

    В значении параметра указывается уровень логирования syslog - 3.

    Тип параметра: целочисленное значение (0-7).

    По умолчанию: 6.

  • max_retries

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

    Тип параметра: целочисленное значение (0-10000000).

    По умолчанию: 2.

  • buffer_max_messages

    В значении параметра указывается максимальное количество сообщений, хранящихся в локальной очереди.

    Тип параметра: целочисленное значение (1-10000000).

    По умолчанию: 100000.

  • backoff

    В значении параметра указывается время отката (в миллисекундах).

    Тип параметра: целочисленное значение (0-3600000).

    По умолчанию: 100.

  • backoff

    В значении параметра указывается время отката (в миллисекундах).

    Тип параметра: целочисленное значение (0-3600000).

    По умолчанию: 100.

  • compression_level

    В значении параметра указывается уровень сжатия.

    Тип параметра: целочисленное значение (-1-12).

    По умолчанию: -1.

  • message_max_bytes

    В значении параметра указывается максимально допустимый размер сообщения.

    Тип параметра: целочисленное значение (1000-1000000000).

    По умолчанию: 1000000.

  • message_max_bytes

    В значении параметра указывается максимально допустимый размер сообщения.

    Тип параметра: целочисленное значение (1000-1000000000).

    По умолчанию: 1000000.

  • message_copy_max_bytes

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

    Тип параметра: целочисленное значение (1000-1000000000).

    По умолчанию: 65535.

  • message_timeout

    В значении параметра указывается таймаут локального сообщения. Значение задается локально и ограничивает время ожидания для доставки сообщения.

    Тип параметра: целочисленное значение.

    По умолчанию: 300000.

  • topic_metadata_refresh_interval

    В значении параметра указывается период времени в миллисекундах, в течение которого обновляется топик и метаданные.

    Тип параметра: целочисленное значение (1-3600000).

    По умолчанию: 300000.

  • ssl_endpoint_identification_algorithm

    В значении параметра указывается алгоритм валидации имени хоста брокера.

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

    • none - валидация отсутствует;

    • https - валидация по RFC2818

    По умолчанию: https.

  • ssl_certificate_verification

    Вкл./Откл. верификации серверного сертификата брокера средствами openssl.

    Тип параметра:

    • true;

    • false.

    По умолчанию: false.

  • debug

    Вкл./Откл. журнал отладки.

    Тип параметра:

    • true;

    • false.

    По умолчанию:

    debug: false
    
  • ssl

    Вкл./Откл. ssl/tls соединение.

    Тип параметра:

    • true;

    • false.

    По умолчанию:

    ssl: false
    
  • ssl_keystore

    В значении параметра определяется местоположение хранилища ключей. Поддерживается хранилище ключей только формата pkcs12. Если все необходимые ключи и сертификаты есть в хранилище, достаточно определения пути к хранилищу и пароля от хранилища.

    Возможно сочетать использование ssl_keystore и ssl_keystore_pwd с ssl_cert, ssl_key и ssl_ca, если того, что находится в хранилище, недостаточно.

    Используется в случае:

    ssl is not None.
    

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

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

  • ssl_keystore_pwd

    В значении параметра определяется файл, содержащий пароль для хранилища ключей.

    Используется в случае:

    ssl is not None.
    

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

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

  • ssl_cert

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

    Используется в случае:

    ssl is not None.
    

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

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

  • ssl_ca

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

    Слияние сертификатов:

    Файл клиентского сертификата может содержать в себе несколько сертификатов. Объединение сертификатов можно произвести с помощью команды cat.

    cat intermediate.pem root.pem interintermediate.pem > common.pem
    

    Используется в случае:

    ssl is not None.
    

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

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

  • ssl_key

    В значении параметра определяется местоположение клиентского ключа.

    Используется в случае:

    ssl is not None.
    

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

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

  • instances

    Список сервисов.

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

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

    Обязательные параметры:

    • id

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

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

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

    service:
      service_http_kafka_proxy:
      ...
      instances:
        - id: 1
    

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

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

    • url

    В значении параметра определяется относительный url, на котором будет работать сервис. Есть возможность использовать регулярное выражение.

    url: /metrics/myapp
    

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

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

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

    • topic

    В значении параметра определяется topic kafka.

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

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

    Опциональные параметры:

    • name

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

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

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

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

    • profile_version

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

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

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

    • description

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

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

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

    • listen

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

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

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

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

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

    • hostname

    В значении параметра указывается виртуальное имя сервера.

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

    По умолчанию:

    hostname
      - localhost
    
    • optional

    Группа optional используется в сервисе для:

    • вызова различных таймаутов;

    • настройки сессии;

    • ограничения по размеру лимита тела запроса/ответа;

    • вызова различных утилит;

    • и др.

    Группа, включающая в себя параметры, описанные в разделе "KafkaProxy - optional".

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

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

    • filters

    Группа, включающая в себя следующие параметры:

    • фильтр modsecurity - позволяет проверить download/upload трафик на наличие угроз (например sql-injection), содержащихся в методе, заголовке запроса, теле и др.

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

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

    • transformations

    transformations предназначен для преобразования заголовков при выполнении заданных условий.

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

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

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

    • validators

    Валидация тела запроса/ответа.

    Группа, включающая в себя параметры, описанные в разделе "Валидация".

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

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

    • postprocessors

    Постобработчик postprocessor_error предназначен для формирования сообщения об ошибке для клиента по указанному шаблону.

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

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

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

Пример минимальной настройки сервиса:

version: 2.0.3
profile: profile_name
system:
  wrk_count: 4
  conn_count: 2048
service:
  service_http_kafka_proxy:
    settings:
      brokers: hostname1:port1, hostname2:port2
    instances:
      - id: UserAnalytics
        allowed_queries:
          - method: post
        url: /metrics/myapp
        topic: topicname
        hostname:
          - localhost
        listen:
          - port: 80

ServiceHttpKafkaProxy - allowed_queries#

Обязательные параметры:

  • method

    В значении параметра указывается разрешенный метод запроса для сервиса.

    Тип параметра:

    • head;

    • post;

    • put;

    • options;

    • patch.

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

Опциональные параметры:

  • params

    В значении параметра определяется множество допустимых параметров запроса, а также, множество допустимых значений, для каждого из параметров. Заданные параметры не являются обязательными, но требуют наличия хотя бы одного допустимого параметра в запросе.

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

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

    Обязательные параметры:

    • name

      В значении параметра указывается имя параметра.

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

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

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

    • pattern

      В значении параметра pattern определяется значение, которое может принимать параметр name. Не чувствительно к регистру.

      Имеется возможность использования регулярного выражение.

      Для использовании символов:

      • \ ^ $ . | ? * + ( ) [ ] { } - в явном виде, необходимо их экранирование.

      Символ \ экранируется только тогда, когда находится в кавычках.

      В примере ниже показывается, что экранируется связка \ с иным элементом (например #):

      - name: "name_1"
        pattern: "[^\\#\\$\\%\\&\\(\\)\\*\\+\\,\\-\\.\\:\\;\\<\\=\\>\\?\\^\\_\\{\\|\\}\\~\\@]+"
      - name: "name_2"
        pattern: "[^ЁёА-я]+"
      

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

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

ServiceHttpKafkaProxy - optional#

Опциональные параметры:

  • allow_empty_message

    Включение возможности отправки пустого сообщения в брокер kafka.

    Тип параметра: булевое значение.

    • on;

    • off.

    По умолчанию:

    allow_empty_message: off
    
  • pass_request_headers

    Включение возможности передавать заголовки http запросов в заголовки сообщения kafka.

    Тип параметра: булевое значение.

    • on;

    • off.

    По умолчанию:

    allow_empty_message: off
    
  • headers_blacklist

    В значении параметра задается список заголовков http запросов, которые будут блокироваться для отправки в kafka. Имена заголовков указываются без учета регистра.

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

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

  • block_mode

    С помощью данного параметра можно включить синхронный режим доставки сообщений в kafka, задать код ответа при ошибке доставки, определить таймаут на проверку доставки сообщения.

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

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

    Опциональные параметры:

    • enabled

      Вкл./Откл. block_mode.

      Если block_mode выключен, транзакции с любыми статус-кодами (в т.ч. ошибочными) будут обработаны и добавлены в очередь на доставку в kafka.

      Тип параметра:

      • true;

      • false.

      По умолчанию:

      enabled: false
      
    • wait_remote_result

      Вкл./Откл. wait_remote_result.

      Если wait_remote_result включен, то клиент будет ожидать результат доставки сообщения в указанный топик kafka или таймаут.

      Используется в случае:

      • enabled is not None.

      Тип параметра:

      • true;

      • false.

      По умолчанию:

      wait_remote_result: false
      
    • remote_timeout

      В значении параметра указывается время ожидания результата доставки сообщения на топик kafka.

      Используется в случае:

      • wait_remote_result is not None.

      remote_timeout: 30
      

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

      • ms - миллисекунда;

      • s - секунда;

      • m - минута;

      • h - час;

      • d - день;

      • w - неделя;

      • M - месяц (30 дней);

      • y - год (365 дней).

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

    • check_interval

      В значении параметра определяется интервал для проверки доставки сообщений.

      Используется в случае:

      • wait_remote_result is not None.

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

      • ms - миллисекунда;

      • s - секунда;

      • m - минута;

      • h - час;

      • d - день;

      • w - неделя;

      • M - месяц (30 дней);

      • y - год (365 дней).

      По умолчанию:

      check_interval: 100ms
      
    • error_code

      В значении параметра указывается код ошибки для клиента при сбое доставки сообщения на топик kafka.

      Используется в случае:

      • enabled is not None.

      error_code: 403
      

      Тип параметра: целочисленное значение.

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

  • log_level

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

    Тип параметра:

    • debug;

    • info;

    • notice;

    • warn;

    • error;

    • crit;

    • alert;

    • off.

    По умолчанию: значение параметра наследуется от значения в system.

  • (2.2) settings

    Блок настроек подключения к kafka, специфичный для сервиса. При наличии, переопределяет общие настройки сервисов. Структура аналогична общим настройкам (см. Тип сервиса HttpKafkaProxy).

  • (2.1, 2.2) group_access_log

    В значении параметра указывается, группировать или нет access журналы по кодам состояния (2xx, 3xx, 4xx, 5xx, 404, 413, 429, 499, 500).

    Тип параметра: логическое значение:

    • true;

    • false.

    По умолчанию:

    group_access_log: false
    
  • internal

    В значении параметра определяется, должен ли сервис быть доступен только локально.

    Тип параметра:

    • true;

    • false.

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

  • session_cache

    В значении параметра определяется размер кэша для ssl/tls сессии.

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

    По умолчанию: значение по умолчанию оценивается автоматически.

    Обязательные параметры:

    • type

      В значении параметра определяется тип размера кэша.

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

      Тип параметра:

      • off - жесткое запрещение использования кэша сессий: nginx явно сообщает клиенту, что сессии не могут использоваться повторно;

      • none - мягкое запрещение использования кэша сессий: nginx сообщает клиенту, что сессии могут использоваться повторно, но на самом деле не хранит параметры сессии в кэше;

      • builtin - встроенный в OpenSSL кэш, используется в рамках только одного рабочего процесса. Размер кэша задается в сессиях. Если размер не задан, то он равен 20480 сессиям. Использование встроенного кэша может вести к фрагментации памяти;

      • shared - кэш, разделяемый между всеми рабочими процессами. Размер кэша задается в байтах, в 1 мегабайт может поместиться около 4000 сессий. У каждого разделяемого кэша должно быть произвольное название. Кэш с одинаковым названием может использоваться в нескольких виртуальных серверах.

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

    • name

      В значении параметра указывается имя размера.

      Используется в случае:

      • type: shared.

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

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

    • size

      В значении параметра указывается величина размера.

      Используется в случае:

      • type: builtin;

      • type: shared.

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

      • число без суффикса - байты;

      • k / K - килобайты;

      • m / M - мегабайты.

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

      Пример:

      session_cache:
        type: shared
        name: my_name_size
        size: 4k
      
  • body

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

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

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

  • message_id

    В значении параметра задается идентификатор сообщения для отправки на kafka.

    message_id: $http_kafka_message_id_from_header
    

    где, например, kafka_message_id_from_header – заголовок запроса.

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

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

  • set_variable

    В значении параметра могут быть определены имена переменных и их значения.

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

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

    Обязательные параметры:

    • name

      В значении параметра указывается имя переменной.

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

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

    • value

      В значении параметра указывается значение переменной.

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

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

  • exclude_req_stat

    exclude_resp_stat

    В значениях параметров исключаются сервисы из статистики учета реквестов/респонсов.

    Подробнее параметры описаны в разделе "Параметр exclude_stat (util_exclude_stat)".

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

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

  • limit_req

    Группа параметров limit_req предназначена для ограничения скорости обработки запросов. В ней определяется, требуется ли пропускать избыточные запросы в пределах всплеска без задержки.

    Группа, включающая в себя параметры, описанные в разделе "Параметр limit_req (util_limit_requests)".

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

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

  • robot_mitigation

    Группа параметров robot_mitigation предназначена для противодействия роботам отправляющим HTTP запросы, а также сканированию портов. Принцип работы основан на отправке клиенту ответов на его запросы, которые должны быть интерпретированы клиентом требуемым образом, для того чтобы модуль мог определить допустимую активность.

    Группа, включающая в себя параметры, описанные в разделе "Параметр robot_mitigation (util_robot_mitigation)".

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

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

  • ip_behavior

    Группа параметров ip_behavior предназначена для мониторинга поведения пользователей при доступе к серверу. ip_behavior в основном используется с другими группами параметров безопасности, такими как limit_req и robot_mitigation. ip_behavior поддерживает обнаружение доступа только через url.

    Группа, включающая в себя параметры, описанные в разделе "Параметр ip_behavior (util_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 (util_cookie_poisoning)".

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

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

  • spnego

    Группа параметров spnego предназначена для аутентификации kerberos.

    Группа, включающая в себя параметры, описанные в разделе "Параметр spnego (util_spnego)".

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

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

  • gzip

    Группа параметров gzip позволяет осуществлять сжатие ответа одноименным методом.

    Группа, включающая в себя параметры, описанные в разделе "Параметр gzip (util_gzip)".

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

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

  • event_hook

    Группа параметров event_hook производит журналирование событий.

    Группа, включающая в себя параметры, описанные в разделе "Параметр event_hook (util_event_hook)".

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

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

  • async_io

    Группа параметров, отвечающих за настройку файлового асинхронного ввода-вывода.

    Группа, включающая в себя параметры, описанные в разделе "Параметр async_io (parameter_async_io)".

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

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

  • log_masking - группа параметров log_masking предназначена для задания правил маскирования чувствительной информации в логах событий и логов транзакции фильтров безопасности.

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

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

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

  • http2 - группа параметров http2 позволяет регулировать настройки входящих подключений по протоколу http2.

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

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

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

  • logging2 - группа параметров logging предназначена для задания параметров отправки событий конфигуратора.

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

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

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

  • upload_size_limit

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

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

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

    Обязательные параметры:

    • size

      В значении параметра задается максимальный размер тела запроса.

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

      • число без суффикса - байты;

      • k / K - килобайты;

      • m / M - мегабайты.

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

    Опциональные параметры:

    • drop

      В значении параметра определяется, нужно ли сбрасывать соединение при превышении size.

      Тип параметра:

      • on;

      • off.

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

    Пример:

    upload_size_limit:
      size: 40M
      drop: on
    
  • (2.2) log_masking_rules

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

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

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

    • log_type

      Тип логов.

      Тип параметра:

      • all - все типы

      • security - логи транзакций фильтра безопасности

      • event - логи событий

      По умолчанию: all.

    • object

      Объект, к которому применяется маскирование.

      Тип параметра:

      • request_header - заголовки запроса

      • response_header - заголовки ответа

      • request_body - тело запроса

      • response_body - тело ответа

      Обязателен для заполнения.

      По умолчанию: нет.

    • header

      Имя заголовка, к которому применяется маскирование.

      Тип параметра: заполняется и обязателен тогда, когда указан object = request_header/response_header.

      По умолчанию: нет.

    • expression

      Регулярное выражение, содержащее группы.

      Тип параметра: должно содержать хотя бы одну группу для определения фрагмента замены. Задается для object = request_body/response_body.

      Обязателен для заполнения.

      По умолчанию: нет.

    • replace_all

      Заменять все или первое найденное.

      Тип параметра: on/off - определяет будут ли заменяться только первое найденное значение или все. В том случае, если гарантировано вхождение будет только один раз рекомендуется устанавливать явно значение off для оптимизации производительности. Применяется только для object = request_body/response_body.

      По умолчанию: on.

    • mask_symbol

      Символ который используется для замены.

      Тип параметра: определяет, какой символ будет использоваться для замены.

      По умолчанию: *.

  • (2.4) pipelined_requests - в значении параметра указывается признак запрета использования HTTP pipelined requests для входящих запросов клиента. Если установлено значение off, то в случае получения нескольких pipelined запросов будет обработан только первый, после чего соединение будет закрыто и в логах появится сообщение об ошибке.

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

    • on;

    • off.

    По умолчанию: on.

  • (2.4) http2_only - включение ограничения приема входящих соединений только по протоколу http2.

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

    • on;

    • off.

    По умолчанию: off.

  • (2.4) keepalive_time - ограничивает максимальное время, в течение которого могут обрабатываться запросы в рамках keep-alive соединения. По достижении заданного времени соединение закрывается после обработки очередного запроса.

    Возможные значения: текстовое значение с суффиксом:

    • ms - миллисекунда;

    • s - секунда;

    • m - минута;

    • h - час;

    • d - день;

    • w - неделя;

    • M - месяц (30 дней);

    • y - год (365 дней).

    По умолчанию: 1h.