Skip to content
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.

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

ref(models): Include event id in Event repr #81345

Merged
merged 1 commit into from
Nov 27, 2024

Conversation

lobsterkatie
Copy link
Member

@lobsterkatie lobsterkatie commented Nov 26, 2024

Recently, when debugging a grouping error using Sentry, I wanted to know what event we'd been processing at the time the error was thrown, so I could examine its contents. Unfortunately, in the stack locals in the Sentry UI, all I saw was <sentry.eventstore.models.Event object at 0x7930346ecce0>. Fortunately, the project in question was low-traffic, so I was able to find the event based on timestamp, but it would have been a whole lot easier with the event id.

This fixes that problem by adding the event id to the Event class's __repr__, so now in stack locals events appear as <sentry.eventstore.models.Event at 0x125d619a0: event_id=8c567b1d65a3486da2db52695a5320d5>.

Note: I chose to keep the full path to the class in the repr - rather than following the safe_repr pattern we use with our DB models, under which it would just be <Event at 0x125d619a0: event_id=8c567b1d65a3486da2db52695a5320d5> - because Event isn't in fact a postgres model, and therefore doesn't live where other DB models do. As a result, I always forget where the Event code is, and have generally found having the full path there a helpful reminder.

@github-actions github-actions bot added the Scope: Backend Automatically applied to PRs that change backend components label Nov 26, 2024
Copy link

codecov bot commented Nov 26, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

✅ All tests successful. No failed tests found.

Additional details and impacted files
@@           Coverage Diff           @@
##           master   #81345   +/-   ##
=======================================
  Coverage   80.35%   80.35%           
=======================================
  Files        7219     7219           
  Lines      319567   319569    +2     
  Branches    20769    20769           
=======================================
+ Hits       256780   256783    +3     
+ Misses      62393    62392    -1     
  Partials      394      394           

@lobsterkatie lobsterkatie marked this pull request as ready for review November 26, 2024 22:51
@lobsterkatie lobsterkatie requested a review from a team as a code owner November 26, 2024 22:51
@lobsterkatie lobsterkatie merged commit 1d2c1c6 into master Nov 27, 2024
52 checks passed
@lobsterkatie lobsterkatie deleted the kmclb-add-event-id-to-event-repr branch November 27, 2024 17:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Scope: Backend Automatically applied to PRs that change backend components
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants