govuk_sidekiq 0.0.4 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fb12b700a2668dbfd07773e13a3420eb2fee4f61
-  data.tar.gz: 0d91b6780abdeb2dfbc56121556d59ca471bf115
+  metadata.gz: d5249ed2d422603f767f82630fe2aef1fc562694
+  data.tar.gz: 939f2183ce458bdc2c88c9fbddb1ce9726375570
 SHA512:
-  metadata.gz: c89561d77443b2412e86a5099067d264243baa8e81bcd7828ccd3f99b4020e251a04df6a63bc03597e6e6db67cc5864e1cce92eea8e573f50579a14817d01f6d
-  data.tar.gz: 45fb1d788beca7b1f619a85f99bed833a7cb868f6f0644b60a612b65e7694aba2f4c6749bad94cf9dff7a89dbbd608e19043ee9b652965feb8467b2e1fcb4783
+  metadata.gz: 4233329cba8c4b6e0b1c2bc33c802bef71a9500faadf790f0c8ab7edf8e8e2e95e40821e88712334dc88323fa3695dca0053e6f6ae9326620fbee00f07d3b59b
+  data.tar.gz: 72324357bef8207b29aa424bca58e04cc33e8773ed0b521e3267c27f1d1ce4de0ea2db1de4689327a2daabbc690a1aeadc3dcf4bfbeb1322b88c7228dbdbd835

data/README.md

@@ -1,41 +1,108 @@
-# GOVUK Sidekiq
+# GOV.UK Sidekiq
 
 Provides a unified set of configurations and behaviours when using Sidekiq
 in GOV.UK applications.
 
-## Usage
+## Features
 
-### Testing
+What does `govuk_sidekiq` do for you?
 
-See [Sidekiq testing documentation](https://github.com/mperham/sidekiq/wiki/Testing)
-on how to test Sidekiq workers.
+1. Makes sure Sidekiq can connect to Redis correctly, using the default
+  environment variables (these are set in [govuk-puppet](https://github.com/alphagov/govuk-puppet)).
+2. Makes sure that the correct HTTP headers are passed on to [gds-api-adapters](https://github.com/alphagov/gds-api-adapters).
+ This means that for each request a unique ID (govuk_request_id) will be passed on to downstream applications.
+ [Read more about request tracing](https://github.gds/pages/gds/opsmanual/infrastructure/howto/setting-up-request-tracing.html).
+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).
+5. Configures Sidekiq so that exceptions will be sent to our [Errbit instance](errbit.publishing.service.gov.uk).
 
+## Installation (Rails only)
 
-Because of the way we use middleware, you may see errors that indicate that
-your job is called with the wrong number invalid arguments. To set up testing
-correctly, replace `require 'sidekiq/testing'` with:
+### 1. Add the gem
 
 ```ruby
-require 'govuk_sidekiq/testing'
+# Gemfile
+gem "govuk_sidekiq", "~> VERSION"
 ```
 
-## Technical documentation
+### 2. Add a Sidekiq config file
+
+```yaml
+# config/sidekiq.yml
+---
+:concurrency:  2
+```
+
+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
+
+This is what puppet uses to create the process.
 
-When added to a Rails application, this gem uses a railtie to inject an
-initializer configuring Sidekiq.
+```sh
+# Procfile
+worker: bundle exec sidekiq -C ./config/sidekiq.yml
+```
+
+### 4. Configure puppet
+
+- Set `REDIS_HOST` and `REDIS_PORT` variables. `GOVUK_APP_NAME` should also be
+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).
+
+### 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.
+
+```ruby
+# your-application/config/deploy.rb
+after "deploy:restart", "deploy:restart_procfile_worker"
+```
 
-It includes our current optimal sidekiq configuration
-including Airbrake/Errbit, statsd, JSON logging,
-and passthrough of the `govuk_request_id`.
+### 6. Add your worker to the Procfile & Pinfile
 
-No other configuration is required other than the presence of the following
-environment variables:
+This makes sure that your development environment behaves like production.
 
-- **GOVUK_APP_NAME**, used for Redis and statsd namespacing.
-- **REDIS_HOST**
-- **REDIS_PORT**
+See the [Pinfile](https://github.gds/gds/development/blob/master/Pinfile) and
+[Procfile](https://github.gds/gds/development/blob/master/Procfile) for examples.
 
-This gem also assumes that the app has separately configured and required Airbrake/Errbit.
+### 7. Add app to sidekiq-monitoring
+
+See the opsmanual for a step-by-step guide: [HOWTO: Add sidekiq-monitoring to your application](https://github.gds/pages/gds/opsmanual/infrastructure/howto/setting-up-new-sidekiq-monitoring-app.html)
+
+### 8. Create some jobs
+
+You can [use normal Sidekiq jobs](https://github.com/mperham/sidekiq/wiki/Getting-Started):
+
+```ruby
+# app/workers/hard_worker.rb
+class HardWorker
+  include Sidekiq::Worker
+  def perform(name, count)
+    # do something
+  end
+end
+```
+
+Note that the convention is to use `app/workers` as the directory for your workers.
+
+## Testing
+
+See [Sidekiq testing documentation](https://github.com/mperham/sidekiq/wiki/Testing)
+on how to test Sidekiq workers.
+
+Because of the way we use middleware, you may see errors that indicate that
+your job is called with the wrong number of arguments. To set up testing
+correctly, replace `require 'sidekiq/testing'` with:
+
+```ruby
+require 'govuk_sidekiq/testing'
+```
 
 ## Licence
 

data/lib/govuk_sidekiq/version.rb

@@ -1,3 +1,3 @@
 module GovukSidekiq
-  VERSION = "0.0.4"
+  VERSION = "1.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_sidekiq
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 1.0.0
 platform: ruby
 authors:
 - Elliot Crosby-McCullough
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-04 00:00:00.000000000 Z
+date: 2016-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq