pliny-librato 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 362932985964ab9a8467c82061e5a6950a6d12ef
-  data.tar.gz: 1243663968f6966454a4a537185654f30725f9c3
+  metadata.gz: d96c0fdc1c319b07e42ee4dc5eba2bad209a7726
+  data.tar.gz: 5b29955485124e99c6e5e0b8b6c8d40d1cd431e6
 SHA512:
-  metadata.gz: c666a43801fda7e4730e8933dfdec3c76aecb2d31a681d6448f08506ece4c45c4bfcba8873aec9ce5e31b8b5ca6528206fe1e4a9f119a4755f60103b94d47f43
-  data.tar.gz: 96e7b31fe8e42ef8e7bc61b14306546ebaea28547c607f4d5c638b5b3711c4d6fd4e83429227a044fca6f17a35149a5224984de4c9a7ee6c35cc4e3b8a604e1b
+  metadata.gz: ea01e6cfa6c5539e079550ac03262c308dafa5dc7700b3a7904cee6e97410f76e8869375795b9466fd17d2508158828ed2487b4529d367bdd28aafa2265d2036
+  data.tar.gz: 496100d0f6960734f8c32ae7803ed494c371c9a456c1bb1c9bb37d19da02c89bedb220319074f7fdfb65979457b5be333738030e519b133f226fb74120e93768

data/.gitignore

@@ -1 +1,2 @@
 pliny-librato*.gem
+Gemfile.lock

data/CHANGELOG.md

@@ -4,7 +4,16 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
-## [Unreleased]
+## 0.5.0
+
+### Added
+
+- Metrics are now reported to Librato from within a thread to prevent blocking
+
+### Changed
+
+- The backend must be started with `#start` and stopped with `#stop`. For example
+  `backend = Backend.new(opts).start`, `backend.stop`.
 
 ## 0.4.0
 

data/README.md

@@ -2,6 +2,10 @@
 
 A [Librato](https://librato.com) metrics reporter backend for [pliny](https://github.com/interagent/pliny).
 
+
+This backend will push reported metrics onto a queue, then periodically
+submit them asynchronously.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -24,7 +28,9 @@ Add a new initializer `config/initializers/librato.rb`:
 
 ```ruby
 Librato::Metrics.authenticate(Config.librato_email, Config.librato_key)
-Pliny::Metrics.backends << Pliny::Librato::Metrics::Backend.new(source: "myapp.production")
+librato_backend = Pliny::Librato::Metrics::Backend.new(source: "myapp.production")
+librato_backend.start
+Pliny::Metrics.backends << librato_backend
 ```
 
 Now `Pliny::Metrics` methods will build a queue and automatically send metrics
@@ -40,6 +46,28 @@ end
 By default, it will send queued metrics every minute, or whenever the
 queue reaches 1000 metrics. These settings can be configured on initialization.
 
+## Shutdown
+By default, any unsubmitted metrics on the queue will not be sent at shutdown. It is the responsibility of the caller to trigger this.
+
+```ruby
+# In the main process
+Signal.trap('TERM') do
+  librato_backend.stop
+end
+
+# e.g. in Puma
+on_worker_shutdown do
+  librato_backend.stop
+end
+
+# e.g. in Sidekiq
+Sidekiq.configure_server do |config|
+  config.on(:shutdown) do
+    librato_backend.stop
+  end
+end
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/pliny/librato/metrics/backend.rb

@@ -7,35 +7,79 @@ module Pliny
       # Implements the Pliny::Metrics.backends API. Puts any metrics sent
       # from Pliny::Metrics onto a queue that gets submitted in batches.
       class Backend
-        attr_reader :queue
+        POISON_PILL = :'❨╯°□°❩╯︵┻━┻'
 
-        def initialize(source: nil, interval: 60, count: 1000, queue: nil)
-          @queue = queue || ::Librato::Metrics::Queue.new(
-            source:              source,
-            autosubmit_interval: interval,
-            autosubmit_count:    count
-          )
-          flush_on_shutdown
+        def initialize(source: nil, interval: 10, count: 500)
+          @source   = source
+          @interval = interval
+          @count    = count
         end
 
         def report_counts(counts)
-          report(counts)
+          metrics_queue.push(counts)
         end
 
         def report_measures(measures)
-          report(measures)
+          metrics_queue.push(measures)
+        end
+
+        def start
+          start_thread
+          self
+        end
+
+        def stop
+          metrics_queue.push(POISON_PILL)
+          thread.join
         end
 
         private
 
-        def report(metrics)
-          queue.add(metrics)
+        attr_reader :source, :interval, :count, :thread
+
+        def start_thread
+          @thread = Thread.new do
+            loop do
+              msg = metrics_queue.pop
+              break unless process(msg)
+            end
+          end
+        end
+
+        def process(msg)
+          if msg == POISON_PILL
+            flush_librato
+            false
+          else
+            enqueue_librato(msg)
+            true
+          end
+        end
+
+        def enqueue_librato(msg)
+          with_error_report { librato_queue.add(msg) }
+        end
+
+        def flush_librato
+          with_error_report { librato_queue.submit }
+        end
+
+        def with_error_report
+          yield
         rescue => error
           Pliny::ErrorReporters.notify(error)
         end
 
-        def flush_on_shutdown
-          Signal.trap('TERM') { queue.submit }
+        def metrics_queue
+          @metrics_queue ||= Queue.new
+        end
+
+        def librato_queue
+          @librato_queue ||= ::Librato::Metrics::Queue.new(
+            source:              source,
+            autosubmit_interval: interval,
+            autosubmit_count:    count
+          )
         end
       end
     end

data/lib/pliny/librato/version.rb

@@ -1,5 +1,5 @@
 module Pliny
   module Librato
-    VERSION = "0.4.0"
+    VERSION = "0.5.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pliny-librato
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Andrew Appleton
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-12-16 00:00:00.000000000 Z
+date: 2017-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: librato-metrics
@@ -133,7 +133,6 @@ files:
 - ".rspec"
 - CHANGELOG.md
 - Gemfile
-- Gemfile.lock
 - README.md
 - Rakefile
 - bin/console

data/Gemfile.lock

@@ -1,97 +0,0 @@
-PATH
-  remote: .
-  specs:
-    pliny-librato (0.3.0)
-      librato-metrics (~> 2.0)
-      pliny (>= 0.20.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    activesupport (4.2.7.1)
-      i18n (~> 0.7)
-      json (~> 1.7, >= 1.7.7)
-      minitest (~> 5.1)
-      thread_safe (~> 0.3, >= 0.3.4)
-      tzinfo (~> 1.1)
-    aggregate (0.2.2)
-    byebug (9.0.6)
-    coderay (1.1.1)
-    diff-lcs (1.2.5)
-    erubis (2.7.0)
-    faraday (0.10.0)
-      multipart-post (>= 1.2, < 3)
-    http_accept (0.1.6)
-    i18n (0.7.0)
-    json (1.8.3)
-    json_schema (0.16.0)
-    librato-metrics (2.0.2)
-      aggregate (~> 0.2.2)
-      faraday
-    method_source (0.8.2)
-    minitest (5.10.1)
-    multi_json (1.12.1)
-    multipart-post (2.0.0)
-    pliny (0.21.0)
-      activesupport (~> 4.1, >= 4.1.0)
-      http_accept (~> 0.1, >= 0.1.5)
-      multi_json (~> 1.9, >= 1.9.3)
-      prmd (~> 0.11, >= 0.11.4)
-      sinatra (~> 1.4, >= 1.4.7)
-      sinatra-router (~> 0.2, >= 0.2.3)
-      thor (~> 0.19, >= 0.19.1)
-    prmd (0.13.0)
-      erubis (~> 2.7)
-      json_schema (~> 0.3, >= 0.3.1)
-    pry (0.10.4)
-      coderay (~> 1.1.0)
-      method_source (~> 0.8.1)
-      slop (~> 3.4)
-    pry-byebug (3.4.1)
-      byebug (~> 9.0)
-      pry (~> 0.10)
-    rack (1.6.5)
-    rack-protection (1.5.3)
-      rack
-    rake (10.5.0)
-    rspec (3.5.0)
-      rspec-core (~> 3.5.0)
-      rspec-expectations (~> 3.5.0)
-      rspec-mocks (~> 3.5.0)
-    rspec-core (3.5.4)
-      rspec-support (~> 3.5.0)
-    rspec-expectations (3.5.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.5.0)
-    rspec-mocks (3.5.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.5.0)
-    rspec-support (3.5.0)
-    sinatra (1.4.7)
-      rack (~> 1.5)
-      rack-protection (~> 1.4)
-      tilt (>= 1.3, < 3)
-    sinatra-router (0.2.3)
-      sinatra (~> 1.4)
-    slop (3.6.0)
-    thor (0.19.4)
-    thread_safe (0.3.5)
-    tilt (2.0.5)
-    timecop (0.8.1)
-    tzinfo (1.2.2)
-      thread_safe (~> 0.1)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 1.13)
-  pliny-librato!
-  pry (~> 0.10)
-  pry-byebug (~> 3.4)
-  rake (~> 10.0)
-  rspec (~> 3.3)
-  timecop (~> 0.8.1)
-
-BUNDLED WITH
-   1.13.6