Merge lp:~hloeung/ubuntu-repository-cache/health-check-user-agent-uid into lp:ubuntu-repository-cache

[Haw Loeung]

Add unique ID in health check requests to easily tie in apache2 logs with health check logs

[🤖 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)]

ubuntu@machine-2:~$ grep raaQyfOa /var/log/ubuntu-repository-cache/health-check.log2021-06-08 01:13:16 127.0.0.1 [raaQyfOa]: OK: #1: /ubuntu/dists/focal/InRelease (0.004)
2021-06-08 01:13:16 127.0.0.1 [raaQyfOa]: OK: #1: /ubuntu/pool/main/ (0.028)
2021-06-08 01:13:16 127.0.0.1 [raaQyfOa]: 200 OK (0.032)

ubuntu@machine-2:~$ grep raaQyfOa /var/log/apache2/archive.ubuntu.com-access.log
127.0.0.1 - - [08/Jun/2021:01:13:16 +0000] "HEAD /ubuntu/dists/focal/InRelease HTTP/1.1" 200 349 "-" "ubuntu-repository-cache/healthcheck (raaQyfOa)"
127.0.0.1 - - [08/Jun/2021:01:13:16 +0000] "HEAD /ubuntu/pool/main/ HTTP/1.1" 200 293 "-" "ubuntu-repository-cache/healthcheck (raaQyfOa)"
ubuntu@machine-2:~$

[lp:~hloeung/ubuntu-repository-cache/health-check-user-agent-uid]

338. By Haw Loeung on 2021-06-08

Fix unit test, fallout from r334

[Paul Collins (pjdc)]

review: Needs Fixing

[lp:~hloeung/ubuntu-repository-cache/health-check-user-agent-uid]

339. By Haw Loeung on 2021-06-08

Avoid modifying the global, so create a copy of it per review

[Paul Collins (pjdc)]

review: Approve (lgtm)

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

Change successfully merged at revision 337

=== modified file 'files/health_check.py'
--- files/health_check.py	2021-05-20 01:51:42 +0000
+++ files/health_check.py	2021-06-08 01:28:00 +0000
@@ -63,7 +63,7 @@
         pass
 
 
-def check_url(url):
+def check_url(url, headers=CHECK_HEADERS):
     start_time = time.time()
 
     count = 0
@@ -75,7 +75,7 @@
         msg = ''
         try:
             check_url = urljoin(CHECK_HOST, url)
-            resp = requests.head(check_url, headers=CHECK_HEADERS, timeout=CHECK_TIMEOUT)
+            resp = requests.head(check_url, headers=headers, timeout=CHECK_TIMEOUT)
             status_code = resp.status_code
             if resp.ok:
                 duration = time.time() - start_time_url
@@ -158,10 +158,14 @@
 
     start_time = time.time()
 
+    headers = CHECK_HEADERS.copy()
+    # We want to include the unique ID in the User-Agent header to
+    # easily match apache2 logs with the health-check logs.
+    headers['User-agent'] = headers['User-agent'] + ' ({})'.format(uid)
     successes = {}
     failures = {}
     for url in CHECK_URLS:
-        res = check_url(url)
+        res = check_url(url, headers)
         if res[0] == 200:
             successes[url] = res
         else:

=== modified file 'lib/ubuntu_repository_cache/tests/test_metadata_sync.py'
--- lib/ubuntu_repository_cache/tests/test_metadata_sync.py	2020-10-13 04:08:14 +0000
+++ lib/ubuntu_repository_cache/tests/test_metadata_sync.py	2021-06-08 01:28:00 +0000
@@ -192,7 +192,7 @@
                         'ubuntu-repository-cache-sync some_meta_var',
                     ],
                 ),
-                {},
+                {'stdout': -3},
             ]
         ]