govuk_app_config 9.0.3 → 9.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2e87fe7b5d3d3c22c7bce9dd0b18ddc1d949741eadb620832752723d7b36dc7c
-  data.tar.gz: '06510976f0ad19f829f5fb5bfb9ad178d48f66eb1ca063f3cad6efffade10a7e'
+  metadata.gz: b294855ddebc514295005646929b0097f632fee29abca5e5bcfcf8762fa6a074
+  data.tar.gz: 5001db9a6a2ea18b55337fa58ffc43698949201644f0274c337468c0228b7220
 SHA512:
-  metadata.gz: 11b27df9aa24a5a0751a75150b4227e7acfd542168766c40ffbbce505502e00db02a9820eb22309b0296a822e6a571f28704d0ac9ede717ddb5640ce89151c4a
-  data.tar.gz: 7321f213d4b9d0356404a03bedd949596c5e8f9e59d1b0f80cc10e1e1e120db162385c6df3d1afa073b24075102f1e84d9a9a66ad37adb743ae54302f3ce1a0f
+  metadata.gz: 5f022124d42f44d65e8b34f47451b2bed770340690529983d9277cf2d5f747d85400b7061048c64e0e9c1b5c040c975b0421bb1143bca052736ffa4e75e6557f
+  data.tar.gz: 80af52848ba6276c0103bb6f7b32830b5cd4ca8fda42b2e4cb682dbce4ea958fd761c394b5864f3ea450f19e85197ccd0fadbd18c921cfee8783bb196a12a650

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+# 9.1.0
+
+* GovukAppConfig silences OpenTelemetry log output when running a rake task ([#311](https://github.com/alphagov/govuk_app_config/pull/311))
+* Update warning message for Prometheus metric server address already in use.
+* Add ability to support custom collectors in the Prometheus exporter.
+
+# 9.0.4
+
+* Fix an issue with Rails.logger being not an instance of ActiveSupport::Logger. Rails expects Rails.logger to have methods that Ruby STD Logger does not provide. e.g. `silence()` ([#309](https://github.com/alphagov/govuk_app_config/pull/309))
+
 # 9.0.3
 
 * When error is reported by Rails logger, the field is now logged as "error_message" in order to avoid overwriting the "message" field.
@@ -32,7 +42,7 @@
 
 # 8.0.1
 
-* Change the "source" field in Rails logs from logstasher from string representing IP host address to an empty object. 
+* Change the "source" field in Rails logs from logstasher from string representing IP host address to an empty object.
 
 # 8.0.0
 

data/govuk_app_config.gemspec

@@ -21,8 +21,8 @@ Gem::Specification.new do |spec|
   spec.require_paths = %w[lib]
 
   spec.add_dependency "logstasher", "~> 2.1"
-  spec.add_dependency "opentelemetry-exporter-otlp", "~> 0.25.0"
-  spec.add_dependency "opentelemetry-instrumentation-all", "~> 0.39.1"
+  spec.add_dependency "opentelemetry-exporter-otlp", ">= 0.25", "< 0.27"
+  spec.add_dependency "opentelemetry-instrumentation-all", ">= 0.39.1", "< 0.41.0"
   spec.add_dependency "opentelemetry-sdk", "~> 1.2"
   spec.add_dependency "plek", ">= 4", "< 6"
   spec.add_dependency "prometheus_exporter", "~> 2.0"
@@ -39,6 +39,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.10"
   spec.add_development_dependency "rspec-its", "~> 1.3"
-  spec.add_development_dependency "rubocop-govuk", "4.11.0"
+  spec.add_development_dependency "rubocop-govuk", "4.12.0"
   spec.add_development_dependency "webmock"
 end

data/lib/govuk_app_config/govuk_json_logging.rb

@@ -8,24 +8,21 @@ module GovukJsonLogging
     # indefinitely while troubleshooting.
     $stdout.sync = true
 
-    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],
-        }
+    Rails.logger = ActiveSupport::Logger.new($stdout, level: Rails.logger.level)
+    Rails.logger.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
+      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"
-      },
-    )
+      "#{hash.to_json}\n"
+    }
 
     LogStasher.add_custom_fields do |fields|
       # Mirrors Nginx request logging, e.g. GET /path/here HTTP/1.1

data/lib/govuk_app_config/govuk_open_telemetry.rb

@@ -13,6 +13,11 @@ module GovukOpenTelemetry
     OpenTelemetry::SDK.configure do |config|
       config.service_name = service_name
       config.use_all # enables all instrumentation!
+      config.logger = Logger.new(File::NULL) if in_rake_task?
     end
   end
+
+  def self.in_rake_task?
+    Rails.const_defined?(:Rake) && Rake.application.top_level_tasks.any?
+  end
 end

data/lib/govuk_app_config/govuk_prometheus_exporter.rb

@@ -11,7 +11,7 @@ module GovukPrometheusExporter
     end
   end
 
-  def self.configure
+  def self.configure(collectors: [])
     return unless should_configure
 
     require "prometheus_exporter"
@@ -37,6 +37,9 @@ module GovukPrometheusExporter
 
     begin
       server = PrometheusExporter::Server::WebServer.new bind: "0.0.0.0", port: 9394
+
+      collectors.each { |collector| server.collector.register_collector(collector.new) }
+
       server.start
 
       if defined?(Rails)
@@ -47,7 +50,7 @@ module GovukPrometheusExporter
         Sinatra.use PrometheusExporter::Middleware
       end
     rescue Errno::EADDRINUSE
-      warn "Warning: Could not connect to Prometheus Server"
+      warn "Could not start Prometheus metrics server as address already in use."
     end
   end
 end

data/lib/govuk_app_config/version.rb

@@ -1,3 +1,3 @@
 module GovukAppConfig
-  VERSION = "9.0.3".freeze
+  VERSION = "9.1.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_app_config
 version: !ruby/object:Gem::Version
-  version: 9.0.3
+  version: 9.1.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-07-14 00:00:00.000000000 Z
+date: 2023-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logstasher
@@ -28,30 +28,42 @@ dependencies:
   name: opentelemetry-exporter-otlp
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.25'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 0.25.0
+        version: '0.27'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.25'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 0.25.0
+        version: '0.27'
 - !ruby/object:Gem::Dependency
   name: opentelemetry-instrumentation-all
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.39.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 0.41.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.39.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 0.41.0
 - !ruby/object:Gem::Dependency
   name: opentelemetry-sdk
   requirement: !ruby/object:Gem::Requirement
@@ -280,14 +292,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.11.0
+        version: 4.12.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.11.0
+        version: 4.12.0
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -363,7 +375,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.16
+rubygems_version: 3.4.19
 signing_key: 
 specification_version: 4
 summary: Base configuration for GOV.UK applications