pressbooks / ideas

Ideas for Pressbooks.
GNU General Public License v3.0
12 stars 4 forks source link

[Research] - Sentry plugin for PB integration #351

Closed richard015ar closed 3 years ago

richard015ar commented 3 years ago

We have recently integrated Sentry (an application monitoring and error tracking tool) with Pressbooks, and added the code to do so directly to the core Pressbooks plugin. PR: pressbooks/pressbooks#1956. See also https://github.com/pressbooks/private/issues/130#issuecomment-634938654

New environment variables added in .env file:
# Sentry.io
SENTRY_KEY=sentry_key
SENTRY_ORGANIZATION=sentry_organization_id
SENTRY_PROJECT=sentry_project_id

We also have the desire to add front end application monitoring to our hosted instances of Pressbooks: https://github.com/pressbooks/private/issues/374

Open source users may not want or need the features provided by the existing proof of concept integration or a possible extension. Before we decide to permanently keep this integration in the Pressbooks core plugin, we should research whether the desired Pressbooks/Sentry integration could be completed using an existing plugin (like https://github.com/stayallive/wp-sentry/) or by creating and maintaing our own plugin.

This research task involves researching existing plugin, options for writing our own plugin, and producing/gathering high level product requirements and a recommendation for what do to next.

Related issues: https://github.com/pressbooks/private/issues/362

richard015ar commented 3 years ago

I created this doc: https://docs.google.com/document/d/1nagi-5CaASGd-4nhR8w2YldHK4do8VVAOPDoukfDdGU/edit# @SteelWagstaff do you think we should include a meeting to take the decision in this ticket? or do you prefer I create a separate ticket for review this doc and decide together the approach?

SteelWagstaff commented 3 years ago

@richard015ar I think adding a short meeting to discuss your research report and decide on our proposed approach would be a good idea. It's fine with me to do this as part of this ticket and to create new tickets for any decisions/work that flows out of that meeting.