From 3f949358c78e8a8a33f4a9aabc6fa36ab954c2a8 Mon Sep 17 00:00:00 2001
From: Peter Sprygada <privateip@users.noreply.github.com>
Date: Thu, 12 Jan 2017 19:20:25 -0500
Subject: [PATCH] adds some more logging to ansible-connection (#20205)

---
 bin/ansible-connection | 49 +++++++++++++++++++++---------------------
 1 file changed, 25 insertions(+), 24 deletions(-)

diff --git a/bin/ansible-connection b/bin/ansible-connection
index 2165dbc69f..d89a590682 100755
--- a/bin/ansible-connection
+++ b/bin/ansible-connection
@@ -19,9 +19,10 @@
 
 ########################################################
 from __future__ import (absolute_import, division, print_function)
-__metaclass__ = type
 
+__metaclass__ = type
 __requires__ = ['ansible']
+
 try:
     import pkg_resources
 except Exception:
@@ -100,6 +101,13 @@ def recv_data(s):
         data += d
     return data
 
+def log(msg, host=None):
+    if host:
+        msg = '[%s] %s' % (host, msg)
+    facility = getattr(syslog, C.DEFAULT_SYSLOG_FACILITY, syslog.LOG_USER)
+    syslog.openlog('ansible-connection', 0, facility)
+    syslog.syslog(syslog.LOG_INFO, str(msg))
+
 
 class Server():
 
@@ -109,37 +117,31 @@ class Server():
 
         self._start_time = datetime.datetime.now()
 
+        self.log('loading connection plugin %s' % str(play_context.connection))
+        self.conn = connection_loader.get(play_context.connection, play_context, sys.stdin)
+
         try:
-            # FIXME: the connection loader here is created brand new,
-            #        so it will not see any custom paths loaded (ie. via
-            #        roles), so we will need to serialize the connection
-            #        loader and send it over as we do the PlayContext
-            #        in the main() method below.
-            self.log('loading connection plugin %s' % str(play_context.connection))
-            self.conn = connection_loader.get(play_context.connection, play_context, sys.stdin)
+            self.log('attempting to connect to remote host')
             self.conn._connect()
 
+            self.log('successfully connected, starting listener')
             self.socket = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
             self.socket.bind(path)
             self.socket.listen(1)
-
         except Exception as exc:
-            self.log(exc)
-            return
+            self.log(str(exc))
+            raise
 
         signal.signal(signal.SIGALRM, self.alarm_handler)
 
-    def log(self, msg):
-        syslog_msg = '[%s] %s' % (self.play_context.remote_addr, msg)
-        facility = getattr(syslog, C.DEFAULT_SYSLOG_FACILITY, syslog.LOG_USER)
-        syslog.openlog('ansible-connection', 0, facility)
-        syslog.syslog(syslog.LOG_INFO, syslog_msg)
-
     def dispatch(self, obj, name, *args, **kwargs):
         meth = getattr(obj, name, None)
         if meth:
             return meth(*args, **kwargs)
 
+    def log(self, msg):
+        log(msg, self.play_context.remote_addr)
+
     def alarm_handler(self, signum, frame):
         '''
         Alarm handler
@@ -222,14 +224,14 @@ class Server():
                 s.close()
         except Exception as e:
             # FIXME: proper logging and error handling here
-            self.log('runtime exception: %s' % e)
+            log('runtime exception: %s' % e)
             print(traceback.format_exc())
         finally:
             # when done, close the connection properly and cleanup
             # the socket file so it can be recreated
             end_time = datetime.datetime.now()
             delta = end_time - self._start_time
-            self.log('shutting down connection, connection was active for %s secs' % delta)
+            log('shutting down connection, connection was active for %s secs' % delta, self.play_context.remote_addr)
             try:
                 self.conn.close()
                 self.socket.close()
@@ -238,6 +240,7 @@ class Server():
             os.remove(self.path)
 
 def main():
+
     try:
         # read the play context data via stdin, which means depickling it
         # FIXME: as noted above, we will probably need to deserialize the
@@ -252,7 +255,6 @@ def main():
             cur_line = sys.stdin.readline()
         src = BytesIO(to_bytes(init_data))
         pc_data = cPickle.load(src)
-        #src.close()
 
         pc = PlayContext()
         pc.deserialize(pc_data)
@@ -312,13 +314,12 @@ def main():
                 time.sleep(C.PERSISTENT_CONNECT_INTERVAL)
                 attempts += 1
                 if attempts > C.PERSISTENT_CONNECT_RETRIES:
-                    sys.stderr.write("failed to connect to the host, connection timeout")
+                    sys.stderr.write('failed to connect to the listener socket, '
+                    'connection timeout.  See syslog for more details')
                     sys.exit(255)
 
-        #
         # send the play_context back into the connection so the connection
-        # can handle any privilege escalation or deescalation activities
-        #
+        # can handle any privilege escalation activities
         pc_data = 'CONTEXT: %s' % src.getvalue()
         send_data(sf, to_bytes(pc_data))
         src.close()