govuk_app_config 4.12.0 → 4.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7906015f743285fadae37a3b4c0754fcb3ef5d6c6d59ff5b8f67d0f0b43ce970
-  data.tar.gz: da302c7be0424e4b4b476669468e8cbb1b6a3f5b38a017ddac4999ec14e0b622
+  metadata.gz: 19626391e07dadef9dce3abc326901bd86952b34532628b3ca0690d2cff2c314
+  data.tar.gz: 996320aff2dbeb2eae7d4fdd961461e33c39e2688ede77eaf7d5a92e5e6b9f84
 SHA512:
-  metadata.gz: fac4b8128b250e74a9e71f165e6ca5eb431bd3f364a2efea18ceb696ce55d9e772fe73a04020811d6cbdd68341bd711fe07bc99e3f37d4ad371ea57b5446360d
-  data.tar.gz: adef9932375e8c63f002a99ef759e1a301fdfbd1f4ad21a7b089fcda8b33acf83dcb4b6c658e5ccf9872171fac6cf58c2e0a0bbfd2a31dd2fbf7323669ea746b
+  metadata.gz: 880a5141ae35cbff8b463c49526fe9b41163fdf2c4a9fec6e1e6717a43f633f602e569449271be1609415b1d4f36b1c51782190ed40ced692ebd6daa722e7f73
+  data.tar.gz: 6b5e893f9abc787e20510f0e2a38565224df5902197f90a07cf861ca4fe7cc49ca306ea12e2440d858e888f1121d1c800767e2b774711749a8c7ea29a30955e4

data/.github/workflows/ci.yml

@@ -30,6 +30,6 @@ jobs:
     if: ${{ github.ref == 'refs/heads/main' }}
     permissions:
       contents: write
-    uses: alphagov/govuk-infrastructure/.github/workflows/publish-rubygem.yaml@main
+    uses: alphagov/govuk-infrastructure/.github/workflows/publish-rubygem.yml@main
     secrets:
       GEM_HOST_API_KEY: ${{ secrets.ALPHAGOV_RUBYGEMS_API_KEY }}

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 4.13.0
+
+- Flush log writes to stdout immediately so that structured (JSON) logs are not lost on crash or delayed indefinitely.
+
 # 4.12.0
 
 * Allow `https://img.youtube.com` as a CSP image source

data/lib/govuk_app_config/govuk_logging.rb

@@ -12,36 +12,37 @@ module GovukLogging
     # `Rails.logger` calls or 'puts' statements. However these are not in a
     # JSON format which causes problems for the log file parsers.
     #
-    # To resolve this we've directed stdout to stderr, to cover any Rails
+    # To resolve this we redirect stdout to stderr, to cover any Rails
     # writing. This frees up the normal stdout for the logstasher logs.
+    #
+    # We also disable buffering, so that logs aren't lost on crash or delayed
+    # indefinitely while troubleshooting.
 
     # rubocop:disable Style/GlobalVars
     $real_stdout = $stdout.clone
+    $real_stdout.sync = true
     $stdout.reopen($stderr)
+    $stdout.sync = true
     # rubocop:enable Style/GlobalVars
 
     # Send Rails' logs to STDERR because they're not JSON formatted.
     Rails.logger = ActiveSupport::TaggedLogging.new(Logger.new($stderr, level: Rails.logger.level))
 
-    # Custom that will be added to the Rails request logs
     LogStasher.add_custom_fields do |fields|
-      # Mirrors Nginx request logging, e.g GET /path/here HTTP/1.1
+      # Mirrors Nginx request logging, e.g. GET /path/here HTTP/1.1
       fields[:request] = "#{request.request_method} #{request.fullpath} #{request.headers['SERVER_PROTOCOL']}"
 
-      # Pass request Id to logging
       fields[:govuk_request_id] = request.headers["GOVUK-Request-Id"]
-
       fields[:varnish_id] = request.headers["X-Varnish"]
-
       fields[:govuk_app_config] = GovukAppConfig::VERSION
     end
 
     Rails.application.config.logstasher.enabled = true
 
-    # Log controller actions so that we can graph response times
+    # Log controller actions so that we can graph response times.
     Rails.application.config.logstasher.controller_enabled = true
 
-    # The other loggers are not that interesting in production
+    # The other loggers are not that interesting in production.
     Rails.application.config.logstasher.mailer_enabled = false
     Rails.application.config.logstasher.record_enabled = false
     Rails.application.config.logstasher.view_enabled = false
@@ -59,11 +60,9 @@ module GovukLogging
     if defined?(GdsApi::Base)
       GdsApi::Base.default_options ||= {}
 
-      # The GDS API Adapters gem logs JSON to describe the requests it
-      # makes and the responses it gets, so direct this to the
-      # logstasher logger
-      GdsApi::Base.default_options[:logger] =
-        Rails.application.config.logstasher.logger
+      # The gds-api-adapters gem logs JSON to describe the requests it makes and
+      # the responses it gets, so direct this to the logstasher logger.
+      GdsApi::Base.default_options[:logger] = Rails.application.config.logstasher.logger
     end
 
     RailsExt::ActionDispatch.monkey_patch_log_error if RailsExt::ActionDispatch.should_monkey_patch_log_error?

data/lib/govuk_app_config/version.rb

@@ -1,3 +1,3 @@
 module GovukAppConfig
-  VERSION = "4.12.0".freeze
+  VERSION = "4.13.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_app_config
 version: !ruby/object:Gem::Version
-  version: 4.12.0
+  version: 4.13.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-01-03 00:00:00.000000000 Z
+date: 2023-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logstasher
@@ -336,7 +336,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.2
+rubygems_version: 3.4.3
 signing_key: 
 specification_version: 4
 summary: Base configuration for GOV.UK applications