govuk_sidekiq 5.0.0 → 7.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 360dbfaafbf182d077a3d010a9b8f7aef892873a74dba9d5360225873bb3dd9e
-  data.tar.gz: 57f5fdc1396bb897fb91497d49dfbe42e63e6d0ed4678484eff67ac9946160a8
+  metadata.gz: b7dcf56fdac303296683242e648f7d5870dffdc4d635bba94e248850c09e8012
+  data.tar.gz: 82db38cec99745be8126a12009baaae8358bb16b1c580bb6f6755fe4ffffd36f
 SHA512:
-  metadata.gz: 592383166d00c61ac5691cc203545c95664bdbc16e5551db9a3df4ad549c197f22a1a49a59ee35a1839ed759ab4adcb2fb2f5bb0b6cd4d0ba4f42ac9b7530592
-  data.tar.gz: 1122c8ac78c73e2d881510d34156d1b2b718433d5e72a2402e870dce15ebc15513391aa2ab136764b9908d2b8ac7cf298e4b0aa55e37dec06f8a3bea04c2bbe8
+  metadata.gz: 8cce38baca997da9cf804ebe2a1021fd29f7f8a5a9b770b3eef02167bfd308d09cb1ce82e262be7c83e83a4fce54dbef7cb42b5dd89fb6aaf9e914671d7e18a0
+  data.tar.gz: 7905fdb2c6b155fdbaf539df1d8b27539758641173475512c93370832eb1131fd2aee23e42c54d984c5b8e28d711779f036af65d550d779d4c80fa0e2f8c8f89

data/README.md

@@ -14,8 +14,6 @@ What does `govuk_sidekiq` do for you?
  [Read more about request tracing][req-tracing].
 3. Makes sure that we use JSON logging, so that Sidekiq logs will end up
  properly in Kibana.
-4. Sends activity stats to Statsd, so that you can make pretty graphs of activity
- in Grafana or Graphite. See the [Rummager dashboards for an example](https://grafana.publishing.service.gov.uk/dashboard/file/rummager_queues.json).
 
 [req-tracing]: https://docs.publishing.service.gov.uk/manual/setting-up-request-tracing.html
 
@@ -25,7 +23,7 @@ What does `govuk_sidekiq` do for you?
 
 ```ruby
 # Gemfile
-gem "govuk_sidekiq", "~> VERSION"
+gem "govuk_sidekiq"
 ```
 
 ### 2. Add a Sidekiq config file
@@ -53,7 +51,7 @@ worker: bundle exec sidekiq -C ./config/sidekiq.yml
 - Set a `REDIS_URL` environment variable. `GOVUK_APP_NAME` should also be
 set, but this is already done by the default `govuk::app::config`.
 
-    Apply redis variables for your app in [the default config](https://github.com/alphagov/govuk-puppet/blob/master/hieradata/common.yaml). For example:
+    Apply redis variables for your app in [the default config](https://github.com/alphagov/govuk-puppet/blob/main/hieradata_aws/common.yaml). For example:
 
     ```
     govuk::apps::your_app::redis_host: "%{hiera('sidekiq_host')}"
@@ -61,7 +59,7 @@ set, but this is already done by the default `govuk::app::config`.
     ```
 - Make sure puppet creates and starts the Procfile worker.
 
-There's no step-by-step guide for this, but [you can copy the config from collections-publisher](https://github.com/alphagov/govuk-puppet/blob/master/modules/govuk/manifests/apps/collections_publisher.pp).
+There's no step-by-step guide for this, but [you can copy the config from collections-publisher](https://github.com/alphagov/govuk-puppet/blob/main/modules/govuk/manifests/apps/collections_publisher.pp).
 
 ### 5. Configure deployment scripts
 
@@ -72,18 +70,9 @@ Make sure you restart the worker after deploying by adding a hook to the [capist
 after "deploy:restart", "deploy:restart_procfile_worker"
 ```
 
-### 6. Add your worker to the Procfile & Pinfile
+### 6. Add app to sidekiq-monitoring
 
-This makes sure that your development environment behaves like production.
-
-See the [Pinfile][] and [Procfile][] for examples.
-
-[Pinfile]: https://github.com/alphagov/govuk-puppet/tree/master/development-vm/Pinfile
-[Procfile]: https://github.com/alphagov/govuk-puppet/tree/master/development-vm/Procfile
-
-### 7. Add app to sidekiq-monitoring
-
-See the opsmanual for a step-by-step guide: [Add sidekiq-monitoring to your application][monitoring]
+See the dev docs for a step-by-step guide: [Add sidekiq-monitoring to your application][monitoring]
 
 [monitoring]: https://docs.publishing.service.gov.uk/manual/setting-up-new-sidekiq-monitoring-app.html
 
@@ -119,7 +108,3 @@ require 'govuk_sidekiq/testing'
 ## Licence
 
 [MIT License](LICENCE)
-
-## Versioning policy
-
-See https://github.com/alphagov/styleguides/blob/master/rubygems.md#versioning

data/lib/govuk_sidekiq/api_headers.rb

@@ -22,8 +22,8 @@ module GovukSidekiq
 
       def header_arguments
         {
-          authenticated_user: GdsApi::GovukHeaders.headers[:x_govuk_authenticated_user],
-          request_id: GdsApi::GovukHeaders.headers[:govuk_request_id],
+          "authenticated_user" => GdsApi::GovukHeaders.headers[:x_govuk_authenticated_user],
+          "request_id" => GdsApi::GovukHeaders.headers[:govuk_request_id],
         }
       end
 

data/lib/govuk_sidekiq/railtie.rb

@@ -4,7 +4,7 @@ module GovukSidekiq
   class Railtie < Rails::Railtie
     initializer "govuk_sidekiq.initialize_sidekiq" do |app|
       SidekiqInitializer.setup_sidekiq(
-        ENV["GOVUK_APP_NAME"] || app.root.basename.to_s,
+        ENV.fetch("GOVUK_APP_NAME", app.root.basename.to_s),
         { url: ENV.fetch("REDIS_URL", "redis://127.0.0.1:6379") },
       )
     end

data/lib/govuk_sidekiq/sidekiq_initializer.rb

@@ -1,8 +1,5 @@
 require "sidekiq"
-require "sidekiq/logging/json"
-require "sidekiq-statsd"
 require "govuk_sidekiq/api_headers"
-require "govuk_app_config/govuk_statsd"
 
 module GovukSidekiq
   module SidekiqInitializer
@@ -13,10 +10,20 @@ module GovukSidekiq
       )
 
       Sidekiq.configure_server do |config|
+        config.log_formatter = Sidekiq::Logger::Formatters::JSON.new if ENV["GOVUK_SIDEKIQ_JSON_LOGGING"]
+
+        # $real_stdout is defined by govuk_app_config and is used to point to
+        # STDOUT as that redirects $stdout to actually be $stderr.
+        # When govuk_app_config does this we need to use $real_stdout to output logs to STDOUT.
+        # https://github.com/alphagov/govuk_app_config/blob/08fd9cf6a848615261b3cef021e34490ed72ee55/lib/govuk_app_config/govuk_logging.rb#L18-L24
+
+        # rubocop:disable Style/GlobalVars
+        config.logger = Sidekiq::Logger.new($real_stdout) if defined?($real_stdout)
+        # rubocop:enable Style/GlobalVars
+
         config.redis = redis_config
 
         config.server_middleware do |chain|
-          chain.add Sidekiq::Statsd::ServerMiddleware, statsd: GovukStatsd, env: nil, prefix: "workers"
           chain.add GovukSidekiq::APIHeaders::ServerMiddleware
         end
       end
@@ -28,8 +35,6 @@ module GovukSidekiq
           chain.add GovukSidekiq::APIHeaders::ClientMiddleware
         end
       end
-
-      Sidekiq.logger.formatter = Sidekiq::Logging::Json::Logger.new if Sidekiq.options[:logfile]
     end
   end
 end

data/lib/govuk_sidekiq/version.rb

@@ -1,3 +1,3 @@
 module GovukSidekiq
-  VERSION = "5.0.0".freeze
+  VERSION = "7.0.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_sidekiq
 version: !ruby/object:Gem::Version
-  version: 5.0.0
+  version: 7.0.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-19 00:00:00.000000000 Z
+date: 2023-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gds-api-adapters
@@ -56,78 +56,58 @@ dependencies:
   name: sidekiq
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '5'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '5'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '6'
 - !ruby/object:Gem::Dependency
-  name: sidekiq-logging-json
+  name: climate_control
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.0'
-  type: :runtime
+        version: '1.2'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.0'
-- !ruby/object:Gem::Dependency
-  name: sidekiq-statsd
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '2.1'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '7'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -142,34 +122,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.4'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.10'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.10'
 - !ruby/object:Gem::Dependency
   name: rubocop-govuk
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.10.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.10.0
 description: 
 email:
 - govuk-dev@digital.cabinet-office.gov.uk
@@ -197,14 +163,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.6'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.4.13
 signing_key: 
 specification_version: 4
 summary: Provides standard setup and behaviour for Sidekiq in GOV.UK applications.