Allow certain paths or endpoints to be excluded

README.md

@@ -231,6 +231,17 @@ user identifier proc can be defined in `config/initializers/dfe_analytics.rb`:
 DfE::Analytics.config.user_identifier = proc { |user| user&.uid }
 ```
 
+You can specify paths that should be excluded from logging using the skip_web_requests configuration option. This is useful for endpoints like health checks that are frequently hit and do not need to be logged.
+
+```ruby
+DfE::Analytics.configure do |config|
+  # other configurations...
+
+  # Specify paths to skip
+  config.skip_web_requests = ['/healthcheck', %r{^/admin}, %r{/api/v1/status}]
+end
+```
+
 ### 6. Import existing data
 
 To load the current contents of your database into BigQuery, run

lib/dfe/analytics.rb

@@ -57,6 +57,7 @@ def self.config
         azure_scope
         gcp_scope
         google_cloud_credentials
+        excluded_paths
       ]
 
       @config ||= Struct.new(*configurables).new
@@ -82,6 +83,7 @@ def self.configure
       config.rack_page_cached                 ||= proc { |_rack_env| false }
       config.bigquery_maintenance_window      ||= ENV.fetch('BIGQUERY_MAINTENANCE_WINDOW', nil)
       config.azure_federated_auth             ||= false
+      config.excluded_paths                   ||= []
 
       return unless config.azure_federated_auth
 

lib/dfe/analytics/requests.rb

@@ -11,6 +11,7 @@ module Requests
 
       def trigger_request_event
         return unless DfE::Analytics.enabled?
+        return if path_excluded?
 
         request_event = DfE::Analytics::Event.new
                                              .with_type('web_request')
@@ -23,6 +24,19 @@ def trigger_request_event
 
         DfE::Analytics::SendEvents.do([request_event.as_json])
       end
+
+      private
+
+      def path_excluded?
+        excluded_path = DfE::Analytics.config.excluded_paths
+        excluded_path.any? do |path|
+          if path.is_a?(Regexp)
+            path.match?(request.fullpath)
+          else
+            request.fullpath.start_with?(path)
+          end
+        end
+      end
     end
   end
 end

spec/dfe/analytics/requests_spec.rb

@@ -36,6 +36,11 @@ def index
     Rails.application.routes.draw do
       get '/example/path' => 'test#index'
       get '/unauthenticated_example' => 'test_unauthenticated#index'
+      get '/healthcheck' => 'test#index'
+      get '/regex_path/test' => 'test#index'
+      get '/some/path/with/regex_path' => 'test#index'
+      get '/another/path/to/regex_path' => 'test#index'
+      get '/included/path' => 'test#index'
     end
 
     ex.run
@@ -63,6 +68,12 @@ def index
       user_id: 1 }
   end
 
+  before do
+    DfE::Analytics.configure do |config|
+      config.excluded_paths = ['/healthcheck', %r{^/regex_path/.*$}, /regex_path$/]
+    end
+  end
+
   it 'sends request data to BigQuery' do
     request = stub_analytics_event_submission
     DfE::Analytics::Testing.webmock! do
@@ -156,4 +167,54 @@ def index
       end).to have_been_made
     end
   end
+
+  context 'when request path is in the skip list' do
+    it 'does not send healthcheck request data to BigQuery' do
+      request = stub_analytics_event_submission
+
+      DfE::Analytics::Testing.webmock! do
+        perform_enqueued_jobs do
+          get('/healthcheck')
+        end
+      end
+
+      expect(request).not_to have_been_made
+    end
+
+    it 'does not send regex_path/test request data to BigQuery' do
+      request = stub_analytics_event_submission
+
+      DfE::Analytics::Testing.webmock! do
+        perform_enqueued_jobs do
+          get('/regex_path/test')
+        end
+      end
+
+      expect(request).not_to have_been_made
+    end
+
+    it 'does not send some/path/with/regex_path request data to BigQuery' do
+      request = stub_analytics_event_submission
+
+      DfE::Analytics::Testing.webmock! do
+        perform_enqueued_jobs do
+          get('/some/path/with/regex_path')
+        end
+      end
+
+      expect(request).not_to have_been_made
+    end
+
+    it 'does not send another/path/to/regex_path request data to BigQuery' do
+      request = stub_analytics_event_submission
+
+      DfE::Analytics::Testing.webmock! do
+        perform_enqueued_jobs do
+          get('/another/path/to/regex_path')
+        end
+      end
+
+      expect(request).not_to have_been_made
+    end
+  end
 end