roqua-support 0.1.16 → 0.1.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fdc528029ceea9027cdb56ce3299bc59a64817e4
-  data.tar.gz: b3eaa1c5921dd5684c595486580533d790a6dc5d
+  metadata.gz: 7a54ca79cd7b20e4121b8aa54b9d707ef1418680
+  data.tar.gz: e06d9c5eadc2fd970adaa4ef0c7602e485c743df
 SHA512:
-  metadata.gz: 2fb16cd904080b1b5e22ed7bd14afda38139ee53b34583967a55a1cd986a54fc4e621adeed1fb64b1ec434f63b5012dc7da3ec317202aac624dd69108945677a
-  data.tar.gz: c6c44518398a0e3a012bcfdcac524c9527de98183cb37930a7175e97e9fa51d59b7362e51309025b7e8579af37fd6fc54baf84df89713a33d2ddce08e45647d5
+  metadata.gz: a3eefb5cab8aaa04bd445f57d24535baf4247a28fdb081f93f14241cb39e9533699191d7e70fea13c9ff90bbc7202609b433ee85d216c656cc4837279a2f9f4f
+  data.tar.gz: 856eb8e8a015bf97ce6b88aea46c0008a8045d60900301dd8e8e5c4f7a55b29ca6e450cd592c5a113d4019488bfb128e0957a291780a51fbc8aee4b57c3a2373

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 0.1.17 / 2014-11-20
+
+* Add support for Hosted Graphite through Roqua.stats
+* Deprecate Roqua::Logging in favor of Roqua::Support::Instrumentation
+
 ## 0.1.16 / 2014-11-19
 
 * Add support for skipping the backtrace in the logs

data/Gemfile.lock

@@ -1,8 +1,9 @@
 PATH
   remote: .
   specs:
-    roqua-support (0.1.16)
+    roqua-support (0.1.17)
       activesupport (>= 3.2, < 5.0)
+      naught (~> 1.0)
 
 GEM
   remote: https://rubygems.org/
@@ -61,6 +62,7 @@ GEM
     lumberjack (1.0.9)
     method_source (0.8.2)
     minitest (5.4.2)
+    naught (1.0.0)
     pry (0.10.1)
       coderay (~> 1.1.0)
       method_source (~> 0.8.1)

data/lib/roqua-support/version.rb

@@ -1,5 +1,5 @@
 module Roqua
   module Support
-    VERSION = '0.1.16'
+    VERSION = '0.1.17'
   end
 end

data/lib/roqua/support.rb

@@ -1,6 +1,8 @@
 require 'logger'
-require 'roqua/support/logging'
+require 'roqua/support/instrumentation'
+require 'roqua/support/log_wrapper'
 require 'roqua/support/errors'
+require 'roqua/support/stats'
 
 module Roqua
   class << self
@@ -19,5 +21,13 @@ module Roqua
     def logger=(logger)
       @logger = LogWrapper.new(logger)
     end
+
+    def stats
+      @stats ||= Stats.new
+    end
+
+    def stats=(stats)
+      @stats = stats
+    end
   end
-end
+end

data/lib/roqua/support/instrumentation.rb

@@ -0,0 +1,31 @@
+require 'active_support/core_ext/module/aliasing'
+require 'roqua/support/log_wrapper'
+
+module Roqua
+  module Support
+    module Instrumentation
+      def with_instrumentation(message, options = {})
+        started_at = Time.now.to_f
+        Roqua.logger.info("#{message}:started", options)
+        value = yield
+        finished_at = Time.now.to_f
+        duration = finished_at - started_at
+        Roqua.logger.info("#{message}:finished", {duration: duration}.merge(options))
+        Roqua.stats.submit("#{message}.finished", 1)
+        Roqua.stats.submit("#{message}.duration", duration)
+        value
+      rescue => e
+        Roqua.logger.error("#{message}:failed", {exception: e.class.name, message: e.message}.merge(options))
+        Roqua.stats.submit("#{message}.failed", 1)
+        raise
+      end
+
+      def eventlog
+        Roqua.logger
+      end
+    end
+  end
+
+  # Roqua::Logging is deprecated, this will keep it alive for now
+  Logging = Support::Instrumentation
+end

data/lib/roqua/support/request_logger.rb

@@ -11,7 +11,7 @@ module Roqua
     end
 
     class RequestLogger < ActiveSupport::LogSubscriber
-      include Roqua::Logging
+      include Roqua::Support::Instrumentation
 
       def process_action(event)
         payload = event.payload
@@ -105,4 +105,4 @@ module Roqua
       end
     end
   end
-end
+end

data/lib/roqua/support/stats.rb

@@ -0,0 +1,28 @@
+require 'naught'
+
+module Roqua
+  module Support
+    class Stats
+      NullBackend = Naught.build do |config|
+        config.singleton
+      end
+
+      attr_reader :backend
+
+      def initialize(backend = NullBackend.instance)
+        @backend = backend
+      end
+
+      # Report a value to the stats backend
+      def submit(key, value)
+        backend.submit(prefix(key), value)
+      end
+
+      private
+
+      def prefix(key)
+        "#{Roqua.appname}.#{key}"
+      end
+    end
+  end
+end

data/lib/roqua/support/stats/hosted_graphite_backend.rb

@@ -0,0 +1,13 @@
+require 'hosted_graphite'
+
+module Roqua
+  module Support
+    class Stats
+      class HostedGraphiteBackend
+        def submit(key, value)
+          HostedGraphite.send_metric(key, value)
+        end
+      end
+    end
+  end
+end

data/roqua-support.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
 
   gem.add_dependency 'activesupport', '>= 3.2', '< 5.0'
+  gem.add_dependency 'naught', '~> 1.0'
 
   gem.add_development_dependency 'bundler', '~> 1.0'
   gem.add_development_dependency 'rake'

data/spec/roqua/support/helpers_spec.rb

@@ -0,0 +1,50 @@
+require 'roqua/support/instrumentation'
+
+describe 'Helper methods' do
+  describe '#with_instrumentation' do
+    include Roqua::Support::Instrumentation
+
+    let(:logger) { double("Logger", info: nil, error: nil) }
+    let(:stats)  { double("Stats", submit: nil) }
+
+    before do
+      allow(Roqua).to receive(:logger).and_return(logger)
+      allow(Roqua).to receive(:stats).and_return(stats)
+    end
+
+    context 'when the block returns a value' do
+      it 'logs the start and finish lifecycle of a block' do
+        expect(logger).to receive(:info).with('testevent:started', {extra: "params"}).ordered
+        expect(logger).to receive(:info).with('testevent:finished', hash_including({extra: "params"})).ordered
+        expect(stats).to receive(:submit).with('testevent.finished', 1)
+        expect(stats).to receive(:submit).with('testevent.duration', an_instance_of(Float))
+
+        with_instrumentation('testevent', extra: 'params') { 1 + 1 }
+      end
+
+      it 'returns the value returned by the block' do
+        with_instrumentation('testevent') { 1 + 1 }.should == 2
+      end
+    end
+
+    context 'when an exception happens during the block' do
+      it 'logs the start and failure of a block if it raises' do
+        expect(logger).to receive(:info).with('testevent:started', instance_of(Hash)).ordered
+        expect(logger).to receive(:error).with('testevent:failed', instance_of(Hash)).ordered
+        expect(stats).to receive(:submit).with('testevent.failed', 1)
+
+        with_instrumentation 'testevent' do
+          raise StandardError, "Foo"
+        end rescue nil
+      end
+
+      it 'reraises the exception' do
+        expect {
+          with_instrumentation 'testevent' do
+            raise "Foo"
+          end
+        }.to raise_error('Foo')
+      end
+    end
+  end
+end

data/spec/roqua/support/{logging_spec.rb → logwrapper_spec.rb}

@@ -1,4 +1,4 @@
-require 'roqua/support/logging'
+require 'roqua/support/log_wrapper'
 require 'logger'
 require 'stringio'
 
@@ -65,24 +65,5 @@ module Roqua
         }.to raise_error('Foo')
       end
     end
-
-    describe '.lifecycle' do
-      it 'wraps given method' do
-        ::Roqua.stub(:logger => logwrapper)
-
-        test = Class.new do
-          include Logging
-
-          def foo
-            'bar'
-          end
-          log :foo, 'roqua.testevent.foo'
-        end
-
-        test.new.foo.should == 'bar'
-        log.should include('roqua.testevent.foo:started')
-        log.should include('roqua.testevent.foo:finished')
-      end
-    end
   end
 end

data/spec/roqua/support/request_logger_spec.rb

@@ -1,4 +1,4 @@
-require 'roqua/support/logging'
+require 'roqua/support/log_wrapper'
 require 'roqua/support/request_logger'
 require 'active_support/notifications'
 require 'active_support/core_ext/string'

data/spec/roqua/support/stats_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+require 'roqua/support/stats'
+
+describe 'Stats' do
+  let(:backend) { double("StatsBackend") }
+  let(:stats)   { Roqua::Support::Stats.new(backend) }
+
+  before do
+    Roqua.appname = 'appname'
+  end
+
+  describe 'tracking a value' do
+    it 'reports to backend' do
+      expect(backend).to receive(:submit).with('appname.data_export.duration', 2.3)
+      stats.submit('data_export.duration', 2.3)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: roqua-support
 version: !ruby/object:Gem::Version
-  version: 0.1.16
+  version: 0.1.17
 platform: ruby
 authors:
 - Marten Veldthuis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-19 00:00:00.000000000 Z
+date: 2014-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -30,6 +30,20 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: naught
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -109,9 +123,11 @@ files:
 - lib/roqua/support.rb
 - lib/roqua/support/command_runner.rb
 - lib/roqua/support/errors.rb
+- lib/roqua/support/instrumentation.rb
 - lib/roqua/support/log_wrapper.rb
-- lib/roqua/support/logging.rb
 - lib/roqua/support/request_logger.rb
+- lib/roqua/support/stats.rb
+- lib/roqua/support/stats/hosted_graphite_backend.rb
 - roqua-support.gemspec
 - spec/roqua/core_ext/active_interaction/date_time_as_unix_extension_spec.rb
 - spec/roqua/core_ext/active_interaction/duration_filter_spec.rb
@@ -123,8 +139,10 @@ files:
 - spec/roqua/responders/active_interaction_aware_responder_spec.rb
 - spec/roqua/responders/api_errors_responder_spec.rb
 - spec/roqua/support/errors_spec.rb
-- spec/roqua/support/logging_spec.rb
+- spec/roqua/support/helpers_spec.rb
+- spec/roqua/support/logwrapper_spec.rb
 - spec/roqua/support/request_logger_spec.rb
+- spec/roqua/support/stats_spec.rb
 - spec/roqua/support_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/roqua/roqua-support
@@ -162,7 +180,9 @@ test_files:
 - spec/roqua/responders/active_interaction_aware_responder_spec.rb
 - spec/roqua/responders/api_errors_responder_spec.rb
 - spec/roqua/support/errors_spec.rb
-- spec/roqua/support/logging_spec.rb
+- spec/roqua/support/helpers_spec.rb
+- spec/roqua/support/logwrapper_spec.rb
 - spec/roqua/support/request_logger_spec.rb
+- spec/roqua/support/stats_spec.rb
 - spec/roqua/support_spec.rb
 - spec/spec_helper.rb

data/lib/roqua/support/logging.rb

@@ -1,26 +0,0 @@
-require 'active_support/core_ext/module/aliasing'
-require 'roqua/support/log_wrapper'
-
-module Roqua
-  module Logging
-    def self.included(base)
-      base.extend ClassMethods
-    end
-
-    module ClassMethods
-      def log(method_name, message, options = {})
-        define_method(:"#{method_name}_with_log") do |*args, &block|
-          eventlog.lifecycle(message, options) do
-            send(:"#{method_name}_without_log", *args, &block)
-          end
-        end
-
-        alias_method_chain method_name, 'log'
-      end
-    end
-
-    def eventlog
-      Roqua.logger
-    end
-  end
-end