Advanced logger

Advanced logger expands features of standard Log4J logger

Getting started

For using this module you need to follow for next steps

Importing dependency

If you are using Maven you need add next dependency

<dependency>
  <groupId>com.github.rkonovalov</groupId>
  <artifactId>advancedlogger</artifactId>
  <version>1.2</version>
</dependency>

If you are using another build automation tool, you can find configuration string by this URL: https://search.maven.org/artifact/com.github.rkonovalov/advancedlogger/1.2/jar

Description

Usually when are you using Log4J logging you should to use next code

public class Example {
    private static final Logger logger = Logger.getLogger(Example.class);

    public static void main(String[] args) {
        
        logger.info("Application started");
        //Do some stuff....
        logger.info("Application ended");
    }
}

But sometimes, specifically in high load applications, we should to use next code

public class Example {
    private static final Logger logger = Logger.getLogger(Example.class);

    public static void main(String[] args) {
        
         if(logger.isInfoEnabled())
             logger.info("Application started");
                
         //Do some stuff....
         if(logger.isDebugEnabled())
             logger.debug("Some debug message");
        
         
         try {            
             //Do some stuff
              logger.info("Some message");
              } catch (Exception e) {
                if(logger.isErrorEnabled())
                    logger.error("Some error", e);
              }  
              
        
         //Do some stuff....
         //Logging multiple messages
           if(logger.isInfoEnabled()) {
               logger.info("First message"); 
               logger.info("Second message"); 
               logger.info("Third message");                
           }
           
           //Or logging multiple messages as one
           if(logger.isInfoEnabled()) {
               logger.info("First message" + "Second message" + "Third message"); 
           }
    }
}

Every time we need to check that some log level is enabled. And we are forced to write some excessive code.

AdvancedLogger Intended to solve this problems. It auto checks log level before call log function. If log level is not enabled AdvancedLogger won't to call log function.

Examples

In the next example you can see typical initialization and usage of AdvancedLogger

Initialization

public class Example {
    private static final AdvancedLogger logger = AdvancedLogger.getLogger(Example.class);

    public static void main(String[] args) {
        
        logger.info(() -> "Application started");//No need to check log level anymore
        //Do some stuff....
        logger.info(() -> "Application ended");
    }
}

Log simple messages

public class Example {
    private static final AdvancedLogger logger = AdvancedLogger.getLogger(Example.class);

    public static void main(String[] args) {
        
        //Log info string
        logger.info(() -> "Hello");
        
        //Log info strings
        logger.info(() -> "First message", () -> "Second message", () -> "Third message");
        
        //Or
        logger.info(() -> "First message")
              .info(() -> "Second message")
              .info(() -> "Third message");
        
        //Log in different log levels
        logger.info(() -> "Info message") //calls info log if INFO level is enabled
                .debug(() -> "Debug message") //calls debug log if DEBUG level is enabled
                .error(() -> "Error message"); //calls error log if ERROR level is enabled
       
    }
}

Log throwable messages

public class Example {
    private static final AdvancedLogger logger = AdvancedLogger.getLogger(Example.class);

    public static void main(String[] args) {
        
        //Log error message
        logger.error(() -> new ThrowableObject("Some error", new RuntimeException())); 
        
    }
}

Log static events

public class Example {
    private static final AdvancedLogger logger = AdvancedLogger.getLogger(Example.class);
    private static final LoggerEvent currentTime = () -> "Current time: " + new Date().toString();

    public static void main(String[] args) {
        
        //Log info current time
        logger.info(currentTime);
        
        //Do some stuff
        
        //Log info current time
        logger.info(currentTime);
    }
}

Result

2018-10-15 12:09:31.271 INFO [main] Example Current time: Mon Oct 15 12:09:31 EDT 2018
...
...
2018-10-15 12:09:31.271 INFO [main] Example Current time: Mon Oct 15 12:09:32 EDT 2018

Packet logging

If the log process takes a lot of time, you can use packet logging

public class Example {
    private static final AdvancedLogger logger = AdvancedLogger.getLogger(Example.class);
    private static final LoggerEvent currentTime = () -> "Current time: " + new Date().toString();

    public static void main(String[] args) {
        
        //Start packet logging. All next log events will be added in event queue
        logger.startPacket();
        
        //Log info current time
        logger.info(currentTime);
        
        //Do some stuff
        //...
        
        //Log info current time
        logger.info(currentTime);
        
        //Stop packet logging. Print all log events from event queue
        logger.stopPacket();
    }
}

Result

...
2018-10-15 12:09:31.271 INFO [main] Example Current time: Mon Oct 15 12:09:32 EDT 2018
2018-10-15 12:09:31.271 INFO [main] Example Current time: Mon Oct 15 12:09:32 EDT 2018

Packet logging in time critical mode

By default packet logging in non critical time mode, that means result from log event will be gotten and printed when logger stopped packet logging by using logger.stopPacket() call

But sometimes we need get result from event at same time when event will be added to event queue. Thus wee need to change packet logging mode to time critical. Next example illustrates how we can do it

public class Example {
    private static final AdvancedLogger logger = AdvancedLogger.getLogger(Example.class);
    private static final LoggerEvent currentTime = () -> "Current time: " + new Date().toString();

    public static void main(String[] args) {
        
        //Start packet logging in critical time mode. All next log events will be added in event queue
        //and all event results will be gotten at same time when it added in queue
        logger.startPacket(PacketType.CRITICAL);
        
        //Log info current time
        logger.info(currentTime);
        
        //Do some stuff
        //...
        
        //Log info current time
        logger.info(currentTime);
        
        //Stop packet logging. Print all log events from event queue
        //logger will print already gotten event results
        logger.stopPacket();
    }
}

Release notes

Version 1.2

• Added static initialization
• Fixed bugs

Version 1.1

• Added packet logging

Version 1.0

• Initial release