ghosttrap-sdk 0.4.0__py3-none-any.whl

ghosttrap/__init__.py

@@ -0,0 +1,3 @@
+from ghosttrap.client import init, report
+
+__all__ = ["init", "report"]

ghosttrap/client.py

@@ -0,0 +1,118 @@
+"""Drop-in error reporter for ghosttrap.io.
+
+Usage:
+    import ghosttrap
+
+    # with a token (recommended):
+    ghosttrap.init("t_abc123def456")
+
+    # or with a full URL:
+    ghosttrap.init("https://ghosttrap.io/trap/owner/repo/")
+
+Hooks into sys.excepthook (unhandled exceptions), Python logging
+(logger.exception / logger.error with exc_info), and Celery task
+failures (if Celery is installed). For additional coverage, use the
+Django middleware: ghosttrap.middleware.GhostTrapMiddleware.
+"""
+
+import json
+import logging
+import sys
+import traceback
+import urllib.request
+
+GHOSTTRAP_SERVER = "https://ghosttrap.io"
+
+_endpoint = None
+_original_excepthook = None
+
+
+def init(dsn, server=None):
+    """Configure the reporter.
+
+    Args:
+        dsn: Either a token (e.g. "t_abc123") or a full URL
+             (e.g. "https://ghosttrap.io/trap/owner/repo/")
+        server: Base server URL. Only needed if dsn is a token and
+                you're not using ghosttrap.io.
+    """
+    global _endpoint, _original_excepthook
+    if dsn.startswith("http://") or dsn.startswith("https://"):
+        _endpoint = dsn.rstrip("/") + "/"
+    else:
+        base = (server or GHOSTTRAP_SERVER).rstrip("/")
+        _endpoint = f"{base}/trap/{dsn}/"
+    _original_excepthook = sys.excepthook
+    sys.excepthook = _error_hook
+    _install_logging_handler()
+    _install_celery_hook()
+
+
+def report(exc):
+    """Report a caught exception to the ghosttrap server.
+
+    Args:
+        exc: the exception instance from an `except Exception as exc` block
+    """
+    if _endpoint is None:
+        return
+    _post(_build_payload(type(exc), exc, exc.__traceback__))
+
+
+def _error_hook(exc_type, exc_value, exc_tb):
+    _post(_build_payload(exc_type, exc_value, exc_tb))
+    _original_excepthook(exc_type, exc_value, exc_tb)
+
+
+def _install_logging_handler():
+    handler = _GhostTrapLogHandler()
+    handler.setLevel(logging.ERROR)
+    logging.getLogger().addHandler(handler)
+
+
+def _install_celery_hook():
+    try:
+        from celery.signals import task_failure
+        task_failure.connect(_on_task_failure)
+    except ImportError:
+        pass
+
+
+def _on_task_failure(sender, exception, traceback, **kwargs):
+    report(exception)
+
+
+class _GhostTrapLogHandler(logging.Handler):
+    def emit(self, record):
+        if record.exc_info and record.exc_info[1]:
+            report(record.exc_info[1])
+
+
+def _build_payload(exc_type, exc_value, exc_tb):
+    frames = traceback.extract_tb(exc_tb) if exc_tb else []
+    return {
+        "type": exc_type.__name__,
+        "message": str(exc_value),
+        "traceback": traceback.format_exception(exc_type, exc_value, exc_tb) if exc_tb else [],
+        "frames": [
+            {
+                "file": f.filename,
+                "line": f.lineno,
+                "function": f.name,
+                "code": f.line,
+            }
+            for f in frames
+        ],
+    }
+
+
+def _post(payload):
+    try:
+        req = urllib.request.Request(
+            _endpoint,
+            data=json.dumps(payload).encode(),
+            headers={"Content-Type": "application/json"},
+        )
+        urllib.request.urlopen(req, timeout=5)
+    except Exception:
+        pass

ghosttrap/django.py

@@ -0,0 +1,43 @@
+"""Django integration for ghosttrap.
+
+Add to INSTALLED_APPS:
+
+    INSTALLED_APPS = [
+        ...
+        "ghosttrap.django.GhostTrapApp",
+    ]
+
+This re-attaches the ghosttrap logging handler after Django's
+dictConfig runs (which typically clobbers handlers added during
+init()). Also provides the GhostTrapMiddleware for catching
+unhandled view exceptions.
+"""
+
+import logging
+
+from django.apps import AppConfig
+
+
+class GhostTrapApp(AppConfig):
+    name = "ghosttrap.django"
+    label = "ghosttrap_django"
+    verbose_name = "Ghosttrap"
+
+    def ready(self):
+        from ghosttrap.client import _install_logging_handler
+        _install_logging_handler()
+
+
+class GhostTrapMiddleware:
+    """Catches unhandled view exceptions and reports them."""
+
+    def __init__(self, get_response):
+        self.get_response = get_response
+
+    def __call__(self, request):
+        return self.get_response(request)
+
+    def process_exception(self, request, exception):
+        from ghosttrap.client import report
+        report(exception)
+        return None

ghosttrap_sdk-0.4.0.dist-info/METADATA

@@ -0,0 +1,43 @@
+Metadata-Version: 2.4
+Name: ghosttrap-sdk
+Version: 0.4.0
+Summary: Drop-in error reporter for ghosttrap.io
+Project-URL: Homepage, https://github.com/arowley-predictive-power/ghosttrap-sdk
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+
+# ghosttrap-sdk
+
+Drop-in error reporter for Python apps.
+
+## Install
+
+```
+pip install ghosttrap-sdk
+```
+
+## Use
+
+```python
+import ghosttrap
+
+# with a token (get one from `ghosttrap watch`):
+ghosttrap.init("t_abc123def456")
+
+# or with a full URL:
+ghosttrap.init("https://ghosttrap.io/trap/owner/repo/")
+```
+
+Unhandled exceptions are POSTed to ghosttrap.io with full tracebacks.
+The original `sys.excepthook` is preserved so errors still print to
+stderr as normal.
+
+For caught exceptions inside web frameworks:
+
+```python
+try:
+    do_something()
+except Exception as exc:
+    ghosttrap.report(exc)
+    raise
+```

ghosttrap_sdk-0.4.0.dist-info/RECORD

@@ -0,0 +1,7 @@
+ghosttrap/__init__.py,sha256=ajn2AhpcLvTMBSwP_lJkzfCYVIqdy7UEbiU6FCsMlac,72
+ghosttrap/client.py,sha256=r2_N7OE5Wk_3dYdg-1Y5-exWJTNcd2DVzTz0XRd1MYU,3181
+ghosttrap/django.py,sha256=KahzTZJzk_6VAgtSlCM1kD-PjOlzM6CATzv_CQgliAE,1048
+ghosttrap_sdk-0.4.0.dist-info/METADATA,sha256=sXGSaik13WJAEwmgz9o8TxBCCX2dUTFq7TVBfSV-vEE,861
+ghosttrap_sdk-0.4.0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+ghosttrap_sdk-0.4.0.dist-info/top_level.txt,sha256=6ke_r_vrKe4pvkNG8uXCLoWy3PT1FnuZiMjbvcJa_5c,10
+ghosttrap_sdk-0.4.0.dist-info/RECORD,,

ghosttrap_sdk-0.4.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

ghosttrap_sdk-0.4.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+ghosttrap