ylqjgm
/
canvas-lms
mirror of https://github.com/instructure/canvas-lms.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
canvas-lms/config/sentry.yml.example

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

11 lines
357 B
Plaintext
Raw Normal View History

get sentry into canvas closes CNVS-6016 No more error reports! (soon) this commit builds up sentry integration through the new Canvas::Errors module, along with other things that need to happen on every exception. ErrorReports should now get pushed towards just being used for representing a complaint a user filed via the get help form. I fixed about half the things that got linted as well while I was in here, but because this touches to much I fear divergence from tackling too many (I think we can safely say it's "better than we found it") I left a lot of the infrastructure for error reports in place until other commits for plugins can be merged TEST PLAN: 1) setup your raven.yml config file with the dsn for our sentry install 2) force an error to happen in a request response cycle. 3) see the error in sentry 4) force an error to happen in a job 5) see the error in sentry 6) statsd increments shoudl still fire 7) for the moment, an error report should still get created. Change-Id: I5a9dc7214598f8d5083451fd15f0423f8f939034 Reviewed-on: https://gerrit.instructure.com/51621 Reviewed-by: Simon Williams <simon@instructure.com> Reviewed-by: Brian Palmer <brianp@instructure.com> Tested-by: Jenkins QA-Review: August Thornton <august@instructure.com> Product-Review: Ethan Vizitei <evizitei@instructure.com>
2015-04-05 10:39:49 +08:00
development:
Add Sentry frontend exception recording This commit adds Sentry support to the frontend, so that exceptions on the browser side will be reported to Sentry. It requires that `frontend_dsn` be defined in `config/sentry.yml` and that the `sentry_disabled` Setting be `false` or unset. Future commits may add support for frontend APM, Fullstory linking, and source map uploading. Settings included in this commit: - `sentry_frontend_errors_sample_rate`, which controls the sample rate of error collection (defaults to 0.0, meaning no errors are collected) flag=none closes DE-967 test plan: - confirm that there are no issues when `frontend_dsn` is not set - confirm that setting `frontend_dsn` results in frontend exceptions being caught - check unhandled exceptions - check exceptions caught by Canvas's React `ErrorBoundary` - confirm that Sentry is not enabled on the frontend if the `sentry_disabled` setting is `true` - confirm that user context is associated with frontend exceptions reported to Sentry - confirm that adjusting `sentry_frontend_errors_sample_rate` correctly adjusts the quantity of errors delivered to Sentry, and that leaving it unset or set to 0.0 results in no errors being sent Change-Id: I47af7006a7f12b54dcb3f0121331af6ca2509124 Reviewed-on: https://gerrit.instructure.com/c/canvas-lms/+/282879 Product-Review: Isaac Moore <isaac.moore@instructure.com> Tested-by: Service Cloud Jenkins <svc.cloudjenkins@instructure.com> Reviewed-by: Ahmad Amireh <ahmad@instructure.com> QA-Review: Ahmad Amireh <ahmad@instructure.com>
2022-01-15 03:23:59 +08:00
dsn: 'your-sandbox-dsn-here'
frontend_dsn: 'your-sandbox-frontend-dsn-here'
Enable Sentry frontend FullStory integration If FullStory is enabled for the current session, this integration will associate the FullStory session URL with any errors sent to Sentry. Additionally, it will add an event to the FullStory session indicating there was a Sentry error, and providing a URL for easy access. If FullStory is not enabled for the current session, this integration is not enabled. closes DE-996 flag=none test plan: - ensure that the appropriate values are provided in config/sentry.yml - enable FullStory for a session by overriding methods in FullStoryHelper - cause an unhandled exception to occur on the frontend - verify that the event in Sentry contains FullStory context with a link to the session URL - verify that the FullStory session contains the Sentry Error event, with a link to the Sentry event - disable FullStory, and verify that frontend exception monitoring with Sentry works as normal Change-Id: I782930ecbea6f3e4afb23045d4087fe4c252875d Reviewed-on: https://gerrit.instructure.com/c/canvas-lms/+/283151 QA-Review: Isaac Moore <isaac.moore@instructure.com> Tested-by: Service Cloud Jenkins <svc.cloudjenkins@instructure.com> Reviewed-by: Charley Kline <ckline@instructure.com> Product-Review: Charley Kline <ckline@instructure.com>
2022-01-20 06:23:11 +08:00
org_slug: 'your-org-slug-here'
base_url: 'your-base-url-here'
get sentry into canvas closes CNVS-6016 No more error reports! (soon) this commit builds up sentry integration through the new Canvas::Errors module, along with other things that need to happen on every exception. ErrorReports should now get pushed towards just being used for representing a complaint a user filed via the get help form. I fixed about half the things that got linted as well while I was in here, but because this touches to much I fear divergence from tackling too many (I think we can safely say it's "better than we found it") I left a lot of the infrastructure for error reports in place until other commits for plugins can be merged TEST PLAN: 1) setup your raven.yml config file with the dsn for our sentry install 2) force an error to happen in a request response cycle. 3) see the error in sentry 4) force an error to happen in a job 5) see the error in sentry 6) statsd increments shoudl still fire 7) for the moment, an error report should still get created. Change-Id: I5a9dc7214598f8d5083451fd15f0423f8f939034 Reviewed-on: https://gerrit.instructure.com/51621 Reviewed-by: Simon Williams <simon@instructure.com> Reviewed-by: Brian Palmer <brianp@instructure.com> Tested-by: Jenkins QA-Review: August Thornton <august@instructure.com> Product-Review: Ethan Vizitei <evizitei@instructure.com>
2015-04-05 10:39:49 +08:00
production:
dsn: 'your-real-dsn-here'
Add Sentry frontend exception recording This commit adds Sentry support to the frontend, so that exceptions on the browser side will be reported to Sentry. It requires that `frontend_dsn` be defined in `config/sentry.yml` and that the `sentry_disabled` Setting be `false` or unset. Future commits may add support for frontend APM, Fullstory linking, and source map uploading. Settings included in this commit: - `sentry_frontend_errors_sample_rate`, which controls the sample rate of error collection (defaults to 0.0, meaning no errors are collected) flag=none closes DE-967 test plan: - confirm that there are no issues when `frontend_dsn` is not set - confirm that setting `frontend_dsn` results in frontend exceptions being caught - check unhandled exceptions - check exceptions caught by Canvas's React `ErrorBoundary` - confirm that Sentry is not enabled on the frontend if the `sentry_disabled` setting is `true` - confirm that user context is associated with frontend exceptions reported to Sentry - confirm that adjusting `sentry_frontend_errors_sample_rate` correctly adjusts the quantity of errors delivered to Sentry, and that leaving it unset or set to 0.0 results in no errors being sent Change-Id: I47af7006a7f12b54dcb3f0121331af6ca2509124 Reviewed-on: https://gerrit.instructure.com/c/canvas-lms/+/282879 Product-Review: Isaac Moore <isaac.moore@instructure.com> Tested-by: Service Cloud Jenkins <svc.cloudjenkins@instructure.com> Reviewed-by: Ahmad Amireh <ahmad@instructure.com> QA-Review: Ahmad Amireh <ahmad@instructure.com>
2022-01-15 03:23:59 +08:00
frontend_dsn: 'your-real-frontend-dsn-here'
Enable Sentry frontend FullStory integration If FullStory is enabled for the current session, this integration will associate the FullStory session URL with any errors sent to Sentry. Additionally, it will add an event to the FullStory session indicating there was a Sentry error, and providing a URL for easy access. If FullStory is not enabled for the current session, this integration is not enabled. closes DE-996 flag=none test plan: - ensure that the appropriate values are provided in config/sentry.yml - enable FullStory for a session by overriding methods in FullStoryHelper - cause an unhandled exception to occur on the frontend - verify that the event in Sentry contains FullStory context with a link to the session URL - verify that the FullStory session contains the Sentry Error event, with a link to the Sentry event - disable FullStory, and verify that frontend exception monitoring with Sentry works as normal Change-Id: I782930ecbea6f3e4afb23045d4087fe4c252875d Reviewed-on: https://gerrit.instructure.com/c/canvas-lms/+/283151 QA-Review: Isaac Moore <isaac.moore@instructure.com> Tested-by: Service Cloud Jenkins <svc.cloudjenkins@instructure.com> Reviewed-by: Charley Kline <ckline@instructure.com> Product-Review: Charley Kline <ckline@instructure.com>
2022-01-20 06:23:11 +08:00
org_slug: 'your-org-slug-here' # like 'instructure'
base_url: 'your-base-url-here' # like https://sentry.io