govuk_app_config 8.0.2 → 8.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 29a6672c834922901fdc98c77a61b43c12a3455ed1445419e3cc2132a52bd6a0
-  data.tar.gz: b91182c0cb0bd09f95a34703e72271afc71479742e1e5177dd3310d8b7b0439e
+  metadata.gz: df59068ad0c6277dddb68a7c934e9557fc3e59db4a72022503c29942ca18fe1a
+  data.tar.gz: 691a810bf1793a069121d37a343c0fb955b7034bdf55166377ebe5454b60af6e
 SHA512:
-  metadata.gz: 9a54c8f6c22ed6157735dfbbfebdd35b5d5264d9d972bfc705cf73429acb0afa5d60e162bda3202208a6d5f3a278c6a66de8d37ac02aca2b8f90994f58cd8e3a
-  data.tar.gz: 22cc9d0cc5c942ae89f05e55dfcbf0a47f51d0a7c7fd3df7d10fdb255ff2e4e46a7b81f488f91080a2cb5077c0ebc4828a6a49b85083179dfa124408ca6cda57
+  metadata.gz: a0dba812e73f859cb79e379f80f05322836c402043849070539d75fbdc489e8e83270ae26adbe816b58eae7a2789ac83cf35581ef94b586bba53e6feb86a6f51
+  data.tar.gz: 9e4840809cdb83747be969f86c78de547d79c635e9e4eb83635e627f607b509b52689a2db66faf85ab11af99327877f9a45597465c8a50d629c2440b8fcc394d

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+# 8.1.1
+
+* Fix prometheus_exporter to method patching compatible with open telemetry.
+
+# 8.1.0
+
+* Add ability to enable Open Telemetry instrumentation for Rails applications.
+
 # 8.0.2
 
 * Fix the ability to collect Sidekiq metrics in GovukPrometheusExporter. ([#299](https://github.com/alphagov/govuk_app_config/pull/299))

data/README.md

@@ -104,6 +104,9 @@ end
 
 `GovukError.configure` has the same options as the Sentry client, Raven. See [the Raven docs for all configuration options](https://docs.sentry.io/clients/ruby/config).
 
+## Open Telemetry
+
+To enable Open Telemetry instrumentation for Rails set the ENABLE_OPEN_TELEMETRY="true" environment variable.
 
 ## Prometheus monitoring
 

data/govuk_app_config.gemspec

@@ -21,6 +21,9 @@ 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-sdk", "~> 1.2"
   spec.add_dependency "plek", ">= 4", "< 6"
   spec.add_dependency "prometheus_exporter", "~> 2.0"
   spec.add_dependency "puma", ">= 5.6", "< 7.0"
@@ -36,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.10.0"
+  spec.add_development_dependency "rubocop-govuk", "4.11.0"
   spec.add_development_dependency "webmock"
 end

data/lib/govuk_app_config/govuk_open_telemetry.rb

@@ -0,0 +1,18 @@
+module GovukOpenTelemetry
+  def self.should_configure?
+    ENV["ENABLE_OPEN_TELEMETRY"] == "true"
+  end
+
+  def self.configure(service_name)
+    return unless should_configure?
+
+    require "opentelemetry/sdk"
+    require "opentelemetry/exporter/otlp"
+    require "opentelemetry/instrumentation/all"
+
+    OpenTelemetry::SDK.configure do |config|
+      config.service_name = service_name
+      config.use_all # enables all instrumentation!
+    end
+  end
+end

data/lib/govuk_app_config/govuk_prometheus_exporter.rb

@@ -40,7 +40,7 @@ module GovukPrometheusExporter
       server.start
 
       if defined?(Rails)
-        Rails.application.middleware.unshift PrometheusExporter::Middleware
+        Rails.application.middleware.unshift PrometheusExporter::Middleware, instrument: :prepend
       end
 
       if defined?(Sinatra)

data/lib/govuk_app_config/railtie.rb

@@ -8,6 +8,10 @@ module GovukAppConfig
       end
     end
 
+    initializer "govuk_app_config.configure_open_telemetry" do |app|
+      GovukOpenTelemetry.configure(app.class.module_parent_name.underscore)
+    end
+
     config.before_initialize do
       GovukLogging.configure if Rails.env.production?
     end

data/lib/govuk_app_config/version.rb

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

data/lib/govuk_app_config.rb

@@ -3,6 +3,7 @@ require "govuk_app_config/govuk_statsd"
 require "govuk_app_config/govuk_error"
 require "govuk_app_config/govuk_proxy/static_proxy"
 require "govuk_app_config/govuk_healthcheck"
+require "govuk_app_config/govuk_open_telemetry"
 require "govuk_app_config/govuk_prometheus_exporter"
 
 if defined?(Rails)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_app_config
 version: !ruby/object:Gem::Version
-  version: 8.0.2
+  version: 8.1.1
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-06-15 00:00:00.000000000 Z
+date: 2023-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logstasher
@@ -24,6 +24,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: opentelemetry-exporter-otlp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.25.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.25.0
+- !ruby/object:Gem::Dependency
+  name: opentelemetry-instrumentation-all
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.39.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.39.1
+- !ruby/object:Gem::Dependency
+  name: opentelemetry-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: plek
   requirement: !ruby/object:Gem::Requirement
@@ -238,14 +280,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.10.0
+        version: 4.11.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.10.0
+        version: 4.11.0
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -295,6 +337,7 @@ files:
 - 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_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
@@ -321,7 +364,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.14
+rubygems_version: 3.4.15
 signing_key: 
 specification_version: 4
 summary: Base configuration for GOV.UK applications