govuk_app_config 8.0.1 → 8.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 86a7c7bbd8a1996a9e919b875f782fc90a1c5fca1f5356dfa219c76868f2a2cf
-  data.tar.gz: 0e1ea3f6bbe677dc656e4b99d27d43c49e6b67368120b3cf2a0a2cd1e754928b
+  metadata.gz: b3d7236b119d0f93a720288c9ca9ee559324fed80472261aa049472dcc7a11f4
+  data.tar.gz: 1803d31e9fa99656514c4c127ae9d230af8dd2eae95791432d547f8604575009
 SHA512:
-  metadata.gz: 0e5360f08d06a6e24f922a214746fabf2a981ba048ca81b6ac11441f759d7b4044e725f9ca9672206645adbe06541aef480e51e4e4ba553fcde2c881adb75704
-  data.tar.gz: f64dfad4c602b668a01685b384956a7f8f3d593fb3876f19357ac142d97c36de10d54224958115070d10596d9f9e06c51fd812685def74267d646052e8aa5fe1
+  metadata.gz: 1674b3b5655bf2fa492cbcd644eff15b3effe83fb504d5bd8f9428dfe404e1b2130626dbc88fa0b63674cd0313a8fa80b0592a61a547aa36f3984f5c2b837f27
+  data.tar.gz: 9676dea638fcad4895d510570a9cebf173a463cd65cc1190ec6e7029a2d521b343efd353bd1990bdbb50228d7a5eeddeda62289133c019a443d5115d31e84d66

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+# 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))
+
 # 8.0.1
 
 * Change the "source" field in Rails logs from logstasher from string representing IP host address to an empty object. 

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

@@ -20,6 +20,7 @@ module GovukPrometheusExporter
 
     if defined?(Sidekiq)
       Sidekiq.configure_server do |config|
+        require "sidekiq/api"
         require "prometheus_exporter/instrumentation"
         config.server_middleware do |chain|
           chain.add PrometheusExporter::Instrumentation::Sidekiq

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.1".freeze
+  VERSION = "8.1.0".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.1
+  version: 8.1.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-06-12 00:00:00.000000000 Z
+date: 2023-07-03 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.13
+rubygems_version: 3.4.15
 signing_key: 
 specification_version: 4
 summary: Base configuration for GOV.UK applications