Регистрация

OpenTSDB использует абстракцию SLF4J вместе с Logback для гибкости регистрации. Настройка выполняется через XML-файл, и существуют различные параметры форматирования, уровня и назначения.

Уровни

Каждое сообщение протокола сопровождается уровнем серьезности с описанием. Уровни, используемые OpenTSDB, включают:

ERROR - Что-то не удалось, будь то недействительные данные, не удавшееся подключение или ошибка в коде. Обратите внимание на них и выясните, что вызвало ошибку. Обратитесь за помощью в пользовательскую группу.
WARN - Они часто вызываются плохими пользовательскими данными или чем-то другим, что было неправильно, но не является критической ошибкой. Обращайте внимание на предупреждения, если вы не получаете ожидаемые результаты при использовании OpenTSDB.
INFO - Информационные сообщения — это уведомления об ожидаемом или нормальном поведении. Они могут быть полезны при устранении неполадок. Большинство аппендеров регистрации должны быть установлены на INFO.
DEBUG - Если вам требуется дополнительная помощь в устранении неполадок, вы можете включить DEBUG регистрация, которая предоставит гораздо больше подробностей о том, что делает OpenTSDB под капотом. Будьте осторожны при включении этого уровня, так как он может вернуть большое количество данных.
OFF - Чтобы отключить любые сообщения регистрации от класса, просто установите уровень на OFF.

Настройка

Файл, называемый logback.xml включён в каталог /src и скопирован для распространения. При запуске OpenTSDB будет искать этот файл в пути к классу и, если найдёт, загрузит конфигурацию. По умолчанию конфигурация из GIT будет регистрировать события уровня INFO в консоль и хранить 1024 последних сообщения в буфере круговой очереди для доступа из графического интерфейса пользователя. Однако по умолчанию он не будет регистрировать на диск. В пакетах, созданных из GIT, ведение журнала в файл включено по умолчанию. Начиная с версии 2.2, все запросы можно регистрировать в отдельный файл для анализа и автоматизации. Этот журнал отключён по умолчанию, но его можно включить, установив соответствующий уровень регистрации.

Аппендеры

Аппендеры — это места назначения, куда отправляется информация о регистрации. Обычно конфигурации регистрации отправляют результаты в консоль и файл. Дополнительно вы можете отправлять журналы в Syslog, электронную почту, сокеты, базы данных и многое другое. Каждый раздел аппендера определяет место назначения, формат и необязательный триггер. Подробнее об аппендерах в Руководстве Logback.

Логгеры

Логгеры определяют, какие данные и какой уровень данных направляются в аппендеры. Логгеры могут соответствовать определённому пространству имён Java-класса и влиять на все сообщения, отправленные из этого пространства. По умолчанию конфигурация OpenTSDB явно перечисляет некоторые логгеры для Zookeeper, AsyncHBase и библиотек Async, чтобы установить их уровни на INFO, чтобы избежать болтливых выводов, которые в большинстве случаев не имеют отношения к делу. Если вы включите плагин и начнёте видеть множество сообщений, которые вас не интересуют, добавьте запись логгера, чтобы подавить сообщения.

Журнал запросов Чтобы включить журнал запросов, найдите следующий раздел:

<logger name="QueryLog" level="OFF" additivity="false">
  <appender-ref ref="QUERY_LOG"/>
</logger>

и установите level на INFO.

Файл журнала Чтобы включить основной файл журнала, найдите следующий раздел:

<!--<appender-ref ref="FILE"/>-->

и удалите комментарии, чтобы он выглядел как <appender-ref ref="FILE"/>.

Корень

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

Регистрация в файл с циклической записью

<appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
  <file>/var/log/opentsdb/opentsdb.log</file>
  <append>true</append>

  <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
  <fileNamePattern>/var/log/opentsdb/opentsdb.log.%i</fileNamePattern>
  <minIndex>1</minIndex>
  <maxIndex>3</maxIndex>
  </rollingPolicy>

  <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
  <maxFileSize>128MB</maxFileSize>
  </triggeringPolicy>

  <!-- encoders are assigned the type
     ch.qos.logback.classic.encoder.PatternLayoutEncoder by default -->
  <encoder>
  <pattern>%d{HH:mm:ss.SSS} %-5level [%logger{0}.%M] - %msg%n</pattern>
  </encoder>
</appender>

Этот аппендер запишет в файл журнала с именем /var/log/opentsdb/opentsdb.log. Когда размер файла достигнет 128 МБ, он переместит журнал в opentsdb.log.1 и начнёт новый файл opentsdb.log. После того, как новый журнал заполнится, он перенесёт .1 в .2, .log в .1 и создаст новый. Он повторяет это, пока не будет четырёх файлов журнала в общей сложности. При следующем заполнении журнала последний журнал будет удалён. Таким образом, гарантируется использование не более 512 МБ дискового пространства. Доступно множество других аппендеров, поэтому выберите тот, который лучше всего подходит для ваших нужд.

© 2010–2016 The OpenTSDB Authors
Licensed under the GNU LGPLv2.1+ and GPLv3+ licenses.
http://opentsdb.net/docs/build/html/user_guide/logging.html