fix: Prepare for timestamps in breadcrumbs

Author: untitaker

README.md

@@ -82,19 +82,21 @@ docs](./docs/logging.md) for more information. You can, however, also create
 breadcrumbs manually:
 
     sentry_sdk.add_breadcrumb(
-        # ty="log",
-        # level="debug",
+        timestamp=datetime.datetime.now(),
+        ty="log",
+        level="debug",
+        # message="hi",
         # category="myapp.models",
-        message="hi"
     })
 
 You can also pass a callback to `add_breadcrumb` like so:
 
     sentry_sdk.add_breadcrumb(lambda: {
-        # "ty": "log",
-        # "level": "debug",
+        "timestamp": datetime.datetime.now(),
+        "ty": "log",
+        "level": "debug",
+        # "message": "hi",
         # "category": "myapp.models",
-        "message": "hi"
     })
 
 The callback will only be called if a sentry client is configured.

sentry_sdk/client.py

@@ -6,7 +6,7 @@
 from .utils import Dsn, SkipEvent, ContextVar
 from .transport import Transport
 from .consts import DEFAULT_OPTIONS, SDK_INFO
-from .event import strip_event, flatten_metadata, Event
+from .event import strip_event, flatten_metadata, convert_types, Event
 
 
 NO_DSN = object()
@@ -97,6 +97,7 @@ def _prepare_event(self, event, scope):
 
         event = strip_event(event)
         event = flatten_metadata(event)
+        event = convert_types(event)
         return event
 
     def _check_should_capture(self, event):

sentry_sdk/event.py

@@ -1,13 +1,13 @@
 import uuid
-from datetime import datetime
+import datetime
 
 from collections import Mapping, Sequence
 
 from .utils import exceptions_from_error_tuple
 from ._compat import text_type
 
 
-def datetime_to_json(dt):
+def _datetime_to_json(dt):
     return dt.strftime("%Y-%m-%dT%H:%M:%SZ")
 
 
@@ -17,7 +17,7 @@ class Event(Mapping):
     def __init__(self, data={}):
         self._data = {
             "event_id": uuid.uuid4().hex,
-            "timestamp": datetime_to_json(datetime.utcnow()),
+            "timestamp": datetime.datetime.utcnow(),
             "level": "error",
         }
 
@@ -124,6 +124,16 @@ def strip_frame(frame):
     return frame, ({"vars": meta} if meta is not None else None)
 
 
+def convert_types(obj):
+    if isinstance(obj, (datetime.datetime, datetime.date)):
+        return _datetime_to_json(obj)
+    if isinstance(obj, Mapping):
+        return {k: convert_types(v) for k, v in obj.items()}
+    if isinstance(obj, Sequence) and not isinstance(obj, (text_type, bytes)):
+        return [convert_types(v) for v in obj]
+    return obj
+
+
 def strip_databag(obj, remaining_depth=20):
     assert not isinstance(obj, bytes), "bytes should have been normalized before"
     if remaining_depth <= 0:

sentry_sdk/integrations/logging.py

@@ -6,7 +6,7 @@
 
 from sentry_sdk import get_current_hub, capture_event, add_breadcrumb
 from sentry_sdk.utils import to_string, skip_internal_frames
-from sentry_sdk.event import Event, datetime_to_json
+from sentry_sdk.event import Event
 from sentry_sdk.hub import _internal_exceptions
 
 from . import Integration
@@ -52,9 +52,7 @@ def _breadcrumb_from_record(self, record):
             "level": self._logging_to_event_level(record.levelname),
             "category": record.name,
             "message": record.message,
-            "timestamp": datetime_to_json(
-                datetime.datetime.fromtimestamp(record.created)
-            ),
+            "timestamp": datetime.datetime.fromtimestamp(record.created),
         }
 
     def _emit(self, record):

tests/test_client.py

@@ -3,8 +3,9 @@
 import pytest
 import sys
 import subprocess
+from datetime import datetime
 from textwrap import dedent
-from sentry_sdk import Hub, Client, configure_scope, capture_message
+from sentry_sdk import Hub, Client, configure_scope, capture_message, add_breadcrumb
 from sentry_sdk.hub import HubMeta
 from sentry_sdk.transport import Transport
 from sentry_sdk.utils import Dsn
@@ -139,6 +140,7 @@ def test_transport_works(sentry_init, httpserver, request, capsys):
     Hub.current.bind_client(client)
     request.addfinalizer(lambda: Hub.current.bind_client(None))
 
+    add_breadcrumb(level="info", message="i like bread", timestamp=datetime.now())
     capture_message("löl")
     client.drain_events()