govuk_app_config 9.0.4 → 9.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 13c7b2080a8136a1799208e1bf685d420afbde632c35780c7b2cef063d7bad54
-  data.tar.gz: 757a148a0d5db0867f8ca54033cb243837c5dadb9427c5047c24db4bcc96a897
+  metadata.gz: a879f92fed2a4b6f098a3a1bbd367853413b3314c4d45f3d38802897cc9ecc68
+  data.tar.gz: 2dcd94fb037f6799cf9ce5229cb3ba6b7e391063091c3f3a65e4085d5eab9195
 SHA512:
-  metadata.gz: 7838253f4088c269f00f85ae005ee072ae3e08a935ba49f39e1dd0aa9b5c857de75472ebb73697b9ad49c31c61a62ad47556a3b75fe660edd2d818b0ad00cd65
-  data.tar.gz: 102c41532cfa9d12140d54c5ed44b8bc06eb0e331524d032652c4f8b9d68fb5b1adcfb1044e197135ed4c7b9161903219719f767327719a09ed862a1de9dbca7
+  metadata.gz: cab7cd78d7ffd83c19e37ad9bcd7865b3c1d7731baf1dd607556d3a758e99288b56186786fa20789011fc84f340e83caa7df6c1d9324c63d934f9b15733e6003
+  data.tar.gz: c547b53fca4fa5ad8f9f4444451dd8facc04bfcbe2312dfe5f591ac6236c6df90f9c49c7d0c3ab2a2cdcd25336b50ab3b23711cf137804286040e1b39b383d0d

data/.github/workflows/ci.yml

@@ -20,7 +20,7 @@ jobs:
         ruby: ['3.0', 3.1, 3.2]
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
       with:
         ref: ${{ inputs.ref || github.ref }}
     - uses: ruby/setup-ruby@v1

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+# 9.2.0
+
+* Default to Prometheus histograms, not summaries ([#318](https://github.com/alphagov/govuk_app_config/pull/318))
+
+# 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))
@@ -36,7 +46,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_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

@@ -1,3 +1,8 @@
+require "prometheus_exporter"
+require "prometheus_exporter/metric"
+require "prometheus_exporter/server"
+require "prometheus_exporter/middleware"
+
 module GovukPrometheusExporter
   def self.should_configure
     # Allow us to force the Prometheus Exporter for persistent Rake tasks...
@@ -11,12 +16,14 @@ module GovukPrometheusExporter
     end
   end
 
-  def self.configure
+  def self.configure(collectors: [], default_aggregation: PrometheusExporter::Metric::Histogram)
     return unless should_configure
 
-    require "prometheus_exporter"
-    require "prometheus_exporter/server"
-    require "prometheus_exporter/middleware"
+    # PrometheusExporter::Metric::Histogram.DEFAULT_BUCKETS tops out at 10 but
+    # we have a few controller actions which are slower than this, so we add a
+    # few extra buckets for slower requests
+    PrometheusExporter::Metric::Histogram.default_buckets = [0.005, 0.01, 0.025, 0.05, 0.1, 0.25, 0.5, 1, 2.5, 5, 10, 15, 25, 50].freeze
+    PrometheusExporter::Metric::Base.default_aggregation = default_aggregation
 
     if defined?(Sidekiq)
       Sidekiq.configure_server do |config|
@@ -37,6 +44,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 +57,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.4".freeze
+  VERSION = "9.2.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_app_config
 version: !ruby/object:Gem::Version
-  version: 9.0.4
+  version: 9.2.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-07-17 00:00:00.000000000 Z
+date: 2023-09-14 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.17
+rubygems_version: 3.4.19
 signing_key: 
 specification_version: 4
 summary: Base configuration for GOV.UK applications