Параметр log_type#

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

Название

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

Описание

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

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

log_type

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

Режим логирования

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

file

log_type.kafka

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

Настройки логирования в Kafka

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

—

log_type.kafka.group

Обязательный (в рамках kafka)

Группа логов, которая будет использовать текущие настройки. Значение system можно указать только при описании настроек логирования в секции system.optional

system, error, access

—

log_type.kafka.broker

Обязательный (в рамках kafka)

Исходный список брокеров в виде host:port. В качестве разделителя используется «,»

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

—

log_type.kafka.topic

Обязательный (в рамках kafka)

Название topic

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

—

log_type.kafka.protocol

Обязательный (в рамках kafka)

Протокол соединения

plaintext, ssl

plaintext

log_type.kafka.id

Опциональный (в рамках kafka)

client.id

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

—

log_type.kafka.certificate

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

Местоположение клиентского сертификата

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

—

log_type.kafka.ca

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

Местоположение сертификатов доверенных CA, используемых для проверки клиентских сертификатов

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

—

log_type.kafka.key

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

Местоположение клиентского ключа

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

—

log_type.kafka.ciphers

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

ssl.cipher.suites. Аналогично ssl ciphers по умолчанию

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

—

log_type.kafka.compression_codec

Опциональный (в рамках kafka)

Формат сжатия сообщений

none, gzip, snappy, lz4, zstd

—

log_type.kafka.compression_level

Опциональный (в рамках kafka)

Уровень компрессии. Максимальное значение определяет наибольшую компрессию за счет большего использования CPU

Целочисленное значение: min -1, max 12

—

log_type.kafka.log_level

Опциональный (в рамках kafka)

Уровень логирования. syslog — 3

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

—

log_type.kafka.debug

Опциональный (в рамках kafka)

Список событий отладки, разделенных через запятую

generic, broker, topic, metadata, feature, queue, msg, protocol, cgrp, security, fetch, interceptor, plugin, consumer, admin, eos, mock, assignor, conf, all

—

log_type.kafka.max_messages

Опциональный (в рамках kafka)

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

Целочисленное значение: min 1, max 1000000

1000000

log_type.kafka.pattern_file

Опциональный (в рамках kafka)

Путь к файлу, описывающему необходимый формат отсылаемой лог-записи. В файле можно использовать переменные: $ngx_kafka_log_hostname, $ngx_kafka_log_message, $ngx_kafka_log_time, $ngx_kafka_log_id

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

—

log_type.kafka.escape

Опциональный (в рамках kafka)

Флаг, включающий экранирование специальных символов в используемых в шаблоне (pattern_file) переменных

true, false

—

log_type.syslog

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

Настройки логирования в syslog

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

—

log_type.syslog.group

Обязательный (в рамках syslog)

Группа логов, которая будет использовать текущие настройки. Значение system можно указать только при описании настроек логирования в секции system.optional

system, error, access

—

log_type.syslog.log_host

Опциональный (в рамках syslog)

Хост для удаленной записи в системный журнал

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

—

log_type.syslog.log_port

Опциональный (в рамках syslog)

Порт для удаленной записи в системный журнал

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

—

log_type.file

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

Настройки логирования в файл

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

—

log_type.file.group

Обязательный (в рамках file)

Группа логов, которая будет использовать текущие настройки. Значение system можно указать только при описании настроек логирования в секции system.optional

system, error, access

—

log_type.security

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

Настройки логирования событий безопасности

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

—

log_type.security.enabled

Опциональный (в рамках security)

Вкл./Откл. логирование событий безопасности (XSD(«XSD Validation Block»), JSON(«JSON Validation Block»), RATE_LIMIT(«Rate limit exceeded»)). События безопасности отбрасываются в системный журнал (syslog) в виде JSON объекта

true, false

false

log_type.security.threads_count

Опциональный (в рамках security)

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

Целочисленное значение

16

log_type.security.hostname

Опциональный (в рамках security)

hostname для отображения в сообщении системного журнала

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

Текущий hostname

log_type.security.appname

Опциональный (в рамках security)

Название приложения для отображения в сообщении системного журнала

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

sowa-security

log_type.security.facility

Опциональный (в рамках security)

Тип системы источника при записи сообщения в системный журнал

KERN, USER, MAIL, DAEMON, AUTH, SYSLOG, LPR, NEWS, UUCP, CRON, AUTHPRIV, FTP, NTP, AUDIT, ALERT, CLOCK, LOCAL0–LOCAL7

USER

log_type.security.severity

Опциональный (в рамках security)

Уровень критичности/важности сообщения системного журнала

EMERGENCY, ALERT, CRITICAL, ERROR, WARNING, NOTICE, INFORMATIONAL, DEBUG

INFORMATIONAL

log_type.security.target_host

Опциональный (в рамках security)

Хост для отправки сообщения системного журнала

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

127.0.0.1

log_type.security.target_port

Опциональный (в рамках security)

Порт для отправки сообщения системного журнала

Целочисленное значение: min 0, max 65535

514

log_type.security.protocol

Опциональный (в рамках security)

Протокол для отправки сообщения системного журнала

UDP, TCP

UDP

log_type.security.msg_format

Опциональный (в рамках security)

Формат сообщения для отправки сообщения системного журнала

RFC_3164, RFC_5424, RFC_5425

RFC_3164

Пример конфигурационного файла с раздельным логированием в Kafka и файл:

system:
  wrk_count: 4
  conn_count: 1024
  optional:
    log_type:
      kafka:
        - group:
          - system
          broker: broker:9092
          topic: test_topic
          id: message_id
          protocol: ssl
          certificate: cert.pem
          ca: ca-cert
          key: key.pem
      file:
        - group:
          - error
          - access

Пример конфигурационного файла с полным логированием в Kafka и задаваемым пользователем форматом записей:

system:
  wrk_count: 4
  conn_count: 1024
  optional:
    log_type:
      kafka:
        - group:
          - system
          - error
          - access
          broker: broker:9092
          topic: test_topic
          id: message_id
          pattern_file: resources/pattern_file.json
          escape: true
          protocol: ssl
          certificate: cert.pem
          ca: ca-cert
          key: key.pem