govuk_sidekiq 6.0.0 → 7.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0b29995a70caf772608c804cddc8f38fedc0d79c5a02157a8c9d1c46576403fc
-  data.tar.gz: 660d8a260f5a175c4bea49e978eb2d302fad1d0a35672e2740770908e134f789
+  metadata.gz: 07e39d37942f15f173005674d60471d56fbe3db4d59d35e67ba5c0e1a33155df
+  data.tar.gz: 3a68c0f33812e2558cb5374b9c56533d2573732702e15eb0e5bc38ef588b63ef
 SHA512:
-  metadata.gz: 2c2ef5066358f76e4c6b4452bb452d498f8c4e7fe38363b570488457cbe3d8c687aec4fac3fee9c5a6208e9e8f57015b7e8ee6fc277246e7e1626b6dcd25c5f2
-  data.tar.gz: 9982cee079fc37d903726c2c6ef259d48884802fa410b071a07ae16d32f1169d0f5a7bba1d4484fac0836dfa9fbbf062f0afb8606e223f232f56851390423981
+  metadata.gz: 1de3bd1211158830997a52e81f3ce1086732d66dc6534c6b4faf08709bd5b16d10555fcf4a571e17abb01b7cc68dea594c5ff07d348f6cea8ad927c1118311f6
+  data.tar.gz: 833611f37c06d5cd8cf621f0115650915aec9e69cf1dd37e3e48d6f66ea3347cf2600eefbe270a4d7e7e3dc783e35909c19d78d78aa13f873117bc4fa6c07dad

data/README.md

@@ -13,9 +13,7 @@ What does `govuk_sidekiq` do for you?
  This means that for each request a unique ID (`govuk_request_id`) will be passed on to downstream applications.
  [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).
+ properly in Logit and searchable through Kibana.
 
 [req-tracing]: https://docs.publishing.service.gov.uk/manual/setting-up-request-tracing.html
 
@@ -39,46 +37,20 @@ gem "govuk_sidekiq"
 This file also allows you to configure queues with priority.
 [See the Sidekiq wiki for available options](https://github.com/mperham/sidekiq/wiki/Advanced-Options).
 
-### 3. Add a Procfile
+### 3. Configure environment variables in EKS
 
-This is what puppet uses to create the process.
+For each environment ([integration](https://github.com/alphagov/govuk-helm-charts/blob/main/charts/app-config/values-integration.yaml), [staging](https://github.com/alphagov/govuk-helm-charts/blob/main/charts/app-config/values-staging.yaml) and [production](https://github.com/alphagov/govuk-helm-charts/blob/main/charts/app-config/values-production.yaml)), add a `REDIS_URL` environment variable for your application with a value of `redis://shared-redis-govuk.eks.{environment}.govuk-internal.digital`.
 
-```sh
-# Procfile
-worker: bundle exec sidekiq -C ./config/sidekiq.yml
-```
-
-### 4. Configure puppet
-
-- 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/main/hieradata_aws/common.yaml). For example:
-
-    ```
-    govuk::apps::your_app::redis_host: "%{hiera('sidekiq_host')}"
-    govuk::apps::your_app::redis_port: "%{hiera('sidekiq_port')}"
-    ```
-- Make sure puppet creates and starts the Procfile worker.
+Additionally, set the value of `workerEnabled` to `true` for your application. This will [result in a `worker` process](https://github.com/alphagov/govuk-helm-charts/blob/8b008832b5e8f62f2f489d3b030be21945d2b08b/charts/generic-govuk-app/values.yaml#L16-L21) running alongside the web application. The queue length and max delay can be monitored using the [Sidekiq Grafana dashboard](https://grafana.eks.production.govuk.digital/d/sidekiq-queues), once the Sidekiq worker is initialised.
 
-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
-
-Make sure you restart the worker after deploying by adding a hook to the [capistrano scripts in govuk-app-deployment](https://github.com/alphagov/govuk-app-deployment). Otherwise the worker will keep running old code.
+There's no step-by-step guide for this, but [you can copy the changes made when Sidekiq was added to the release application](https://github.com/alphagov/govuk-helm-charts/pull/1117/files). You may also want to [resize resource requests](https://github.com/alphagov/govuk-helm-charts/pull/1121/files) for the app depending on the predicted request rate. 
 
 ```ruby
 # your-application/config/deploy.rb
 after "deploy:restart", "deploy:restart_procfile_worker"
 ```
 
-### 6. Add app to sidekiq-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
-
-### 8. Create some jobs
+### 4. Create some jobs
 
 You can [use normal Sidekiq jobs](https://github.com/mperham/sidekiq/wiki/Getting-Started):
 

data/lib/govuk_sidekiq/api_headers.rb

@@ -1,4 +1,5 @@
 require "gds_api/govuk_headers"
+require "sidekiq"
 
 module GovukSidekiq
   module APIHeaders
@@ -16,6 +17,7 @@ module GovukSidekiq
         else
           job["args"] << header_arguments
         end
+        Sidekiq::Context.add("govuk_request_id", job["args"].last["request_id"])
 
         yield
       end
@@ -45,6 +47,7 @@ module GovukSidekiq
           authenticated_user = last_arg["authenticated_user"]
           GdsApi::GovukHeaders.set_header(:govuk_request_id, request_id)
           GdsApi::GovukHeaders.set_header(:x_govuk_authenticated_user, authenticated_user)
+          Sidekiq::Context.add("govuk_request_id", request_id)
         end
 
         yield

data/lib/govuk_sidekiq/govuk_json_formatter.rb

@@ -0,0 +1,19 @@
+require "sidekiq"
+require "govuk_sidekiq/api_headers"
+
+module GovukSidekiq
+  class GovukJsonFormatter < Sidekiq::Logger::Formatters::Base
+    def call(severity, time, _, message)
+      hash = {
+        "@timestamp": time.utc.iso8601(3),
+        pid: ::Process.pid,
+        tid: tid,
+        level: severity,
+        message: message,
+        tags: %w[sidekiq],
+      }
+      ctx.each { |key, value| hash[key] = value unless hash[key] }
+      Sidekiq.dump_json(hash) << "\n"
+    end
+  end
+end

data/lib/govuk_sidekiq/sidekiq_initializer.rb

@@ -1,7 +1,6 @@
 require "sidekiq"
-require "sidekiq-statsd"
 require "govuk_sidekiq/api_headers"
-require "govuk_app_config/govuk_statsd"
+require "govuk_sidekiq/govuk_json_formatter"
 
 module GovukSidekiq
   module SidekiqInitializer
@@ -12,8 +11,6 @@ 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.
@@ -22,11 +19,11 @@ module GovukSidekiq
         # rubocop:disable Style/GlobalVars
         config.logger = Sidekiq::Logger.new($real_stdout) if defined?($real_stdout)
         # rubocop:enable Style/GlobalVars
+        config.log_formatter = GovukSidekiq::GovukJsonFormatter.new if ENV["GOVUK_SIDEKIQ_JSON_LOGGING"]
 
         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

data/lib/govuk_sidekiq/version.rb

@@ -1,3 +1,3 @@
 module GovukSidekiq
-  VERSION = "6.0.0".freeze
+  VERSION = "7.1.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_sidekiq
 version: !ruby/object:Gem::Version
-  version: 6.0.0
+  version: 7.1.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-01-05 00:00:00.000000000 Z
+date: 2023-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gds-api-adapters
@@ -66,20 +66,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '6'
-- !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'
 - !ruby/object:Gem::Dependency
   name: climate_control
   requirement: !ruby/object:Gem::Requirement
@@ -142,14 +128,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.9.0
+        version: 4.10.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.9.0
+        version: 4.10.0
 description: 
 email:
 - govuk-dev@digital.cabinet-office.gov.uk
@@ -161,6 +147,7 @@ files:
 - README.md
 - lib/govuk_sidekiq.rb
 - lib/govuk_sidekiq/api_headers.rb
+- lib/govuk_sidekiq/govuk_json_formatter.rb
 - lib/govuk_sidekiq/railtie.rb
 - lib/govuk_sidekiq/sidekiq_initializer.rb
 - lib/govuk_sidekiq/testing.rb
@@ -177,14 +164,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.2
+rubygems_version: 3.4.14
 signing_key: 
 specification_version: 4
 summary: Provides standard setup and behaviour for Sidekiq in GOV.UK applications.