Merge lp:~joetalbott/adt-cloud-worker/add_logging_extra into lp:adt-cloud-worker

[Joe Talbott]

Add logging_extra.

Add logging_extra.

[Paul Larson (pwlars)]

Unless I've missed something, there's some duplication introduced by this.

review: Needs Fixing

[Para Siva (psivaa)]

An inline comment, just to be sure. Otherwise +1 from me.

review: Approve

[lp:~joetalbott/adt-cloud-worker/add_logging_extra]

36. By Joe Talbott on 2015-04-15

Move description above imports.

37. By Joe Talbott on 2015-04-15

Remove duplication for API_VERSION

=== modified file 'adt_cloud_worker/__init__.py'
--- adt_cloud_worker/__init__.py	2015-04-14 22:34:53 +0000
+++ adt_cloud_worker/__init__.py	2015-04-15 19:15:52 +0000
@@ -38,12 +38,15 @@
     set_config_dict,
     upload_tarball_to_swift_container,
 )
+from adt_cloud_worker.constants import (
+    API_VERSION,
+    logging_extra,
+)
 
 ARCHITECTURES = (
     'amd64',
     'i386'
 )
-API_VERSION = "v1"
 
 
 logger = logging.getLogger(__name__)
@@ -86,7 +89,9 @@
         for later checking.
         """
         body['worker'] = self.worker_name
-        logger.info('Received message request: %s', body, extra=body)
+        extra = logging_extra.copy()
+        extra.update(body)
+        logger.info('Received message request: %s', body, extra=extra)
 
         # Run requested tests safely.
         tarball_path = None
@@ -105,10 +110,10 @@
                 arguments = _make_adt_argument_list(adt_kwargs)
                 logger.info(
                     'Running adt-run with: %s', ' '.join(arguments),
-                    extra=body)
+                    extra=extra)
                 body['exit_code'] = run_adt(arguments)
                 logger.info(
-                    'Exit code: %s', body['exit_code'], extra=body)
+                    'Exit code: %s', body['exit_code'], extra=extra)
                 _create_run_metadata_file(result_dir, body)
                 tarball_path = _create_tarball_from_directory(
                     result_dir,
@@ -124,9 +129,9 @@
             # help debugging of deadletter-ed messages.
             body['exit_code'] = 100
             body['worker_traceback'] = traceback.format_exc()
-            logger.error(e, exc_info=True, extra=body)
+            logger.error(e, exc_info=True, extra=extra)
         finally:
-            logger.info('Posting results: %s', body, extra=body)
+            logger.info('Posting results: %s', body, extra=extra)
             queue = self.connection.SimpleQueue(
                 'adt.results.{}'.format(API_VERSION))
             queue.put(body)
@@ -134,7 +139,7 @@
             if tarball_path is not None and os.path.exists(tarball_path):
                 os.remove(tarball_path)
             message.ack()
-            logger.info('Done!', extra=body)
+            logger.info('Done!', extra=extra)
 
 
 def _create_run_metadata_file(directory, request):

=== added file 'adt_cloud_worker/constants.py'
--- adt_cloud_worker/constants.py	1970-01-01 00:00:00 +0000
+++ adt_cloud_worker/constants.py	2015-04-15 19:15:52 +0000
@@ -0,0 +1,36 @@
+# adt-cloud-worker
+# Copyright (C) 2015 Canonical
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+
+"""Constants for this service."""
+
+import socket
+
+
+API_VERSION = "v1"
+
+SOLUTION_NAME = "proposed-migration"
+
+SERVICE_NAME = "adt-cloud-worker"
+
+HOSTNAME = socket.gethostname()
+
+
+logging_extra = {
+    'solution': SOLUTION_NAME,
+    'service': SERVICE_NAME,
+    'hostname': HOSTNAME,
+}