Skip to content

Add API to set custom Span timestamps #1770

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
antonpirker merged 2 commits into from
Nov 30, 2022
Merged

Add API to set custom Span timestamps #1770

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
28dcc57
Add parameter to set and on Span creation or finishing
antonpirker Nov 30, 2022
c89fd9b
Made end_timestamp parameter explicit
antonpirker Nov 30, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 16 additions & 10 deletions sentry_sdk/tracing.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,7 @@ def __init__(
status=None, # type: Optional[str]
transaction=None, # type: Optional[str] # deprecated
containing_transaction=None, # type: Optional[Transaction]
start_timestamp=None, # type: Optional[datetime]
instrumenter=None, # type: Optional[str]
):
# type: (...) -> None
Expand All @@ -141,7 +142,7 @@ def __init__(
self._tags = {} # type: Dict[str, str]
self._data = {} # type: Dict[str, Any]
self._containing_transaction = containing_transaction
self.start_timestamp = datetime.utcnow()
self.start_timestamp = start_timestamp or datetime.utcnow()
try:
# TODO: For Python 3.7+, we could use a clock with ns resolution:
# self._start_timestamp_monotonic = time.perf_counter_ns()
Expand Down Expand Up @@ -472,8 +473,8 @@ def is_success(self):
# type: () -> bool
return self.status == "ok"

def finish(self, hub=None):
# type: (Optional[sentry_sdk.Hub]) -> Optional[str]
def finish(self, hub=None, end_timestamp=None):
# type: (Optional[sentry_sdk.Hub], Optional[datetime]) -> Optional[str]
# XXX: would be type: (Optional[sentry_sdk.Hub]) -> None, but that leads
# to incompatible return types for Span.finish and Transaction.finish.
if self.timestamp is not None:
Expand All @@ -483,8 +484,13 @@ def finish(self, hub=None):
hub = hub or self.hub or sentry_sdk.Hub.current

try:
duration_seconds = time.perf_counter() - self._start_timestamp_monotonic
self.timestamp = self.start_timestamp + timedelta(seconds=duration_seconds)
if end_timestamp:
self.timestamp = end_timestamp
else:
duration_seconds = time.perf_counter() - self._start_timestamp_monotonic
self.timestamp = self.start_timestamp + timedelta(
seconds=duration_seconds
)
except AttributeError:
self.timestamp = datetime.utcnow()

Expand Down Expand Up @@ -630,8 +636,8 @@ def containing_transaction(self):
# reference.
return self

def finish(self, hub=None):
# type: (Optional[sentry_sdk.Hub]) -> Optional[str]
def finish(self, hub=None, end_timestamp=None):
# type: (Optional[sentry_sdk.Hub], Optional[datetime]) -> Optional[str]
if self.timestamp is not None:
# This transaction is already finished, ignore.
return None
Expand Down Expand Up @@ -663,7 +669,7 @@ def finish(self, hub=None):
)
self.name = "<unlabeled transaction>"

Span.finish(self, hub)
Span.finish(self, hub, end_timestamp)

if not self.sampled:
# At this point a `sampled = None` should have already been resolved
Expand Down Expand Up @@ -876,8 +882,8 @@ def set_http_status(self, http_status):
# type: (Any) -> Any
pass

def finish(self, hub=None, **kwargs):
# type: (Any, **Any) -> Any
def finish(self, hub=None, end_timestamp=None):
# type: (Any, Any) -> Any
pass


Expand Down