log_config

Секция log_config управляет тем, как серверный процесс YDB обрабатывает и управляет своими логами. Она позволяет настраивать уровни логирования для различных компонентов, а также глобальные форматы логов и методы вывода.

Обзор

Логирование является критически важной частью системы наблюдаемости YDB. Секция log_config позволяет настраивать различные аспекты логирования, включая:

• уровень логирования по умолчанию;
• уровни логирования для конкретных компонентов;
• формат вывода логов;
• интеграцию с syslog или внешними сервисами логирования.

Способы вывода логов

• В stderr: по умолчанию, YDB отправляет все логи в stderr.
• В файл: логи могут быть записаны в файл с помощью параметра backend_file_name.
• В syslog: при включении параметра sys_log: true логи перенаправляются в системный журнал syslog и перестают выводиться в stderr. Логи отправляются с использованием сокета /dev/log.
• В Unified Agent: при настройке секции uaclient_config логи отправляются в Unified Agent и перестают выводиться в stderr.

При одновременном включении sys_log и настройке uaclient_config, логи будут отправляться и в syslog, и в Unified Agent. Если вам нужно продолжать выводить логи в stderr при использовании других способов, активируйте sys_log_to_stderr: true.

Параметры конфигурации

Объекты Entry

Поле entry содержит массив объектов со следующей структурой:

Объект UAClientConfig

Поле uaclient_config настраивает интеграцию с Unified Agent:

Уровни логирования

YDB использует следующие уровни логирования, перечисленные от наивысшей к наименьшей серьезности:

Примеры

Базовая конфигурация

log_config:
  default_level: 5  # NOTICE
  format: "full"

Данная конфигурация выводит логи в stderr с уровнем логирования NOTICE и выше.

Конфигурация с выводом в файл

log_config:
  default_level: 5  # NOTICE
  format: "full"
  backend_file_name: "/var/log/ydb/ydb.log"

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

Конфигурация с выводом в syslog

log_config:
  default_level: 5  # NOTICE
  sys_log: true
  sys_log_service: "ydb"
  format: "full"

Эта конфигурация отправляет логи в syslog с именем сервиса "ydb".

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

log_config:
  default_level: 5  # NOTICE
  entry:
    - component: "SCHEMESHARD"
      level: 7  # DEBUG
    - component: "TABLET_MAIN"
      level: 6  # INFO
  backend_file_name: "/var/log/ydb/ydb.log"

Конфигурация семплирования

log_config:
  default_level: 5  # NOTICE
  default_sampling_level: 7  # DEBUG
  default_sampling_rate: 10  # Логировать каждое 10-е сообщение между NOTICE и DEBUG
  entry:
    - component: "BLOBSTORAGE"
      sampling_level: 8  # TRACE
      sampling_rate: 100  # Логировать каждое 100-е сообщение между NOTICE и TRACE

Эта конфигурация настраивает семплирование логов. При настройках по умолчанию каждое 10-е сообщение с приоритетом между NOTICE и DEBUG будет записано в лог. Для компонента BLOBSTORAGE каждое 100-е сообщение с приоритетом между NOTICE и TRACE будет записано в лог.

Конфигурация формата JSON

log_config:
  default_level: 5  # NOTICE
  format: "json"
  cluster_name: "production-cluster"
  uaclient_config:
    uri: "[fd53::1]:16400"
    grpc_max_message_size: 4194304
    log_name: "ydb_logs"

Эта конфигурация выводит логи в формате JSON и отправляет их в Unified Agent.

Примечания

• Уровни логирования указываются в конфигурации как числовые значения, а не строки. Используйте таблицу выше для сопоставления между числовыми значениями и их значениями.
• Если указан параметр backend_file_name, логи записываются в этот файл. Если параметр sys_log имеет значение true, логи отправляются в системный регистратор.
• Параметр format определяет, как форматируются записи логов. Формат «full» включает всю доступную информацию, «short» предоставляет более компактный формат, а «json» выводит логи в формате JSON, который удобен для парсинга сервисами логирования.
• Внутренний буфер логов имеет следующие ограничения по размеру:
  • Общий размер по умолчанию: 10МБ (10 * 1024 * 1024 байт)
  • Размер гранулы по умолчанию: 64КБ (1024 * 64 байт)
  • Максимальный размер сообщения: 1КБ (1024 байт)

Смотрите также

• Справка по наблюдаемости YDB
• Справка по метрикам
• Трассировка в YDB
• Аудитный лог