dbt-copilot-python 2.0.0__tar.gz → 2.0.1a0__tar.gz

{dbt_copilot_python-2.0.0 → dbt_copilot_python-2.0.1a0}/PKG-INFO

@@ -1,11 +1,11 @@
 Metadata-Version: 2.4
 Name: dbt-copilot-python
-Version: 2.0.0
+Version: 2.0.1a0
 Summary: Helper functions to run Django and Flask applications in AWS Copilot/ECS.
 License-File: LICENSE
 Author: Department for Business and Trade Platform Team
 Author-email: sre-team@digital.trade.gov.uk
-Requires-Python: >=3.9,<4.0
+Requires-Python: >=3.9,<3.15
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
@@ -14,7 +14,9 @@ Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.14
 Provides-Extra: celery
+Provides-Extra: error-tracking
 Requires-Dist: celery (>=5.0) ; extra == "celery"
+Requires-Dist: ddtrace (>=3,<5) ; extra == "error-tracking"
 Requires-Dist: requests (>=2.32.3,<3.0.0)
 Description-Content-Type: text/markdown
 
@@ -38,7 +40,7 @@ pip install dbt-copilot-python
 
 #### With celery
 
-If you are using celery, you should also install an appropriate version of celery using your project's package manager, or use our built-in extra.
+If you are using celery, you should also install an appropriate version of celery using your project's package manager, or our built-in extra.
 
 ```shell
 # Poetry
@@ -66,6 +68,37 @@ pip freeze | grep "^celery==" >> requirements.txt
 pipenv install dbt-copilot-python[celery]
 ```
 
+#### With error tracking
+
+If you intend on using the error tracking filter, you should also install an appropriate version of ddtrace using your project's package manager, or our built-in extra.
+
+```shell
+# Poetry
+poetry add ddtrace
+
+# Pip
+pip install ddtrace
+pip freeze | grep "^ddtrace==" >> requirements.txt
+
+# Pipenv
+pipenv install ddtrace
+```
+
+**OR**
+
+```shell
+# Poetry
+poetry add dbt-copilot-python[error-tracking]
+
+# Pip
+pip install dbt-copilot-python[error-tracking]
+pip freeze | grep "^ddtrace==" >> requirements.txt
+
+# Pipenv
+pipenv install dbt-copilot-python[error-tracking]
+```
+
+
 ### Usage
 
 #### `ALLOWED_HOSTS` setting
@@ -129,7 +162,7 @@ To configure the `DATABASES` setting from an RDS JSON object stored in AWS Secre
     import dj_database_url
 
     from dbt_copilot_python.database import database_url_from_env
-   
+
     DATABASES = {
         "default": dj_database_url.config(
             default=database_url_from_env("DATABASE_ENV_VAR_KEY")
@@ -145,6 +178,21 @@ To configure the `DATABASES` setting from an RDS JSON object stored in AWS Secre
     DATABASES = database_from_env("DATABASE_ENV_VAR_KEY")
     ```
 
+#### Error tracking
+
+To enable error tracking for logs you must attach the `DatadogErrorTrackingFilter` to any of the loggers which you'd like to track logs emitted at a level `>=logging.ERROR`.
+
+Generally speaking you could do something as follows
+
+```python
+import logging
+
+from dbt_copilot_python import DatadogErrorTrackingFilter
+
+logger = logging.getLogger()
+logger.addFilter(DatadogErrorTrackingFilter())
+```
+
 ## Contributing to `dbt-copilot-python`
 
 ### Requirements

{dbt_copilot_python-2.0.0 → dbt_copilot_python-2.0.1a0}/README.md

@@ -18,7 +18,7 @@ pip install dbt-copilot-python
 
 #### With celery
 
-If you are using celery, you should also install an appropriate version of celery using your project's package manager, or use our built-in extra.
+If you are using celery, you should also install an appropriate version of celery using your project's package manager, or our built-in extra.
 
 ```shell
 # Poetry
@@ -46,6 +46,37 @@ pip freeze | grep "^celery==" >> requirements.txt
 pipenv install dbt-copilot-python[celery]
 ```
 
+#### With error tracking
+
+If you intend on using the error tracking filter, you should also install an appropriate version of ddtrace using your project's package manager, or our built-in extra.
+
+```shell
+# Poetry
+poetry add ddtrace
+
+# Pip
+pip install ddtrace
+pip freeze | grep "^ddtrace==" >> requirements.txt
+
+# Pipenv
+pipenv install ddtrace
+```
+
+**OR**
+
+```shell
+# Poetry
+poetry add dbt-copilot-python[error-tracking]
+
+# Pip
+pip install dbt-copilot-python[error-tracking]
+pip freeze | grep "^ddtrace==" >> requirements.txt
+
+# Pipenv
+pipenv install dbt-copilot-python[error-tracking]
+```
+
+
 ### Usage
 
 #### `ALLOWED_HOSTS` setting
@@ -109,7 +140,7 @@ To configure the `DATABASES` setting from an RDS JSON object stored in AWS Secre
     import dj_database_url
 
     from dbt_copilot_python.database import database_url_from_env
-   
+
     DATABASES = {
         "default": dj_database_url.config(
             default=database_url_from_env("DATABASE_ENV_VAR_KEY")
@@ -125,6 +156,21 @@ To configure the `DATABASES` setting from an RDS JSON object stored in AWS Secre
     DATABASES = database_from_env("DATABASE_ENV_VAR_KEY")
     ```
 
+#### Error tracking
+
+To enable error tracking for logs you must attach the `DatadogErrorTrackingFilter` to any of the loggers which you'd like to track logs emitted at a level `>=logging.ERROR`.
+
+Generally speaking you could do something as follows
+
+```python
+import logging
+
+from dbt_copilot_python import DatadogErrorTrackingFilter
+
+logger = logging.getLogger()
+logger.addFilter(DatadogErrorTrackingFilter())
+```
+
 ## Contributing to `dbt-copilot-python`
 
 ### Requirements

dbt_copilot_python-2.0.1a0/dbt_copilot_python/error_tracking.py

@@ -0,0 +1,47 @@
+import logging
+import os
+import sys
+import traceback
+from functools import lru_cache
+
+from ddtrace.trace import tracer
+
+
+class DatadogErrorTrackingFilter(logging.Filter):
+    def __init__(self, name: str = "") -> None:
+        self._working_directory = os.getcwd()
+        super().__init__(name)
+
+    def filter(self, record):
+        if record.levelno >= logging.ERROR:
+            # Escape quickly if inside of a handled exception, use native
+            # functionality to surface handled errors
+            # https://docs.datadoghq.com/error_tracking/backend/capturing_handled_errors/python/#automatic-instrumentation
+            exc_info = sys.exc_info()
+            if any(exc_info):
+                return True
+
+            span = tracer.current_span()
+            if span:
+                span.record_exception(
+                    BaseException(record.msg),
+                    attributes={
+                        "exception.stacktrace": "".join(traceback.format_stack(limit=20)),
+                        "exception.type": f"{self._calculate_module_path(record.pathname, record.module, record.funcName)}.LoggedError",
+                    },
+                )
+
+        return True
+
+    @lru_cache(maxsize=32)
+    def _calculate_module_path(self, pathname: str, module: str, func_name: str) -> str:
+        path_from_project_root = pathname.replace(self._working_directory, "")
+
+        if path_from_project_root != pathname:
+            module_path_with_function = path_from_project_root.split("/")[1:-1]
+        else:
+            module_path_with_function = path_from_project_root.split("/")[1:]
+
+        module_path_with_function.extend([module, func_name])
+
+        return ".".join(module_path_with_function)

{dbt_copilot_python-2.0.0 → dbt_copilot_python-2.0.1a0}/pyproject.toml

@@ -3,7 +3,7 @@ line-length = 100
 
 [tool.poetry]
 name = "dbt-copilot-python"
-version = "2.0.0"
+version = "2.0.1a0"
 description = "Helper functions to run Django and Flask applications in AWS Copilot/ECS."
 authors = [
     "Department for Business and Trade Platform Team <sre-team@digital.trade.gov.uk>",
@@ -12,12 +12,14 @@ readme = "README.md"
 packages = [{ include = "dbt_copilot_python" }]
 
 [tool.poetry.dependencies]
-python = "^3.9"
+python = ">=3.9,<3.15"
 requests = "^2.32.3"
 celery = { version = ">=5.0", optional = true }
+ddtrace = { version = ">=3,<5", optional = true }
 
 [tool.poetry.extras]
 celery = ["celery"]
+error-tracking = ["ddtrace"]
 
 [tool.poetry.group.dev.dependencies]
 pre-commit = ">=3.3.3,<5.0.0"
@@ -25,6 +27,7 @@ pytest = ">=7.3.2,<9.0.0"
 requests-mock = "^1.11.0"
 tox = "^4.6.3"
 pytest-celery = "^0.0.0"
+ddtrace = ">=3,<5"
 
 [build-system]
 requires = ["poetry-core"]