Параметр event_hook#

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

Доступно четыре вида журналирования:

  • запрос клиенту;

  • ответ клиенту;

  • запрос на upstream;

  • ответ от upstream.

Название

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

Описание

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

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

stage

Обязательный (если enabled: true)

Последовательность этапов журналирования

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

—

stage.name

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

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

client_request, client_response, upstream_request, upstream_response

—

stage.log_file

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

Имя файла журнала

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

/sowalogs/<profile_name>/services/service_http_proxy/service_http_proxy_<id>/<stage>/$request_id.log

stage.pattern_file

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

Файл шаблона, в соответствии с которым будет заполнен файл журнала

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

—

stage.max_size

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

Пороговое значение, после превышения которого событие журналирования будет записано в файл temp

Текстовое значение с суффиксом: число без суффикса — байты, k/K — килобайты, m/M — мегабайты

—

log_in_file

Обязательный (если enabled: true и logger_service is None)

Необходимость осуществлять журналирование в файл

"on", "off"

—

enabled

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

Вкл./Откл. evh (журналирование) для сервиса

true, false

true

logger_service

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

Тип сервиса для обработки события

Текстовое значение

—

logger_service_type

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

Синхронное или асинхронное журналирование

sync, async

sync

logger_id

Обязательный (если enabled: true и logger_service is not None)

Идентификатор сервиса для обработки события

Текстовое значение

—

logger_read_timeout

Обязательный (если logger_service is not None)

Таймаут чтения для сервиса обработки события

Текстовое значение

1s

logger_send_timeout

Обязательный (если logger_service is not None)

Таймаут отправки для сервиса обработки события

Текстовое значение

1s

logger_connect_timeout

Обязательный (если logger_service is not None)

Таймаут соединения для сервиса обработки события

Текстовое значение

1s

logger_client_body_timeout

Обязательный (если logger_service is not None)

Таймаут для тела клиента для сервиса обработки события

Текстовое значение

1s

logger_buffer_size

Обязательный (если logger_service != None, logger_service_type != None, logger_service_type == 'async')

Размер буфера сервиса обработки события для записи в сервис таймаута

Текстовое значение

16k

logger_max_memory

Обязательный (если logger_service != None, logger_service_type != None, logger_service_type == 'async')

Максимальный размер встроенной памяти асинхронного сервиса обработки события для события

Текстовое значение

2M

temp_path

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

Путь для хранения временных данных

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

/sowarun/<profile_name>/service_http_proxy/service_http_proxy_<id>

Пример использования параметра event_hook:

event_hook:
  stage:
    - name: client_request
    - name: client_response
    - name: upstream_request
    - name: upstream_response
  log_in_file: "on"