extract and add tests for statsd blocks

Author: wuan

blitzortung/cache.py

@@ -117,7 +117,7 @@ def clean_expired(self):
     def get_time_to_live(self):
         return self.__ttl_seconds
 
-    def get_ratio(self):
+    def get_ratio(self) -> float:
         if self.total_hit_count == 0:
             return 0.0
         return self.total_hit_count / self.total_count

blitzortung/cli/webservice.py

@@ -23,6 +23,7 @@
 from blitzortung.gis.constants import grid, global_grid
 from blitzortung.gis.local_grid import LocalGrid
 from blitzortung.service.cache import ServiceCache
+from blitzortung.service.metrics import StatsDMetrics
 from blitzortung.util import TimeConstraint
 
 try:
@@ -47,8 +48,6 @@
 
 is_pypy = platform.python_implementation() == 'PyPy'
 
-statsd_client = statsd.StatsClient('localhost', 8125, prefix='org.blitzortung.service')
-
 FORBIDDEN_IPS = {}
 
 USER_AGENT_PREFIX = 'bo-android-'
@@ -93,6 +92,8 @@ def __init__(self, db_connection_pool, log_directory):
         self.next_memory_info = 0.0
         self.minute_constraints = TimeConstraint(self.DEFAULT_MINUTE_LENGTH, self.MAX_MINUTES_PER_DAY)
 
+        self.metrics = StatsDMetrics(statsd_client)
+
     addSlash = True
 
     def __get_epoch(self, timestamp):
@@ -143,7 +144,7 @@ def get_strikes_grid(self, minute_length, grid_baselength, minute_offset, region
         time_interval = create_time_interval(minute_length, minute_offset)
 
         grid_result, state = self.strike_grid_query.create(grid_parameters, time_interval, self.connection_pool,
-                                                           statsd_client)
+                                                           self.metrics.statsd)
 
         histogram_result = self.get_histogram(time_interval, envelope=grid_parameters.grid) \
             if minute_length > self.HISTOGRAM_MINUTE_THRESHOLD else succeed([])
@@ -160,7 +161,7 @@ def get_global_strikes_grid(self, minute_length, grid_baselength, minute_offset,
         time_interval = create_time_interval(minute_length, minute_offset)
 
         grid_result, state = self.global_strike_grid_query.create(grid_parameters, time_interval, self.connection_pool,
-                                                                  statsd_client)
+                                                                  self.metrics.statsd)
 
         histogram_result = self.get_histogram(
             time_interval) if minute_length > self.HISTOGRAM_MINUTE_THRESHOLD else succeed([])
@@ -179,7 +180,7 @@ def get_local_strikes_grid(self, x, y, grid_baselength, minute_length, minute_of
         time_interval = create_time_interval(minute_length, minute_offset)
 
         grid_result, state = self.strike_grid_query.create(grid_parameters, time_interval, self.connection_pool,
-                                                           statsd_client)
+                                                           self.metrics.statsd)
 
         histogram_result = self.get_histogram(time_interval, envelope=grid_parameters.grid) \
             if minute_length > self.HISTOGRAM_MINUTE_THRESHOLD else succeed([])
@@ -237,12 +238,7 @@ def jsonrpc_get_global_strikes_grid(self, request, minute_length, grid_base_leng
              minute_offset,
              0, count_threshold, client, user_agent))
 
-        statsd_client.incr('strikes_grid.total_count')
-        statsd_client.incr('global_strikes_grid.total_count')
-        statsd_client.gauge('global_strikes_grid.cache_hits', cache.get_ratio())
-        if minute_length == 10:
-            statsd_client.incr('strikes_grid.bg_count')
-            statsd_client.incr('global_strikes_grid.bg_count')
+        self.metrics.for_global_strikes(minute_length, cache.get_ratio())
 
         return response
 
@@ -289,13 +285,7 @@ def jsonrpc_get_local_strikes_grid(self, request, x, y, grid_base_length=10000,
                 minute_offset,
                 -1, count_threshold, client, user_agent, x, y, data_area))
 
-        statsd_client.incr('strikes_grid.total_count')
-        statsd_client.incr('local_strikes_grid.total_count')
-        statsd_client.incr(f'local_strikes_grid.data_area.{data_area}')
-        statsd_client.gauge('local_strikes_grid.cache_hits', cache.get_ratio())
-        if minute_length == 10:
-            statsd_client.incr('strikes_grid.bg_count')
-            statsd_client.incr('local_strikes_grid.bg_count')
+        self.metrics.for_local_strikes(minute_length, data_area, cache.get_ratio())
 
         return response
 
@@ -340,12 +330,7 @@ def jsonrpc_get_strikes_grid(self, request, minute_length, grid_base_length=1000
              region,
              count_threshold, client, user_agent))
 
-        statsd_client.incr('strikes_grid.total_count')
-        statsd_client.incr('strikes_grid.total_count.{}'.format(region))
-        statsd_client.gauge('strikes_grid.cache_hits', cache.get_ratio())
-        if minute_length == 10:
-            statsd_client.incr('strikes_grid.bg_count')
-            statsd_client.incr('strikes_grid.bg_count.{}'.format(region))
+        self.metrics.for_strikes(minute_length, region, cache.get_ratio())
 
         return response
 

blitzortung/service/metrics.py

@@ -0,0 +1,34 @@
+from typing import Optional
+
+from statsd import StatsClient
+
+
+class StatsDMetrics:
+
+    def __init__(self, statsd: Optional[StatsClient]= None):
+        self.statsd = statsd if statsd else StatsClient('localhost', 8125, prefix='org.blitzortung.service')
+
+    def for_global_strikes(self, minute_length: int, cache_ratio: float):
+        self.statsd.incr('strikes_grid.total_count')
+        self.statsd.incr('global_strikes_grid.total_count')
+        self.statsd.gauge('global_strikes_grid.cache_hits', cache_ratio)
+        if minute_length == 10:
+            self.statsd.incr('strikes_grid.bg_count')
+            self.statsd.incr('global_strikes_grid.bg_count')
+
+    def for_local_strikes(self, minute_length: int, data_area, cache_ratio: float):
+        self.statsd.incr('strikes_grid.total_count')
+        self.statsd.incr('local_strikes_grid.total_count')
+        self.statsd.incr(f'local_strikes_grid.data_area.{data_area}')
+        self.statsd.gauge('local_strikes_grid.cache_hits', cache_ratio)
+        if minute_length == 10:
+            self.statsd.incr('strikes_grid.bg_count')
+            self.statsd.incr('local_strikes_grid.bg_count')
+
+    def for_strikes(self, minute_length:int, region: int, cache_ratio: float):
+        self.statsd.incr('strikes_grid.total_count')
+        self.statsd.incr('strikes_grid.total_count.{}'.format(region))
+        self.statsd.gauge('strikes_grid.cache_hits', cache_ratio)
+        if minute_length == 10:
+            self.statsd.incr('strikes_grid.bg_count')
+            self.statsd.incr('strikes_grid.bg_count.{}'.format(region))

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = 'blitzortung'
-version = '1.11.29'
+version = '1.11.30'
 description = 'blitzortung.org python modules'
 authors = [
     {name = "Andreas Würl",email = "andi@tryb.de"}

tests/service/test_metrics.py

@@ -0,0 +1,94 @@
+import pytest
+from unittest.mock import Mock
+
+from blitzortung.service.metrics import StatsDMetrics
+
+
+@pytest.fixture
+def mock_statsd():
+    """Create a mock StatsClient for testing."""
+    statsd = Mock()
+    statsd.incr = Mock()
+    statsd.gauge = Mock()
+    return statsd
+
+
+class TestStatsDMetrics:
+    """Tests for StatsDMetrics class."""
+
+    @pytest.fixture
+    def metrics(self, mock_statsd):
+        return StatsDMetrics(mock_statsd)
+
+
+    def test_init_with_custom_statsd(self, metrics, mock_statsd):
+        """Test initialization with custom StatsClient."""
+        assert metrics.statsd is mock_statsd
+
+    def test_init_with_default_statsd(self):
+        """Test initialization with default StatsClient."""
+        metrics = StatsDMetrics()
+        assert metrics.statsd is not None
+        # Default should create StatsClient with specific config
+        assert hasattr(metrics.statsd, 'incr')
+        assert hasattr(metrics.statsd, 'gauge')
+
+    @pytest.mark.parametrize("minute_length,is_bg,cache_ratio", [
+        (10, True, 0.75),
+        (60, False, 0.85),
+    ])
+    def test_for_global_strikes(self, metrics, mock_statsd, minute_length, is_bg, cache_ratio):
+        """Test for_global_strikes with 10 minute length."""
+
+        metrics.for_global_strikes(minute_length=minute_length, cache_ratio=cache_ratio)
+
+        # Verify all expected calls
+        assert mock_statsd.incr.call_count == 2 + 2 * is_bg
+
+        mock_statsd.incr.assert_any_call('strikes_grid.total_count')
+        mock_statsd.incr.assert_any_call('global_strikes_grid.total_count')
+        if is_bg:
+            mock_statsd.incr.assert_any_call('strikes_grid.bg_count')
+            mock_statsd.incr.assert_any_call('global_strikes_grid.bg_count')
+
+        mock_statsd.gauge.assert_called_once_with('global_strikes_grid.cache_hits', cache_ratio)
+
+    @pytest.mark.parametrize("minute_length,is_bg,cache_ratio,data_area", [
+        (10, True, 0.75, 5),
+        (60, False, 0.85, 10),
+    ])
+    def test_for_local_strikes_with_10_minute_length(self, metrics, mock_statsd, minute_length, is_bg, cache_ratio, data_area):
+        """Test for_local_strikes."""
+
+        metrics.for_local_strikes(minute_length=minute_length, data_area=data_area, cache_ratio=cache_ratio)
+
+        # Verify all expected calls
+        assert mock_statsd.incr.call_count == 3 + 2 * is_bg
+        mock_statsd.incr.assert_any_call('strikes_grid.total_count')
+        mock_statsd.incr.assert_any_call('local_strikes_grid.total_count')
+        mock_statsd.incr.assert_any_call(f'local_strikes_grid.data_area.{data_area}')
+        if is_bg:
+            mock_statsd.incr.assert_any_call('strikes_grid.bg_count')
+            mock_statsd.incr.assert_any_call('local_strikes_grid.bg_count')
+
+        mock_statsd.gauge.assert_called_once_with('local_strikes_grid.cache_hits', cache_ratio)
+
+
+    @pytest.mark.parametrize("minute_length,is_bg,cache_ratio,region", [
+        (10, True, 0.75, 1),
+        (60, False, 0.85, 2),
+    ])
+    def test_for_strikes_with_10_minute_length(self, metrics, mock_statsd, minute_length, is_bg, cache_ratio, region):
+        """Test for_strikes on regions."""
+
+        metrics.for_strikes(minute_length=minute_length, region=region, cache_ratio=cache_ratio)
+
+        # Verify all expected calls
+        assert mock_statsd.incr.call_count == 2 + 2 * is_bg
+        mock_statsd.incr.assert_any_call('strikes_grid.total_count')
+        mock_statsd.incr.assert_any_call(f'strikes_grid.total_count.{region}')
+        if is_bg:
+            mock_statsd.incr.assert_any_call('strikes_grid.bg_count')
+            mock_statsd.incr.assert_any_call(f'strikes_grid.bg_count.{region}')
+
+        mock_statsd.gauge.assert_called_once_with('strikes_grid.cache_hits', cache_ratio)