Merge pull request #93 from ivanildobarauna-dev/feature/implement-otel-observability

[FEATURE] Implement Open Telemetry

Author: IvanildoBarauna

.idea/api-to-dataframe.iml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "api-to-dataframe"
-version = "1.3.13"
+version = "1.4.0"
 description = "A package to convert API responses to pandas dataframe"
 authors = ["IvanildoBarauna <[email protected]>"]
 readme = "README.md"
@@ -27,7 +27,7 @@ python = "^3.9"
 pandas = "^2.2.3"
 requests = "^2.32.3"
 logging = "^0.4.9.6"
-datadog = "^0.50.2"
+otel-wrapper = "^0.0.1"
 
 [tool.poetry.group.dev.dependencies]
 poetry-dynamic-versioning = "^1.3.0"

.idea/misc.xml

@@ -1,7 +1,7 @@
 from api_to_dataframe.models.retainer import retry_strategies, Strategies
 from api_to_dataframe.models.get_data import GetData
-from api_to_dataframe.utils.logger import log, LogLevel
-from api_to_dataframe.utils.metrics import MetricsClient
+from api_to_dataframe.utils.logger import logger
+from otel_wrapper import OpenObservability
 
 
 class ClientBuilder:
@@ -35,16 +35,16 @@ def __init__(  # pylint: disable=too-many-positional-arguments,too-many-argument
         if headers is None:
             headers = {}
         if endpoint == "":
-            log("endpoint param is mandatory", LogLevel.ERROR)
+            logger.error("endpoint cannot be an empty string")
             raise ValueError
         if not isinstance(retries, int) or retries < 0:
-            log("retries must be a non-negative integer", LogLevel.ERROR)
+            logger.error("retries must be a non-negative integer")
             raise ValueError
         if not isinstance(initial_delay, int) or initial_delay < 0:
-            log("delay must be a non-negative integer", LogLevel.ERROR)
+            logger.error("initial_delay must be a non-negative integer")
             raise ValueError
         if not isinstance(connection_timeout, int) or connection_timeout < 0:
-            log("connection_timeout must be a non-negative integer", LogLevel.ERROR)
+            logger.error("connection_timeout must be a non-negative integer")
             raise ValueError
 
         self.endpoint = endpoint
@@ -53,10 +53,9 @@ def __init__(  # pylint: disable=too-many-positional-arguments,too-many-argument
         self.headers = headers
         self.retries = retries
         self.delay = initial_delay
-        self.metrics_client = MetricsClient()
-
-        self.metrics_client.increment("builded_client")
-
+        self._o11y_wrapper = OpenObservability(application_name="api-to-dataframe").get_wrapper()
+        self._traces = self._o11y_wrapper.traces()
+        self._tracer = self._traces.get_tracer()
 
     @retry_strategies
     def get_api_data(self):
@@ -71,16 +70,15 @@ def get_api_data(self):
             dict: The JSON response from the API as a dictionary.
         """
 
-        self.metrics_client.increment("get_api_data_attempt")
-
-        response = GetData.get_response(
-            endpoint=self.endpoint,
-            headers=self.headers,
-            connection_timeout=self.connection_timeout,
-        )
+        with self._tracer.start_as_current_span("get_last_quote") as span:
+            span.set_attribute("endpoint", self.endpoint)
 
+            response = GetData.get_response(
+                endpoint=self.endpoint,
+                headers=self.headers,
+                connection_timeout=self.connection_timeout,
+            )
 
-        self.metrics_client.increment("get_api_data_success")
 
         return response.json()
 
@@ -99,9 +97,7 @@ def api_to_dataframe(response: dict):
         Returns:
             DataFrame: A pandas DataFrame containing the data from the API response.
         """
-        MetricsClient().increment("api_to_dataframe_attempt")
 
         df = GetData.to_dataframe(response)
 
-        MetricsClient().increment("api_to_dataframe_success")
         return df

poetry.lock

@@ -1,8 +1,6 @@
 import requests
 import pandas as pd
 
-from api_to_dataframe.utils.logger import log, LogLevel
-
 
 class GetData:
     @staticmethod
@@ -16,13 +14,11 @@ def to_dataframe(response):
         try:
             df = pd.DataFrame(response)
         except Exception as err:
-            log(f"Error serializing to dataframe: {err}", LogLevel.ERROR)
             raise TypeError(
                 f"Invalid response for transform in dataframe: {err}"
             ) from err
 
         if df.empty:
-            log("DataFrame is empty", LogLevel.ERROR)
             raise ValueError("::: DataFrame is empty :::")
 
         return df

pyproject.toml

@@ -2,7 +2,7 @@
 from enum import Enum
 
 from requests.exceptions import RequestException
-from api_to_dataframe.utils.logger import log, LogLevel
+from api_to_dataframe.utils.logger import logger
 from api_to_dataframe.utils import Constants
 
 
@@ -18,11 +18,7 @@ def wrapper(*args, **kwargs):  # pylint: disable=inconsistent-return-statements
         while retry_number < args[0].retries:
             try:
                 if retry_number > 0:
-                    log(
-                        f"Trying for the {retry_number} of {Constants.MAX_OF_RETRIES} retries. "
-                        f"Using {args[0].retry_strategy}",
-                        LogLevel.INFO,
-                    )
+                    logger.info(f"Trying for the {retry_number} of {Constants.MAX_OF_RETRIES} retries. Using {args[0].retry_strategy}")
                 return func(*args, **kwargs)
             except RequestException as e:
                 retry_number += 1
@@ -35,10 +31,7 @@ def wrapper(*args, **kwargs):  # pylint: disable=inconsistent-return-statements
                     time.sleep(args[0].delay * retry_number)
 
                 if retry_number in (args[0].retries, Constants.MAX_OF_RETRIES):
-                    log(
-                        f"Failed after {retry_number} retries using {args[0].retry_strategy}",
-                        LogLevel.ERROR,
-                    )
+                    logger.error(f"Failed after {retry_number} retries")
                     raise e
 
     return wrapper

src/api_to_dataframe/controller/client_builder.py

@@ -1,12 +1,4 @@
 import logging
-from enum import Enum
-
-
-class LogLevel(Enum):
-    INFO = logging.INFO
-    WARNING = logging.WARNING
-    ERROR = logging.ERROR
-
 
 # Configure logging once at the start of your program
 logging.basicConfig(
@@ -16,7 +8,4 @@ class LogLevel(Enum):
     level=logging.INFO,
 )
 
-
-def log(message: str, level: LogLevel):
-    logger = logging.getLogger("api-to-dataframe")
-    logger.log(level.value, message)
+logger = logging.getLogger("api-to-dataframe")