How to use Log4j in Selenium

Logging is a procedure that direct coating to a newer point with info log on how the applications may or may not have performed/executed. It afford an exact idea of software execution, including any shortcomings. This is where Log4j in Selenium helps.

This article explore the concept of log, how to set up and use Log4j in Selenium, and why it is an essential tool for enhancing test automation and debug efficiency.

What is Logging?

Logging is a process that conduct applications to a newer level with information logs on how the applications may or may not get performed/executed. It gives an exact mind of software performance, including any shortcomings.

Log4j in is one such lumber framework that helps in garner info in the pattern of log or log file.

What is Log4j in Selenium?

Log4j is a logging model written in Java that provides an easy way for logging in Selenium. In a nutshell, the framework give out information about everything that goes on during the software performance.

Log4j also provides insight into anything that may have gone wrong during software execution or mechanization. Overall, Log4j documents the output in the signifier of logs that can be examined later for design such as auditing small-scale and large-scale.

Components of Log4j

The Log4j logging framework be the following components:

1. Logger
2. Appenders
3. Layout

Logger

The map of the logger in Log4j is basically storing and capturing all the necessary logging information that will be generated apply the framework.

To truly understand its performance, let ’ s dig a little deeper and discourse the logger class, and log level methods. The loggers too decide which priority is travel to be becharm.

1. Logger Class& # 8211; To fully use the logger, create an instance for a logger grade where all the generic methods will be at the exploiter ’ s disposition, required to use Log4j.
2. Log Levels& # 8211; These are the method that will be habituate to print the log messages. There are principally solely a few log levels that are used in a script.

• ALL & # 8211;This level will prioritize and include everything in the logarithm.
• ERROR & # 8211;This level will prove content that inform user about erroneousness events that may not stop the application.
• WARN & # 8211;This level will show info regarding warnings, that may not kibosh the executing but may however induce problems.
• DEBUG & # 8211;This level will log debugging information.
• INFO & # 8211;This level will log the progress of the application.
• FATAL & # 8211;This will print information critical to the system that may even ram the coating.

SUSA automates exploratory testing with persona-driven behavior, catching bugs that scripted automation misses.

Appenders

The appender essentially grabs information from the lumberman and writes log messages to a file or any other storehouse position. The pursuit are some of the appenders one can use for Log4j:

1. FileAppender & # 8211;This will supplement the log message to a file.
2. RollingFileAppender & # 8211;It will perform the same function as FileAppender, but users will be able to specify the maximal file size. Once the limit is pass, the appender will create another file to write the messages.
3. DailyRollingFileAppender & # 8211;It fix the frequence by which the messages are to be written to the file.
4. ConsoleAppender & # 8211;In this, the appender will simply write the log message in the console.

Layout

The layout is where the format in which log messages will appear is decided. There are several layouts one can use for log messages:

1. Pattern Layout & # 8211;The user must specify a conversion pattern base on which the logs will be displayed. Otherwise, it occupy the default conversion pattern in case of “ no pattern specified ”.
2. HTML Layout & # 8211;In this layout, the format of logarithm will be in the pattern of an HTML table.
3. XML Layout & # 8211;This will evidence the logs in an XML format.

Now, let ’ s lead a look at how to download and set up Log4j.

How to Set up Log4j in Selenium

To efficiently download and set up Log4j for Selenium, follow the coming below:

1. Download Log4j from the officialApache website.

2. After download theLog4j, add the log4j.jarfile to the java build path.

3. After adding the jar file in the configuration, one can useLog4jsuccessfully in scripts.

How to Use Log4j in Selenium

Follow the step below to successfully run Log4j with:

1. Write an automation script, such as the one in the example below. It is a simple script that opens a URL, post key to username and password, and ends the book when it snap the login push.
2. After creating the playscript, create alog4j.propertiesfile and specify the root faller, affix, and layout information in the file.
3. Import log4j dependencies likeLogger, PropertyConfigurator,and add them to the script along with the logger class.
4. Add the messages that will be displayed in the log file.

Here ’ s an instance to understand it better.

[java] parcel newpackage; import org.openqa.selenium.WebDriver; import org.openqa.selenium.chrome.ChromeOptions; import org.openqa.selenium.UnexpectedAlertBehaviour; importee org.openqa.selenium.chrome.ChromeDriver; import org.apache.log4j.Logger; import org.apache.log4j.PropertyConfigurator; import org.openqa.selenium.JavascriptExecutor; public class Myclass {static Logger log = Logger.getLogger (Myclass.class); public inactive void main (String [] args) {PropertyConfigurator.configure (`` path\\to\\log4j.properties ''); System.setProperty (`` webdriver.chrome.driver '', `` Path\\to\\chromedriver.exe ''); ChromeOptions option = new ChromeOptions (); options.setUnhandledPromptBehaviour (UnexpectedAlertBehaviour.IGNORE); WebDriver driver = new ChromeDriver (options); JavascriptExecutor js = (JavascriptExecutor) driver; driver.get (`` https: //www.browserstack.com/users/sign_in ''); log.info (`` Open browserstack ''); driver.manage () .window () .maximize (); log.info (`` Maximize window size ''); js.executeScript (`` document.getElementById ('user_email_login ') .value='rbc @ xyz.com '; ''); log.info (`` enter username ''); js.executeScript (`` document.getElementById ('user_password ') .value='password '; ''); log.info (`` enter password ''); js.executeScript (`` document.getElementById ('user_submit ') .click (); ''); log.info (`` click on login ''); driver.close ();}} [/java]

Output:

The above programme will run an automation book, and simultaneously create a log file at the specified locating with the name given in thelog4j.properties file.

Log4j with Properties File Configuration

The properties configuration file will contain the information regarding the following:

1. The first objective is to identify the log level and the address where the log will be written. In this example, the log degree is theDEBUG pointand a file is the destination.
2. The future measure is to establish an appender. This example uses aRollingFIleAppenderwith a maximum capacity of 2MB and the file locating is likewise specified in this section. TheMaxBackupIndexis the number of files that will be created in suit the file size is exceeded.
3. The last section control the layout in which a format is specified. This example usesPatternLayout. And, since we have not used a conversion pattern here, it will take the nonremittal conversion pattern into report.

# beginning feller log4j.rootLogger = DEBUG, file # appender log4j.appender.file = org.apache.log4j.RollingFileAppender log4j.appender.file.File = PATH\\TO\\firstoutput.log log4j.appender.file.MaxFileSize = 2MB log4j.appender.file.MaxBackupIndex = 3 # layout log4j.appender.file.layout = org.apache.log4j.PatternLayout

Why Use Log4j in Selenium?

Use Log4j logging fabric in Selenium for the following reasons:

1. Log4j logging framework can help in debugging coating well. With different log levels, it turn easier to sort information based on categories.
2. The logging framework is open source and can facilitate in log in different log levels and suppress logs in different environments & # 8211; which finally improves application performance.
3. The framework make better output in general.
4. With three components and clearness in usage, it becomes leisurely to use and configure log4j in Selenium.
5. The setup is easy and free of cost, making it more accessible for faster debugging.

Talk to an Expert

Conclusion

Log4j is a great logging framework to use in Selenium. Its robust design and clear ingredient make it easier to track, monitor, and debug automation exam by continue log. Not entirely do debug become easier, but Log4j also offers the ability to continue logging in different levels in both examination and production surround without create any rough-and-tumble.

Bear in mind trial must be executed on existent devices and browsers. Remember that is a major concern for every developer and tester. Every website has to work seamlessly on multiple device-browser-OS combinations. With be use to access the internet globally, all package has to be optimized for different configurations, viewports,.

In this state, no emulator or simulator can replicate. Software require to be tested on real devices so that they can work in real-world luck such as a low battery, incoming calls,, and so on. If an in-house lab is not accessible, opt for a that proffer real devices.

BrowserStack ’ s offers 3500+ existent devices and browser for machine-controlled testing. That means exploiter can run tests on multiple real device and browsers by simply signing up, logging in, and take the mandatory combination. Testers can also conduct on 30+ real browser versions across Windows and macOS. Detects bugs before users do by testing software in real user conditions with BrowserStack.

Related Guides