fix: enable usage cache by default (#5356)

Author: gagantrivedi

api/app/settings/common.py

@@ -340,8 +340,14 @@
 INFLUXDB_ORG = env.str("INFLUXDB_ORG", default="")
 
 USE_POSTGRES_FOR_ANALYTICS = env.bool("USE_POSTGRES_FOR_ANALYTICS", default=False)
-USE_CACHE_FOR_USAGE_DATA = env.bool("USE_CACHE_FOR_USAGE_DATA", default=False)
-PG_API_USAGE_CACHE_SECONDS = env.int("PG_API_USAGE_CACHE_SECONDS", default=60)
+USE_CACHE_FOR_USAGE_DATA = env.bool("USE_CACHE_FOR_USAGE_DATA", default=True)
+
+API_USAGE_CACHE_SECONDS = env.int("API_USAGE_CACHE_SECONDS", default=0)
+
+if not API_USAGE_CACHE_SECONDS:
+    # Fallback to the old variable name, which is deprecated
+    # and will be removed in the future.
+    API_USAGE_CACHE_SECONDS = env.int("PG_API_USAGE_CACHE_SECONDS", default=60)
 
 FEATURE_EVALUATION_CACHE_SECONDS = env.int(
     "FEATURE_EVALUATION_CACHE_SECONDS", default=60

api/app/settings/test.py

@@ -14,6 +14,7 @@
 }
 
 AWS_SSE_LOGS_BUCKET_NAME = "test_bucket"
+USE_CACHE_FOR_USAGE_DATA = False
 
 RETRY_WEBHOOKS = True
 

api/app_analytics/cache.py

@@ -46,7 +46,7 @@ def track_request(
                 self._cache[key] += 1
             if (
                 timezone.now() - self._last_flushed_at
-            ).seconds > settings.PG_API_USAGE_CACHE_SECONDS:
+            ).seconds > settings.API_USAGE_CACHE_SECONDS:
                 self._flush()
 
 

api/tests/unit/app_analytics/test_unit_app_analytics_cache.py

@@ -12,7 +12,7 @@ def test_api_usage_cache(
     settings: SettingsWrapper,
 ) -> None:
     # Given
-    settings.PG_API_USAGE_CACHE_SECONDS = 60
+    settings.API_USAGE_CACHE_SECONDS = 60
 
     cache = APIUsageCache()
     now = timezone.now()
@@ -40,7 +40,7 @@ def test_api_usage_cache(
         assert not mocked_track_request_task.called
 
         # Now, let's move the time forward
-        frozen_time.tick(settings.PG_API_USAGE_CACHE_SECONDS + 1)  # type: ignore[arg-type]
+        frozen_time.tick(settings.API_USAGE_CACHE_SECONDS + 1)  # type: ignore[arg-type]
 
         # let's track another request(to trigger flush)
         cache.track_request(

docs/docs/deployment/hosting/locally-api.md

@@ -224,6 +224,8 @@ the below variables will be ignored.
 - `ENABLE_API_USAGE_TRACKING`: Enable tracking of all API requests in Postgres / Influx. Default is True. Setting to
   False will mean that the Usage tab in the Organisation Settings will not show any data. Useful when using Postgres for
   analytics in high traffic environments to limit the size of database.
+- `USE_CACHE_FOR_USAGE_DATA`: If enabled, this will use in-process caching to track usage data. Defaults to true.
+- `API_USAGE_CACHE_SECONDS`: Controls how frequently the usage cache is flushed. Defaults to 60 seconds
 - `PROMETHEUS_ENABLED`: Enables the Prometheus `/metrics` endpoint. Default is False.
 - `PROMETHEUS_HISTOGRAM_BUCKETS`: Allows to specify your bucket sizes for Prometheus histograms, e.g., `"0.5,0.6,1.0,Inf"`. Defaults to Python Prometheus client default histogram sizes.
 

infrastructure/aws/production/ecs-task-definition-web.json

@@ -159,6 +159,14 @@
                     "name": "FEATURE_EVALUATION_CACHE_SECONDS",
                     "value": "300"
                 },
+                {
+                    "name": "USE_CACHE_FOR_USAGE_DATA",
+                    "value": "True"
+                },
+                {
+                    "name": "API_USAGE_CACHE_SECONDS",
+                    "value": "300"
+                },
                 {
                     "name": "EDGE_RELEASE_DATETIME",
                     "value": "2022-06-07T10:00:00Z"

infrastructure/aws/staging/ecs-task-definition-web.json

@@ -171,6 +171,14 @@
                     "name": "USE_POSTGRES_FOR_ANALYTICS",
                     "value": "False"
                 },
+                {
+                    "name": "USE_CACHE_FOR_USAGE_DATA",
+                    "value": "True"
+                },
+                {
+                    "name": "API_USAGE_CACHE_SECONDS",
+                    "value": "300"
+                },
                 {
                     "name": "INFLUXDB_ORG",
                     "value": "ben.rometsch@bullet-train.io"