fix: Rename drain_timeout to shutdown_timeout

Fixes #29

Author: untitaker

docs/config.md

@@ -9,7 +9,7 @@
   running in, e.g.  ``"staging"`` or ``"production"``.
 - ``server_name`` (default to the system's hostname): The actual hostname of your
   system.
-- ``drain_timeout`` (default ``2.0``): When calling ``Client.close()`` or when
+- ``shutdown_timeout`` (default ``2.0``): When calling ``Client.close()`` or when
   exiting the contextmanager provided by ``sentry_sdk.init``, wait this many
   seconds for the last events to be sent.
 - ``integrations`` (default: ``[]``): Integrations to be enabled in addition to

sentry_sdk/client.py

@@ -132,7 +132,7 @@ def capture_event(self, event, scope=None):
 
     def drain_events(self, timeout=None):
         if timeout is None:
-            timeout = self.options["drain_timeout"]
+            timeout = self.options["shutdown_timeout"]
         if self._transport is not None:
             self._transport.drain_events(timeout)
 

sentry_sdk/consts.py

@@ -8,7 +8,7 @@
     "release": None,
     "environment": None,
     "server_name": DEFAULT_SERVER_NAME,
-    "drain_timeout": 2.0,
+    "shutdown_timeout": 2.0,
     "integrations": [],
     "default_integrations": True,
     "repos": {},

tests/test_client.py

@@ -73,7 +73,7 @@ def send_event(pool, event, auth):
         print(event["message"])
 
     transport.send_event = send_event
-    init("http://foobar@localhost/123", drain_timeout={num_messages})
+    init("http://foobar@localhost/123", shutdown_timeout={num_messages})
 
     for _ in range({num_messages}):
         capture_message("HI")