feat: sample_rate option

Author: untitaker

sentry_sdk/client.py

@@ -1,5 +1,6 @@
 import os
 import uuid
+import random
 
 from .utils import Dsn, SkipEvent, ContextVar
 from .transport import Transport
@@ -27,14 +28,15 @@ def __init__(self, dsn=None, *args, **kwargs):
         options = dict(DEFAULT_OPTIONS)
         options.update(*args, **kwargs)
         self.options = options
-        self._transport = self.options.pop('transport')
+        self._transport = self.options.pop("transport")
         if self._transport is None and dsn is not None:
             self._transport = Transport(dsn)
             self._transport.start()
         elif passed_dsn is not None and self._transport is not None:
             raise ValueError("Cannot pass DSN and a custom transport.")
 
         from .integrations import logging as logging_integration
+
         integrations = list(options.pop("integrations") or ())
 
         logging_configured = any(
@@ -78,6 +80,12 @@ def _prepare_event(self, event, scope):
         if event.get("platform") is None:
             event["platform"] = "python"
 
+        if (
+            self.options["sample_rate"] < 1.0
+            and random.random() >= self.options["sample_rate"]
+        ):
+            raise SkipEvent()
+
         event = strip_event(event)
         event = flatten_metadata(event)
         return event

sentry_sdk/consts.py

@@ -11,9 +11,10 @@
     "drain_timeout": 2.0,
     "integrations": [],
     "default_integrations": True,
-    'repos': {},
-    'dist': None,
-    'transport': None
+    "repos": {},
+    "dist": None,
+    "transport": None,
+    "sample_rate": 1.0,
 }
 
 SDK_INFO = {"name": "sentry-python", "version": VERSION}

tests/test_client.py

@@ -2,9 +2,10 @@
 from sentry_sdk import Client
 from sentry_sdk.transport import Transport
 
+
 def test_transport_option(monkeypatch):
-    dsn = 'https://[email protected]/123'
-    dsn2 = 'https://[email protected]/124'
+    dsn = "https://[email protected]/123"
+    dsn2 = "https://[email protected]/124"
     assert str(Client(dsn=dsn).dsn) == dsn
     assert Client().dsn is None
     with pytest.raises(ValueError):