Чёрный Ящик: забудьте о логировании

Привет! Спасибо за комментарий.

Spring AOP точно есть, ApsectJ тоже (насколько я знаю, но не пробовал сам).

Spring AOP работает медленно. "Чёрный ящик" встраивается на этапе компиляции и не замедляет работу приложения. А AspectJ требует отдельного компилятора, что затрудняет переносимость библиотек, использующих его.

Так что AST наиболее беспроблемный вариант. А вот насчёт гибкости — разве в общем случае AOP более гибкий, чем AST API?

Как бы то ни было, мы позаботились об этом в "Карбюраторе" (абстрактный AST API, используемый в "Чёрном ящике") — он гибко настраивается (даже есть экстернализированная конфигурация), и предоставляет доступ ко всем нужным мета-данным этапа компиляции на этапе исполнения.

Но интересно узнать Ваше мнение насчёт этого.

Привет!

Изначально использовали иерархический формат — XML (с XSD на соответствующим классовой модели Groovy AST):

• Исключение
  

  <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
  <rootAstNode xsi:type="MethodNode" methodName="foo" className="io.infinite.blackbox.SandBox"
           startDateTime="2018-10-22T16:17:40.843+04:00" lineNumber="29" columnNumber="5" lastLineNumber="35"
           lastColumnNumber="6" xmlns="https://i-t.io/blackbox/groovy/2_x_x/BlackBox.xsd"
           xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <astNodeList/>
  <argumentList>
      <argument argumentClassName="java.lang.String" argumentName="bar">
          <argumentValue>foobar</argumentValue>
      </argument>
  </argumentList>
  <exception exceptionDateTime="2018-10-22T16:17:40.913+04:00">
      <exceptionStackTrace>java.lang.Exception: Bar can not be foobar
          at io.infinite.blackbox.SandBox$_foo_closure1$_closure3.doCall(SandBox.groovy:32)
          at io.infinite.blackbox.SandBox$_foo_closure1$_closure3.doCall(SandBox.groovy)
          at io.infinite.blackbox.BlackBoxEngine.expressionEvaluation(BlackBoxEngine.groovy:70)
          at io.infinite.blackbox.BlackBoxEngine$expressionEvaluation$3.call(Unknown Source)
          at io.infinite.blackbox.SandBox$_foo_closure1.doCall(SandBox.groovy:32)
          at io.infinite.blackbox.SandBox$_foo_closure1.doCall(SandBox.groovy)
          at io.infinite.blackbox.BlackBoxEngine.executeMethod(BlackBoxEngine.groovy:175)
          at io.infinite.blackbox.BlackBoxEngine$executeMethod$1.call(Unknown Source)
          at io.infinite.blackbox.SandBox.foo(SandBox.groovy)
          at io.infinite.blackbox.SandBox.run(SandBox.groovy:40)
      </exceptionStackTrace>
  </exception>
  </rootAstNode>

• Нормальное выполнение
  

  <rootAstNode startDateTime="2018-10-22T15:59:49.120+04:00" xmlns="https://i-t.io/logging/groovy/2_x_x/BlackBox.xsd"
           xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <astNodeList>
      <astNode xsi:type="MethodNode" methodName="foo" className="io.infinite.blackbox.SandBox"
               startDateTime="2018-10-22T15:59:49.156+04:00" lineNumber="29" columnNumber="5" lastLineNumber="32"
               lastColumnNumber="6">
          <argumentList>
              <argument argumentClassName="java.lang.String" argumentName="bar">
                  <argumentValue>z</argumentValue>
              </argument>
          </argumentList>
          <astNodeList>
              <astNode xsi:type="Statement" statementClassName="ReturnStatement"
                       startDateTime="2018-10-22T15:59:49.217+04:00" sourceNodeName="BlockStatement:statements"
                       lineNumber="31" columnNumber="9" lastLineNumber="31" lastColumnNumber="19">
                  <restoredScriptCode>
                  <astNodeList>
                  </astNodeList>
              </astNode>
              <astNode xsi:type="Expression" expressionClassName="VariableExpression"
                       startDateTime="2018-10-22T15:59:49.226+04:00" sourceNodeName="ReturnStatement:expression"
                       lineNumber="31" columnNumber="16" lastLineNumber="31" lastColumnNumber="19">
                  <restoredScriptCode>bar</restoredScriptCode>
                  <astNodeList>
                  </astNodeList>
                  <expressionValue className="java.lang.String">
                      <value>z</value>
                  </expressionValue>
              </astNode>
          </astNodeList>
          <methodResult className="java.lang.String">
              <value>z</value>
          </methodResult>
      </astNode>
  </astNodeList>
  </rootAstNode>

Но из-за большой вложенности стеков всё это сильно съезжало вправо, и становилось ещё менее читаемым на практике. Поэтому сделали просто читабельный текстовый вывод.

Как показывает практика, в нём не так важна красота — чаще всего знаешь, что именно искать — и ищешь с помощью ctrl-f. А вот минимализм — помогает.

Так что текущая реализация — базовая. Имеет смысл вариации делать именно как отдельные реализации; Базовый API — карбюратор. Если есть желание — можете поэкспериментировать с ним.

А если мыслить масштабно — то это вообще дело не программы, а Kibana/Splunk/Grafana. В этом случае вообще не так критичен формат вывода из программы. Главное чтобы он был единообразен.

Это если в общем виде — какие строки и сообщения логировать.

Если говорить про частные случаи форматирования отдельных сообщений (например method exception — как вы написали выше) — это должно решаться на уровне настроек логгера.
Мы рекомендуем использовать логгер Бобину.
Вот как бы выглядили настройки Бобины для Вашего примера:

Bobbin.yml:

destinations:
  - name: io.infinite.bobbin.config.ConsoleDestinationConfig
    levels: [error]
    formatThrowable: ("error\n    time $dateTime\n    class $className\n    type ${throwable.class.name}\n stack ${exceptionUtils.stacktrace(throwable)}")

Это если без реализации Tree. А так, надо бы реализовать на Java его, отличный формат! Спасибо за наводку.

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

Лучше всего попробуйте на практике Чёрный ящик.

извиняюсь за 3й ответ Вам подряд. Тему затронули обширную сразу.
Так вот, забыл сказать самое важное: если Вы хотели бы использовать Чёрный ящик у себя в проектах, но именно с форматом Tree — пожалуйста дайте знать. Мы подготовим реализацию BlackBoxTree. Это не займёт много времени.

Подход именно такой: под каждый формат — отдельная реализация.