Support sync function for observation

.github/workflows/python-tests.yml

@@ -7,7 +7,6 @@ on:
 
 jobs:
   test:
-
     runs-on: ubuntu-latest
     strategy:
       matrix:

src/huntflow_base_metrics/base.py

@@ -1,5 +1,6 @@
 """Base definitions for metrics collections via prometheus client."""
 
+import inspect
 import logging
 import platform
 import time
@@ -30,7 +31,7 @@
 
 # Labels must be present in all collectors.
 # These labels identify the whole service and it's current instance.
-# The values should be set via `init_metrics_common` function
+# The values should be set via `start_metrics` function
 # before usage.
 COMMON_LABELS = [SERVICE_LABEL, POD_LABEL]
 COMMON_LABELS_VALUES = {
@@ -160,22 +161,39 @@ def observe_metrics(
         counter.
     """
 
-    def wrap(coro: Callable) -> Callable:
-        @wraps(coro)
-        async def _wrapper(*args: Any, **kwargs: Any) -> Any:
+    def wrap(func: Callable) -> Callable:
+        @wraps(func)
+        async def wrapper(*args: Any, **kwargs: Any) -> Any:
             if not _MetricsContext.enable_metrics:
-                return await coro(*args, **kwargs)
+                return await func(*args, **kwargs)
             start = time.perf_counter()
             if metric_inprogress is not None:
                 apply_labels(metric_inprogress, method=method).inc()
             try:
-                return await coro(*args, **kwargs)
+                return await func(*args, **kwargs)
             finally:
                 end = time.perf_counter()
                 apply_labels(metric_timings, method=method).observe(end - start)
                 if metric_inprogress is not None:
                     apply_labels(metric_inprogress, method=method).dec()
 
-        return _wrapper
+        @wraps(func)
+        def sync_wrapper(*args: Any, **kwargs: Any) -> Any:
+            if not _MetricsContext.enable_metrics:
+                return func(*args, **kwargs)
+            start = time.perf_counter()
+            if metric_inprogress is not None:
+                apply_labels(metric_inprogress, method=method).inc()
+            try:
+                return func(*args, **kwargs)
+            finally:
+                end = time.perf_counter()
+                apply_labels(metric_timings, method=method).observe(end - start)
+                if metric_inprogress is not None:
+                    apply_labels(metric_inprogress, method=method).dec()
+
+        if inspect.iscoroutinefunction(func):
+            return wrapper
+        return sync_wrapper
 
     return wrap

tests/test_observe_metrics.py

@@ -1,4 +1,5 @@
 import asyncio
+import time
 from unittest.mock import Mock
 from uuid import uuid4
 
@@ -21,10 +22,19 @@ async def observable_func(sleep_time=None):
             await asyncio.sleep(sleep_time)
         return sleep_time
 
+    @observe_metrics(method, histogram_mock)
+    def sync_observable_func(sleep_time=None):
+        if sleep_time:
+            time.sleep(sleep_time)
+        return sleep_time
+
     sleep_time = 0.3
     result = await observable_func(sleep_time)
     assert sleep_time == result
 
+    result = sync_observable_func(sleep_time)
+    assert sleep_time == result
+
     assert not histogram_mock.labels.called
 
 
@@ -55,10 +65,25 @@ async def observable_func(sleep_time=None):
         }
     )
 
-    assert (
-        REGISTRY.get_sample_value(
-            "test_timing_histogram_sum",
-            labels,
-        )
-        >= sleep_time
+    time_sum = REGISTRY.get_sample_value(
+        "test_timing_histogram_sum",
+        labels,
+    )
+    assert time_sum is not None
+    assert sleep_time <= time_sum < sleep_time + 0.01
+
+    @observe_metrics(method, histogram)
+    def sync_observable_func(sleep_time=None):
+        if sleep_time:
+            time.sleep(sleep_time)
+        return sleep_time
+
+    result = sync_observable_func(sleep_time)
+    assert sleep_time == result
+
+    time_sum = REGISTRY.get_sample_value(
+        "test_timing_histogram_sum",
+        labels,
     )
+    assert time_sum is not None
+    assert sleep_time * 2 <= time_sum < sleep_time * 2 + 0.01