Posted on Oct 19 • Originally published at hardikchotaliya.hashnode.dev Logging is an essential aspect of any automation Framework. It not only helps us monitor the progress of test execution but also plays a crucial role in debugging issues. In this blog post, we will explore how to set up a Logger for a WebdriverIO automation framework using TypeScript. We will use the popular Winston logger to enhance our test reporting and debugging capabilities.Before diving into the details of setting up a logger in a WebdriverIO framework, let's understand why logging is crucial:Monitoring Test Progress: Logging allows us to keep track of each step of our test cases, making it easier to identify the progress and identify any issues during test execution.Debugging: When a test fails, logs can be a lifesaver. They provide valuable information that helps us diagnose and fix problems quickly. Without logs, identifying the root cause of a failure can be a time-consuming task.Reporting: Comprehensive logs are valuable for generating detailed test reports. They can be used to create meaningful reports that stakeholders can use to understand the test results.Winston is a versatile and widely used logger in the Node.js ecosystem. In the context of a WebdriverIO framework, we'll use it for console logging. Here are the steps to set up the Winston logger:First, you need to install the Winston package as a development dependency. You can do this using npm:Next, create a logger.ts file in your framework project. In this file, you'll define the logger and its configuration. Here's a simple example of what it might look like:In this example, we set up a basic logger that logs messages in a colored format to the console.👩🏼‍🏫 Explanation:Import the required winston library for logging.Create a function consoleFormat that formats log messages. It takes the log level, message, and timestamp as input and colorizes the log level. The formatted message includes the timestamp, log level (in uppercase), and the actual log message.Create a Winston logger by using winston.createLogger. It uses a Console transport for logging.Inside the logger configuration, set the log level based on the LOG_LEVEL environment variable. This allows you to control the log level dynamically.Add the handleExceptions: true option to handle exceptions and log them.Apply the custom format to the log entries, including adding a timestamp and using the consoleFormat function for formatting.Create an event listener for the "error" event on the logger. This will catch and log any unknown errors that may occur within the logger.Export the configured logger for use in other parts of your application.This code sets up a flexible Winston logger with customizable log levels, proper formatting, and the ability to catch and log errors. It is well-documented for clarity and maintainNow, you can use the logger in your test scripts. Import it and utilize its various methods to log messages according to their significance. For example:You can configure log levels based on the environment to make your logger more versatile. For instance, you might want to log more information during debugging but limit logging during regular test runs. You can set the log level using an environment variable like process.env.loglevel.With the Winston logger integrated into your WebdriverIO framework, you'll see detailed log messages as your tests run. These logs will include information about the progress of your tests and any errors encountered.In this blog post, we've learned the importance of logging in a WebdriverIO + TypeScript framework and how to set up a powerful logger using Winston. Effective logging is crucial for monitoring test progress, debugging, and generating meaningful reports. By implementing logging in your automation framework, you can improve the efficiency and reliability of your test suite, making it easier to identify and address issues as they arise. Happy testing!If you have any questions or need further assistance with setting up a logger in your automation framework, feel free to reach out to the below GitHub Repository!%[https://github.com/hardikchotaliya/WebdriverIO-TS-Cucumber-e2e] Templates let you quickly answer FAQs or store snippets for re-use. Are you sure you want to hide this comment? It will become hidden in your post, but will still be visible via the comment's permalink. Hide child comments as well Confirm For further actions, you may consider blocking this person and/or reporting abuse Arek Nawo - Oct 18 Priyankesh - Oct 18 chedy322 - Oct 18 Michael Antczak - Oct 18 Once suspended, hardikchotaliya will not be able to comment or publish posts until their suspension is removed. Once unsuspended, hardikchotaliya will be able to comment and publish posts again. Once unpublished, all posts by hardikchotaliya will become hidden and only accessible to themselves. If hardikchotaliya is not suspended, they can still re-publish their posts from their dashboard. Note: Once unpublished, this post will become invisible to the public and only accessible to Hardik Chotaliya. They can still re-publish the post if they are not suspended. Thanks for keeping DEV Community safe. Here is what you can do to flag hardikchotaliya: hardikchotaliya consistently posts content that violates DEV Community's code of conduct because it is harassing, offensive or spammy. Unflagging hardikchotaliya will restore default visibility to their posts. DEV Community — A constructive and inclusive social network for software developers. With you every step of your journey. Built on Forem — the open source software that powers DEV and other inclusive communities.Made with love and Ruby on Rails. DEV Community © 2016 - 2023. We're a place where coders share, stay up-to-date and grow their careers.