Как интегрировать программную конфигурацию в log4j? - PullRequest
0 голосов
/ 08 мая 2018

Я пользуюсь версией Log4j версии 2.0.1, и из-за политик организации я не могу пока использовать более высокую версию.

group:'org.apache.logging.log4j',name:'log4j-core',version:'2.0.1'
group:'org.apache.logging.log4j',name:'log4j-api',version:'2.0.1'

Мои требования для ведения журнала

  1. Если customDebug = true в качестве переменной среды, включить ведение журнала отладки
  2. Должно быть создано 2 файла журнала - один основной журнал (информация / отладка на основе описанных выше журналов) и журнал ошибок.
  3. Стратегия проката на основе размера
  4. Каталог файлов журнала является динамическим.
  5. Формат должен содержать время в определенном стиле вместе с идентификатором потока.

Я попытался реализовать программную настройку log4j следующим образом -

CustomConfigFactory.java >>

@Plugin(name = "CustomConfigFactory", category = "JsonConfigurationFactory")
@Order(10)
public class CustomConfigFactory extends JsonConfigurationFactory {

    @Override
    public String[] getSupportedTypes() {
        return new String[] {".json"};
    }

    @Override
    public Configuration getConfiguration(ConfigurationSource cs) {
        try{
            String file = Thread.currentThread().getContextClassLoader().getResource("customRollingConfiguration.json").getFile()
            cs = new ConfigurationSource(new FileInputStream(new File(file ));
        } catch (Exception e){
            System.err.println("ERROR : Exception encountered while initiating configuration source: "+e);
        }
        return new CustomJsonConfiguration(cs);
    }

}

CustomJsonConfiguration.java >>

public class CustomJsonConfiguration extends JsonConfiguration {

    public CustomJsonConfiguration(final ConfigurationSource configSource) {
        super(configSource);
    }

    @Override
    protected void doConfigure(){
        try {
            ConfigurationSource source = this.getConfigurationSource();
            Configuration config = CustomConfigFactory.getInstance().getConfiguration(source);

            final Layout layout = PatternLayout.createLayout("%d{yyyy-MM-dd HH:mm:ss.SSS} %-5p [%5T] %c{1}:%L - %m%n",
                config,null,Charset.defaultCharset(),true,false,"","");

            SizeBasedTriggeringPolicy policy = SizeBasedTriggeringPolicy.createPolicy("10 MB");
            DefaultRolloverStrategy strategy = DefaultRolloverStrategy.createStrategy("50", "5", "min", "9", config);

            String logDir = System.getenv("log_dir");
            String primaryLogFile = logDir+"/my_main_log";
            String primaryLogFilePattern = primaryLogFile+"-backup-%d{MM-dd-yy-HH-mm-ss}-%i.log.gz";

            String errorLogFile = logDir+"/my_err_log";
            String errorLogFilePattern = errorLogFile+"-backup-%d{MM-dd-yy-HH-mm-ss}-%i.log.gz";

            RollingFileAppender appender1 = RollingFileAppender.createAppender(primaryLogFile,
                primaryLogFilePattern,"true", "debugFile","true", "false","false",
                policy, strategy, layout, null, null, null, null, config);
            appender1.start();;

            RollingFileAppender appender2 = RollingFileAppender.createAppender(errorLogFile,
                errorLogFilePattern,"true","errorFile","true","false","false",
                policy, strategy, layout, null,null,null,null, config);
            appender2.start();;

            config.addAppender(appender1);
            config.addAppender(appender2);

            LoggerConfig primaryLoggerConfig = null;
            if(Boolean.valueOf(System.getenv("customDebug")){
                 primaryLoggerConfig = new LoggerConfig("aa.bb.cc.dd",Level.DEBUG,false);
            } else {
                primaryLoggerConfig = new LoggerConfig("aa.bb.cc.dd",Level.INFO,false);
            }
            LoggerConfig errorLoggerConfig = new LoggerConfig("aa.bb.cc.dd",Level.ERROR,false);

            primaryLoggerConfig.addAppender(appender1,null,null);
            errorLoggerConfig.addAppender(appender2,null,null);
            config.addLogger("aa.bb.cc.dd",primaryLoggerConfig);
            config.addLogger("aa.bb.cc.dd",errorLoggerConfig);

            LoggerContext context = new LoggerContext("default_context");
            context.start(config);
        } catch (Exception e){
            System.err.println("");
        }
    }

где aa.bb.cc.dd ссылается на имя пакета MyClass ниже.

MyClass.java , где будет использоваться этот регистратор >>

package aa.bb.cc.dd;

public MyClass {
    static final Logger myCustomLog = LogManager.getLogger(MyClass.class);

    void doSomething(){
        myCustomLog.info("Doing something");
    }
}

Пример метода тестирования как часть класса testng для тестирования вышеуказанного класса >>>

@Test
public void testDoingSomething(){
    MyClass m1 = new MyClass();
    m1.doSomething();
}

Но вышеприведенное, похоже, не работает, и ни один из файлов журнала не генерируется, т.е. ведение журнала не работает. Я упомянул это прежде всего для реализации - - https://logging.apache.org/log4j/2.x/manual/customconfig.html#Hybrid

Буду признателен, если кто-нибудь сможет мне помочь с этой реализацией. Все предложения приветствуются !!!

Заранее спасибо.

РЕДАКТИРОВАТЬ >>> Ниже приведена конфигурация json после включения комментариев @ VikasSachdeva. Файл ошибок все еще пуст, даже если в my_main.log

зарегистрировано условие ОШИБКИ.
{
  "configuration": {
     "name": "RollingKitConfig",
    "Appenders": {
  "appender": [
    {
      "type": "RollingFile",
      "name": "debugFile",
      "fileName": "${env:log_dir}/my_main_log",
      "filePattern": "${env:log_dir  }/my_main_backup-%d{MM-dd-yy-HH-mm-ss}-%i.log.gz",
      "PatternLayout": {
        "pattern": "%d{yyyy-MM-dd HH:mm:ss,nnn} [%-5p] [%5t] [%c{3}:%L] - %m%n"
      },
      "Policies": {
        "SizeBasedTriggeringPolicy": {
          "size": "10 MB"
        }
      },
      "DefaultRolloverStrategy": {
        "max": "10"
      },
      "ThresholdFilter": {
        "level": "${env:customDebug:-info}"
      }
    },
    {
      "type": "RollingFile",
      "name": "errorFile",
      "fileName": "${env:log_dir}/errors.log",
      "filePattern": "${env:log_dir}/errors_backup-%d{MM-dd-yy-HH-mm-ss}-%i.log.gz",
      "PatternLayout": {
        "pattern": "%d{yyyy-MM-dd HH:mm:ss,nnn} [%-5p] [%5t] [%c{1}:%L] - %m%n"
      },
      "Policies": {
        "SizeBasedTriggeringPolicy": {
          "size": "10 MB"
        }
      },
      "DefaultRolloverStrategy": {
        "max": "10"
      },
      "ThresholdFilter": {
        "level": "ERROR",
        "onMatch": "ACCEPT",
        "onMisMatch": "DENY"
      }
    }
  ]
},
"Loggers": {
  "logger": [
    {
      "name": "KitLogger",
      "level": "info",
      "additivity": "false",
      "AppenderRef": [
        {
          "ref": "debugFile"
        },
        {
          "ref": "errorFile"
        }
      ]
    }
  ],
  "root": {
    "level": "debug",
    "appender-ref": {
      "ref": "debugFile"
    }
  }
}
  }
}

1 Ответ

0 голосов
/ 13 мая 2018

Если вы просто хотите выбрать местоположение файла журнала, используя переменные среды, вы можете сделать это, используя только файл конфигурации, как описано в документации log4j2

Учитывая, что ваша переменная среды равна log_dir=D:/logs/.Затем вы можете изменить свою конфигурацию, как показано ниже -

{
    "configuration": {
        "name": "RollingConfig",
        "ThresholdFilter": { "level": "info" },
        "properties": {
            "property": {
                "name": "basePath",
                "value": "${env:log_dir}"
             }
        },
        "appenders": {
            "RollingFile": {
                "name": "debugFile",
                "fileName": "${basePath}my_main.log",
                "filePattern": "${basePath}my_main_%d{yyyyMMdd}.log.gz",
                "PatternLayout": { "pattern": "%d{yyyy-MM-dd HH:mm:ss} %-5p [%5T] %c{1}:%L - %m%n" },
                "Policies": {
                    "SizeBasedTriggeringPolicy": { "size": "10 MB" }
                },
               "DefaultRolloverStrategy": { "max": "10"  }
            },
            "RollingFile": {
                "name": "errorFile",
                "fileName": "${basePath}my_err.log",,
                "filePattern": "${basePath}my_err_%d{yyyyMMdd}.log.gz",
                "thresholdFilter": {
                    "level": "ERROR",
                    "onMatch": "ACCEPT",
                    "onMisMatch": "DENY"
                },
                "PatternLayout": { "pattern": "%d{yyyy-MM-dd HH:mm:ss} %-5p [%5T] %c{1}:%L - %m%n" },
                "Policies": {
                     "SizeBasedTriggeringPolicy": {  "size": "10 MB" }
                },
                "DefaultRolloverStrategy": {"max": "10"}
            }
        },
        "loggers": {
            "logger": {
                 "name": "mainLogger",
                 "level": "info",
                 "additivity": "false",
                 "appender-ref": [ 
                                 {"ref": "debugFile"}, 
                                 { "ref":"errorFile"}
                                 ]
            },
            "root": {
                "level": "info",
                 "appender-ref": [ 
                                 {"ref": "debugFile" }, 
                                 { "ref":"errorFile" }
                                 ]
             }
          }
       }
}
Добро пожаловать на сайт PullRequest, где вы можете задавать вопросы и получать ответы от других членов сообщества.
...