tinymonpy 0.1.0__tar.gz → 0.2.0__tar.gz

{tinymonpy-0.1.0 → tinymonpy-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: tinymonpy
-Version: 0.1.0
+Version: 0.2.0
 Summary: Tiny error monitoring SDK for Python.
 Author: tinymon
 License: MIT

{tinymonpy-0.1.0 → tinymonpy-0.2.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "tinymonpy"
-version = "0.1.0"
+version = "0.2.0"
 description = "Tiny error monitoring SDK for Python."
 requires-python = ">=3.8"
 license = { text = "MIT" }

{tinymonpy-0.1.0 → tinymonpy-0.2.0}/tinymonpy/__init__.py

@@ -34,7 +34,7 @@ __all__ = [
     "_parse_traceback",
 ]
 
-__version__ = "0.1.0"
+__version__ = "0.2.0"
 
 _client: Optional[Client] = None
 
@@ -47,6 +47,10 @@ def init(
     release: Optional[str] = None,
     sample_rate: float = 1.0,
     before_send: Optional[Callable[[Dict[str, Any]], Optional[Dict[str, Any]]]] = None,
+    # Privacy controls. See https://tinymon.dev/docs/privacy.html
+    scrub_url_query: bool = True,
+    scrub_patterns: Optional[list] = None,
+    send_default_pii: bool = False,
 ) -> None:
     global _client
     _client = Client(
@@ -56,6 +60,9 @@ def init(
         release=release,
         sample_rate=sample_rate,
         before_send=before_send,
+        scrub_url_query=scrub_url_query,
+        scrub_patterns=scrub_patterns,
+        send_default_pii=send_default_pii,
     )
     install_global_handlers(_client)
 

tinymonpy-0.2.0/tinymonpy/client.py

@@ -0,0 +1,89 @@
+"""The Client orchestrates capture: build event, scrub, run before_send, enqueue."""
+from __future__ import annotations
+
+import random
+from typing import Any, Callable, Dict, List, Optional, Pattern
+
+from .event_builder import build_event
+from .scope import scope
+from .scrub import scrub_event
+from .transport import Transport
+
+_DEFAULT_ENDPOINT = "https://console.tinymon.dev/api/ingest"
+
+BeforeSend = Callable[[Dict[str, Any]], Optional[Dict[str, Any]]]
+
+
+class Client:
+    def __init__(
+        self,
+        dsn: str,
+        *,
+        endpoint: Optional[str] = None,
+        environment: Optional[str] = None,
+        release: Optional[str] = None,
+        sample_rate: float = 1.0,
+        before_send: Optional[BeforeSend] = None,
+        # Privacy controls — defaults are privacy-preserving.
+        scrub_url_query: bool = True,
+        scrub_patterns: Optional[List[Pattern[str]]] = None,
+        send_default_pii: bool = False,
+    ) -> None:
+        self.dsn = dsn
+        self.endpoint = endpoint or _DEFAULT_ENDPOINT
+        self.environment = environment
+        self.release = release
+        self.sample_rate = sample_rate
+        self.before_send = before_send
+        self.scrub_url_query = scrub_url_query
+        self.scrub_patterns = scrub_patterns
+        self.send_default_pii = send_default_pii
+        self.transport = Transport(self.endpoint, dsn)
+
+    def _prepare(self, exc: BaseException) -> Optional[Dict[str, Any]]:
+        snap = scope.snapshot()
+        event = build_event(
+            exc,
+            release=self.release,
+            environment=self.environment,
+            user=snap["user"],
+            tags=snap["tags"],
+            breadcrumbs=snap["breadcrumbs"],
+        )
+        # Default scrub BEFORE before_send.
+        scrub_event(
+            event,
+            scrub_url_query=self.scrub_url_query,
+            scrub_patterns=self.scrub_patterns,
+        )
+        # PII gate on the wire — server only attaches IP if true.
+        event["send_default_pii"] = bool(self.send_default_pii)
+        if self.before_send is not None:
+            result = self.before_send(event)
+            if result is None:
+                return None
+            event = result
+        return event
+
+    def capture_exception(self, exc: BaseException) -> None:
+        try:
+            if random.random() > self.sample_rate:
+                return
+            event = self._prepare(exc)
+            if event is None:
+                return
+            self.transport.enqueue(event)
+        except Exception:
+            # SWALLOW. The SDK must never throw into the host app.
+            pass
+
+    def capture_message(self, message: str, level: str = "info") -> None:
+        try:
+            event = self._prepare(Exception(message))
+            if event is None:
+                return
+            event["level"] = level
+            event["exception"]["type"] = "Message"
+            self.transport.enqueue(event)
+        except Exception:
+            pass

tinymonpy-0.2.0/tinymonpy/scrub.py

@@ -0,0 +1,67 @@
+"""Default PII scrub. Identical semantics to the JS SDK and the server.
+
+Runs BEFORE before_send so user hooks can both relax and tighten the defaults.
+"""
+from __future__ import annotations
+
+import re
+from typing import Any, Dict, List, Optional, Pattern
+
+SENSITIVE_TAG_KEY: Pattern[str] = re.compile(
+    r"password|token|secret|auth|card|cvv|ssn", re.IGNORECASE
+)
+
+_EMAIL = re.compile(r"\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\.[A-Za-z]{2,}\b")
+_CARD = re.compile(r"\b(?:\d[ -]?){12,15}\d\b")
+_BEARER = re.compile(r"\b[Bb]earer\s+[A-Za-z0-9._\-]+")
+_AUTH_HDR = re.compile(r"\bAuthorization\s*:\s*\S+")
+
+DEFAULT_PATTERNS: List[Pattern[str]] = [_EMAIL, _CARD, _BEARER, _AUTH_HDR]
+
+
+def _scrub_string(s: str, patterns: List[Pattern[str]]) -> str:
+    out = s
+    for re_ in patterns:
+        out = re_.sub("[redacted]", out)
+    return out
+
+
+def _strip_url_query(url: Optional[str]) -> Optional[str]:
+    if not url:
+        return url
+    for i, ch in enumerate(url):
+        if ch in "?#":
+            return url[:i]
+    return url
+
+
+def scrub_event(
+    event: Dict[str, Any],
+    *,
+    scrub_url_query: bool = True,
+    scrub_patterns: Optional[List[Pattern[str]]] = None,
+) -> Dict[str, Any]:
+    """Mutate the event dict in place. Returns it for chaining."""
+    patterns = list(DEFAULT_PATTERNS) + list(scrub_patterns or [])
+
+    req = event.get("request") or {}
+    if scrub_url_query and req.get("url"):
+        req["url"] = _strip_url_query(req.get("url"))
+        event["request"] = req
+
+    exc = event.get("exception") or {}
+    if exc.get("value"):
+        exc["value"] = _scrub_string(exc["value"], patterns)
+
+    for b in event.get("breadcrumbs") or []:
+        if b.get("message"):
+            b["message"] = _scrub_string(b["message"], patterns)
+
+    tags = event.get("tags")
+    if tags:
+        cleaned: Dict[str, str] = {}
+        for k, v in tags.items():
+            cleaned[k] = "[redacted]" if SENSITIVE_TAG_KEY.search(k) else v
+        event["tags"] = cleaned
+
+    return event

{tinymonpy-0.1.0 → tinymonpy-0.2.0}/tinymonpy.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: tinymonpy
-Version: 0.1.0
+Version: 0.2.0
 Summary: Tiny error monitoring SDK for Python.
 Author: tinymon
 License: MIT

{tinymonpy-0.1.0 → tinymonpy-0.2.0}/tinymonpy.egg-info/SOURCES.txt

@@ -5,6 +5,7 @@ tinymonpy/client.py
 tinymonpy/event_builder.py
 tinymonpy/integrations.py
 tinymonpy/scope.py
+tinymonpy/scrub.py
 tinymonpy/stacktrace.py
 tinymonpy/transport.py
 tinymonpy.egg-info/PKG-INFO

tinymonpy-0.1.0/tinymonpy/client.py

@@ -1,75 +0,0 @@
-"""The Client orchestrates capture: build event, run beforeSend, enqueue."""
-from __future__ import annotations
-
-import random
-from typing import Any, Callable, Dict, Optional
-
-from .event_builder import build_event
-from .scope import scope
-from .transport import Transport
-
-_DEFAULT_ENDPOINT = "https://console.tinymon.dev/api/ingest"
-
-BeforeSend = Callable[[Dict[str, Any]], Optional[Dict[str, Any]]]
-
-
-class Client:
-    def __init__(
-        self,
-        dsn: str,
-        *,
-        endpoint: Optional[str] = None,
-        environment: Optional[str] = None,
-        release: Optional[str] = None,
-        sample_rate: float = 1.0,
-        before_send: Optional[BeforeSend] = None,
-    ) -> None:
-        self.dsn = dsn
-        self.endpoint = endpoint or _DEFAULT_ENDPOINT
-        self.environment = environment
-        self.release = release
-        self.sample_rate = sample_rate
-        self.before_send = before_send
-        self.transport = Transport(self.endpoint, dsn)
-
-    def capture_exception(self, exc: BaseException) -> None:
-        try:
-            if random.random() > self.sample_rate:
-                return
-            snap = scope.snapshot()
-            event = build_event(
-                exc,
-                release=self.release,
-                environment=self.environment,
-                user=snap["user"],
-                tags=snap["tags"],
-                breadcrumbs=snap["breadcrumbs"],
-            )
-            if self.before_send is not None:
-                result = self.before_send(event)
-                if result is None:
-                    return
-                event = result
-            self.transport.enqueue(event)
-        except Exception:
-            # SWALLOW. The SDK must never throw into the host app.
-            pass
-
-    def capture_message(self, message: str, level: str = "info") -> None:
-        try:
-            # Synthesize an exception without a stack — value carries the message.
-            synthetic = Exception(message)
-            snap = scope.snapshot()
-            event = build_event(
-                synthetic,
-                release=self.release,
-                environment=self.environment,
-                user=snap["user"],
-                tags=snap["tags"],
-                breadcrumbs=snap["breadcrumbs"],
-            )
-            event["level"] = level
-            event["exception"]["type"] = "Message"
-            self.transport.enqueue(event)
-        except Exception:
-            pass