govuk_app_config 4.6.0 → 4.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eb1a459de6e7028eb9a6c9a4aa50d8dfcb50f51366e6dacb3a0f30b20fd86f2e
-  data.tar.gz: 3f80116c1a62f95049f70868608f1adb45ca854cf8d9944be5b5db4d61011e19
+  metadata.gz: cff338c8b3be717888644d1bd0b93df938c222250f13d25977c119fb567ef7fa
+  data.tar.gz: 69141cb68b950829dc7f7c714e426cf1d49ddb9cf679f4d839bb09ffe5283f95
 SHA512:
-  metadata.gz: d1f267792e9cda26e31e5582dcc4a16a2c57e671f1ce61ff11365c2836d4320d980aa3a9092caa121110f44c93411d8b8fbc3e59ff43a98962aa9a4cc9f68550
-  data.tar.gz: f68be43db0fde35ee87bca4542893781833ce0fb67056d3b5462ad474caff8cd316845a85b786e25f04efbd21b2177e2d77059711898101763708f5dcb8cb093
+  metadata.gz: b816ba7e9b980a4473f67f4ef5ecd59b61c26658ccef8bc6daab2d938fac015ea96e1f2edeee101246db31aedd7359ff1c4e5ff7fa533a16e3cbe5783ffc0466
+  data.tar.gz: 8bad47cadbba6ad9a5aa1622a30ccdc13d98ae9588605d18a919ce7f15a439eb541f21550f9d0462a276486f167d138a95abf6f73bb3564a2cc868677f99813c

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+# 4.6.3
+
+- Adds `region1.google-analytics.com` to the security policy for GA ([#250](https://github.com/alphagov/govuk_app_config/pull/250))
+
+# 4.6.2
+
+- Adds a new domain to the security policy for GA ([#248](https://https://github.com/alphagov/govuk_app_config/pull/248))
+
+# 4.6.1
+
+- Fixes warning message to refer to correct Sidekiq gem dependency name ([#243](https://github.com/alphagov/govuk_app_config/pull/243)).
+
 # 4.6.0
 
 - Add a warning for apps using GovukError with Sidekiq that don't have sentry-sidekiq installed ([#241](https://github.com/alphagov/govuk_app_config/pull/241)).

data/docs/healthchecks.md

@@ -1,47 +1,6 @@
 # Health Checks
 
-## Check interface
-
-A check is expected to be a class with the following methods:
-
-```ruby
-class CustomCheck
-  def name
-    :the_name_of_the_check
-  end
-
-  def status
-    if critical_condition?
-      :critical
-    elsif warning_condition?
-      :warning
-    else
-      :ok
-    end
-  end
-
-  # Optional
-  def message
-    "This is an optional custom message that will show up in the alert in Icinga"
-  end
-
-  # Optional
-  def details
-    {
-      extra: "This is an optional details hash",
-    }
-  end
-
-  # Optional
-  def enabled?
-    true # false if the check is not relevant at this time
-  end
-end
-```
-
-It is expected that these methods may cache their results for performance
-reasons, if a user wants to ensure they have the latest value they should
-create a new instance of the check first.
+GOV.UK apps often have special `/healthcheck` routes, which give an indication of whether the app is running and able to respond to requests. [Read about how health checks are used](https://docs.publishing.service.gov.uk/manual/alerts/app-healthcheck-not-ok.html).
 
 ## Including checks in your app
 
@@ -51,7 +10,7 @@ or custom checks you wish to perform.
 For Rails apps:
 
 ```ruby
-get "/healthcheck", to: GovukHealthcheck.rack_response(
+get "/healthcheck/ready", to: GovukHealthcheck.rack_response(
   GovukHealthcheck::SidekiqRedis,
   GovukHealthcheck::ActiveRecord,
   CustomCheck,
@@ -61,95 +20,64 @@ get "/healthcheck", to: GovukHealthcheck.rack_response(
 It also accepts objects, so classes can be initialized:
 
 ```ruby
-get "/healthcheck", to: GovukHealthcheck.rack_response(
+get "/healthcheck/ready", to: GovukHealthcheck.rack_response(
   InitializedCheck.new(:param),
 )
 ```
 
-## Built-in Checks
-
-A convention used when naming these classes is that it should end with `Check`
-if it must be subclassed to work, but a concrete class which works on its own
-doesn't need that suffix. You should aim to follow this convention in your own
-apps, ideally putting custom health checks into a `Healthcheck` module.
-
-### `RailsCache`
+Built-in checks you can use include:
 
-This checks that the Rails cache store, such as Memcached, is acessible by
-writing and reading back a cache entry called "healthcheck-cache".
+- `GovukHealthcheck::RailsCache` - checks that the Rails cache store, such as Memcached, is acessible by writing and reading back a cache entry called "healthcheck-cache".
 
-### `Mongoid`
+- `GovukHealthcheck::Redis` - checks that the app can connect to Redis by writing and reading back a cache entry called "healthcheck-cache".
 
-This checks that the app has a connection to its Mongo database via Mongoid.
+- `GovukHealthcheck::Mongoid` - checks that the app has a connection to its Mongo database via Mongoid.
 
-### `SidekiqRedis`
+- `GovukHealthcheck::SidekiqRedis` - checks that the app has a connection to Redis via Sidekiq.
 
-This checks that the app has a connection to Redis via Sidekiq.
+- `GovukHealthcheck::ActiveRecord` - checks that the app has a connection to the database via ActiveRecord.
 
-### `ActiveRecord`
+## Writing a custom healthcheck
 
-This checks that the app has a connection to the database via ActiveRecord.
-
-### `ThresholdCheck`
-
-This class is the basis for a check which compares a value with a warning or a
-critical threshold.
+A check is expected to be a class with the following methods:
 
 ```ruby
-class MyThresholdCheck < GovukHealthcheck::ThresholdCheck
+class CustomCheck
   def name
-    :my_threshold_check
-  end
-
-  def value
-    # get the value to be checked
-  end
-
-  def total
-    # (optional) get the total value to be included in the details as extra
-    # information
+    :the_name_of_the_check
   end
 
-  def warning_threshold
-    # if the value is above this threshold, its status is warning
+  def status
+    if critical_condition?
+      :critical
+    elsif warning_condition?
+      :warning
+    else
+      :ok
+    end
   end
 
-  def critical_threshold
-    # if the value is above this threshold, its status is critical
+  # Optional
+  def message
+    "This is an optional custom message that will show up in the alert in Icinga"
   end
-end
-```
 
-### `SidekiqQueueLatencyCheck`
-
-This class is the basis for a check which compares the Sidekiq queue latencies
-with warning or critical thresholds.
-
-```ruby
-class MySidekiqQueueLatencyCheck < GovukHealthcheck::SidekiqQueueLatencyCheck
-  def warning_threshold(queue:)
-    # the warning threshold for a particular queue
+  # Optional
+  def details
+    {
+      extra: "This is an optional details hash",
+    }
   end
 
-  def critical_threshold(queue:)
-    # the critical threshold for a particular queue
+  # Optional
+  def enabled?
+    true # false if the check is not relevant at this time
   end
 end
 ```
 
-### `SidekiqRetrySizeCheck`
-
-Similar to `SidekiqQueueSizeCheck`, this class is the basis for a check which
-compares the Sidekiq retry set size with a warning and critical threshold.
-
-```ruby
-class MySidekiqRetrySizeCheck < GovukHealthcheck::SidekiqRetrySizeCheck
-  def warning_threshold
-    # the warning threshold for the retry set
-  end
+It is expected that these methods may cache their results for performance
+reasons, if a user wants to ensure they have the latest value they should
+create a new instance of the check first.
 
-  def critical_threshold
-    # the critical threshold for the retry set
-  end
-end
-```
+Put custom health checks for your app into a `Healtcheck` module. Each custom check class should end with `Check`.

data/lib/govuk_app_config/govuk_content_security_policy.rb

@@ -18,7 +18,9 @@ module GovukContentSecurityPolicy
   GOOGLE_ANALYTICS_DOMAINS = %w[www.google-analytics.com
                                 ssl.google-analytics.com
                                 stats.g.doubleclick.net
-                                www.googletagmanager.com].freeze
+                                www.googletagmanager.com
+                                www.region1.google-analytics.com
+                                region1.google-analytics.com].freeze
 
   GOOGLE_STATIC_DOMAINS = %w[www.gstatic.com].freeze
 

data/lib/govuk_app_config/govuk_error.rb

@@ -35,7 +35,7 @@ module GovukError
     raise GovukError::AlreadyInitialised if is_configured?
 
     if defined?(Sidekiq) && !defined?(Sentry::Sidekiq)
-      warn "Warning: GovukError is not configured to track Sidekiq errors, install the sidekiq-sentry gem to track them."
+      warn "Warning: GovukError is not configured to track Sidekiq errors, install the sentry-sidekiq gem to track them."
     end
 
     Sentry.init do |sentry_config|

data/lib/govuk_app_config/version.rb

@@ -1,3 +1,3 @@
 module GovukAppConfig
-  VERSION = "4.6.0".freeze
+  VERSION = "4.6.3".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_app_config
 version: !ruby/object:Gem::Version
-  version: 4.6.0
+  version: 4.6.3
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-05-13 00:00:00.000000000 Z
+date: 2022-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logstasher
@@ -296,7 +296,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.13
+rubygems_version: 3.3.16
 signing_key: 
 specification_version: 4
 summary: Base configuration for GOV.UK applications