govuk_app_config 2.5.2 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ac69416b5c20576e14410fd9f46d4b0992b13d823b64983f702ea0226dc40461
-  data.tar.gz: eb47104d4c81dc24f9c6919d650a21acc388986948819a971294a46594bc7ea1
+  metadata.gz: 42c7ced77e0c6592acdcbd98f489a2ed0ac60e7651aad238f4a4cdaa5f840952
+  data.tar.gz: 577864e98f093d456e3c3f911a8b67bd09dd7f25d9484da63fad8fb1473d19a9
 SHA512:
-  metadata.gz: 171a7f28f2d6daf265b3829a487d8b2b6a355915a535f9d3c728edce1f4d6bf89aa8163e11c37ce0c5976cd18f6c7ca9a5bddf3ca0bca4ccbdf3453d19470c9f
-  data.tar.gz: cc5a3382d6fdc1ce5ac1cd868c18fc6e7a77b68d8da04d32190c1317ec8def77969dab9528821cea8e5257676f7a15155fced541148dfd8c4dd850f342235005
+  metadata.gz: 1b19a36fda15dd6a28ca60ab34bfd2b7f1c5ff0c078912f79b8a7936afe69723f5ce8812b3dc1d61afd3eb194eb6de56ecc8e2ac1de5ed7d0d81a507eb457393
+  data.tar.gz: 0ada829997c9a0f659b08dd5095c57420d37d1f0c47e6ddfc82ecbf4ab28e32ccd5a512d9907512020431b5ad6a80374bf9be622d4455ffa5f4e603888869d3e

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 2.6.0
+
+* Ignore errors that occur in temporary environments (adds `active_sentry_environments` config) (https://github.com/alphagov/govuk_app_config/pull/168)
+
 # 2.5.2
 
 * Fix govuk_app_config in Ruby 2.7 environments by explicitly requiring the 'delegate' library (https://github.com/alphagov/govuk_app_config/pull/167)

data/README.md

@@ -51,7 +51,7 @@ If you include `govuk_app_config` in your `Gemfile`, Rails' autoloading mechanis
 Your app will have to have the following environment variables set:
 
 - `SENTRY_DSN` - the [Data Source Name (DSN)][dsn] for Sentry
-- `SENTRY_CURRENT_ENV` - production, staging or integration
+- `SENTRY_CURRENT_ENV` - e.g. "production". Make sure it is [configured to be active](#active-sentry-environments).
 - `GOVUK_STATSD_PREFIX` - a Statsd prefix like `govuk.apps.application-name.hostname`
 
 [dsn]: https://docs.sentry.io/quickstart/#about-the-dsn
@@ -79,6 +79,18 @@ GovukError.notify(
 )
 ```
 
+### Active Sentry environments
+
+GovukError will only send errors to Sentry if your `SENTRY_CURRENT_ENV` matches one of the 'active environments' in the [default configuration](https://github.com/alphagov/govuk_app_config/blob/master/lib/govuk_app_config/govuk_error/configure.rb). This is to prevent temporary test environments from flooding our Sentry account with errors.
+
+You can add your environment to the list of active Sentry environments like so:
+
+```ruby
+GovukError.configure do |config|
+  config.active_sentry_environments << "my-test-environment"
+end
+```
+
 ### Error configuration
 
 You can exclude certain errors from being reported using this:

data/lib/govuk_app_config/govuk_error/configuration.rb

@@ -3,19 +3,21 @@ require "govuk_app_config/govuk_error/govuk_data_sync"
 
 module GovukError
   class Configuration < SimpleDelegator
-    attr_reader :data_sync
-    attr_accessor :data_sync_excluded_exceptions
+    attr_reader :data_sync, :sentry_environment
+    attr_accessor :active_sentry_environments, :data_sync_excluded_exceptions
 
     def initialize(_raven_configuration)
       super
+      @sentry_environment = ENV["SENTRY_CURRENT_ENV"]
       @data_sync = GovukDataSync.new(ENV["GOVUK_DATA_SYNC_PERIOD"])
+      self.active_sentry_environments = []
       self.data_sync_excluded_exceptions = []
-      self.should_capture = ignore_excluded_exceptions_in_data_sync
+      self.should_capture = ignore_exceptions_based_on_env_and_data_sync
     end
 
     def should_capture=(closure)
       combined = lambda do |error_or_event|
-        (ignore_excluded_exceptions_in_data_sync.call(error_or_event) && closure.call(error_or_event))
+        (ignore_exceptions_based_on_env_and_data_sync.call(error_or_event) && closure.call(error_or_event))
       end
 
       super(combined)
@@ -23,6 +25,17 @@ module GovukError
 
   protected
 
+    def ignore_exceptions_based_on_env_and_data_sync
+      lambda do |error_or_event|
+        ignore_exceptions_if_not_in_active_sentry_env.call(error_or_event) &&
+          ignore_excluded_exceptions_in_data_sync.call(error_or_event)
+      end
+    end
+
+    def ignore_exceptions_if_not_in_active_sentry_env
+      ->(_error_or_event) { active_sentry_environments.include?(sentry_environment) }
+    end
+
     def ignore_excluded_exceptions_in_data_sync
       lambda { |error_or_event|
         data_sync_ignored_error = data_sync_excluded_exceptions.any? do |exception_to_ignore|

data/lib/govuk_app_config/govuk_error/configure.rb

@@ -7,6 +7,16 @@ GovukError.configure do |config|
 
   config.silence_ready = !Rails.env.production? if defined?(Rails)
 
+  # These are the environments (described by the `SENTRY_CURRENT_ENV`
+  # ENV variable) where we want to capture Sentry errors. If
+  # `SENTRY_CURRENT_ENV` isn't in this list, or isn't defined, then
+  # don't capture the error.
+  config.active_sentry_environments = %w[
+    integration-blue-aws
+    staging
+    production
+  ]
+
   config.excluded_exceptions = [
     # Default ActionDispatch rescue responses
     "ActionController::RoutingError",

data/lib/govuk_app_config/version.rb

@@ -1,3 +1,3 @@
 module GovukAppConfig
-  VERSION = "2.5.2".freeze
+  VERSION = "2.6.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_app_config
 version: !ruby/object:Gem::Version
-  version: 2.5.2
+  version: 2.6.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-10-22 00:00:00.000000000 Z
+date: 2020-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logstasher