Merge branch 'development' of github.com:splitio/python-client into development

Author: mmelograno

.github/workflows/ci.yml

@@ -10,20 +10,20 @@ on:
 
 jobs:
   test:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-20.04
     services:
       redis:
         image: redis
         ports:
           - 6379:6379
     steps:
       - name: Checkout code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
         with:
           fetch-depth: 0
 
       - name: Set up Python
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v3
         with:
           python-version: '3.6'
 

CHANGES.txt

@@ -1,3 +1,18 @@
+9.3.0-rc1 (Jan 20, 2023)
+- Updated SDK telemetry storage, metrics and updater to be more effective and send less often.
+- Removed deprecated threading.Thread.setDaemon() method.
+
+9.2.2 (Dec 13, 2022)
+- Fixed RedisSenderAdapter instantiation to store mtk keys.
+
+9.2.1 (Dec 2, 2022)
+- Changed redis record type for impressions counts from list using rpush to hashed key using hincrby.
+- Apply Timeout Exception when incorrect SDK API Key is used.
+- Changed potential initial fetching segment Warning to Debug in logging.
+
+9.2.0 (Oct 14, 2022)
+- Added a new impressions mode for the SDK called NONE , to be used in factory when there is no desire to capture impressions on an SDK factory to feed Split's analytics engine. Running NONE mode, the SDK will only capture unique keys evaluated for a particular feature flag instead of full blown impressions
+
 9.1.3 (July 25, 2022)
 - Fixed synching missed segment(s) after receiving split update
 

LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright © 2022 Split Software, Inc.
+Copyright © 2023 Split Software, Inc.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

setup.py

@@ -12,6 +12,7 @@
     'pytest-cov',
     'importlib-metadata==4.2',
     'tomli==1.2.3',
+    'iniconfig==1.1.1'
 ]
 
 INSTALL_REQUIRES = [

splitio/api/auth.py

@@ -4,18 +4,19 @@
 import json
 
 from splitio.api import APIException
-from splitio.api.commons import headers_from_metadata
+from splitio.api.commons import headers_from_metadata, record_telemetry
+from splitio.util.time import get_current_epoch_time_ms
 from splitio.api.client import HttpClientException
 from splitio.models.token import from_raw
-
+from splitio.models.telemetry import HTTPExceptionsAndLatencies
 
 _LOGGER = logging.getLogger(__name__)
 
 
 class AuthAPI(object):  # pylint: disable=too-few-public-methods
     """Class that uses an httpClient to communicate with the SDK Auth Service API."""
 
-    def __init__(self, client, apikey, sdk_metadata):
+    def __init__(self, client, apikey, sdk_metadata, telemetry_runtime_producer):
         """
         Class constructor.
 
@@ -29,6 +30,7 @@ def __init__(self, client, apikey, sdk_metadata):
         self._client = client
         self._apikey = apikey
         self._metadata = headers_from_metadata(sdk_metadata)
+        self._telemetry_runtime_producer = telemetry_runtime_producer
 
     def authenticate(self):
         """
@@ -37,17 +39,21 @@ def authenticate(self):
         :return: Json representation of an authentication.
         :rtype: splitio.models.token.Token
         """
+        start = get_current_epoch_time_ms()
         try:
             response = self._client.get(
                 'auth',
                 '/v2/auth',
                 self._apikey,
-                extra_headers=self._metadata
+                extra_headers=self._metadata,
             )
+            record_telemetry(response.status_code, get_current_epoch_time_ms() - start, HTTPExceptionsAndLatencies.TOKEN, self._telemetry_runtime_producer)
             if 200 <= response.status_code < 300:
                 payload = json.loads(response.body)
                 return from_raw(payload)
             else:
+                if (response.status_code >= 400 and response.status_code < 500):
+                    self._telemetry_runtime_producer.record_auth_rejections()
                 raise APIException(response.body, response.status_code)
         except HttpClientException as exc:
             _LOGGER.error('Exception raised while authenticating')

splitio/api/client.py

@@ -2,10 +2,11 @@
 from collections import namedtuple
 
 import requests
+import logging
+_LOGGER = logging.getLogger(__name__)
 
 HttpResponse = namedtuple('HttpResponse', ['status_code', 'body'])
 
-
 class HttpClientException(Exception):
     """HTTP Client exception."""
 
@@ -42,7 +43,7 @@ def __init__(self, timeout=None, sdk_url=None, events_url=None, auth_url=None, t
         :param telemetry_url: Optional alternative telemetry URL.
         :type telemetry_url: str
         """
-        self._timeout = timeout/1000 if timeout else None  # Convert ms to seconds.
+        self._timeout = timeout/1000 if timeout else None # Convert ms to seconds.
         self._urls = {
             'sdk': sdk_url if sdk_url is not None else self.SDK_URL,
             'events': events_url if events_url is not None else self.EVENTS_URL,

splitio/api/commons.py

@@ -1,5 +1,5 @@
 """Commons module."""
-
+from splitio.util.time import get_current_epoch_time_ms
 
 _CACHE_CONTROL = 'Cache-Control'
 _CACHE_CONTROL_NO_CACHE = 'no-cache'
@@ -32,6 +32,27 @@ def headers_from_metadata(sdk_metadata, client_key=None):
 
     return metadata
 
+def record_telemetry(status_code, elapsed, metric_name, telemetry_runtime_producer):
+    """
+    Record Telemetry info
+
+    :param status_code: http request status code
+    :type status_code: int
+
+    :param elapsed: response time elapsed.
+    :type status_code: int
+
+    :param metric_name: metric name for telemetry
+    :type metric_name: str
+
+    :param telemetry_runtime_producer: telemetry recording instance
+    :type telemetry_runtime_producer: splitio.engine.telemetry.TelemetryRuntimeProducer
+    """
+    telemetry_runtime_producer.record_sync_latency(metric_name, elapsed)
+    if 200 <= status_code < 300:
+        telemetry_runtime_producer.record_successful_sync(metric_name, get_current_epoch_time_ms())
+        return
+    telemetry_runtime_producer.record_sync_error(metric_name, status_code)
 
 class FetchOptions(object):
     """Fetch Options object."""
@@ -92,4 +113,4 @@ def build_fetch(change_number, fetch_options, metadata):
         extra_headers[_CACHE_CONTROL] = _CACHE_CONTROL_NO_CACHE
     if fetch_options.change_number is not None:
         query['till'] = fetch_options.change_number
-    return query, extra_headers
+    return query, extra_headers

splitio/api/events.py

@@ -1,9 +1,12 @@
 """Events API module."""
 import logging
+import time
 
 from splitio.api import APIException
 from splitio.api.client import HttpClientException
-from splitio.api.commons import headers_from_metadata
+from splitio.api.commons import headers_from_metadata, record_telemetry
+from splitio.util.time import get_current_epoch_time_ms
+from splitio.models.telemetry import HTTPExceptionsAndLatencies
 
 
 _LOGGER = logging.getLogger(__name__)
@@ -12,7 +15,7 @@
 class EventsAPI(object):  # pylint: disable=too-few-public-methods
     """Class that uses an httpClient to communicate with the events API."""
 
-    def __init__(self, http_client, apikey, sdk_metadata):
+    def __init__(self, http_client, apikey, sdk_metadata, telemetry_runtime_producer):
         """
         Class constructor.
 
@@ -26,6 +29,7 @@ def __init__(self, http_client, apikey, sdk_metadata):
         self._client = http_client
         self._apikey = apikey
         self._metadata = headers_from_metadata(sdk_metadata)
+        self._telemetry_runtime_producer = telemetry_runtime_producer
 
     @staticmethod
     def _build_bulk(events):
@@ -61,14 +65,16 @@ def flush_events(self, events):
         :rtype: bool
         """
         bulk = self._build_bulk(events)
+        start = get_current_epoch_time_ms()
         try:
             response = self._client.post(
                 'events',
                 '/events/bulk',
                 self._apikey,
                 body=bulk,
-                extra_headers=self._metadata
+                extra_headers=self._metadata,
             )
+            record_telemetry(response.status_code, get_current_epoch_time_ms() - start, HTTPExceptionsAndLatencies.EVENT, self._telemetry_runtime_producer)
             if not 200 <= response.status_code < 300:
                 raise APIException(response.body, response.status_code)
         except HttpClientException as exc:

splitio/api/impressions.py

@@ -5,8 +5,10 @@
 
 from splitio.api import APIException
 from splitio.api.client import HttpClientException
-from splitio.api.commons import headers_from_metadata
-from splitio.engine.impressions.impressions import ImpressionsMode
+from splitio.api.commons import headers_from_metadata, record_telemetry
+from splitio.util.time import get_current_epoch_time_ms
+from splitio.engine.impressions import ImpressionsMode
+from splitio.models.telemetry import HTTPExceptionsAndLatencies
 
 
 _LOGGER = logging.getLogger(__name__)
@@ -15,7 +17,7 @@
 class ImpressionsAPI(object):  # pylint: disable=too-few-public-methods
     """Class that uses an httpClient to communicate with the impressions API."""
 
-    def __init__(self, client, apikey, sdk_metadata, mode=ImpressionsMode.OPTIMIZED):
+    def __init__(self, client, apikey, sdk_metadata, telemetry_runtime_producer, mode=ImpressionsMode.OPTIMIZED):
         """
         Class constructor.
 
@@ -28,6 +30,7 @@ def __init__(self, client, apikey, sdk_metadata, mode=ImpressionsMode.OPTIMIZED)
         self._apikey = apikey
         self._metadata = headers_from_metadata(sdk_metadata)
         self._metadata['SplitSDKImpressionsMode'] = mode.name
+        self._telemetry_runtime_producer = telemetry_runtime_producer
 
     @staticmethod
     def _build_bulk(impressions):
@@ -91,14 +94,16 @@ def flush_impressions(self, impressions):
         :type impressions: list
         """
         bulk = self._build_bulk(impressions)
+        start = get_current_epoch_time_ms()
         try:
             response = self._client.post(
                 'events',
                 '/testImpressions/bulk',
                 self._apikey,
                 body=bulk,
-                extra_headers=self._metadata
+                extra_headers=self._metadata,
             )
+            record_telemetry(response.status_code, get_current_epoch_time_ms() - start, HTTPExceptionsAndLatencies.IMPRESSION, self._telemetry_runtime_producer)
             if not 200 <= response.status_code < 300:
                 raise APIException(response.body, response.status_code)
         except HttpClientException as exc:
@@ -116,14 +121,16 @@ def flush_counters(self, counters):
         :type impressions: list
         """
         bulk = self._build_counters(counters)
+        start = get_current_epoch_time_ms()
         try:
             response = self._client.post(
                 'events',
                 '/testImpressions/count',
                 self._apikey,
                 body=bulk,
-                extra_headers=self._metadata
+                extra_headers=self._metadata,
             )
+            record_telemetry(response.status_code, get_current_epoch_time_ms() - start, HTTPExceptionsAndLatencies.IMPRESSION_COUNT, self._telemetry_runtime_producer)
             if not 200 <= response.status_code < 300:
                 raise APIException(response.body, response.status_code)
         except HttpClientException as exc:

splitio/api/segments.py

@@ -2,10 +2,13 @@
 
 import json
 import logging
+import time
 
 from splitio.api import APIException
-from splitio.api.commons import headers_from_metadata, build_fetch
+from splitio.api.commons import headers_from_metadata, build_fetch, record_telemetry
+from splitio.util.time import get_current_epoch_time_ms
 from splitio.api.client import HttpClientException
+from splitio.models.telemetry import HTTPExceptionsAndLatencies
 
 
 _LOGGER = logging.getLogger(__name__)
@@ -14,7 +17,7 @@
 class SegmentsAPI(object):  # pylint: disable=too-few-public-methods
     """Class that uses an httpClient to communicate with the segments API."""
 
-    def __init__(self, http_client, apikey, sdk_metadata):
+    def __init__(self, http_client, apikey, sdk_metadata, telemetry_runtime_producer):
         """
         Class constructor.
 
@@ -29,6 +32,7 @@ def __init__(self, http_client, apikey, sdk_metadata):
         self._client = http_client
         self._apikey = apikey
         self._metadata = headers_from_metadata(sdk_metadata)
+        self._telemetry_runtime_producer = telemetry_runtime_producer
 
     def fetch_segment(self, segment_name, change_number, fetch_options):
         """
@@ -46,6 +50,7 @@ def fetch_segment(self, segment_name, change_number, fetch_options):
         :return: Json representation of a segmentChange response.
         :rtype: dict
         """
+        start = get_current_epoch_time_ms()
         try:
             query, extra_headers = build_fetch(change_number, fetch_options, self._metadata)
             response = self._client.get(
@@ -55,7 +60,7 @@ def fetch_segment(self, segment_name, change_number, fetch_options):
                 extra_headers=extra_headers,
                 query=query,
             )
-
+            record_telemetry(response.status_code, get_current_epoch_time_ms() - start, HTTPExceptionsAndLatencies.SEGMENT, self._telemetry_runtime_producer)
             if 200 <= response.status_code < 300:
                 return json.loads(response.body)
             else: