Log errors to Sentry (SCP-2525) #117
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
eweitz
requested review from
bistline,
devonbush,
jlchang and
knapii-developments
Codecov Report
@@ Coverage Diff @@
## master #117 +/- ##
==========================================
+ Coverage 50.19% 50.27% +0.07%
==========================================
Files 20 20
Lines 2526 2538 +12
==========================================
+ Hits 1268 1276 +8
- Misses 1258 1262 +4
Continue to review full report at Codecov.
|
bistline
approved these changes
Jul 24, 2020
devonbush
approved these changes
Jul 24, 2020
Contributor
devonbush
left a comment
devonbush
left a comment
There was a problem hiding this comment.
code looks great, just minor comment updates
| See logs in Sentry: | ||
| https://sentry.io/organizations/broad-institute/issues/?project=1424198 | ||
| ''' |
Contributor
There was a problem hiding this comment.
I love these links to the docs. I might move them up to where you import sentry, since these are more general
Co-authored-by: Devon <dbush@broadinstitute.org>
devonbush
approved these changes
Jul 25, 2020
knapii-developments
approved these changes
Jul 27, 2020
…ngest-pipeline into ew-sentry-error-log
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This improves observability for Ingest Pipeline by logging errors to Sentry, our main error monitoring platform.
Previously, Ingest Pipeline errors were only 1) logged to an ingest-operation-specific
errors.txtfile, and 2) emailed in summary form to the user.Now, such errors are also logged to Sentry. This lets us easily correlate and inspect errors in Ingest Pipeline, using stack traces and other rich debugging context, in the same place we use for our main Rails codebase. You can find example Ingest Pipeline errors in Sentry by filtering on
logger:ingest_pipeline. Ingest Pipeline errors also appear in the default unfiltered view.I tested this manually by setting the
SENTRY_DSNenvironment variable in my terminal (as described in the updated README instructions) and ingesting known-bad files via example commands noted atopingest_pipeline.py. I also manually tested the integration by pointing my local SCP Rails app to a development Docker build in GCR (gcr.io/broad-singlecellportal-staging/scp-ingest-pipeline-development:1.4.0_deb29ad).See broadinstitute/single_cell_portal_core/pull/675 for a small, coupled PR.
This satisfies SCP-2525.