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.

Sign up for GitHub

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

Jump to bottom

Support for error tracking with Sentry #4026

Closed
torgeirl opened this issue May 26, 2023 · 8 comments
Closed

Support for error tracking with Sentry #4026

torgeirl opened this issue May 26, 2023 · 8 comments
Assignees
@torgeirl @reckart
Labels
⭐️ Enhancement New feature or request
Milestone
29.0

Comments

@torgeirl
Copy link
Contributor

torgeirl commented May 26, 2023 •
edited
Loading

Is your feature request related to a problem? Please describe.
As a system administrator I would like to be able to use Sentry as an error tracker the Inception deployment I maintain.

Describe the solution you'd like
This would be possible if the needed Sentry SDK libraries (MIT License) were included in the standard build of Inception. Since Inception is built using Spring Boot, this would include two new dependencies:

  • sentry-spring-boot-starter (required)
  • sentry-log4j2 (optional; would allow for transaction performance monitoring)

The later could in addition be supported by also adding SentryAppender to the list of supported loggers. Otherwise, it would have to be specified as a custom logger.

Sentry's documentation for Spring Boot

Describe alternatives you've considered
Kibana/ELK is fine for metrics/general traffic monitoring, but compared to Sentry they require more setup to monitor errors, include more noise, and often requires you to already be digging for answers to a reported issue.

Additional context
I would happily expand Inception's documentation with instructions on how to set it up if the needed libraries get included.
@reckart reckart added the ⭐️ Enhancement New feature or request label May 30, 2023
@reckart reckart added this to the 29.0 milestone May 30, 2023
@reckart reckart self-assigned this May 30, 2023
reckart added a commit that referenced this issue May 30, 2023
@reckart
#4026 - Support for error tracking with Sentry
0c0bb19 
- Add sentry dependencies
reckart added a commit that referenced this issue May 30, 2023
@reckart
Merge pull request #4042 from inception-project/feature/4026-Support-…
6b2258f 
…for-error-tracking-with-Sentry

#4026 - Support for error tracking with Sentry
reckart added a commit that referenced this issue Jun 9, 2023
@reckart
#4026: Support for error tracking with Sentry
58b4424 
- Add sentry log4j dependency
- sentry 6.20.0 -> 6.22.0
reckart added a commit that referenced this issue Jun 9, 2023
@reckart
#4026: Support for error tracking with Sentry
d26024f 
- Add sentry log4j dependency
- sentry 6.20.0 -> 6.22.0
reckart added a commit that referenced this issue Jun 9, 2023
@reckart
Merge pull request #4059 from inception-project/feature/4026-Support-…
2772368 
…for-error-tracking-with-Sentry

#4026: Support for error tracking with Sentry
reckart added a commit that referenced this issue Jun 9, 2023
@reckart
Merge branch 'main' into refactoring/4060-Clean-up-redundant-code-in-…
4cc877d 
…annotation-handlers

* main:
  #4026: Support for error tracking with Sentry
reckart added a commit that referenced this issue Jun 13, 2023
@reckart
Merge branch 'main' into refactoring/Upgrade-to-Spring-Boot-3
14d38be 
* main: (189 commits)
  No issue. Minor additions to BioC format description
  #4062 - ViewportTracker should focus on block-like elements
  #4032 - Allow using externalized strings from backend code
  #4060 - Clean up redundant code in annotation handlers
  #4026: Support for error tracking with Sentry
  #3673 - Update dependencies
  update dead link to the new file
  #4055 - Editor scrolls up when left sidebar is opened/closed
  [maven-release-plugin] prepare for next development iteration
  [maven-release-plugin] prepare release inception-28.2
  #4052 - Admins no longer see all projects in the project overview
  #3673 - Update dependencies
  #4048 - Document navigation options not visible to manager when viewing other users document
  #3673 - Update dependencies
  #3673 - Update dependencies
  #1496 - Some spans are missing begin offset field
  #1511 - External recommender fails when CAS contains control characters
  #1496 - Some spans are missing begin offset field
  #4040 - Ability to store preferences from client-side code
  #1066 - Recommender status info
  ...

% Conflicts:
%	inception/inception-api-annotation/src/main/java/de/tudarmstadt/ukp/clarin/webanno/api/annotation/page/AnnotationPageBase.java
%	inception/inception-brat-editor/src/main/java/de/tudarmstadt/ukp/clarin/webanno/brat/annotation/BratAnnotationEditor.java
%	inception/inception-diam/src/main/java/de/tudarmstadt/ukp/inception/diam/service/DiamWebsocketController.java
%	inception/inception-documents/src/test/java/de/tudarmstadt/ukp/inception/documents/DocumentServiceImplConcurrencyTest.java
%	inception/inception-external-search-solr/pom.xml
%	inception/inception-html-editor/src/main/java/de/tudarmstadt/ukp/inception/htmleditor/docview/HtmlDocumentViewControllerImpl.java
%	inception/inception-html-editor/src/main/resources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports
%	inception/inception-preferences/src/main/java/de/tudarmstadt/ukp/inception/preferences/config/PreferencesServiceAutoConfig.java
%	inception/inception-recommendation/src/main/java/de/tudarmstadt/ukp/inception/recommendation/service/LearningRecordServiceImpl.java
%	inception/inception-recommendation/src/main/java/de/tudarmstadt/ukp/inception/recommendation/service/RecommendationServiceImpl.java
%	inception/inception-recommendation/src/main/java/de/tudarmstadt/ukp/inception/recommendation/tasks/TrainingTask.java
%	inception/inception-recommendation/src/test/java/de/tudarmstadt/ukp/inception/recommendation/footer/RecommendationEventWebsocketControllerImplTest.java
%	inception/inception-support/pom.xml
%	inception/inception-ui-core/pom.xml
%	inception/inception-websocket/pom.xml
%	inception/pom.xml
reckart added a commit that referenced this issue Jul 2, 2023
@reckart
Merge branch 'main' into feature/1336-Add-dark-mode
d88b802 
* main:
  No issue. Slightly improving PDF editor visual
  No issue: Experiment with a Jenkinsfile
  No issue: Experiment with a Jenkinsfile
  No issue: Experiment with a Jenkinsfile
  No issue: Experiment with a Jenkinsfile
  No issue: Experiment with a Jenkinsfile
  #4058 - Cannot export texts containing certain characters as UIMA CAS XMI
  #3673 - Update dependencies
  #4066 - Display document name on export failure
  No issue. Minor additions to BioC format description
  #4062 - ViewportTracker should focus on block-like elements
  #4058 - Cannot export texts containing certain characters as UIMA CAS XMI
  #4032 - Allow using externalized strings from backend code
  #4060 - Clean up redundant code in annotation handlers
  #4026: Support for error tracking with Sentry
@reckart
Copy link
Member

reckart commented Jul 3, 2023

@torgeirl how are you sentry experiments going? Is this something we should keep? If you don't get sentry to run, I would consider removing the dependencies again.

@torgeirl
Copy link
Contributor Author

torgeirl commented Jul 3, 2023

@reckart: I have been traveling since right before you added the latest dependency, and have therefore not had the change to test it yet. Back at the office this Thursday. Will give you an update either Thursday or Friday!

@torgeirl
Copy link
Contributor Author

torgeirl commented Jul 7, 2023

@reckart: seems to be working well now, but I like to test some more to be sure. Is there a rough timeline for the 29.0 release ("docs due date")?

@reckart
Copy link
Member

reckart commented Jul 7, 2023

The 29.0 milestone currently has the 8.8.2023 attached to it.

@reckart reckart modified the milestones: 29.0, 30.0 Jul 29, 2023
@reckart
Copy link
Member

reckart commented Aug 1, 2023

@torgeirl would you like to write up a few lines of documentation regarding sentry this week? The 29.0 release is scheduled for Tuesday next week.

@torgeirl
Copy link
Contributor Author

torgeirl commented Aug 1, 2023

@torgeirl would you like to write up a few lines of documentation regarding sentry this week? The 29.0 release is scheduled for Tuesday next week.

Will do! 👍

@torgeirl torgeirl mentioned this issue Aug 1, 2023
Merged
@torgeirl
Copy link
Contributor Author

torgeirl commented Aug 1, 2023

@reckart: I've added the most common settings in a PR now. There are a lot of settings so I added the most common, and a link to the official docs.

reckart pushed a commit that referenced this issue Aug 1, 2023
@torgeirl
#4026 - Support for error tracking with Sentry
f719170 
- added Sentry docs
@reckart
Copy link
Member

reckart commented Aug 1, 2023

Thx. I have squashed-merged it and in the process updated the commit comment according to the usual format. Normally, I prefer regular merges, but then the commit messages should already follow the conventions.

@reckart reckart closed this as completed Aug 1, 2023
@reckart reckart added this to Kanban Aug 7, 2024
@reckart reckart moved this to 🍹 Done in Kanban Aug 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@torgeirl torgeirl

@reckart reckart

Labels
⭐️ Enhancement New feature or request
Projects
Kanban
Archived in project
Milestone
29.0
Development

No branches or pull requests
2 participants
@torgeirl @reckart