Reformatted and added color to logger messages. (#252)

Closes #248 

Added color to logging and converted some info messages to debug.

added colors and cleaned up logger

corrected formatting

added to dependencies

reverted message log level change

added debug format

debug logging format now works

flake8 fix

maestrowf/conductor.py

@@ -48,8 +48,7 @@
 LOGGER = logging.getLogger(__name__)
 
 # Formatting of logger.
-LFORMAT = "%(asctime)s - %(name)s:%(funcName)s:%(lineno)s - " \
-               "%(levelname)s - %(message)s"
+LFORMAT = "[%(asctime)s: %(levelname)s] %(message)s"
 
 
 def setup_logging(name, output_path, log_lvl=2, log_path=None,

maestrowf/datastructures/core/study.py

@@ -196,7 +196,7 @@ def __init__(self, name, description,
         self._out_path = out_path
         self._meta_path = os.path.join(out_path, "meta")
 
-        LOGGER.info("OUTPUT_PATH = %s", out_path)
+        LOGGER.debug("OUTPUT_PATH = %s", out_path)
         # Flag the study as not having been set up and add the source node.
         self._issetup = False
         self.add_node(SOURCE, None)
@@ -376,7 +376,7 @@ def walk_study(self, src=SOURCE):
     def setup_workspace(self):
         """Set up the study's main workspace directory."""
         try:
-            LOGGER.info("Setting up study workspace in '%s'", self._out_path)
+            LOGGER.debug("Setting up study workspace in '%s'", self._out_path)
             create_parentdir(self._out_path)
         except Exception as e:
             LOGGER.error(e.args)
@@ -386,7 +386,7 @@ def setup_environment(self):
         """Set up the environment by acquiring outside dependencies."""
         # Set up the environment if it hasn't been already.
         if not self.environment.is_set_up:
-            LOGGER.info("Environment is setting up.")
+            LOGGER.debug("Environment is setting up.")
             self.environment.acquire_environment()
 
     def configure_study(self, submission_attempts=1, restart_limit=1,

maestrowf/datastructures/core/studyenvironment.py

@@ -188,7 +188,7 @@ def acquire_environment(self):
             LOGGER.info("Environment already set up. Returning.")
             return
 
-        LOGGER.info("Acquiring dependencies")
+        LOGGER.debug("Acquiring dependencies")
         for dependency, value in self.dependencies.items():
             LOGGER.info("Acquiring -- %s", dependency)
             value.acquire(substitutions=self.substitutions.values())

maestrowf/maestro.py

@@ -53,8 +53,9 @@
 LOG_UTIL = LoggerUtility(LOGGER)
 
 # Configuration globals
-LFORMAT = "%(asctime)s - %(name)s:%(funcName)s:%(lineno)s - " \
-          "%(levelname)s - %(message)s"
+DEBUG_FORMAT = "[%(asctime)s: %(levelname)s] " \
+               "[%(module)s: %(lineno)d] %(message)s"
+LFORMAT = "[%(asctime)s: %(levelname)s] %(message)s"
 ACCEPTED_INPUT = set(["yes", "y"])
 
 
@@ -409,7 +410,11 @@ def main():
 
     # If we have requested to log stdout, set it up to be logged.
     if args.logstdout:
-        LOG_UTIL.configure(LFORMAT, args.debug_lvl)
+        if args.debug_lvl == 1:
+            lformat = DEBUG_FORMAT
+        else:
+            lformat = LFORMAT
+        LOG_UTIL.configure(lformat, args.debug_lvl)
 
     LOGGER.info("INFO Logging Level -- Enabled")
     LOGGER.warning("WARNING Logging Level -- Enabled")

maestrowf/utils.py

@@ -30,6 +30,7 @@
 """A collection of more general utility functions."""
 
 from collections import OrderedDict
+import coloredlogs
 import logging
 import os
 import string
@@ -271,14 +272,17 @@ def __init__(self, logger):
         """
         self._logger = logger
 
-    def configure(self, log_format, log_lvl=2):
+    def configure(self, log_format, log_lvl=2, colors=True):
         """
         Configures the general logging facility.
 
         :param log_format: String containing the desired logging format.
         :param log_lvl: Integer level (1-5) to set the logger to.
         """
         logging.basicConfig(level=self.map_level(log_lvl), format=log_format)
+        if colors:
+            coloredlogs.install(level=self.map_level(log_lvl),
+                                logger=self._logger, fmt=log_format)
 
     def add_stream_handler(self, log_format, log_lvl=2):
         """

requirements.txt

@@ -5,6 +5,7 @@ tabulate
 enum34; python_version<'3.4'
 dill
 jsonschema>=3.2.0
+coloredlogs
 -e .
 
 fabric

setup.py

@@ -26,6 +26,7 @@
     "enum34 ; python_version<'3.4'",
     "dill",
     "jsonschema>=3.2.0",
+    "coloredlogs",
   ],
   extras_require={},
   long_description_content_type='text/markdown',