Merge lp:~hloeung/ubuntu-repository-cache/metrics-include-leader-unit into lp:ubuntu-repository-cache

[Haw Loeung]

Include leader unit, or which unit we're syncing from, in metrics; Fix naming of peer sync failures metric so it's consistent

[🤖 Canonical IS Merge Bot (canonical-is-mergebot)]

This merge proposal is being monitored by mergebot. Change the status to Approved to merge.

[Haw Loeung (hloeung)]

Metrics only come from the leader unit, so this is not needed.

review: Disapprove

Unmerged revisions

381. By Haw Loeung on 2022-08-22

Fix naming of metric so it's consistent

380. By Haw Loeung on 2022-08-22

Include leader unit, or which unit we're syncing from, in metrics

=== modified file 'lib/ubuntu_repository_cache/metadata_sync.py'
--- lib/ubuntu_repository_cache/metadata_sync.py	2022-08-22 00:32:23 +0000
+++ lib/ubuntu_repository_cache/metadata_sync.py	2022-08-22 03:43:52 +0000
@@ -142,7 +142,7 @@
 # END OF VENDORING OF CHARMHELPERS FUNCTIONS.
 
 
-def mirror_archive(hostname, apache_root, local_unit, log, mirror_series, rsync_module='ubuntu'):  # NOQA: C901
+def mirror_archive(hostname, apache_root, leader_unit, local_unit, log, mirror_series, rsync_module='ubuntu'):  # NOQA: C901, E501
     """Sync Ubuntu repository metadata to the mirror.
 
     Metadata synchronization is performed and then the metadata is
@@ -201,7 +201,8 @@
         log('Sync from {} completed.'.format(archive_ip))
         duration = time.time() - upstream_sync_start_time
         metric_name = 'ubuntu_repository_cache_metadata_sync_upstream_duration'
-        send_to_influx(render_influx(metric_name, 'upstream_host={}'.format(archive_ip), duration))
+        labels = 'upstream_host={},leader_unit={}'.format(archive_ip, leader_unit)
+        send_to_influx(render_influx(metric_name, labels, duration))
 
         log('Starting repository mirror verification.')
         verification_start_time = time.time()
@@ -272,11 +273,12 @@
     except KeyError:
         rsync_module = 'ubuntu'
     apache_root = environment["APACHE_ROOT"]
+    leader_unit = environment["LEADER_UNIT"]
     local_unit = environment["LOCAL_UNIT"]
     unit_path = environment["UNIT_PATH"]
     mirror_series = environment["MIRROR_SERIES"]
 
-    meta_ver = mirror_archive(sync_host, apache_root, local_unit, log, mirror_series, rsync_module=rsync_module)
+    meta_ver = mirror_archive(sync_host, apache_root, leader_unit, local_unit, log, mirror_series, rsync_module=rsync_module)  # NOQA: E501
     if meta_ver is None:
         # If we failed to download and/or validate a new version of the
         # archives, don't propagate the information to other units.
@@ -622,6 +624,7 @@
 
         duration = time.time() - start_time
         metric_name = 'ubuntu_repository_cache_metadata_sync_total_duration'
-        send_to_influx(render_influx(metric_name, 'upstream_host={}'.format(environment["SYNC_HOST"]), duration))
+        labels = 'upstream_host={},leader_unit={}'.format(environment["SYNC_HOST"], environment["LEADER_UNIT"])
+        send_to_influx(render_influx(metric_name, labels, duration))
     except SemaphoreExistsError:
         cache_logger.info("Can't acquire semaphore: {} already exists.".format(SEMAPHORE_FILE))

=== modified file 'lib/ubuntu_repository_cache/mirror.py'
--- lib/ubuntu_repository_cache/mirror.py	2022-08-22 00:32:23 +0000
+++ lib/ubuntu_repository_cache/mirror.py	2022-08-22 03:43:52 +0000
@@ -92,7 +92,7 @@
         rsync_dest = '{}@{}:{}'.format(user, peer, dest_dir)
         LOG('Syncing {} to {}.'.format(source_dir, rsync_dest))
 
-        metric_name = 'ubuntu_repository_cache_metadata_sync_to_peers_failures'
+        metric_name = 'ubuntu_repository_cache_metadata_sync_peers_failures'
         label = 'peer={}'.format(peer)
         failures = 0
 

=== modified file 'lib/ubuntu_repository_cache/service.py'
--- lib/ubuntu_repository_cache/service.py	2022-07-27 23:26:52 +0000
+++ lib/ubuntu_repository_cache/service.py	2022-08-22 03:43:52 +0000
@@ -286,6 +286,7 @@
         # Add Juju model name  and AZ so it's easier to work out which region sent out cron emails.
         cron_context['JujuModelName'] = os.environ.get('JUJU_MODEL_NAME')
         cron_context['JujuAvailabilityZone'] = os.environ.get('JUJU_AVAILABILITY_ZONE')
+        cron_context['LeaderUnit'] = config['leader_unit']
         templating.render('cron/ubuntu-repository-cache_rsync.cron', cron_filename, cron_context)
         templating.render('cron/ubuntu-repository-cache-config', urc_config_path, cron_context)
     else:

=== modified file 'lib/ubuntu_repository_cache/tests/test_metadata_sync.py'
--- lib/ubuntu_repository_cache/tests/test_metadata_sync.py	2022-08-09 08:39:55 +0000
+++ lib/ubuntu_repository_cache/tests/test_metadata_sync.py	2022-08-22 03:43:52 +0000
@@ -151,6 +151,7 @@
             "SYNC_HOST": "foo.com",
             "MIRROR_SERIES": "xenial",
             "APACHE_ROOT": "/var/www/",
+            "LEADER_UNIT": "unit/0",
             "LOCAL_UNIT": "unit/0",
             "UNIT_PATH": "something",
         }
@@ -166,6 +167,7 @@
             "SYNC_HOST": "foo.com",
             "MIRROR_SERIES": "xenial",
             "APACHE_ROOT": "/var/www/",
+            "LEADER_UNIT": "unit/0",
             "LOCAL_UNIT": "unit/0",
             "UNIT_PATH": "something",
         }

=== modified file 'templates/cron/ubuntu-repository-cache-config'
--- templates/cron/ubuntu-repository-cache-config	2019-09-09 05:35:39 +0000
+++ templates/cron/ubuntu-repository-cache-config	2022-08-22 03:43:52 +0000
@@ -1,4 +1,9 @@
 export APACHE_ROOT={{ ApacheRoot }}
+export JUJU_MODEL_NAME={{ JujuModelName }}
+{%- if JujuAvailabilityZone %}
+export JUJU_AVAILABILITY_ZONE={{ JujuAvailabilityZone }}
+{%- endif %}
+export LEADER_UNIT={{ LeaderUnit }}
 export LOCAL_UNIT={{ UnitId }}
 export MIRROR_SERIES="{{ MirrorSeries }}"
 export PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin