squash_repeater 0.1.8 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c60506271e72774c320843d02b880621d3109a50
-  data.tar.gz: 30e5660d35d24583c7070b9ac9cd0097b06fbc28
+  metadata.gz: ba6dd0117c149134a1b6ebf6fcfdc03e358e5e13
+  data.tar.gz: 25fd38a8b755bb537e3215fded0550e21210177d
 SHA512:
-  metadata.gz: 5b2eb749252eeda4ad7b9fb8c07a3cf9c99c587c76b025447b15fdb9b2ca264b1ec303d5937cbeff81029d5c803fd6f5e1097e4fa84000f34826c913d3e8e7d7
-  data.tar.gz: 290abcf712a6da20b90a9ded9d58f8e1f2031b88cecd62149f2a7e82e261bdebfeb0fd18f6246622a5d80cda5a6561c688d6811dfdacd20df306c5f6b4991dab
+  metadata.gz: 713119033a8555b7c4ba84f56750127f7e23d7ee669482b9c7e0d20995f3494e95bdee1aa206d8fc49dddfec9f9d24487fe402aea8cb3746e10b7bc607cc68c0
+  data.tar.gz: dd6392f9d8b1aa5f2be44501d59a411ca9505f618f4431a8d587ccd905324b827d42d43b922ffce77efe3347d4e1f93fa2d7621f090b7b096f9522dae7d27553

data/README.md

@@ -1,22 +1,19 @@
 # SquashRepeater
 
-One difficulty with Squash is that whenever any exception occurs, it contacts the
-Squash server to upload details of that failure, which means the code blocks until
-contact is made or the connection times-out.
-
-In many cases, an exception is a failure, and you probably don't want to be nice
-about it, but for user-facing app's, you're degrading the user-experience even
-further.  A quick-response "failure" message to the user is still many times better
-than waiting many seconds (or more).
-
-On top of that, almost all exceptions are valuable, in that they have captured a
-failure-mode that you weren't previously aware of.  If the server is down, then the
-chances are that data is lost.
-
-Squash Repeater uses a low-overhead queueing service to capture any exceptions and
-return control as quickly as possible, after which an independent "worker" process
-will attempt to send the queued exception reports to the Squash server.
-This should mean:
+One difficulty with Squash is that whenever any exception occurs, it contacts the Squash server to
+upload details of that failure, which means the code blocks until contact is made or the connection
+times-out.
+
+In many cases, an exception is a failure, and you probably don't want to be nice about it, but for
+user-facing app's, you're degrading the user-experience even further.  A quick-response "failure"
+message to the user is still many times better than waiting many seconds (or more).
+
+On top of that, almost all exceptions are valuable, in that they have captured a failure-mode that
+you weren't previously aware of.  If the server is down, then the chances are that data is lost.
+
+Squash Repeater uses a low-overhead queueing service to capture any exceptions and return control as
+quickly as possible, after which an independent "worker" process will attempt to send the queued
+exception reports to the Squash server.  This should mean:
 - the local Squash client code can return far more quickly
 - any exception reports that fail to be accepted by the Squash server aren't lost
   (or dropped from the queue)
@@ -39,11 +36,15 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install squash_repeater
+```bash
+$ gem install squash_repeater
+```
 
 If you're using Rails, you can install an initialiser template with:
 
-    $ bundle exec rails generate squash_repeater:install
+```bash
+$ bundle exec rails generate squash_repeater:install
+```
 
 ## Install `beanstalkd`
 
@@ -53,30 +54,47 @@ If you're using Rails, you can install an initialiser template with:
 
 ## Configure `backburner`
 
-`backburner` is the Gem used to interact with the `beanstalk` queue.
-It works in two parts:  client libraries that put data on the queue, and background-worker jobs that process the data on
-queue.
+`backburner` is the Gem used to interact with the `beanstalk` queue. It works in two parts: client
+libraries that put data on the queue, and background-worker jobs that process the data on queue.
 
 Simply adding the Gem to your app will configure the client part with useful defaults.
 
-To enable the background-worker part, you need to be able to automatically start the `backburner` worker.
-The `backburner` Gem documentation covers this is detail, but they include a God script.
+To enable the background-worker part, you need to be able to automatically start the `backburner`
+worker. The `backburner` Gem documentation covers this in detail, but they include a God script.
+
+I've included a set of example Ubuntu Upstart scripts in the `share/upstart` directory, which you
+will need to update with details like "app_name" and "app_dir" and install to your machine's
+`/etc/init/` dir.  You may also need to make other adjustments to it according to your needs and/or
+skill.
+
+Alternatively, you can either start the SquashRepeater worker directly with `rails runner`:
 
-I've included a set of example Ubuntu Upstart scripts in the `share/upstart` directory, which you will need to update
-with details like "app_name" and "app_dir" and install to your machine's `/etc/init/` dir.
-You may also need to make other adjustments to it according to your needs and/or skill.
+```bash
+$ cd ${app_dir}
+$ bundle exec rails runner SquashRepeater.work
+```
 
-Alternatively, you can either start `backburner` in daemon mode with:
+Or wrapped with some other daemoniser (such as Niet) with:
 
-    $ cd ${app_dir}
-    $ bundle exec backburner -d -r ${app_config}
+```bash
+$ niet -k 30 -t SquashRepeater -c ${app_dir} -- bundle exec rails runner SquashRepeater.work
+```
 
-Or wrapped with some-other daemoniser (such as Niet) with:
+Or, start `backburner` in daemon mode with:
 
-    $ niet -t backburner -c ${app_dir} -- bundle exec backburner -r ${app_config}
+```bash
+$ cd ${app_dir}
+$ bundle exec backburner -d -r ${app_config}
+```
 
-NB: Replace ${app_dir} with the directory your app is installed to, and ${app_config} with the path to your Squash
-Repeater config.
+Or with a daemoniser:
+
+```bash
+$ niet -t backburner -c ${app_dir} -- bundle exec backburner -r ${app_config}
+```
+
+NB: Replace ${app_dir} with the directory your app is installed to, and ${app_config} with the path
+to your Squash Repeater config.
 
 ## Configure Squash Repeater
 
@@ -97,7 +115,6 @@ SquashRepeater.configure do |c|
   #c.backburner.max_job_retries = 10   # retry jobs 10 times
   #c.backburner.retry_delay = 30   # wait 30 seconds in between retries
 
-
   ###
   # You can set Squash::Ruby config here, or through their configration method. Either way, they must be set:
   # @param api_host:
@@ -116,8 +133,8 @@ SquashRepeater.configure do |c|
 end
 ```
 
-As mentioned above, you can configure a few `Squash::Ruby` settings via this config block, or configure it in the Squash
-way via `Squash::Ruby.configure()`
+As mentioned above, you can configure a few `Squash::Ruby` settings via this config block, or
+configure it in the Squash way via `Squash::Ruby.configure()`
 
 ## Contributing
 

data/bin/squash_repeater

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+
+require "thor"
+require "squash_repeater"
+
+class SquashRepeater::CLI < Thor
+  # contents of the Thor class
+  desc "transmitter", "Start a worker that sends all queued captured exceptions to the Squash service"
+  option :beanstalk_host, :type => :string
+  option :beanstalk_port, :type => :numeric
+  option :beanstalk_tube, :type => :string
+  def transmitter
+    SquashRepeater.configure do |c|
+      beanstalk_url = nil
+
+      beanstalk_url = "beanstalk://#{options[:beanstalk_host]}" if options[:beanstalk_host]
+      beanstalk_url += ":#{options[:beanstalk_port]}" if beanstalk_url && options[:beanstalk_port]
+      c.backburner.beanstalk_url = beanstalk_url if beanstalk_url
+
+      c.backburner.tube_namespace = options[:beanstalk_tube] if options[:beanstalk_tube]
+    end
+
+    SquashRepeater.configuration.logger.info "Starting SquashRepeater worker"
+
+    SquashRepeater.transmit_exceptions
+  end
+end
+
+SquashRepeater::CLI.start(ARGV)

data/lib/squash_repeater/version.rb

@@ -1,3 +1,3 @@
 module SquashRepeater
-  VERSION = "0.1.8"
+  VERSION = "0.1.9"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: squash_repeater
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.1.9
 platform: ruby
 authors:
 - Will Robertson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-28 00:00:00.000000000 Z
+date: 2015-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -125,7 +125,8 @@ dependencies:
 description: Use beanstalkd to locally queue and repeat Squash exception capturing.
 email:
 - will.robertson@powershop.co.nz
-executables: []
+executables:
+- squash_repeater
 extensions: []
 extra_rdoc_files: []
 files:
@@ -134,6 +135,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/squash_repeater
 - lib/generators/squash_repeater/install_generator.rb
 - lib/generators/templates/squash_repeater_initializer.rb
 - lib/squash_repeater.rb