Pull Request review and better log formatting

nchammas · Mar 13, 2017 · f656118 · f656118
1 parent 75d130c
commit f656118
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 13 deletions.
diff --git a/flintrock/ec2.py b/flintrock/ec2.py
@@ -4,7 +4,6 @@
 import time
 import urllib.request
 import base64
-import os
 import logging
 from collections import namedtuple
 from datetime import datetime
@@ -127,9 +126,8 @@ def wait_for_state(self, state: str):
         while any([i.state['Name'] != state for i in self.instances]):
             if logger.isEnabledFor(logging.DEBUG):
                 waiting_instances = [i for i in self.instances if i.state['Name'] != state]
-                sample_size = 3
-                sample = [i.id for i in waiting_instances][:sample_size]
-                logger.debug('{size} instances not in state {state}, like: {sample} ...'.format(size=len(waiting_instances), state=state, sample=sample))
+                sample = ', '.join(["'{}'".format(i.id) for i in waiting_instances][:3])
+                logger.debug("{size} instances not in state '{state}': {sample}, ...".format(size=len(waiting_instances), state=state, sample=sample))
             time.sleep(3)
             # Update metadata for all instances in one shot. We don't want
             # to make a call to AWS for each of potentially hundreds of

diff --git a/flintrock/flintrock.py b/flintrock/flintrock.py
@@ -161,15 +161,17 @@ def get_config_file() -> str:
 
 
 def configure_log(debug: bool):
-    handler = logging.StreamHandler()
+    root_logger = logging.getLogger('flintrock')
+    import sys
+    handler = logging.StreamHandler(sys.stdout)
     handler.setLevel(logging.DEBUG)
     if debug:
-        logger.setLevel(logging.DEBUG)
-        handler.setFormatter(logging.Formatter('%(asctime)s %(message)s'))
+        root_logger.setLevel(logging.DEBUG)
+        handler.setFormatter(logging.Formatter('%(asctime)s - flintrock.%(module)-9s - %(levelname)-5s - %(message)s'))
     else:
-        logger.setLevel(logging.INFO)
+        root_logger.setLevel(logging.INFO)
         handler.setFormatter(logging.Formatter('%(message)s'))
-    logger.addHandler(handler)
+    root_logger.addHandler(handler)
 
 
 @click.group()
@@ -180,7 +182,7 @@ def configure_log(debug: bool):
 @click.option('--provider', default='ec2', type=click.Choice(['ec2']))
 @click.version_option(version=__version__)
 # TODO: implement some solution like in https://github.com/pallets/click/issues/108
-@click.option('--debug/--no-debug', default=False, help="Whether to show debug messages")
+@click.option('--debug/--no-debug', default=False, help="Show debug information.")
 @click.pass_context
 def cli(cli_context, config, provider, debug):
     """

diff --git a/flintrock/ssh.py b/flintrock/ssh.py
@@ -84,17 +84,17 @@ def get_ssh_client(
                 logger.info("[{h}] SSH online.".format(h=host))
             break
         except socket.timeout as e:
-            logger.debug("[{h}] SSH got a timeout...".format(h=host))
+            logger.debug("[{h}] SSH timeout.".format(h=host))
             time.sleep(5)
         except paramiko.ssh_exception.NoValidConnectionsError as e:
             if any(error.errno != errno.ECONNREFUSED for error in e.errors.values()):
                 raise
-            logger.debug("[{h}] SSH got an exception: {e}".format(h=host, e=e))
+            logger.debug("[{h}] SSH exception: {e}".format(h=host, e=e))
             time.sleep(5)
         # We get this exception during startup with CentOS but not Amazon Linux,
         # for some reason.
         except paramiko.ssh_exception.AuthenticationException as e:
-            logger.debug("[{h}] SSH got an AuthenticationException".format(h=host))
+            logger.debug("[{h}] SSH AuthenticationException.".format(h=host))
             time.sleep(5)
     else:
         raise SSHError(