improve logging

splitio · mredolatti · Apr 24, 2019 · Apr 12, 2019 · Apr 12, 2019 · Apr 12, 2019
commit 48ab64c1ec745dcfb219a25e8ce81fbe2aefd6e6
@@ -3,19 +3,12 @@
 class APIException(Exception):
     """Exception to raise when an API call fails."""
 
-    def __init__(self, custom_message, status_code=None, original_exception=None):
+    def __init__(self, custom_message, status_code=None):
         """Constructor."""
         Exception.__init__(self, custom_message)
         self._status_code = status_code if status_code else -1
-        self._custom_message = custom_message
-        self._original_exception = original_exception
 
     @property
     def status_code(self):
         """Return HTTP status code."""
         return self._status_code
-
-    @property
-    def custom_message(self):
-        """Return custom message."""
-        return self._custom_message
@@ -2,6 +2,8 @@
 from __future__ import division
 
 from collections import namedtuple
+
+from six import raise_from
 import requests
 
 HttpResponse = namedtuple('HttpResponse', ['status_code', 'body'])
@@ -10,7 +12,7 @@
 class HttpClientException(Exception):
     """HTTP Client exception."""
 
-    def __init__(self, custom_message, original_exception=None):
+    def __init__(self, custom_message):
         """
         Class constructor.
 
@@ -20,18 +22,6 @@ def __init__(self, custom_message, original_exception=None):
         :type original_exception: Exception.
         """
         Exception.__init__(self, custom_message)
-        self._custom_message = custom_message
-        self._original_exception = original_exception
-
-    @property
-    def custom_message(self):
-        """Return custom message."""
-        return self._custom_message
-
-    @property
-    def original_exception(self):
-        """Return original exception."""
-        return self._original_exception
 
 
 class HttpClient(object):
@@ -101,8 +91,8 @@ def get(self, server, path, apikey, query=None, extra_headers=None):  #pylint: d
                 timeout=self._timeout
             )
             return HttpResponse(response.status_code, response.text)
-        except Exception as exc:
-            raise HttpClientException('requests library is throwing exceptions', exc)
+        except Exception as exc:  #pylint: disable=broad-except
+            raise_from(HttpClientException('requests library is throwing exceptions'), exc)
 
     def post(self, server, path, apikey, body, query=None, extra_headers=None):  #pylint: disable=too-many-arguments
         """
@@ -137,5 +127,5 @@ def post(self, server, path, apikey, body, query=None, extra_headers=None):  #py
                 timeout=self._timeout
             )
             return HttpResponse(response.status_code, response.text)
-        except Exception as exc:
-            raise HttpClientException('requests library is throwing exceptions', exc)
+        except Exception as exc:  #pylint: disable=broad-except
+            raise_from(HttpClientException('requests library is throwing exceptions'), exc)
@@ -1,5 +1,8 @@
 """Events API module."""
 import logging
+
+from six import raise_from
+
 from splitio.api import APIException
 from splitio.api.client import HttpClientException
 
@@ -69,5 +72,6 @@ def flush_events(self, events):
             if not 200 <= response.status_code < 300:
                 raise APIException(response.body, response.status_code)
         except HttpClientException as exc:
-            self._logger.debug('Error flushing events: ', exc_info=True)
-            raise APIException(exc.custom_message, original_exception=exc.original_exception)
+            self._logger.error('Http client is throwing exceptions')
+            self._logger.debug('Error: ', exc_info=True)
+            raise_from(APIException('Events not flushed properly.'), exc)
@@ -2,6 +2,9 @@
 
 import logging
 from itertools import groupby
+
+from six import raise_from
+
 from splitio.api import APIException
 from splitio.api.client import HttpClientException
 
@@ -78,5 +81,6 @@ def flush_impressions(self, impressions):
             if not 200 <= response.status_code < 300:
                 raise APIException(response.body, response.status_code)
         except HttpClientException as exc:
-            self._logger.debug('Error flushing events: ', exc_info=True)
-            raise APIException(exc.custom_message, original_exception=exc.original_exception)
+            self._logger.error('Http client is throwing exceptions')
+            self._logger.debug('Error: ', exc_info=True)
+            raise_from(APIException('Impressions not flushed properly.'), exc)
@@ -2,6 +2,9 @@
 
 import json
 import logging
+
+from six import raise_from
+
 from splitio.api import APIException
 from splitio.api.client import HttpClientException
 
@@ -47,5 +50,6 @@ def fetch_segment(self, segment_name, change_number):
             else:
                 raise APIException(response.body, response.status_code)
         except HttpClientException as exc:
-            self._logger.debug('Error flushing events: ', exc_info=True)
-            raise APIException(exc.custom_message, original_exception=exc.original_exception)
+            self._logger.error('Http client is throwing exceptions')
+            self._logger.debug('Error: ', exc_info=True)
+            raise_from(APIException('Segments not fetched properly.'), exc)
@@ -2,6 +2,9 @@
 
 import logging
 import json
+
+from six import raise_from
+
 from splitio.api import APIException
 from splitio.api.client import HttpClientException
 
@@ -44,5 +47,6 @@ def fetch_splits(self, change_number):
             else:
                 raise APIException(response.body, response.status_code)
         except HttpClientException as exc:
-            self._logger.debug('Error flushing events: ', exc_info=True)
-            raise APIException(exc.custom_message, original_exception=exc.original_exception)
+            self._logger.error('Http client is throwing exceptions')
+            self._logger.debug('Error: ', exc_info=True)
+            raise_from(APIException('Splits not fetched correctly.'), exc)
@@ -60,7 +60,9 @@ def flush_latencies(self, latencies):
             if not 200 <= response.status_code < 300:
                 raise APIException(response.body, response.status_code)
         except HttpClientException as exc:
-            raise APIException(exc.custom_message, original_exception=exc.original_exception)
+            self._logger.error('Http client is throwing exceptions')
+            self._logger.debug('Error: ', exc_info=True)
+            six.raise_from(APIException('Latencies not flushed correctly.'), exc)
 
     @staticmethod
     def _build_gauges(gauges):
@@ -94,7 +96,9 @@ def flush_gauges(self, gauges):
             if not 200 <= response.status_code < 300:
                 raise APIException(response.body, response.status_code)
         except HttpClientException as exc:
-            raise APIException(exc.custom_message, original_exception=exc.original_exception)
+            self._logger.error('Http client is throwing exceptions')
+            self._logger.debug('Error: ', exc_info=True)
+            six.raise_from(APIException('Gauges not flushed correctly.'), exc)
 
     @staticmethod
     def _build_counters(counters):
@@ -128,5 +132,6 @@ def flush_counters(self, counters):
             if not 200 <= response.status_code < 300:
                 raise APIException(response.body, response.status_code)
         except HttpClientException as exc:
-            self._logger.debug('Error flushing events: ', exc_info=True)
-            raise APIException(exc.custom_message, original_exception=exc.original_exception)
+            self._logger.error('Http client is throwing exceptions')
+            self._logger.debug('Error: ', exc_info=True)
+            six.raise_from(APIException('Counters not flushed correctly.'), exc)
@@ -44,7 +44,7 @@ def test_post_events(self, mocker):
 
         httpclient.reset_mock()
         def raise_exception(*args, **kwargs):
-            raise client.HttpClientException('some_message', Exception('something'))
+            raise client.HttpClientException('some_message')
         httpclient.post.side_effect = raise_exception
         with pytest.raises(APIException) as exc_info:
             response = events_api.flush_events([

@@ -51,7 +51,7 @@ def test_post_impressions(self, mocker):
 
         httpclient.reset_mock()
         def raise_exception(*args, **kwargs):
-            raise client.HttpClientException('some_message', Exception('something'))
+            raise client.HttpClientException('some_message')
         httpclient.post.side_effect = raise_exception
         with pytest.raises(APIException) as exc_info:
             response = impressions_api.flush_impressions([

@@ -19,7 +19,7 @@ def test_fetch_segment_changes(self, mocker):
 
         httpclient.reset_mock()
         def raise_exception(*args, **kwargs):
-            raise client.HttpClientException('some_message', Exception('something'))
+            raise client.HttpClientException('some_message')
         httpclient.get.side_effect = raise_exception
         with pytest.raises(APIException) as exc_info:
             response = segment_api.fetch_segment('some_segment', 123)

@@ -19,7 +19,7 @@ def test_fetch_split_changes(self, mocker):
 
         httpclient.reset_mock()
         def raise_exception(*args, **kwargs):
-            raise client.HttpClientException('some_message', Exception('something'))
+            raise client.HttpClientException('some_message')
         httpclient.get.side_effect = raise_exception
         with pytest.raises(APIException) as exc_info:
             response = split_api.fetch_splits(123)

@@ -38,7 +38,7 @@ def test_post_latencies(self, mocker):
 
         httpclient.reset_mock()
         def raise_exception(*args, **kwargs):
-            raise client.HttpClientException('some_message', Exception('something'))
+            raise client.HttpClientException('some_message')
         httpclient.post.side_effect = raise_exception
         with pytest.raises(APIException) as exc_info:
             response = telemetry_api.flush_latencies({
@@ -75,7 +75,7 @@ def test_post_counters(self, mocker):
 
         httpclient.reset_mock()
         def raise_exception(*args, **kwargs):
-            raise client.HttpClientException('some_message', Exception('something'))
+            raise client.HttpClientException('some_message')
         httpclient.post.side_effect = raise_exception
         with pytest.raises(APIException) as exc_info:
             response = telemetry_api.flush_counters({'counter1': 1, 'counter2': 2})
@@ -110,7 +110,7 @@ def test_post_gauge(self, mocker):
 
         httpclient.reset_mock()
         def raise_exception(*args, **kwargs):
-            raise client.HttpClientException('some_message', Exception('something'))
+            raise client.HttpClientException('some_message')
         httpclient.post.side_effect = raise_exception
         with pytest.raises(APIException) as exc_info:
             response = telemetry_api.flush_gauges({'gauge1': 1, 'gauge2': 2})