Page MenuHomePhabricator
Create Task
Maniphest T91649

Deploy Sentry (JavaScript error logging) to production, configured to log only a limited subset of users/pages
Closed, DeclinedPublic
Actions

Description

Noticing, tracking and debugging errors should be easy. Wikimedia developers and users should be able to easily notice new errors (possibly only a subset of them that they are interested in), find out details, and share with others. At the same time security and privacy standards should be enforced.

Sentry is the most popular open-source software for error logging and aggregation; we should use it to (initially) collect errors from logged-in users (maybe leaving out the largest wikis, if the high traffic is problematic - those wikis are usually better at noticing problems quickly anyway) and/or errors on some specific pages with smaller traffic and more problematic history (e.g. Special:UploadWizard).

Details

SubjectRepoBranchLines +/-
Stop branching the Sentry extension for Wikimedia productionmediawiki/tools/releasemaster+0 -1
Drop Sentry, Part III: Drop from i18n build stepoperations/mediawiki-configmaster+0 -1
layout: [mediawiki/extensions/Sentry] Move out of deployed sectionintegration/configmaster+6 -7
Drop Sentry, Part II: Stop configuring it for Beta Clusteroperations/mediawiki-configmaster+0 -20
Drop Sentry, Part I: Stop loading it anywhereoperations/mediawiki-configmaster+0 -5
Customize query in gerrit

Related Objects
Search...

StatusSubtypeAssignedTask
 DeclinedNoneT382 RfC: Server-side Javascript error logging
 ResolvedTgrT524 Interface to display JS error logs
 Resolved• GillesT525 Review existing JS error logging solutions
 OpenNoneT106913 Use Sentry on non-production Wikimedia wikis, Toolforge and other sites/tools
 DeclinedNoneT106915 Use Sentry in production
 DeclinedTgrT91649 Deploy Sentry (JavaScript error logging) to production, configured to log only a limited subset of users/pages
 ResolvedTgrT1345 Set up and test Sentry on Labs for JS error logging
 ResolvedTgrT78807 Deploy Sentry extension on beta cluster
 Resolved• csteippT86677 Quick/short security review of Extension:Sentry
 ResolvedTgrT84957 Vagrantize Sentry
 ResolvedTgrT90773 Fix log directory permissions in Sentry vagrant role
 ResolvedAklapperT84955 Create MediaWiki-extensions-Sentry project
 ResolvedTgrT89384 Add error id generation to mw.errorLogging
 ResolvedTgrT105374 Investigate if the XSS vulnerability addressed in Sentry 7.6.1 affects us
 Resolved• jlinehanT88399 Improve Javascript error logging coverage
 ResolvedTgrT78809 Implement module wrapping for Sentry
 DeclinedTgrT85262 Add startup script to automatically wrap asynchronous functions in try..catch
 DeclinedTgrT86058 Find out whether any browser supported by MediaWiki needs TraceKit's "rethrow to window.onerror" logic for stack traces
 DeclinedTgrT92247 Wrap jQuery AJAX callbacks in try..catch via mw.errorLogging
 ResolvedTgrT92701 Test the impact of Javascript error logging on performance
 DeclinedTgrT93392 Make sure async wrapping for Javascript error logging only happens when the call is truly async
 ResolvedTgrT85263 Track module initialization errors in ResourceLoader
 ResolvedTgrT88874 Catch uncaught exceptions with Sentry
 ResolvedKrinkleT93986 mw.track subscribers cannot unsubscribe
 DeclinedNoneT90524 Use source urls in mw.loader.store
 OpenNoneT508 Use CORS-enabled fetch of scripts to avoid same-domain limitations in JS error logging
 ResolvedTgrT507 Measure how many users have CORS-hostile proxies
 DeclinedNoneT88078 Automated tests for Javascript error logging
 DeclinedNoneT526 Add sampling and throttling support to JS error logging
 InvalidNoneT89732 Investigate production and/or beta requirements for Sentry
 DeclinedTgrT93138 Procure hardware for Sentry
 ResolvedTgrT84956 Create basic puppet role for Sentry
 ResolvedjcrespoT112228 Need to run postgresql::user twice to set the password
 ResolvedTgrT94428 Log Javascript errors in UploadWizard funnel flow

Event Timeline

• Gilles created this task.Mar 5 2015, 3:58 PM
• Gilles assigned this task to Tgr.
• Gilles raised the priority of this task from to High.
• Gilles updated the task description. (Show Details)
• Gilles added projects: Multimedia, Roadmap, Sentry, UploadWizard.
• Gilles added subscribers: • Gilles, Tgr.
Restricted Application added a subscriber: Aklapper. · View Herald TranscriptMar 5 2015, 3:58 PM
• Gilles moved this task from Unscheduled to March 2015: Platform on the Roadmap board.Mar 5 2015, 3:58 PM
Eloquence renamed this task from Deploy Sentry to production, configured to log only UploadWizard to Deploy Sentry (JavaScript error logging) to production, configured to log only UploadWizard.Mar 5 2015, 9:02 PM
Eloquence set Security to None.
• RobLa-WMF added a project: Epic.Mar 6 2015, 1:26 AM
• RobLa-WMF subscribed.
Tgr added subtasks: T1345: Set up and test Sentry on Labs for JS error logging, T88399: Improve Javascript error logging coverage, T88078: Automated tests for Javascript error logging.Mar 6 2015, 1:29 AM
Tgr added a subtask: T526: Add sampling and throttling support to JS error logging.Mar 6 2015, 1:37 AM
Tgr mentioned this in T77892: Instrument JS errors in UploadWizard.Mar 6 2015, 1:41 AM
Tgr added a subtask: T89732: Investigate production and/or beta requirements for Sentry.Mar 6 2015, 1:55 AM
Eloquence subscribed.Mar 9 2015, 6:42 PM

Do we have a "week of" ETA for this yet?

Eloquence added a comment.Mar 20 2015, 2:45 AM

Poke -- is this happening next week, or do we need to bump it to April?

Tgr added a comment.Mar 20 2015, 10:36 PM
In T91649#1134379, @Eloquence wrote:

Poke -- is this happening next week, or do we need to bump it to April?

Sorry for being unresponsive! To a large extent this is blocked on review so it's hard for me to predict an exact date. It's definitely not happening next week though.

Tgr moved this task from March 2015: Platform to August 2015 on the Roadmap board.Mar 20 2015, 10:37 PM
Tgr added a subtask: T93138: Procure hardware for Sentry.Mar 25 2015, 9:51 PM
Restricted Application added a project: Notice. · View Herald TranscriptMar 25 2015, 9:51 PM
gpaumier added a project: Developer-notice.Mar 25 2015, 9:52 PM
gpaumier moved this task from Backlog to Triaged on the Notice board.
Tgr mentioned this in T94428: Log Javascript errors in UploadWizard funnel flow.Mar 30 2015, 4:46 PM
gpaumier moved this task from Triaged to Archive on the Notice board.Apr 2 2015, 7:01 PM
Tgr added a comment.Apr 9 2015, 7:26 AM

Javascript error logging (but not Sentry) has been deployed; the part of this project that's a dependency for UploadWizard work is tracked under T94428.

matmarex removed a project: Multimedia.Apr 24 2015, 9:45 PM
Restricted Application added a project: Multimedia. · View Herald TranscriptApr 24 2015, 9:45 PM
Jdforrester-WMF added a subtask: T94428: Log Javascript errors in UploadWizard funnel flow.Apr 24 2015, 9:49 PM
gpaumier moved this task from August 2015 to June 2015 on the Roadmap board.May 6 2015, 9:34 PM
greg moved this task from June 2015 to July 2015 on the Roadmap board.Jun 18 2015, 4:09 PM
Jdforrester-WMF added a project: User-notice.Jun 29 2015, 10:38 PM
Restricted Application added subscribers: Steinsplitter, Matanya. · View Herald TranscriptJun 29 2015, 10:38 PM
Jdforrester-WMF removed a project: User-notice.Jun 29 2015, 10:40 PM
Tgr added a subtask: T105374: Investigate if the XSS vulnerability addressed in Sentry 7.6.1 affects us.Jul 9 2015, 5:37 PM
Tgr moved this task from Backlog to Goals on the Sentry board.Jul 20 2015, 3:01 PM
Tgr lowered the priority of this task from High to Medium.Jul 24 2015, 11:29 PM
Tgr added a parent task: T106915: Use Sentry in production.Jul 24 2015, 11:45 PM
Tgr closed subtask T105374: Investigate if the XSS vulnerability addressed in Sentry 7.6.1 affects us as Resolved.Jul 30 2015, 5:35 AM
Jdforrester-WMF moved this task from Untriaged to Backlog on the Multimedia board.Sep 4 2015, 6:25 PM
greg added a subtask: T84956: Create basic puppet role for Sentry.Sep 24 2015, 1:46 AM
greg closed subtask T89732: Investigate production and/or beta requirements for Sentry as Invalid.
Tgr closed subtask T84956: Create basic puppet role for Sentry as Resolved.Sep 24 2015, 4:55 AM
Tgr mentioned this in T106915: Use Sentry in production.Jan 29 2017, 11:36 PM
Tgr renamed this task from Deploy Sentry (JavaScript error logging) to production, configured to log only UploadWizard to Deploy Sentry (JavaScript error logging) to production, configured to log only a limited subset of users/pages.Feb 5 2017, 8:58 AM
Tgr added a project: Developer-Wishlist (2017).
Tgr updated the task description. (Show Details)
Tgr moved this task from To Be Triaged to Backend on the Developer-Wishlist (2017) board.
Tgr moved this task from Backend to Frontend on the Developer-Wishlist (2017) board.Feb 5 2017, 9:25 AM
akosiaris subscribed.Nov 12 2019, 3:04 PM

Sentry is no longer open source (by the definition of OSI and by the admission of upstream as well). More at https://forum.sentry.io/t/re-licensing-sentry-faq-dAiscussion/8044.

Jdforrester-WMF subscribed.Nov 12 2019, 3:07 PM

Should we re-purpose this for the generic work not using Sentry itself, then?

Tgr added a comment.Nov 28 2019, 9:58 PM
In T91649#5656529, @akosiaris wrote:

Sentry is no longer open source (by the definition of OSI and by the admission of upstream as well). More at https://forum.sentry.io/t/re-licensing-sentry-faq-dAiscussion/8044.

To be more exact, Sentry is now business source, ie. eventually opensource with a non-compete restriction. (The code can be used in any way, except it cannot be used to offer paid error monitoring services; and it becomes proper Apache-2.0 three years after being published.) That is of course a no-go for any code that needs to be integrated with MediaWiki (using it would probably violate both the Sentry license and the GPL); using the Sentry server as a self-contained service should IMO still be considered. The license meets all the conditions for which we care about open source, and it's a reasonable balance between the spirit of open source (far closer to it than open core, which we do use) and not letting large commercial entities cannibalize your project. But of course that's a far larger discussion that would have to involve WMF Legal and TechCom at the minimum.

In any case, this task does not reflect reality, which is that (for unrelated reasons, mainly the technical complexity of running Sentry) we will deploy error logging based on our event logging stack. That is being tracked in T217142: [Proposal] Use the Kafka-Logstash logging infrastructure to log client-side errors.

akosiaris closed this task as Declined.Nov 29 2019, 8:11 AM
In T91649#5700798, @Tgr wrote:
In T91649#5656529, @akosiaris wrote:

Sentry is no longer open source (by the definition of OSI and by the admission of upstream as well). More at https://forum.sentry.io/t/re-licensing-sentry-faq-dAiscussion/8044.

To be more exact, Sentry is now business source, ie. eventually opensource with a non-compete restriction. (The code can be used in any way, except it cannot be used to offer paid error monitoring services; and it becomes proper Apache-2.0 three years after being published.) That is of course a no-go for any code that needs to be integrated with MediaWiki (using it would probably violate both the Sentry license and the GPL); using the Sentry server as a self-contained service should IMO still be considered. The license meets all the conditions for which we care about open source, and it's a reasonable balance between the spirit of open source (far closer to it than open core, which we do use) and not letting large commercial entities cannibalize your project. But of course that's a far larger discussion that would have to involve WMF Legal and TechCom at the minimum.

Indeed. There's a huge discussion around this trend in licensing and counter arguments (and counter-counter arguments and so on) to the above, but I too see little value in having this discussion in this task.

In any case, this task does not reflect reality, which is that (for unrelated reasons, mainly the technical complexity of running Sentry) we will deploy error logging based on our event logging stack. That is being tracked in T217142: [Proposal] Use the Kafka-Logstash logging infrastructure to log client-side errors.

I 'll resolve this as Declined per the above, feel free to reopen/change status.

Framawiki subscribed.Apr 29 2020, 7:43 PM

@akosiaris @Tgr As I can see Sentry extension is still deployed in production (present in extension-list file, plus wmgUseSentry is present in CommonSettings.php, but enabled nowhere in InitialiseSettings.php), perhaps it should be cleaned if it'll never be deployed?

Tgr added a comment.Apr 29 2020, 9:45 PM

Yeah, it should be cleaned up.

gerritbot added a comment.Apr 29 2020, 11:22 PM

Change 593346 had a related patch set uploaded (by Jforrester; owner: Jforrester):
[mediawiki/tools/release@master] Stop branching the Sentry extension for Wikimedia production

https://gerrit.wikimedia.org/r/593346

gerritbot added a project: Patch-For-Review.Apr 29 2020, 11:22 PM

Change 593347 had a related patch set uploaded (by Jforrester; owner: Jforrester):
[operations/mediawiki-config@master] Drop Sentry, Part I: Stop loading it anywhere

https://gerrit.wikimedia.org/r/593347

gerritbot added a comment.Apr 29 2020, 11:23 PM

Change 593348 had a related patch set uploaded (by Jforrester; owner: Jforrester):
[operations/mediawiki-config@master] Drop Sentry, Part II: Stop configuring it for Beta Cluster

https://gerrit.wikimedia.org/r/593348

gerritbot added a comment.Apr 29 2020, 11:23 PM

Change 593349 had a related patch set uploaded (by Jforrester; owner: Jforrester):
[operations/mediawiki-config@master] Drop Sentry, Part III: Drop from i18n build step

https://gerrit.wikimedia.org/r/593349

gerritbot added a comment.Apr 29 2020, 11:50 PM

Change 593347 merged by jenkins-bot:
[operations/mediawiki-config@master] Drop Sentry, Part I: Stop loading it anywhere

https://gerrit.wikimedia.org/r/593347

Stashbot added a comment.Apr 29 2020, 11:51 PM

Mentioned in SAL (#wikimedia-operations) [2020-04-29T23:51:43Z] <jforrester@deploy1001> Synchronized wmf-config/CommonSettings.php: T91649 Drop Sentry, Part I: Stop loading it anywhere (duration: 01m 05s)

gerritbot added a comment.Apr 29 2020, 11:53 PM

Change 593348 merged by jenkins-bot:
[operations/mediawiki-config@master] Drop Sentry, Part II: Stop configuring it for Beta Cluster

https://gerrit.wikimedia.org/r/593348

gerritbot added a comment.Apr 29 2020, 11:54 PM

Change 593355 had a related patch set uploaded (by Jforrester; owner: Jforrester):
[integration/config@master] layout: [mediawiki/extensions/Sentry] Move out of deployed section

https://gerrit.wikimedia.org/r/593355

Stashbot added a comment.Apr 29 2020, 11:56 PM

Mentioned in SAL (#wikimedia-operations) [2020-04-29T23:55:58Z] <jforrester@deploy1001> Synchronized wmf-config/InitialiseSettings.php: T91649 Drop Sentry, Part II: Stop configuring it for production or Beta Cluster (duration: 01m 05s)

gerritbot added a comment.Apr 29 2020, 11:56 PM

Change 593349 merged by jenkins-bot:
[operations/mediawiki-config@master] Drop Sentry, Part III: Drop from i18n build step

https://gerrit.wikimedia.org/r/593349

gerritbot added a comment.Apr 29 2020, 11:58 PM

Change 593355 merged by jenkins-bot:
[integration/config@master] layout: [mediawiki/extensions/Sentry] Move out of deployed section

https://gerrit.wikimedia.org/r/593355

Stashbot added a comment.Apr 29 2020, 11:59 PM

Mentioned in SAL (#wikimedia-releng) [2020-04-29T23:59:04Z] <James_F> Zuul: [mediawiki/extensions/Sentry] Move out of deployed section T91649

Jdforrester-WMF added a comment.Apr 30 2020, 12:01 AM
In T91649#6095433, @Tgr wrote:

Yeah, it should be cleaned up.

Done.

Tgr added a comment.Apr 30 2020, 9:37 AM

Thanks!

gerritbot added a comment.May 1 2020, 5:13 PM

Change 593346 merged by jenkins-bot:
[mediawiki/tools/release@master] Stop branching the Sentry extension for Wikimedia production

https://gerrit.wikimedia.org/r/593346

Maintenance_bot removed a project: Patch-For-Review.May 1 2020, 6:10 PM
Aklapper mentioned this in T257424: Update status of (or also clean up) #Sentry Phab tasks, Phab project, on-wiki documentation.Jul 8 2020, 11:19 AM
Tgr closed subtask T1345: Set up and test Sentry on Labs for JS error logging as Resolved.Sep 17 2020, 12:02 AM
Tgr closed subtask T93138: Procure hardware for Sentry as Declined.Sep 17 2020, 2:19 AM
Aklapper closed subtask T88078: Automated tests for Javascript error logging as Declined.Oct 4 2020, 12:00 PM
Framawiki mentioned this in T106913: Use Sentry on non-production Wikimedia wikis, Toolforge and other sites/tools.Feb 9 2021, 10:28 PM
• jlinehan closed subtask T88399: Improve Javascript error logging coverage as Resolved.Jun 30 2021, 3:07 PM
Aklapper closed subtask T526: Add sampling and throttling support to JS error logging as Declined.Apr 3 2023, 2:20 PM
Content licensed under Creative Commons Attribution-ShareAlike (CC BY-SA) 4.0 unless otherwise noted; code licensed under GNU General Public License (GPL) 2.0 or later and other open source licenses. By using this site, you agree to the Terms of Use, Privacy Policy, and Code of Conduct. · Wikimedia Foundation · Privacy Policy · Code of Conduct · Terms of Use · Disclaimer · CC-BY-SA · GPL