<!-- triage-serverless v3 PLEASE DO NOT REMOVE THIS SECTION --> *This page may contain information related to upcoming products, features and functionality. It is important to note that the information presented is for informational purposes only, so please do not rely on the information for purchasing or planning purposes. Just like with all projects, the items mentioned on the page are subject to change or delay, and the development, release, and timing of any products, features, or functionality remain at the sole discretion of GitLab Inc.* <!-- triage-serverless v3 PLEASE DO NOT REMOVE THIS SECTION --> ### Release notes Like Sentry backend but inside GitLab #### Key points: 1. Error tracking will work out of the box. No need for Sentry self-hosted instance. The necessary API will be inside GitLab 2. Errors will be stored in GitLab database. No need to query Sentry backend api for data. 3. GitLab error tracking API will be compatible with sentry-sdk. So users can switch between Sentry backend and GitLab backend without adjustments to code. #### Re-using existing functionality We already have models and UI for rendering Sentry errors in GitLab UI. We should reuse that code for presenting and rendering errors in UI. #### Limitations and expectations Sentry is a big and well developed product. The goal here is to provide an easy, out-of-the-box experience for users who are not interested in running a separate Sentry instance. ### TODO: For minimal product we need the following steps: ##### Core functionality - [x] Add Rails modes with database migrations (so we have place to store errors) => https://gitlab.com/gitlab-org/gitlab/-/merge_requests/64712, https://gitlab.com/gitlab-org/gitlab/-/merge_requests/65753 - [x] Add collector (API to store errors and events from sentry client into database) => https://gitlab.com/gitlab-org/gitlab/-/merge_requests/65767 - [x] Add authentication for collector => https://gitlab.com/gitlab-org/gitlab/-/merge_requests/66466 - [x] Expose errors and events to existing UI => https://gitlab.com/gitlab-org/gitlab/-/merge_requests/66847 - [x] Add `integrated` setting to project error tracking API so we can enable the feature before introducing UI for that => https://gitlab.com/gitlab-org/gitlab/-/merge_requests/68260 - [x] API to generate collector client key and give user a DSN => https://gitlab.com/gitlab-org/gitlab/-/merge_requests/68384 - [x] Handle feature flag https://gitlab.com/gitlab-org/gitlab/-/issues/335846 - [x] Add documentation => https://gitlab.com/gitlab-org/gitlab/-/merge_requests/67755 - [x] Test with Rails project => https://gitlab.com/gitlab-org/creator-pairing/integrated-error-tracking - [x] Test with nodejs project => https://gitlab.com/gitlab-org/creator-pairing/express-js-app/ - [x] Allow enable feature via UI - [x] Add `integrated` setting to project error tracking UI => https://gitlab.com/gitlab-org/gitlab/-/merge_requests/66845 - [x] Update docs with enable error tracking via UI. => https://gitlab.com/gitlab-org/gitlab/-/merge_requests/70525 - [x] Create and show client key DSN in UI => https://gitlab.com/gitlab-org/gitlab/-/merge_requests/70791 - [x] Update docs with DSN in UI => https://gitlab.com/gitlab-org/gitlab/-/merge_requests/70803 - [x] Add full support for UI when integrated error tracking is used - [x] Filter, sort => https://gitlab.com/gitlab-org/gitlab/-/merge_requests/68777 - [x] Pagination => https://gitlab.com/gitlab-org/gitlab/-/merge_requests/70945 - [x] Enable feature by default => https://gitlab.com/gitlab-org/gitlab/-/merge_requests/71088 ##### Important improvements - [x] Cleanup `app/validators/json_schemas/error_tracking_event_payload.json` - [x] Add `integrated` setting check in collector => https://gitlab.com/gitlab-org/gitlab/-/merge_requests/67756 - [x] Add index on `error_tracking_errors.status` column, => https://gitlab.com/gitlab-org/gitlab/-/merge_requests/68777 - [x] Refactor error tracking API: move under namespace => https://gitlab.com/gitlab-org/gitlab/-/merge_requests/70939 - [x] Generate DSN based on client key => https://gitlab.com/gitlab-org/gitlab/-/merge_requests/68487 - [x] `last seen at` is not updated on error tracking list UI => https://gitlab.com/gitlab-org/gitlab/-/merge_requests/68952 - [x] Expose `sentry_dsn` via API => https://gitlab.com/gitlab-org/gitlab/-/merge_requests/68767 - [x] Fix error mulpliying when object id used in error description. Ex: `ProjectControllerx0fd432` => https://gitlab.com/gitlab-org/gitlab/-/merge_requests/68952 - [x] Make `Event#actor` more flexible. Ex. in `sentry-clj` the payload does not have such value. => https://gitlab.com/gitlab-org/gitlab/-/commit/b79a4e9bad2029a2ca4b0d12ae060737303d1ae8 - [x] Add support for `/store` collector endpoint => https://gitlab.com/gitlab-org/gitlab/-/merge_requests/69660 - [x] Show first seen and last seen info on error details => https://gitlab.com/gitlab-org/gitlab/-/merge_requests/71405 - [x] Add gzip compression support to `/store` method (needed for python and php support) => https://gitlab.com/gitlab-org/gitlab/-/merge_requests/71949 - [x] Fix 500 errors on invalid payload => https://gitlab.com/gitlab-org/gitlab/-/merge_requests/73557 - [ ] Support major Sentry SDK => https://gitlab.com/gitlab-org/gitlab/-/issues/340178 - [ ] Remove unused data from event payload. - [ ] Optimise stacktrace storing (maybe keep N last stacktraces per error) ##### Good to have improvements - [ ] Create fixtures files from different SDK and add them to spec - [ ] Add ability to create and delete error tracking client keys via UI - [ ] Save release info into event https://gitlab.com/gitlab-org/gitlab/-/merge_requests/69378 - [ ] Refactor project error tracking settings. Move everyting related to sentry_client into separate class - [ ] Email notification on new errors would be great - [ ] Rename SentryRequestParser to SentryEnvelopeParser https://gitlab.com/gitlab-org/gitlab/-/merge_requests/73744 - [ ] Add 24h stats to error - [ ] UI search does not work yet - [ ] Refactor collector service for better error handling https://gitlab.com/gitlab-org/gitlab/-/issues/344789 - [ ] Add support for sentry message. See `capture_message` from https://docs.sentry.io/platforms/ruby/usage/ - [ ] Allow download raw payload - [ ] Show more data in UI like `level`, `environment` etc ### End result After this issue is finished, user should be able to: 1. Enable integrated error tracking in GitLab UI 1. Receive a DSN from GitLab to use with Sentry SDK 1. Have Gitlab receive and save errors from Sentry SDK 1. Browse saved errors at project `/error_tracking` page ### Timeline - 14.3 Error tracking for Ruby SDK. Feature enabled by API - 14.4 Error tracking for Ruby SDK. Feature can be enabled in UI. GitLab backend is default. - 14.5 More SDK support => https://gitlab.com/gitlab-org/gitlab/-/issues/340178 - 14.6 Enabled by default for new projects