govuk_message_queue_consumer 2.0.1 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 35f5b177e277ec11d5aea2811c4e1ef6e2dd4886
-  data.tar.gz: 54050cbbc46013a6bcdaed24eb5c21966e99b8b8
+  metadata.gz: 6ea5c6560ba396d9f32d22371cd8f94240bdfbcd
+  data.tar.gz: fdc543d6ee7d1290e3df4db3628f497aa3151e37
 SHA512:
-  metadata.gz: 00d5f07c06e4063bc7b06b9d52e7d96464cf59c024bd80fc7770d6780013a7b8bb587b98cc500edf0066e390055215f0eb2e55f36fb7e788d124216378d329df
-  data.tar.gz: a93529d6ef53a6db31e199f946b51b0e7aa971291dc725915a351f3f4d09a3f788513594074beeee9ae4e2d914695713e48c3d6168ea71ee00675f47fd8e0fca
+  metadata.gz: 760eb4893ce343d4e5dc439bc05a80ef49ceb8fc9c4538395079f6644b05ad555e435e32415be004bb0116dd1d9ec8b54bedf62819bf8eceaf7ac1caa3ce8451
+  data.tar.gz: 98f3ff7cb41cb8f20233114121e53967d180462ecd1118c07d0abf409456ca3c663127c6e2692f8a7cbadaa250bf2e36ba65e4865a45edf160a3d6f6d9e71374

data/README.md

@@ -9,6 +9,8 @@ the content-items it receives, so that applications such as
 [email-alert-service](https://github.com/alphagov/email-alert-service) can be
 notified of changes in content.
 
+For detailed documentation, check out the [gem documentation on rubydoc.info](http://www.rubydoc.info/gems/govuk_message_queue_consumer/GovukMessageQueueConsumer/Consumer#initialize-instance_method).
+
 ## Nomenclature
 
 ![A graph showing the message flow](docs/graph.png)
@@ -51,7 +53,7 @@ Add the gem:
 
 ```ruby
 # Gemfile
-gem "govuk_message_queue_consumer", "~> 2.0.0"
+gem "govuk_message_queue_consumer", "~> 2.1"
 ```
 
 Add a rake task like the following example:
@@ -70,6 +72,8 @@ namespace :message_queue do
 end
 ```
 
+More options are [documented here](http://www.rubydoc.info/gems/govuk_message_queue_consumer/GovukMessageQueueConsumer/Consumer#initialize-instance_method).
+
 The consumer expects a number of environment variables to be present. On GOV.UK,
 these should be set up in puppet.
 
@@ -129,6 +133,28 @@ class MyProcessor
 end
 ```
 
+### Statsd integration
+
+You can pass a `statsd_client` to the `GovukMessageQueueConsumer::Consumer` initializer. The consumer will emit counters to statsd with these keys:
+
+- `your_queue_name.started` - message picked up from the your_queue_name
+- `your_queue_name.retried` - message has been retried
+- `your_queue_name.acked` - message has been processed and acked
+- `your_queue_name.discarded` - message has been discarded
+- `your_queue_name.uncaught_exception` - an uncaught exception occured during processing
+
+Remember to use a namespace for the `Statsd` client:
+
+```ruby
+statsd_client = Statsd.new("localhost")
+statsd_client.namespace = "govuk.app.my_app_name"
+
+GovukMessageQueueConsumer::Consumer.new(
+  statsd_client: statsd_client
+  # ... other setup code omitted
+).run
+```
+
 ### Testing your processor
 
 This gem provides a test helper for your processor.

data/lib/govuk_message_queue_consumer/consumer.rb

@@ -1,4 +1,5 @@
 require 'bunny'
+require_relative 'null_statsd'
 
 module GovukMessageQueueConsumer
   class Consumer
@@ -11,21 +12,32 @@ module GovukMessageQueueConsumer
     # time to share the work evenly.
     NUMBER_OF_MESSAGES_TO_PREFETCH = 1
 
-    def initialize(queue_name:, exchange_name:, processor:, routing_key: '#')
+    # Create a new consumer
+    #
+    # @param queue_name [String] Your queue name. This is specific to your application.
+    # @param exchange_name [String] Name of the exchange to bind to, for example `published_documents`
+    # @param processor [Object] An object that responds to `process`
+    # @param routing_key [String] The RabbitMQ routing key to bind the queue to
+    # @param statsd_client [Statsd] An instance of the Statsd class
+    def initialize(queue_name:, exchange_name:, processor:, routing_key: '#', statsd_client: NullStatsd.new)
       @queue_name = queue_name
       @exchange_name = exchange_name
       @processor = processor
       @routing_key = routing_key
+      @statsd_client = statsd_client
     end
 
     def run
       queue.subscribe(block: true, manual_ack: true) do |delivery_info, headers, payload|
         begin
           message = Message.new(payload, headers, delivery_info)
+          @statsd_client.increment("#{@queue_name}.started")
           processor_chain.process(message)
+          @statsd_client.increment("#{@queue_name}.#{message.status}")
         rescue Exception => e
+          @statsd_client.increment("#{@queue_name}.uncaught_exception")
           Airbrake.notify_or_ignore(e) if defined?(Airbrake)
-          $stderr.puts "Uncaught exception in processor: \n\n #{e.class}: #{e.message}\n\n#{e.backtrace}"
+          $stderr.puts "Uncaught exception in processor: \n\n #{e.class}: #{e.message}\n\n#{e.backtrace.join("\n")}"
           exit(1) # Ensure rabbitmq requeues outstanding messages
         end
       end

data/lib/govuk_message_queue_consumer/message.rb

@@ -3,24 +3,28 @@ require 'json'
 module GovukMessageQueueConsumer
   # Client code will receive an instance of this
   class Message
-    attr_accessor :delivery_info, :headers, :payload
+    attr_accessor :delivery_info, :headers, :payload, :status
 
     def initialize(payload, headers, delivery_info)
       @payload = payload
       @headers = headers
       @delivery_info = delivery_info
+      @status = :status
     end
 
     def ack
       @delivery_info.channel.ack(@delivery_info.delivery_tag)
+      @status = :acked
     end
 
     def retry
       @delivery_info.channel.reject(@delivery_info.delivery_tag, true)
+      @status = :retried
     end
 
     def discard
       @delivery_info.channel.reject(@delivery_info.delivery_tag, false)
+      @status = :discarded
     end
   end
 end

data/lib/govuk_message_queue_consumer/null_statsd.rb

@@ -0,0 +1,4 @@
+class NullStatsd
+  def increment(_key)
+  end
+end

data/lib/govuk_message_queue_consumer/version.rb

@@ -1,3 +1,3 @@
 module GovukMessageQueueConsumer
-  VERSION = '2.0.1'
+  VERSION = '2.1.0'
 end

data/spec/consumer_spec.rb

@@ -1,33 +1,34 @@
 require_relative 'spec_helper'
+require_relative 'support/queue_helpers'
 
 describe Consumer do
-  let(:queue) { instance_double('Bunny::Queue', bind: nil, subscribe: '') }
-  let(:channel) { instance_double('Bunny::Channel', queue: queue, prefetch: nil, topic: nil) }
-  let(:rabbitmq_connecton) { instance_double("Bunny::Session", start: nil, create_channel: channel) }
-  let(:client_processor) { instance_double('Client::Processor') }
+  include QueueHelpers
 
-  before do
-    stub_environment_variables!
-    allow(Bunny).to receive(:new).and_return(rabbitmq_connecton)
-  end
+  let(:client_processor) { instance_double('Client::Processor') }
 
-  describe "running the consumer" do
+  describe "#run" do
     it "binds the queue to the all-routing key" do
+      queue = create_stubbed_queue
+
       expect(queue).to receive(:bind).with(nil, { routing_key: "#" })
 
       Consumer.new(queue_name: "some-queue", exchange_name: "my-exchange", processor: client_processor).run
     end
 
     it "binds the queue to a custom routing key" do
+      queue = create_stubbed_queue
+
       expect(queue).to receive(:bind).with(nil, { routing_key: "*.major" })
 
       Consumer.new(queue_name: "some-queue", exchange_name: "my-exchange", processor: client_processor, routing_key: "*.major").run
     end
 
     it "calls the heartbeat processor when subscribing to messages" do
+      queue = create_stubbed_queue
+
       expect(queue).to receive(:subscribe).and_yield(:delivery_info_object, :headers, "payload")
-      expect(Message).to receive(:new).with("payload", :headers, :delivery_info_object)
-      expect_any_instance_of(HeartbeatProcessor).to receive(:process)
+
+      expect_any_instance_of(HeartbeatProcessor).to receive(:process).with(kind_of(Message))
 
       Consumer.new(queue_name: "some-queue", exchange_name: "my-exchange", processor: client_processor).run
     end

data/spec/consumer_with_statsd_spec.rb

@@ -0,0 +1,54 @@
+require_relative 'spec_helper'
+require_relative 'support/queue_helpers'
+
+describe Consumer do
+  include QueueHelpers
+
+  describe "#run" do
+    it "increments the counters on the statsd client" do
+      statsd_client = StatsdClientMock.new
+      queue = create_stubbed_queue
+
+      expect(queue).to receive(:subscribe).and_yield(
+        double(:delivery_info, channel: double(:channel, reject: double), delivery_tag: double),
+        double(:headers, content_type: 'application/json'),
+        "message_payload"
+      )
+
+      Consumer.new(queue_name: "some-queue", exchange_name: "my-exchange", processor: double, statsd_client: statsd_client).run
+
+      expect(statsd_client.incremented_keys).to eql(['some-queue.started', 'some-queue.discarded'])
+    end
+
+    it "increments the uncaught_exception counter for uncaught exceptions" do
+      statsd_client = StatsdClientMock.new
+      queue = create_stubbed_queue
+
+      expect(queue).to receive(:subscribe).and_yield(
+        double(:delivery_info, channel: double(:channel, reject: double), delivery_tag: double),
+        double(:headers, content_type: 'application/json'),
+        {}.to_json
+      )
+
+      processor = double
+      expect(processor).to receive(:process).and_raise("An exception")
+
+      expect do
+        Consumer.new(queue_name: "some-queue", exchange_name: "my-exchange", processor: processor, statsd_client: statsd_client).run
+      end.to raise_error(SystemExit)
+
+      expect(statsd_client.incremented_keys).to eql(['some-queue.started', 'some-queue.uncaught_exception'])
+    end
+  end
+
+  class StatsdClientMock
+    attr_reader :incremented_keys
+    def initialize
+      @incremented_keys = []
+    end
+
+    def increment(key)
+      @incremented_keys << key
+    end
+  end
+end

data/spec/message_spec.rb

@@ -10,17 +10,23 @@ describe Message do
     expect(mock_channel).to receive(:ack).with("a_tag")
 
     message.ack
+
+    expect(message.status).to eql(:acked)
   end
 
   it "retry sends a reject to the channel with requeue set" do
     expect(mock_channel).to receive(:reject).with("a_tag", true)
 
     message.retry
+
+    expect(message.status).to eql(:retried)
   end
 
   it "reject sends a reject to the channel without requeue set" do
     expect(mock_channel).to receive(:reject).with("a_tag", false)
 
     message.discard
+
+    expect(message.status).to eql(:discarded)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_message_queue_consumer
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.1.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-15 00:00:00.000000000 Z
+date: 2016-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bunny
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 10.4.2
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Avoid writing boilerplate code in order to consume messages from an AMQP
   message queue. Plug in queue configuration, and how to process each message.
 email:
@@ -81,6 +95,7 @@ files:
 - lib/govuk_message_queue_consumer/heartbeat_processor.rb
 - lib/govuk_message_queue_consumer/json_processor.rb
 - lib/govuk_message_queue_consumer/message.rb
+- lib/govuk_message_queue_consumer/null_statsd.rb
 - lib/govuk_message_queue_consumer/rabbitmq_config.rb
 - lib/govuk_message_queue_consumer/test_helpers.rb
 - lib/govuk_message_queue_consumer/test_helpers/mock_message.rb
@@ -88,6 +103,7 @@ files:
 - lib/govuk_message_queue_consumer/test_helpers/test_consumer.rb
 - lib/govuk_message_queue_consumer/version.rb
 - spec/consumer_spec.rb
+- spec/consumer_with_statsd_spec.rb
 - spec/heartbeat_processor_spec.rb
 - spec/json_processor_spec.rb
 - spec/message_spec.rb
@@ -122,6 +138,8 @@ test_files:
 - spec/spec_helper.rb
 - spec/message_spec.rb
 - spec/consumer_spec.rb
+- spec/consumer_with_statsd_spec.rb
 - spec/mock_message_spec.rb
 - spec/json_processor_spec.rb
 - spec/rabbitmq_config_spec.rb
+has_rdoc: