librato-rails 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0ce2ae4e1528ebaf9d1a0530a44b359732605e58
-  data.tar.gz: 651bd515fba4f8c855f7a7f192fa983ff8be48bf
+  metadata.gz: 8edc380bcb2f20518999f643e9c7d13174d84db6
+  data.tar.gz: da5c0130f153953623836aab0638a97f2ce4fc09
 SHA512:
-  metadata.gz: 303a719b828e20520f08a3bc6bada5383cf2abf5a9c557862e50b6a31e9b089be404442ea701b9c8ae039ff59a433c578582ce81346fc8a87f37584699720e05
-  data.tar.gz: fba27e56efb1cf238d145ea1bce403b8a23988905290b3e8486c74a05ab41c7bff3ea7b1c316ffc8272bde3367bb825ce3bdfd8dca2830972c33641cda8687d9
+  metadata.gz: de8fa725eb2a36317341c01b9ee6b4855a74e64cbcdb2840be949d3259b8a8c490fb15053721c7b558bc8beabde9f1d1bfedb1e50641eef0134eaf1e3fd9508b
+  data.tar.gz: 7e0f2ba4b6220a55d8597f12d95037e0d9a5981c527ea7ff550c4eb3989eb46e0ec6272fca60570817b45f59c046c16e5f1f25caa9bbc4184025aadad8f16538

data.tar.gz.sig

@@ -1,3 +1,3 @@
-"���R��'��/j�]
-�������4�Z�$fk[��S��Q�U�4�
-���)���$F#
+OU�'�C�d!���N'�v�b�@+j?-���2����/�hD�ٲ��|������b��T�Sy�Po'�#����IJ1E7��k�Q���j7Z��l�<��I��e>�����=�o�%(9
+f�\u�;�
+?��F��X�����'���9�Rn����[�_�)��Y�n�B�|l�74�鲜�B����G��l�.!���E����Vv+q�{RC���(�2��>j���A�j�)u*�|��}�nǍ�Ų�w

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+### Version 1.3.0
+* Add support for configurable metric suites
+
 ### Version 1.2.0
 * Allow use of Rails.application.secrets in the librato.yaml (Zack Siri)
 

data/README.md

@@ -66,6 +66,48 @@ Note that if a config file is present, _all environment variables will be ignore
 
 For more information on combining config files and environment variables, see the [full configuration docs](https://github.com/librato/librato-rails/wiki/Configuration).
 
+##### Metric Suites
+
+The metrics recorded by `librato-rails` are organized into named metric suites that can be selectively enabled/disabled:
+
+* `rack`: The `rack.request.total`, `rack.request.time`, `rack.request.slow`, and `rack.request.queue.time` metrics
+* `rack_status`: All of the `rack.request.status.*` metrics
+* `rack_method`: All of the `rack.request.method.*` metrics
+* `rails_action`: All of the `rails.action.*` metrics reported by the `instrument_action` helper
+* `rails_cache`: All of the `rails.cache.*` metrics
+* `rails_controller`: The `rails.request.total`, `rails.request.exceptions`, `rails.request.slow` and `rails.request.time.*` metrics
+* `rails_job`: All of the `rails.job.*` metrics
+* `rails_mail`: All of the `rails.mail.*` metrics
+* `rails_method`: All of the `rails.request.method.*` metrics
+* `rails_render`: All of the `rails.view.*` metrics
+* `rails_sql`: All of the `rails.sql.*` metrics
+* `rails_status`: All of the `rails.request.status.*` metrics
+
+All of the metric suites listed above are enabled by default.
+
+The metric suites can be configured via either the `LIBRATO_SUITES` environment variable or the `config/librato.yml` configuration file. The configuration syntax is the same regardless of which configuration method you use.
+
+```bash
+  LIBRATO_SUITES="rails_controller,rails_sql"  # use ONLY the rails_controller and rails_sql suites
+  LIBRATO_SUITES="+foo,+bar"                   # + prefix indicates that you want the default suites plus foo and bar
+  LIBRATO_SUITES="-rails_render"               # - prefix indicates that you want the default suites removing rails_render
+  LIBRATO_SUITES="+foo,-rack_status"           # Use all default suites except for rack_status while also adding foo
+  LIBRATO_SUITES="all"                         # Enable all suites
+  LIBRATO_SUITES="none"                        # Disable all suites
+  LIBRATO_SUITES=""                            # Use only the default suites (same as if env var is absent)
+```
+
+Note that you should EITHER specify an explict list of suites to enable OR add/subtract individual suites from the default list (using the +/- prefixes). If you try to mix these two forms a `Librato::Rack::InvalidSuiteConfiguration` error will be raised.
+
+Configuring the metric suites via the `config/librato.yml` file would look like this:
+
+```yaml
+production:
+  user: name@example.com
+  token: abc123
+  suites: 'all'
+```
+
 ##### Running on Heroku
 
 If you are using the Librato Heroku addon, your user and token environment variables will already be set in your Heroku environment. If you are running without the addon you will need to provide them yourself.

data/lib/librato/rails/configuration.rb

@@ -8,7 +8,9 @@ module Librato
     # https://github.com/librato/librato-rack/blob/master/lib/librato/rack/configuration.rb
     #
     class Configuration < Rack::Configuration
-      CONFIG_SETTABLE = %w{user token flush_interval log_level prefix source source_pids proxy}
+      CONFIG_SETTABLE = %w{user token flush_interval log_level prefix source source_pids proxy suites}
+
+      DEFAULT_SUITES = [:rails_action, :rails_cache, :rails_controller, :rails_mail, :rails_method, :rails_render, :rails_sql, :rails_status, :rails_job]
 
       attr_accessor :config_by, :config_file
 
@@ -33,6 +35,7 @@ module Librato
         # respect autorun and log_level env vars regardless of config method
         self.autorun = detect_autorun
         self.log_level = :info if log_level.blank?
+        self.suites = '' if suites.nil?
         self.log_level = ENV['LIBRATO_LOG_LEVEL'] if ENV['LIBRATO_LOG_LEVEL']
       end
 
@@ -47,6 +50,10 @@ module Librato
         end
       end
 
+      def default_suites
+        super + DEFAULT_SUITES
+      end
+
     end
   end
 end

data/lib/librato/rails/railtie.rb

@@ -39,6 +39,19 @@ module Librato
           end
         end
 
+        tracker = config.librato_rails.tracker
+        require_relative 'subscribers/action' if tracker.suite_enabled?(:rails_action)
+        require_relative 'subscribers/cache' if tracker.suite_enabled?(:rails_cache)
+        require_relative 'subscribers/controller' if tracker.suite_enabled?(:rails_controller)
+        require_relative 'subscribers/mail' if tracker.suite_enabled?(:rails_mail)
+        require_relative 'subscribers/method' if tracker.suite_enabled?(:rails_method)
+        require_relative 'subscribers/render' if tracker.suite_enabled?(:rails_render)
+        require_relative 'subscribers/sql' if tracker.suite_enabled?(:rails_sql)
+        require_relative 'subscribers/status' if tracker.suite_enabled?(:rails_status)
+
+        Librato::Rails::VersionSpecifier.supported(min: '4.2') do
+          require_relative 'subscribers/job'if tracker.suite_enabled?(:rails_job)
+        end
       end
 
     end

data/lib/librato/rails/subscribers.rb

@@ -11,16 +11,10 @@ module Librato
         @collector ||= Librato.tracker.collector
       end
 
+      def self.watch_controller_action(controller, action)
+        @watches ||= []
+        @watches << "#{controller}##{action}".freeze
+      end
     end
   end
 end
-
-require_relative 'subscribers/cache'
-require_relative 'subscribers/controller'
-require_relative 'subscribers/render'
-require_relative 'subscribers/sql'
-require_relative 'subscribers/mail'
-
-Librato::Rails::VersionSpecifier.supported(min: '4.2') do
-  require_relative 'subscribers/job'
-end

data/lib/librato/rails/subscribers/action.rb

@@ -0,0 +1,39 @@
+module Librato
+  module Rails
+    module Subscribers
+
+      # Controller Actions
+
+      ActiveSupport::Notifications.subscribe 'process_action.action_controller' do |*args|
+
+        event = ActiveSupport::Notifications::Event.new(*args)
+        controller = event.payload[:controller]
+        action = event.payload[:action]
+
+        format = event.payload[:format] || "all"
+        format = "all" if format == "*/*"
+        exception = event.payload[:exception]
+
+        if @watches && @watches.index("#{controller}##{action}")
+          source = "#{controller}.#{action}.#{format}"
+          collector.group 'rails.action.request' do |r|
+
+            r.increment 'total', source: source
+            r.increment 'slow', source: source if event.duration > 200.0
+            r.timing    'time', event.duration, source: source, percentile: 95
+
+            if exception
+              r.increment 'exceptions', source: source
+            else
+              r.timing 'time.db', event.payload[:db_runtime] || 0, source: source, percentile: 95
+              r.timing 'time.view', event.payload[:view_runtime] || 0, source: source, percentile: 95
+            end
+
+          end
+        end
+
+      end # end subscribe
+
+    end
+  end
+end

data/lib/librato/rails/subscribers/controller.rb

@@ -4,24 +4,10 @@ module Librato
 
       # Controllers
 
-      def self.watch_controller_action(controller, action)
-        @watches ||= []
-        @watches << "#{controller}##{action}".freeze
-      end
+      ActiveSupport::Notifications.subscribe 'process_action.action_controller' do |*args|
 
-      AS = ActiveSupport
-      AS::Notifications.subscribe 'process_action.action_controller' do |*args|
-
-        event = AS::Notifications::Event.new(*args)
-        controller = event.payload[:controller]
-        action = event.payload[:action]
-
-        format = event.payload[:format] || "all"
-        format = "all" if format == "*/*"
-        status = event.payload[:status]
-        http_method = event.payload[:method]
+        event = ActiveSupport::Notifications::Event.new(*args)
         exception = event.payload[:exception]
-        # page_key = "request.#{controller}.#{action}_#{format}."
 
         collector.group "rails.request" do |r|
 
@@ -35,46 +21,11 @@ module Librato
             r.timing 'time.view', event.payload[:view_runtime] || 0, percentile: 95
           end
 
-          if http_method
-            verb = http_method.to_s.downcase
-            r.group 'method' do |m|
-              m.increment verb
-              m.timing "#{verb}.time", event.duration
-            end
-          end
-
-          unless status.blank?
-            r.group 'status' do |s|
-              s.increment status
-              s.increment "#{status.to_s[0]}xx"
-              s.timing "#{status}.time", event.duration
-              s.timing "#{status.to_s[0]}xx.time", event.duration
-            end
-          end
-
           r.increment 'slow' if event.duration > 200.0
         end # end group
 
-        if @watches && @watches.index("#{controller}##{action}")
-          source = "#{controller}.#{action}.#{format}"
-          collector.group 'rails.action.request' do |r|
-
-            r.increment 'total', source: source
-            r.increment 'slow', source: source if event.duration > 200.0
-            r.timing    'time', event.duration, source: source, percentile: 95
-
-            if exception
-              r.increment 'exceptions', source: source
-            else
-              r.timing 'time.db', event.payload[:db_runtime] || 0, source: source, percentile: 95
-              r.timing 'time.view', event.payload[:view_runtime] || 0, source: source, percentile: 95
-            end
-
-          end
-        end
-
       end # end subscribe
 
     end
   end
-end
+end

data/lib/librato/rails/subscribers/method.rb

@@ -0,0 +1,25 @@
+module Librato
+  module Rails
+    module Subscribers
+
+      # Controller Method
+
+      ActiveSupport::Notifications.subscribe 'process_action.action_controller' do |*args|
+
+        event = ActiveSupport::Notifications::Event.new(*args)
+        http_method = event.payload[:method]
+
+        if http_method
+          verb = http_method.to_s.downcase
+
+          collector.group "rails.request.method" do |m|
+            m.increment verb
+            m.timing "#{verb}.time", event.duration
+          end # end group
+        end
+
+      end # end subscribe
+
+    end
+  end
+end

data/lib/librato/rails/subscribers/status.rb

@@ -0,0 +1,25 @@
+module Librato
+  module Rails
+    module Subscribers
+
+      # Controller Status
+
+      ActiveSupport::Notifications.subscribe 'process_action.action_controller' do |*args|
+
+        event = ActiveSupport::Notifications::Event.new(*args)
+        status = event.payload[:status]
+
+        unless status.blank?
+          collector.group "rails.request.status" do |s|
+            s.increment status
+            s.increment "#{status.to_s[0]}xx"
+            s.timing "#{status}.time", event.duration
+            s.timing "#{status.to_s[0]}xx.time", event.duration
+          end # end group
+        end
+
+      end # end subscribe
+
+    end
+  end
+end

data/lib/librato/rails/version.rb

@@ -1,5 +1,5 @@
 module Librato
   module Rails
-    VERSION = "1.2.0"
+    VERSION = "1.3.0"
   end
 end

data/test/fixtures/config/librato.yml

@@ -6,6 +6,7 @@ test:
   source: 'custom-1'
   source_pids: false
   proxy: 'http://localhost:8080'
+  suites: all
   
 production:
   user: 'live@bar.com'

data/test/unit/configuration_test.rb

@@ -18,21 +18,12 @@ module Librato
         ENV['LIBRATO_USER'] = 'foo@bar.com'
         ENV['LIBRATO_TOKEN'] = 'api_key'
         ENV['LIBRATO_SOURCE'] = 'source'
+        ENV['LIBRATO_SUITES'] = 'all'
         config = Configuration.new
         assert_equal 'foo@bar.com', config.user
         assert_equal 'api_key', config.token
         assert_equal 'source', config.source
-        assert config.explicit_source?, 'source is explicit'
-      end
-
-      def test_legacy_env_variable_config
-        ENV['LIBRATO_METRICS_USER'] = 'foo@bar.com'
-        ENV['LIBRATO_METRICS_TOKEN'] = 'api_key'
-        ENV['LIBRATO_METRICS_SOURCE'] = 'source'
-        config = Configuration.new
-        assert_equal 'foo@bar.com', config.user
-        assert_equal 'api_key', config.token
-        assert_equal 'source', config.source
+        assert_equal 'all', config.suites
         assert config.explicit_source?, 'source is explicit'
       end
 
@@ -45,6 +36,7 @@ module Librato
         assert_equal 'custom-1', config.source
         assert_equal false, config.source_pids
         assert_equal 'http://localhost:8080', config.proxy
+        assert_equal 'all', config.suites
         assert config.explicit_source?, 'source is explicit'
       end
 
@@ -71,6 +63,26 @@ module Librato
         assert_equal :info, config.log_level, 'should be default'
       end
 
+      def test_empty_config_file_doesnt_break_suites
+        config = fixture_config('empty')
+        assert_equal '', config.suites, 'should be default'
+      end
+
+      def test_default_suites
+        defaults = Configuration.new.send(:default_suites)
+        assert_includes defaults, :rack
+        assert_includes defaults, :rack_method
+        assert_includes defaults, :rack_status
+        assert_includes defaults, :rails_cache
+        assert_includes defaults, :rails_controller
+        assert_includes defaults, :rails_mail
+        assert_includes defaults, :rails_method
+        assert_includes defaults, :rails_render
+        assert_includes defaults, :rails_sql
+        assert_includes defaults, :rails_status
+        assert_includes defaults, :rails_job
+      end
+
       def fixture_config(file='librato')
         fixture_config = File.join(File.dirname(__FILE__), "../fixtures/config/#{file}.yml")
         Configuration.new(:config_file => fixture_config)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: librato-rails
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Matt Sanders
@@ -29,7 +29,7 @@ cert_chain:
   hvjx0WJP8pzZMJPKJBRZQXJO5ifEPyKjZyMi5XMHmrtDclHLj3sx4RAvEZjGWkRP
   JSQ=
   -----END CERTIFICATE-----
-date: 2016-03-09 00:00:00.000000000 Z
+date: 2016-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -65,14 +65,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -135,12 +135,15 @@ files:
 - lib/librato/rails/helpers/controller.rb
 - lib/librato/rails/railtie.rb
 - lib/librato/rails/subscribers.rb
+- lib/librato/rails/subscribers/action.rb
 - lib/librato/rails/subscribers/cache.rb
 - lib/librato/rails/subscribers/controller.rb
 - lib/librato/rails/subscribers/job.rb
 - lib/librato/rails/subscribers/mail.rb
+- lib/librato/rails/subscribers/method.rb
 - lib/librato/rails/subscribers/render.rb
 - lib/librato/rails/subscribers/sql.rb
+- lib/librato/rails/subscribers/status.rb
 - lib/librato/rails/tracker.rb
 - lib/librato/rails/version.rb
 - lib/librato/rails/version_specifier.rb