Logger utility which creates an HTML log file which is easier to organize and helps with debugging.

• Easy to implement
• Logs current data and time, example: 01/23/2022 14:55:38 PM
• Generates on runtime
  • does not need to flush at the end
  • an exception thrown by client does not impact cretion of the file
• Parallel Execution
  • allows the user to create multiple sub logs within the main log
  • also works as a single log without internal logs
• Organization
  • creates sub logs as a list
  • links the logs to the log tables
  • allows to only view a single sub-log at a time
  • allows creation of main logs without sub-logs
  • allows to add nodes within the logs for large log messages like data base query results and api request and responses
• Customization
  • overwrite default logo
  • overwrite default target directory / file name
  • overwrite heading / sub-heading / title
  • add custom logo via source URL
  • add links to GitHub, Jira, mail-to-address
  • remove images
• Methods
  • info (logs info with timestamp)
  • warn (logs warning (in red) with timestamp)
  • toNode (creates collapsible node with timestamp)

Creating a new logger, providing custom options, creating sub-logs, and logging information to the log file is very simple. See below for details.

Upon initializing the Logger class, a new log file is created with default values. Read more about LoggerOptions for deails about default values and over-writing them.
Log can be initiazed using one of the 2 constructors

Logger myNewLog = new Logger();

Logger myNewLog = new Logger(loggerOptions);

The above statement takes instance of the the Logger Options class. See below for more deails about LoggerOptions. By providing the logger options, the log file will be created using user provided properties.

LoggerOptions class allows the user to overwrite the default values while creating the new log file. The logger options allows user to change/create:

• Target directory: folder path where log file is created
  • Method: setTargetDir("directory path")
  • Default value: project directory/target which is default for maven projects
• File name: name of the log file
  • Method: setFilename("log file name.html")
  • Default value: logs.html
• Title: title of the HTML page
  • Method: setTitle("HTML page title")
  • Default value: CHIMP CENTRAL
• Heading: heading on top of the page
  • Method: setHeading("heading")
  • Default value: CHIMP CENTRAL
• Sub Heading: sub heading on top under heading
  • Method: setSubHeading("sub heading")
  • Default value: Project Logs
• Logo Source URL: source URL for the log in navigation pane
  • Method: setLogoSrcURL("source URL")
  • Default value: points to Chimp Central logo
• Remove Images: By default the links are created with images/icons. These icon can be removed by calling this method. Keeping the images does not have a significant impact on perfomance.
  • Method: removeImages();
  • Default value: true Below options are only added to the log file if provided in the logger options. If the setters are not called for the below options, then these would not exist in the log file since they are very specific to the user/organization.
• GitHub URL: href URL for the GitHub website
  • Method: setGithubURL("URL to GitHub website")
  • Default value: none
• Jira URL: href URL for the Jira website
  • Method: setJiraURL("URL to Jira website")
  • Default value: none
• Mail To Address: email address for send email link
  • Method: setMailToAddress("email address")
  • Default value: none Logger Options setters return the instance of the LoggerOptions using this keyword and the setters can be called using chains. Below are a few examples of initializing LoggerOptions.

LoggerOptions myloggeroptions = new LoggerOptions();
myloggeroptions.setTargetDir(System.getProperty("user.dir) + "/myDirectory")
myloggeroptions.setFilename("mylog.html")
myloggeroptions.setHeading("MY HEADING")
myloggeroptions.setGithubURL("https://github.com/kwbhatti/logger")

LoggerOptions myloggeroptions = new LoggerOptions();
            .setLogoSrcURL("URL to logo file")
            .setTitle("my title")
            .setMailToAddress("[email protected]")
            .removeImages();

Sub log is log within the main logger. A new log can be instantiated by calling the createLog method from the logger instance. Creating a sub log creates a list item pane in the main logger. Each log name is displayed in the log list and is linked to the table for that specific log. Logger is not limited to a single sub log, but many sub logs can be created inside a logger.

Log mySubLog1 = logger.createLog("Sub Log 1");
Log mySubLog2 = logger.createLog("Sub Log 2");
Log mySubLog3 = logger.createLog("Sub Log 3");

Before creating a sub log, the log table container width expands to 95% of the page, but create a sub log creates a log list which takes up to 20% and reduces the log table container width to 75%.

Log methods are available at both for the logger (main log) and the log (sub log) instance. See below for details and examples.

Creates a log row with timestamp and message.
Examples:
logger.info("this is a message in the main log");
mySubLog1.info("this is a message in the sub log 1")
mySubLog2.info("this is a message in the sub log 2")\

Creates a log row with timestamp and message, and the word warning is in red color.
Examples:
logger.warn("this is a warning in the main log");
mySubLog3.info("this is a warning in the sub log 3")
mySubLog2.info("this is a warning in the sub log 2")

Creates a log row with the exception method, and the word warning is in red color. Logs the following:

• exception message
• exception cause
• exception class name
• exception stack trace\

Examples:
logger.exception(new Exception("some exception message in main log"));
mySubLog1.exception(new Exception("some exception message in sub log 1"));

Create a log row, and instead of the whole message, creates two containers that act as an accodion. the first container displays the name of the node, and displays the full message when clicked. Great for organization, which allows to view the log in a more compact view. General uses are to use for data base query ResultSet. API request and responses.
Examples:
logger.toNode("name of node", "message in main log");
mySubLog3.toNode("name of node", "message in sub log 3");\

Here is some sample code to get started. Passing the instance of LoggerOptions is optional in the below examples.

LoggerOptions loggerOptions = new LoggerOptions()
         .setFilename("log example 1.html")
         .setGithubURL("https://github.com/")
         .setJiraURL("https://www.atlassian.com/software/jira")
         .setMailToAddress("[email protected]")
         .setTitle("Example Log")
         .setHeading("Single log example")
         .setSubHeading("logs for demo purpose")
         .removeImages();

Logger logger = new Logger();
logger.info("some random info text in log");
logger.info("some random info text in log");
logger.info("some random info text in log");
logger.warn("some random warning text in log");
logger.info("some random info text in log");
logger.exception(new Exception("some exception in log"));
logger.info("some random info text in log");
logger.toNode("foo", "some random info text in logger node foo");
logger.info("some random info text in log");
logger.toNode("bar", "some random info text in logger node bar");
logger.warn("some random warning text in log");
logger.info("some random info text in log");\

Above code would create a new logger with the provided logger options and add the logs to the main log. Calling the removeImages method would also remove the images from the log file. See below.

• Khurram Waleed Bhatti