Merge pull request #127 from splitio/development

Development

Author: mmelograno

CHANGES.txt

@@ -1,3 +1,7 @@
+7.0.1 (Mar 8, 2019)
+ - Updated Splits refreshing rate.
+ - Replaced exception log level to error level.
+ - Improved validation for apikey.
 7.0.0 (Feb 21, 2019)
  - BREAKING CHANGE: Stored Impressions in Queue.
  - Fixed bug related to Machine Name and Machine IP.

doc/source/introduction.rst

@@ -79,7 +79,7 @@ All the possible configuration options are:
 +------------------------+------+--------------------------------------------------------+---------+
 | readTimeout            | int  | The read timeout for HTTP connections in milliseconds. | 1500    |
 +------------------------+------+--------------------------------------------------------+---------+
-| featuresRefreshRate    | int  | The features (splits) update refresh period in         | 30      |
+| featuresRefreshRate    | int  | The features (splits) update refresh period in         | 5      |
 |                        |      | seconds.                                               |         |
 +------------------------+------+--------------------------------------------------------+---------+
 | segmentsRefreshRate    | int  | The segments update refresh period in seconds.         | 60      |

splitio/api.py

@@ -5,7 +5,6 @@
 import requests
 import json
 
-from splitio.exceptions import ForbiddenException
 from splitio.config import SDK_API_BASE_URL, EVENTS_API_BASE_URL, SDK_VERSION
 
 _SEGMENT_CHANGES_URL_TEMPLATE = '{base_url}/segmentChanges/{segment_name}/'
@@ -93,9 +92,6 @@ def _build_headers(self):
         return headers
 
     def _logHttpError(self, response):
-        if response.status_code == requests.codes.forbidden:
-            raise ForbiddenException()
-
         if response.status_code < requests.codes.ok or response.status_code >= requests.codes.bad:
             respJson = response.json()
             if 'message' in respJson:

splitio/brokers.py

@@ -264,7 +264,6 @@ def _init_config(self, config=None):
             self._segment_fetcher_interval = segment_fetcher_interval
             self._split_fetcher_interval = split_fetcher_interval
             self._impressions_interval = impressions_interval
-
         self._metrics_max_time_between_calls = min(
             MAX_INTERVAL,
             self._config['metricsRefreshRate']
@@ -661,7 +660,7 @@ def get_self_refreshing_broker(api_key, **kwargs):
       "eventsApiBaseUrl": "https://events.split.io/api",
       "connectionTimeout": 1500,
       "readTimeout": 1500,
-      "featuresRefreshRate": 30,
+      "featuresRefreshRate": 5,
       "segmentsRefreshRate": 60,
       "metricsRefreshRate": 60,
       "impressionsRefreshRate": 60,
@@ -676,7 +675,7 @@ def get_self_refreshing_broker(api_key, **kwargs):
 
     * connectionTimeout: The TCP connection timeout (Default: 1500ms)
     * readTimeout: The HTTP read timeout (Default: 1500ms)
-    * featuresRefreshRate: The refresh rate for features (Default: 30s)
+    * featuresRefreshRate: The refresh rate for features (Default: 5s)
     * segmentsRefreshRate: The refresh rate for segments (Default: 60s)
     * metricsRefreshRate: The refresh rate for metrics (Default: 60s)
     * impressionsRefreshRate: The refresh rate for impressions (Default: 60s)
@@ -808,7 +807,7 @@ def get_uwsgi_broker(api_key, **kwargs):
       "apiKey": "some-api-key",
       "sdkApiBaseUrl": "https://sdk.split.io/api",
       "eventsApiBaseUrl": "https://events.split.io/api",
-      "featuresRefreshRate": 30,
+      "featuresRefreshRate": 5,
       "segmentsRefreshRate": 60,
       "metricsRefreshRate": 60,
       "impressionsRefreshRate": 60

splitio/clients.py

@@ -62,7 +62,7 @@ def _send_impression_to_listener(self, impression, attributes):
             try:
                 self._impression_listener.log_impression(impression, attributes)
             except ImpressionListenerException as e:
-                self._logger.exception(e)
+                self._logger.error(e)
 
     def get_treatment(self, key, feature, attributes=None):
         """
@@ -115,7 +115,7 @@ def get_treatment(self, key, feature, attributes=None):
 
             return result['treatment']
         except Exception:
-            self._logger.exception('Exception caught getting treatment for feature')
+            self._logger.error('Error getting treatment for feature')
 
             try:
                 impression = self._build_impression(
@@ -129,9 +129,7 @@ def get_treatment(self, key, feature, attributes=None):
 
                 self._send_impression_to_listener(impression, attributes)
             except Exception:  # pylint: disable=broad-except
-                self._logger.exception(
-                    'Exception reporting impression into get_treatment exception block'
-                )
+                self._logger.error('Error reporting impression into get_treatment exception block')
             return CONTROL
 
     def get_treatments(self, key, features, attributes=None):
@@ -189,8 +187,8 @@ def get_treatments(self, key, features, attributes=None):
                 treatments[feature] = treatment['treatment']
 
             except Exception:
-                self._logger.exception('get_treatments: An exception occured when evaluating '
-                                       'feature ' + feature + ' returning CONTROL.')
+                self._logger.error('get_treatments: An exception occured when evaluating '
+                                   'feature ' + feature + ' returning CONTROL.')
                 treatments[feature] = CONTROL
                 continue
 
@@ -202,8 +200,8 @@ def get_treatments(self, key, features, attributes=None):
                     for impression in bulk_impressions:
                         self._send_impression_to_listener(impression, attributes)
             except Exception:
-                self._logger.exception('get_treatments: An exception when trying to store '
-                                       'impressions.')
+                self._logger.error('get_treatments: An exception when trying to store '
+                                   'impressions.')
 
         return treatments
 
@@ -244,7 +242,7 @@ def _record_stats(self, impressions, start, operation):
                 self._broker.log_impressions(impressions)
             self._broker.log_operation_time(operation, end - start)
         except Exception:
-            self._logger.exception('Exception caught recording impressions and metrics')
+            self._logger.error('Error recording impressions and metrics')
 
     def track(self, key, traffic_type, event_type, value=None):
         """

splitio/config.py

@@ -22,7 +22,7 @@
     'splitSdkMachineName': None,
     'splitSdkMachineIp': None,
     'readTimeout': 1500,
-    'featuresRefreshRate': 30,
+    'featuresRefreshRate': 5,
     'segmentsRefreshRate': 60,
     'metricsRefreshRate': 60,
     'impressionsRefreshRate': 60,
@@ -85,7 +85,7 @@ def parse_config_file(filename):
       "eventsApiBaseUrl": "https://events-loadtesting.split.io/api",
       "connectionTimeout": 1500,
       "readTimeout": 1500,
-      "featuresRefreshRate": 30,
+      "featuresRefreshRate": 5,
       "segmentsRefreshRate": 60,
       "metricsRefreshRate": 60,
       "impressionsRefreshRate": 60,
@@ -115,7 +115,7 @@ def parse_config_file(filename):
             if 'splitSdkMachineIp' in config:
                 set_machine_ip(config['splitSdkMachineIp'])
     except Exception:
-        logger.exception('There was a problem reading the config file: %s', filename)
+        logger.error('There was a problem reading the config file: %s', filename)
         return DEFAULT_CONFIG.copy()
 
     return config

splitio/exceptions.py

@@ -6,5 +6,5 @@ class TimeoutException(Exception):
     pass
 
 
-class ForbiddenException(Exception):
+class NetworkingException(Exception):
     pass

splitio/impressions.py

@@ -352,9 +352,7 @@ def _update_evictions(self, feature_name, feature_impressions):
             if len(test_impressions_data) > 0:
                 self._api.test_impressions(test_impressions_data)
         except Exception:
-            self._logger.exception(
-                'Exception caught updating evicted impressions'
-            )
+            self._logger.error('Error updating evicted impressions')
             self._stopped = True
 
     def _update_impressions(self):
@@ -370,7 +368,7 @@ def _update_impressions(self):
             if len(test_impressions_data) > 0:
                 self._api.test_impressions(test_impressions_data)
         except Exception:
-            self._logger.exception('Exception caught updating impressions')
+            self._logger.error('Error updating impressions')
             self._stopped = True
 
     def _notify_eviction(self, feature_name, feature_impressions):
@@ -392,9 +390,7 @@ def _notify_eviction(self, feature_name, feature_impressions):
                 self._update_evictions, feature_name, feature_impressions
             )
         except Exception:
-            self._logger.exception(
-                'Exception caught starting evicted impressions update thread'
-            )
+            self._logger.error('Error starting evicted impressions update thread')
 
     def _timer_refresh(self):
         """
@@ -407,9 +403,7 @@ def _timer_refresh(self):
         try:
             self._thread_pool_executor.submit(self._update_impressions)
         except Exception:
-            self._logger.exception(
-                'Exception caught starting impressions update thread'
-            )
+            self._logger.error('Error starting impressions update thread')
 
         try:
             if hasattr(self._interval, '__call__'):
@@ -421,7 +415,7 @@ def _timer_refresh(self):
             timer.daemon = True
             timer.start()
         except Exception:
-            self._logger.exception('Exception caught refreshing timer')
+            self._logger.error('Error refreshing timer')
             self._stopped = True
 
 
@@ -466,9 +460,7 @@ def log(self, impression):
             try:
                 self._thread_pool_executor.submit(self._delegate.log, impression)
             except Exception:
-                self._logger.exception(
-                    'Exception caught logging impression asynchronously'
-                )
+                self._logger.error('Error logging impression asynchronously')
 
     def log_impressions(self, impressions):
         """Log a bulk of impressions.
@@ -506,7 +498,7 @@ def log_impression(self, impression, attributes=None):
         try:
             self.impression_listener.log_impression(data)
         except Exception:
-            raise ImpressionListenerException('Exception caught in log_impression user\'s'
+            raise ImpressionListenerException('Error in log_impression user\'s'
                                               'method is throwing exceptions')
 
 

splitio/input_validator.py

@@ -6,10 +6,11 @@
 import six
 import re
 import math
+import requests
 from splitio.key import Key
 from splitio.treatments import CONTROL
 from splitio.api import SdkApi
-from splitio.exceptions import ForbiddenException
+from splitio.exceptions import NetworkingException
 
 
 _LOGGER = logging.getLogger(__name__)
@@ -397,11 +398,20 @@ def _valid_apikey_type(api_key, sdk_api_base_url):
         api_key,
         sdk_api_base_url=sdk_api_base_url,
     )
+    _SEGMENT_CHANGES_URL_TEMPLATE = '{base_url}/segmentChanges/{segment_name}/'
+    url = _SEGMENT_CHANGES_URL_TEMPLATE.format(base_url=sdk_api_base_url,
+                                               segment_name='___TEST___')
+    params = {
+        'since': -1
+    }
+    headers = sdk_api._build_headers()
     try:
-        sdk_api.segment_changes('___TEST___', -1)
-    except ForbiddenException:
-        return False
-    return True
+        response = requests.get(url, params=params, headers=headers, timeout=sdk_api._timeout)
+        if response.status_code == requests.codes.forbidden:
+            return False
+        return True
+    except requests.exceptions.RequestException:
+        raise NetworkingException()
 
 
 def validate_factory_instantiation(apikey, config, sdk_api_base_url):
@@ -426,9 +436,12 @@ def validate_factory_instantiation(apikey, config, sdk_api_base_url):
         _LOGGER.error('no ready parameter has been set - incorrect control treatments '
                       + 'could be logged')
         return False
-    if not _valid_apikey_type(apikey, sdk_api_base_url):
-        _LOGGER.error('factory instantiation: you passed a browser type '
-                      + 'api_key, please grab an api key from the Split '
-                      + 'console that is of type sdk')
-        return False
-    return True
+    try:
+        if not _valid_apikey_type(apikey, sdk_api_base_url):
+            _LOGGER.error('factory instantiation: you passed a browser type '
+                          + 'api_key, please grab an api key from the Split '
+                          + 'console that is of type sdk')
+            return False
+        return True
+    except NetworkingException:
+        _LOGGER.error("Error occured when tried to connect with Split servers")

splitio/metrics.py

@@ -363,50 +363,48 @@ def _update_count_fn(self):
         try:
             self._api.metrics_counters(build_metrics_counter_data(count_metrics))
         except:
-            self._logger.exception('Exception caught sending count metrics to the back-end. '
-                                   'Ignoring metrics.')
+            self._logger.error('Error sending count metrics to the back-end. Ignoring metrics.')
             self._ignore_metrics = True
 
     def update_count(self):
         """Signals that an update on count metrics should be sent to the Split.io back-end"""
         try:
             self._thread_pool_executor.submit(self._update_count_fn)
         except:
-            self._logger.exception('Exception caught submitting count metrics update task.')
+            self._logger.error('Error submitting count metrics update task.')
 
     def _update_time_fn(self):
         time_metrics = self._fetch_time_metrics_and_clear()
 
         try:
             self._api.metrics_times(build_metrics_times_data(time_metrics))
         except:
-            self._logger.exception('Exception caught sending time metrics to the back-end. '
-                                   'Ignoring metrics.')
+            self._logger.error('Error sending time metrics to the back-end. Ignoring metrics.')
             self._ignore_metrics = True
 
     def update_time(self):
         """Signals that an update on time metrics should be sent to the Split.io back-end"""
         try:
             self._thread_pool_executor.submit(self._update_time_fn)
         except:
-            self._logger.exception('Exception caught submitting time metrics update task.')
+            self._logger.error('Error submitting time metrics update task.')
 
     def _update_gauge_fn(self):
         gauge_metrics = self._fetch_gauge_metrics_and_clear()
 
         try:
             self._api.metrics_gauge(build_metrics_gauge_data(gauge_metrics))
         except:
-            self._logger.exception('Exception caught sending gauge metrics to the back-end. '
-                                   'Ignoring metrics.')
+            self._logger.error('Error sending gauge metrics to the back-end. '
+                               'Ignoring metrics.')
             self._ignore_metrics = True
 
     def update_gauge(self):
         """Signals that an update on time metrics should be sent to the Split.io back-end"""
         try:
             self._thread_pool_executor.submit(self._update_gauge_fn)
         except:
-            self._logger.exception('Exception caught submitting gauge metrics update task.')
+            self._logger.error('Error submitting gauge metrics update task.')
 
 
 class LoggerMetrics(InMemoryMetrics):
@@ -469,7 +467,7 @@ def count(self, counter, delta):
         try:
             self._thread_pool_executor.submit(self._delegate.count, counter, delta)
         except:
-            self._logger.exception('Exception caught submitting count metric')
+            self._logger.error('Error submitting count metric')
 
     def time(self, operation, time_in_ms):
         """Records an execution time in milliseconds for the specified named operation. This method
@@ -485,7 +483,7 @@ def time(self, operation, time_in_ms):
         try:
             self._thread_pool_executor.submit(self._delegate.time, operation, time_in_ms)
         except:
-            self._logger.exception('Exception caught submitting time metric')
+            self._logger.error('Error submitting time metric')
 
     def gauge(self, gauge, value):
         """Records the latest fixed value for the specified named gauge. This method is
@@ -501,7 +499,7 @@ def gauge(self, gauge, value):
         try:
             self._thread_pool_executor.submit(self._delegate.gauge, gauge, value)
         except:
-            self._logger.exception('Exception caught submitting gauge metric')
+            self._logger.error('Error submitting gauge metric')
 
 
 class CacheBasedMetrics(Metrics):