Add Sentry for error tracking

Author: fbacall

Gemfile

@@ -50,6 +50,9 @@ gem 'reverse_markdown'
 gem 'rss'
 gem 'sass-rails'
 gem 'sassc-rails'
+gem 'sentry-rails'
+gem 'sentry-ruby'
+gem 'sentry-sidekiq'
 gem 'sidekiq'
 gem 'sidekiq-status'
 gem 'simple_form'

Gemfile.lock

@@ -614,6 +614,14 @@ GEM
       sprockets-rails
       tilt
     scanf (1.0.0)
+    sentry-rails (5.11.0)
+      railties (>= 5.0)
+      sentry-ruby (~> 5.11.0)
+    sentry-ruby (5.11.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+    sentry-sidekiq (5.11.0)
+      sentry-ruby (~> 5.11.0)
+      sidekiq (>= 3.0)
     shacl (0.3.0)
       json-ld (~> 3.2)
       rdf (~> 3.2, >= 3.2.8)
@@ -817,6 +825,9 @@ DEPENDENCIES
   rubocop
   sass-rails
   sassc-rails
+  sentry-rails
+  sentry-ruby
+  sentry-sidekiq
   sidekiq
   sidekiq-status
   simple_form

app/controllers/application_controller.rb

@@ -107,6 +107,9 @@ def user_not_authorized(exception)
 
   def set_current_user
     User.current_user = current_user
+    if TeSS::Config.sentry_enabled?
+      Sentry.set_user(current_user ? { id: current_user.id, username: current_user.username } : {})
+    end
   end
 
   protected

config/application.rb

@@ -94,6 +94,14 @@ def analytics_enabled
     def map_enabled
       !feature['disabled'].include?('events_map') && Rails.application.secrets.google_maps_api_key.present?
     end
+
+    def _sentry_dsn
+      ENV.fetch('SENTRY_DSN') { sentry_dsn }
+    end
+
+    def sentry_enabled?
+      _sentry_dsn.present? && Rails.env.production?
+    end
   end
 
   Config = TessConfig.new(tess_config)

config/initializers/sentry.rb

@@ -0,0 +1,20 @@
+Rails.configuration.after_initialize do
+  if TeSS::Config.sentry_enabled?
+    Sentry.init do |config|
+      config.dsn = TeSS::Config._sentry_dsn
+      config.breadcrumbs_logger = [:active_support_logger, :http_logger]
+      config.excluded_exceptions += ['ActionController::RoutingError', 'ActiveRecord::RecordNotFound']
+      filter = ActiveSupport::ParameterFilter.new(Rails.application.config.filter_parameters)
+      config.before_send = lambda do |event, hint|
+        filter.filter(event.to_hash)
+      end
+      config.release = `git rev-parse --short HEAD`&.chomp("\n")
+    end
+    Sentry.configure_scope do |scope|
+      scope.set_context('app', {
+        app_name: TeSS::Config.site['title_short'],
+        app_version: APP_VERSION
+      })
+    end
+  end
+end

config/tess.example.yml

@@ -15,6 +15,7 @@ default: &default
   require_cookie_consent: true
   blocked_domains:
     - !ruby/regexp '/bad-domain\.example/'
+  sentry_dsn:
   site:
     title: 'TeSS (Training eSupport System)'
     title_short: TeSS