govuk_app_config 9.1.0 → 9.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b294855ddebc514295005646929b0097f632fee29abca5e5bcfcf8762fa6a074
-  data.tar.gz: 5001db9a6a2ea18b55337fa58ffc43698949201644f0274c337468c0228b7220
+  metadata.gz: 91aa874fe05081ba23cdf6d37cb9046b357fe1d20d79ec3c336877a3e75e2edc
+  data.tar.gz: eff73c0ebf947cd2adb0c8bd37599c5bae85497db9c3942621b2178465c586de
 SHA512:
-  metadata.gz: 5f022124d42f44d65e8b34f47451b2bed770340690529983d9277cf2d5f747d85400b7061048c64e0e9c1b5c040c975b0421bb1143bca052736ffa4e75e6557f
-  data.tar.gz: 80af52848ba6276c0103bb6f7b32830b5cd4ca8fda42b2e4cb682dbce4ea958fd761c394b5864f3ea450f19e85197ccd0fadbd18c921cfee8783bb196a12a650
+  metadata.gz: fcf73e2e1bcf53b466918e89fd23b2083e02dc7d9e8dd4333021db40f46a3d9774d52079c443d204bc00b0d09547e5be83c0f824611f532fc90a786f07cfe8f4
+  data.tar.gz: b0ffcd15e23557623c9749eb925ec52ffa867558769da1cb13cd9d52e275e1201576c5c1d040ce9d90b80af5a7848452bd43ffe8d59d328bfdbed4029781f4b4

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,11 @@
+# 9.3.0
+
+* Get prometheus labels from controller, not params ([#320](https://github.com/alphagov/govuk_app_config/pull/320))
+
+# 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))

data/govuk_app_config.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "logstasher", "~> 2.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-instrumentation-all", ">= 0.39.1", "< 0.51.0"
   spec.add_dependency "opentelemetry-sdk", "~> 1.2"
   spec.add_dependency "plek", ">= 4", "< 6"
   spec.add_dependency "prometheus_exporter", "~> 2.0"

data/lib/govuk_app_config/govuk_prometheus_exporter.rb

@@ -1,4 +1,46 @@
+require "prometheus_exporter"
+require "prometheus_exporter/metric"
+require "prometheus_exporter/server"
+require "prometheus_exporter/middleware"
+
 module GovukPrometheusExporter
+  #
+  # See https://github.com/discourse/prometheus_exporter/pull/293
+  #
+  # RailsMiddleware can be removed and replaced with the default middleware if
+  # that PR is merged / released
+  #
+  class RailsMiddleware < PrometheusExporter::Middleware
+    def default_labels(env, _result)
+      controller_instance = env["action_controller.instance"]
+      action = controller = nil
+      if controller_instance
+        action = controller_instance.action_name
+        controller = controller_instance.controller_name
+      elsif (cors = env["rack.cors"]) && cors.respond_to?(:preflight?) && cors.preflight?
+        # if the Rack CORS Middleware identifies the request as a preflight request,
+        # the stack doesn't get to the point where controllers/actions are defined
+        action = "preflight"
+        controller = "preflight"
+      end
+      {
+        action: action || "other",
+        controller: controller || "other",
+      }
+    end
+  end
+
+  class SinatraMiddleware < PrometheusExporter::Middleware
+    def default_labels(_env, _result)
+      # The default prometheus exporter middleware uses the controller and
+      # action as labels.  These aren't meaningful in Sinatra applications, and
+      # other options (such as request.path_info) have potentially very high
+      # cardinality.  For now, just accept that we can't be more specific than
+      # the application / pod and don't provide any other labels
+      {}
+    end
+  end
+
   def self.should_configure
     # Allow us to force the Prometheus Exporter for persistent Rake tasks...
     if ENV["GOVUK_PROMETHEUS_EXPORTER"] == "force"
@@ -11,12 +53,14 @@ module GovukPrometheusExporter
     end
   end
 
-  def self.configure(collectors: [])
+  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|
@@ -43,11 +87,11 @@ module GovukPrometheusExporter
       server.start
 
       if defined?(Rails)
-        Rails.application.middleware.unshift PrometheusExporter::Middleware, instrument: :prepend
+        Rails.application.middleware.unshift RailsMiddleware, instrument: :prepend
       end
 
       if defined?(Sinatra)
-        Sinatra.use PrometheusExporter::Middleware
+        Sinatra.use SinatraMiddleware
       end
     rescue Errno::EADDRINUSE
       warn "Could not start Prometheus metrics server as address already in use."

data/lib/govuk_app_config/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_app_config
 version: !ruby/object:Gem::Version
-  version: 9.1.0
+  version: 9.3.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-09-08 00:00:00.000000000 Z
+date: 2023-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logstasher
@@ -53,7 +53,7 @@ dependencies:
         version: 0.39.1
     - - "<"
       - !ruby/object:Gem::Version
-        version: 0.41.0
+        version: 0.51.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -63,7 +63,7 @@ dependencies:
         version: 0.39.1
     - - "<"
       - !ruby/object:Gem::Version
-        version: 0.41.0
+        version: 0.51.0
 - !ruby/object:Gem::Dependency
   name: opentelemetry-sdk
   requirement: !ruby/object:Gem::Requirement
@@ -375,7 +375,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.19
+rubygems_version: 3.4.20
 signing_key: 
 specification_version: 4
 summary: Base configuration for GOV.UK applications