govuk_app_config 8.1.1 → 9.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: df59068ad0c6277dddb68a7c934e9557fc3e59db4a72022503c29942ca18fe1a
-  data.tar.gz: 691a810bf1793a069121d37a343c0fb955b7034bdf55166377ebe5454b60af6e
+  metadata.gz: fc7d94f65aa2c81b7df62708d405601aeef8ca8dfe8455d59da46843c75eaf1e
+  data.tar.gz: 183aecdff3c9a1f8fd0f0ee3ad20bdece7a195d8005592d02b3eac1f4ae8770d
 SHA512:
-  metadata.gz: a0dba812e73f859cb79e379f80f05322836c402043849070539d75fbdc489e8e83270ae26adbe816b58eae7a2789ac83cf35581ef94b586bba53e6feb86a6f51
-  data.tar.gz: 9e4840809cdb83747be969f86c78de547d79c635e9e4eb83635e627f607b509b52689a2db66faf85ab11af99327877f9a45597465c8a50d629c2440b8fcc394d
+  metadata.gz: 82c3121d70042f7333b8c81acae37a2466bb2e04a6142a75eeaecdc2ccc345dd35886350da7b6657e0bc9550eeaf0d09aa43326a3327c4ffdcac5d6536784c28
+  data.tar.gz: 4dd45d0cebff36feda7e21a5032baa716d7147cb03b7388674e9bab8421a5f04af1089bb472f82b7267a60dc014a8085ea14bb3c7ef415ada8f674a8bbe1b3fb

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+# 9.0.1
+
+* Rename the "error" field in Rails logs from logstasher to "message" as error is supposed to be an object.
+
+# 9.0.0
+
+* BREAKING: JSON logs are no longer configured automatically for production Rails apps and are turned on with the GOVUK_RAILS_JSON_LOGGING environment variable ([#302](https://github.com/alphagov/govuk_app_config/pull/302))
+* Add govuk_request_id to JSON logging for apps with gds-api-adapters ([#300](https://github.com/alphagov/govuk_app_config/pull/300))
+* BREAKING: Remove $stdout, $stderr and $real_stdout redirections ([#300](https://github.com/alphagov/govuk_app_config/pull/300))
+* BREAKING: Change error log behaviour from logging JSON to full string ([#300](https://github.com/alphagov/govuk_app_config/pull/300))
+* Remove monkeypatch for errors ([#300](https://github.com/alphagov/govuk_app_config/pull/300))
+
 # 8.1.1
 
 * Fix prometheus_exporter to method patching compatible with open telemetry.

data/README.md

@@ -142,8 +142,12 @@ check docs](docs/healthchecks.md) for more information on how to use it.
 
 ## Rails logging
 
-In Rails applications, the application will be configured to send JSON-formatted
-logs to `STDOUT` and unstructured logs to `STDERR`.
+To enable production-like logging, an env variable `GOVUK_RAILS_JSON_LOGGING`
+is set in the `govuk-helm-charts` and then checked in `railtie.rb`. This will
+allow JSON format logs and `Govuk-Request-Id` to be visible.
+
+For development logs, in order to see the production style logs, developers should
+set `GOVUK_RAILS_JSON_LOGGING`in `govuk-docker` -> `docker-compose` files.
 
 
 ## Content Security Policy generation

data/lib/govuk_app_config/{govuk_logging.rb → govuk_json_logging.rb}

@@ -1,32 +1,31 @@
+require "json"
 require "logstasher"
 require "action_controller"
-require_relative "rails_ext/action_dispatch/debug_exceptions"
 
-module GovukLogging
+module GovukJsonLogging
   def self.configure
-    # GOV.UK Rails applications are expected to output JSON to stdout which is
-    # then indexed in a Kibana instance. These log outputs are created by the
-    # logstasher gem.
-    #
-    # Rails applications will typically write other things to stdout such as
-    # `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 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
+    # We 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))
+    Rails.logger = Logger.new(
+      $stdout,
+      level: Rails.logger.level,
+      formatter: proc { |severity, datetime, _progname, msg|
+        hash = {
+          "@timestamp": datetime.utc.iso8601(3),
+          message: msg,
+          level: severity,
+          tags: %w[rails],
+        }
+
+        if defined?(GdsApi::GovukHeaders) && !GdsApi::GovukHeaders.headers[:govuk_request_id].nil?
+          hash[:govuk_request_id] = GdsApi::GovukHeaders.headers[:govuk_request_id]
+        end
+
+        "#{hash.to_json}\n"
+      },
+    )
 
     LogStasher.add_custom_fields do |fields|
       # Mirrors Nginx request logging, e.g. GET /path/here HTTP/1.1
@@ -51,9 +50,14 @@ module GovukLogging
     # Elasticsearch index expect source to be an object and logstash defaults
     # source to be the host IP address causing logs to be dropped.
     Rails.application.config.logstasher.source = {}
+    # Elasticsearch index expect error to be an object and logstash defaults
+    # error to be a string causing logs to be dropped.
+    Rails.application.config.logstasher.field_renaming = {
+      error: :message,
+    }
 
     Rails.application.config.logstasher.logger = Logger.new(
-      $real_stdout, # rubocop:disable Style/GlobalVars
+      $stdout,
       level: Rails.logger.level,
       formatter: proc { |_severity, _datetime, _progname, msg|
         "#{msg.is_a?(String) ? msg : msg.inspect}\n"
@@ -68,7 +72,5 @@ module GovukLogging
       # 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?
   end
 end

data/lib/govuk_app_config/railtie.rb

@@ -13,7 +13,7 @@ module GovukAppConfig
     end
 
     config.before_initialize do
-      GovukLogging.configure if Rails.env.production?
+      GovukJsonLogging.configure if ENV["GOVUK_RAILS_JSON_LOGGING"]
     end
 
     config.after_initialize do

data/lib/govuk_app_config/version.rb

@@ -1,3 +1,3 @@
 module GovukAppConfig
-  VERSION = "8.1.1".freeze
+  VERSION = "9.0.1".freeze
 end

data/lib/govuk_app_config.rb

@@ -7,7 +7,7 @@ require "govuk_app_config/govuk_open_telemetry"
 require "govuk_app_config/govuk_prometheus_exporter"
 
 if defined?(Rails)
-  require "govuk_app_config/govuk_logging"
+  require "govuk_app_config/govuk_json_logging"
   require "govuk_app_config/govuk_content_security_policy"
   require "govuk_app_config/railtie"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_app_config
 version: !ruby/object:Gem::Version
-  version: 8.1.1
+  version: 9.0.1
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-07-04 00:00:00.000000000 Z
+date: 2023-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logstasher
@@ -336,13 +336,12 @@ files:
 - lib/govuk_app_config/govuk_healthcheck/rails_cache.rb
 - lib/govuk_app_config/govuk_healthcheck/redis.rb
 - lib/govuk_app_config/govuk_healthcheck/sidekiq_redis.rb
-- lib/govuk_app_config/govuk_logging.rb
+- lib/govuk_app_config/govuk_json_logging.rb
 - lib/govuk_app_config/govuk_open_telemetry.rb
 - lib/govuk_app_config/govuk_prometheus_exporter.rb
 - lib/govuk_app_config/govuk_proxy/static_proxy.rb
 - lib/govuk_app_config/govuk_puma.rb
 - lib/govuk_app_config/govuk_statsd.rb
-- lib/govuk_app_config/rails_ext/action_dispatch/debug_exceptions.rb
 - lib/govuk_app_config/railtie.rb
 - lib/govuk_app_config/version.rb
 homepage: https://github.com/alphagov/govuk_app_config

data/lib/govuk_app_config/rails_ext/action_dispatch/debug_exceptions.rb

@@ -1,52 +0,0 @@
-require "action_dispatch/middleware/debug_exceptions"
-
-module GovukLogging
-  module RailsExt
-    module ActionDispatch
-      def self.should_monkey_patch_log_error?(clazz = ::ActionDispatch::DebugExceptions)
-        empty_instance = clazz.new nil
-        target_method = empty_instance.method :log_error
-
-        expected_parameters = [%i[req request], %i[req wrapper]]
-        actual_parameters = target_method.parameters
-
-        should_monkey_patch = actual_parameters == expected_parameters
-
-        unless should_monkey_patch
-          Rails.logger.warn "Refused to monkey patch ::ActionDispatch::DebugExceptions#log_error - " \
-            "signatures do not match. " \
-            "Expected #{expected_parameters}, but got #{actual_parameters}"
-        end
-
-        should_monkey_patch
-      rescue StandardError => e
-        Rails.logger.warn "Failed to detect whether to monkey patch " \
-          "::ActionDispatch::DebugExceptions#log_error - #{e.inspect}"
-        false
-      end
-
-      def self.monkey_patch_log_error(clazz = ::ActionDispatch::DebugExceptions)
-        clazz.class_eval do
-          private
-
-          def log_error(request, wrapper)
-            logger = logger(request)
-
-            return unless logger
-
-            exception = wrapper.exception
-
-            trace = wrapper.application_trace
-            trace = wrapper.framework_trace if trace.empty?
-
-            logger.fatal({
-              exception_class: exception.class.to_s,
-              exception_message: exception.message,
-              stacktrace: trace,
-            }.to_json)
-          end
-        end
-      end
-    end
-  end
-end