From d2034cd7b6946829a7d95c4d2c71d4322f80e855 Mon Sep 17 00:00:00 2001
From: Clay Gerrard <clay.gerrard@gmail.com>
Date: Tue, 16 Jan 2018 17:03:38 -0800
Subject: [PATCH] Keep object-updater stats logging consistent

If we're going to encapsulate the stats tracking it seems reasonable if
we ever add any more metrics we can reduce the number of places we need
to update log messages.

Change-Id: I187cf6cfec1e0a9138b709fa298e1991aa809ec4
---
 swift/obj/updater.py          | 45 +++++++++++++----------------------
 test/unit/obj/test_updater.py | 12 +++++++---
 2 files changed, 25 insertions(+), 32 deletions(-)

diff --git a/swift/obj/updater.py b/swift/obj/updater.py
index 3116aa4e27..df21c01d7b 100644
--- a/swift/obj/updater.py
+++ b/swift/obj/updater.py
@@ -66,6 +66,16 @@ class SweepStats(object):
         self.successes = 0
         self.unlinks = 0
 
+    def __str__(self):
+        keys = (
+            (self.successes, 'successes'),
+            (self.failures, 'failures'),
+            (self.quarantines, 'quarantines'),
+            (self.unlinks, 'unlinks'),
+            (self.errors, 'errors'),
+        )
+        return ', '.join('%d %s' % pair for pair in keys)
+
 
 class ObjectUpdater(Daemon):
     """Update object information in container listings."""
@@ -148,16 +158,9 @@ class ObjectUpdater(Daemon):
                     elapsed = time.time() - forkbegin
                     self.logger.info(
                         ('Object update sweep of %(device)s '
-                         'completed: %(elapsed).02fs, '
-                         '%(successes)d successes, %(failures)d failures, '
-                         '%(quarantines)d quarantines, '
-                         '%(unlinks)d unlinks, %(errors)d errors'),
+                         'completed: %(elapsed).02fs, %(stats)s'),
                         {'device': device, 'elapsed': elapsed,
-                         'success': self.stats.successes,
-                         'failures': self.stats.failures,
-                         'quarantines': self.stats.quarantines,
-                         'unlinks': self.stats.unlinks,
-                         'errors': self.stats.errors})
+                         'stats': self.stats})
                     sys.exit()
             while pids:
                 pids.remove(os.wait()[0])
@@ -186,16 +189,8 @@ class ObjectUpdater(Daemon):
         elapsed = time.time() - begin
         self.logger.info(
             ('Object update single-threaded sweep completed: '
-             '%(elapsed).02fs, %(successes)d successes, '
-             '%(failures)d failures, '
-             '%(quarantines)d quarantines, %(unlinks)d unlinks, '
-             '%(errors)d errors'),
-            {'elapsed': elapsed,
-             'successes': self.stats.successes,
-             'failures': self.stats.failures,
-             'quarantines': self.stats.quarantines,
-             'unlinks': self.stats.unlinks,
-             'errors': self.stats.errors})
+             '%(elapsed).02fs, %(stats)s'),
+            {'elapsed': elapsed, 'stats': self.stats})
         dump_recon_cache({'object_updater_sweep': elapsed},
                          self.rcache, self.logger)
 
@@ -267,19 +262,11 @@ class ObjectUpdater(Daemon):
                         this_sweep = self.stats.since(start_stats)
                         self.logger.info(
                             ('Object update sweep progress on %(device)s: '
-                             '%(elapsed).02fs, '
-                             '%(successes)d successes, %(failures)d failures, '
-                             '%(quarantines)d quarantines, '
-                             '%(unlinks)d unlinks, %(errors)d errors '
-                             '(pid: %(pid)d)'),
+                             '%(elapsed).02fs, %(stats)s (pid: %(pid)d)'),
                             {'device': device,
                              'elapsed': now - start_time,
                              'pid': my_pid,
-                             'successes': this_sweep.successes,
-                             'failures': this_sweep.failures,
-                             'quarantines': this_sweep.quarantines,
-                             'unlinks': this_sweep.unlinks,
-                             'errors': this_sweep.errors})
+                             'stats': this_sweep})
                         last_status_update = now
                 try:
                     os.rmdir(prefix_path)
diff --git a/test/unit/obj/test_updater.py b/test/unit/obj/test_updater.py
index 32f72094d8..aac6325254 100644
--- a/test/unit/obj/test_updater.py
+++ b/test/unit/obj/test_updater.py
@@ -298,15 +298,21 @@ class TestObjectUpdater(unittest.TestCase):
 
         self.assertIn("sweep progress", info_lines[1])
         # the space ensures it's a positive number
-        self.assertIn(" 2 successes", info_lines[1])
+        self.assertIn(
+            "2 successes, 0 failures, 0 quarantines, 2 unlinks, 0 error",
+            info_lines[1])
         self.assertIn(self.sda1, info_lines[1])
 
         self.assertIn("sweep progress", info_lines[2])
-        self.assertIn(" 4 successes", info_lines[2])
+        self.assertIn(
+            "4 successes, 0 failures, 0 quarantines, 4 unlinks, 0 error",
+            info_lines[2])
         self.assertIn(self.sda1, info_lines[2])
 
         self.assertIn("sweep complete", info_lines[3])
-        self.assertIn(" 5 successes", info_lines[3])
+        self.assertIn(
+            "5 successes, 0 failures, 0 quarantines, 5 unlinks, 0 error",
+            info_lines[3])
         self.assertIn(self.sda1, info_lines[3])
 
     @mock.patch.object(object_updater, 'check_drive')