librato-rails 0.7.3 → 0.8.0

data/README.md

@@ -35,7 +35,7 @@ Note that using a configuration file allows you to specify different configurati
 
 ##### Use environment variables
 
-Alternately you can provide `LIBRATO_METRICS_USER` and `LIBRATO_METRICS_TOKEN` environment variables. Unlike config file settings, environment variables will be used in all non-test environments (development, production, etc).  
+Alternately you can provide `LIBRATO_USER` and `LIBRATO_TOKEN` environment variables. Unlike config file settings, environment variables will be used in all non-test environments (development, production, etc).  
 
 Note that if a config file is present, _all environment variables will be ignored_.
 
@@ -47,7 +47,7 @@ If you are using the Librato Metrics Heroku addon, your user and token environme
 
 In either case you will need to specify a custom source for your app to track properly. If `librato-rails` does not detect an explicit source it will not start. You can set the source in your environment:
 
-    heroku config:add LIBRATO_METRICS_SOURCE=myappname
+    heroku config:add LIBRATO_SOURCE=myappname
     
 If you are using a config file, add your source entry to that instead.
 

data/lib/librato/rack/middleware.rb

@@ -4,7 +4,7 @@ class Librato::Rack::Middleware
   end
 
   def call(env)
-    @metrics.check_worker if @metrics.send(:forking_server?)
+    @metrics.check_worker
 
     header_metrics env
 

data/lib/librato/rails/configuration.rb

@@ -0,0 +1,52 @@
+module Librato
+  module Rails
+    module Configuration
+      CONFIG_SETTABLE = %w{user token flush_interval log_level prefix source source_pids}
+
+      mattr_accessor :config_file
+      self.config_file = 'config/librato.yml'
+
+      # set custom api endpoint
+      def api_endpoint=(endpoint)
+        @api_endpoint = endpoint
+      end
+
+      # detect / update configuration
+      def check_config
+        self.log_level = ENV['LIBRATO_LOG_LEVEL'] if ENV['LIBRATO_LOG_LEVEL']
+        if self.config_file && File.exists?(self.config_file)
+          configure_with_config_file
+        else
+          configure_with_environment
+        end
+      end
+
+      private
+
+      def configure_with_config_file
+        log :debug, "configuring with librato.yml; ignoring environment variables.."
+        if env_specific = YAML.load(ERB.new(File.read(config_file)).result)[::Rails.env]
+          settable = CONFIG_SETTABLE & env_specific.keys
+          settable.each { |key| self.send("#{key}=", env_specific[key]) }
+        else
+          log :debug, "halting: current environment (#{::Rails.env}) not in config file."
+        end
+      end
+
+      def configure_with_environment
+        log :debug, "using environment variables for configuration.."
+        %w{user token source log_level prefix}.each do |settable|
+          legacy_env_var = "LIBRATO_METRICS_#{settable.upcase}"
+          if ENV[legacy_env_var]
+            log :warn, "#{legacy_env_var} is deprecated, use LIBRATO_#{settable.upcase} instead"
+            send("#{settable}=", ENV[legacy_env_var])
+          end
+          # if both are present, new-style dominates
+          env_var = "LIBRATO_#{settable.upcase}"
+          send("#{settable}=", ENV[env_var]) if ENV[env_var]
+        end
+      end
+
+    end
+  end
+end

data/lib/librato/rails/logging.rb

@@ -0,0 +1,75 @@
+module Librato::Rails
+  module Logging
+    LOG_LEVELS = [:off, :error, :warn, :info, :debug, :trace]
+
+    # ex: log :debug, 'this is a debug message'
+    def log(level, message)
+      return unless should_log?(level)
+      case level
+      when :error, :warn
+        method = level
+      else
+        method = :info
+      end
+      message = '[librato-rails] ' << message
+      logger.send(method, message)
+    end
+
+    # set log level to any of LOG_LEVELS
+    def log_level=(level)
+      level = level.to_sym
+      if LOG_LEVELS.index(level)
+        @log_level = level
+        require 'pp' if should_log?(:debug)
+      else
+        raise "Invalid log level '#{level}'"
+      end
+    end
+
+    def log_level
+      @log_level ||= :info
+    end
+
+    private
+
+    def logger
+      @logger ||= if on_heroku
+        logger = Logger.new(STDOUT)
+        logger.level = Logger::INFO
+        logger
+      else
+        ::Rails.logger
+      end
+    end
+
+    def should_log?(level)
+      LOG_LEVELS.index(self.log_level) >= LOG_LEVELS.index(level)
+    end
+
+    # trace current environment
+    def trace_environment
+      log :info, "Environment: " + ENV.pretty_inspect
+    end
+
+    # trace metrics being sent
+    def trace_queued(queued)
+      log :trace, "Queued: " + queued.pretty_inspect
+    end
+
+    def trace_settings
+      settings = {
+        :user => self.user,
+        :token => self.token,
+        :source => source,
+        :explicit_source => self.explicit_source ? 'true' : 'false',
+        :source_pids => self.source_pids ? 'true' : 'false',
+        :qualified_source => qualified_source,
+        :log_level => log_level,
+        :prefix => prefix,
+        :flush_interval => self.flush_interval
+      }
+      log :info, 'Settings: ' + settings.pretty_inspect
+    end
+
+  end
+end

data/lib/librato/rails/version.rb

@@ -1,5 +1,5 @@
 module Librato
   module Rails
-    VERSION = "0.7.3"
+    VERSION = "0.8.0"
   end
 end

data/lib/librato/rails.rb

@@ -8,8 +8,10 @@ require 'librato/metrics'
 require 'librato/rack'
 require 'librato/rails/aggregator'
 require 'librato/rails/collector'
+require 'librato/rails/configuration'
 require 'librato/rails/counter_cache'
 require 'librato/rails/group'
+require 'librato/rails/logging'
 require 'librato/rails/validating_queue'
 require 'librato/rails/version'
 require 'librato/rails/worker'
@@ -20,14 +22,12 @@ module Librato
 
   module Rails
     extend SingleForwardable
-    CONFIG_SETTABLE = %w{user token flush_interval log_level prefix source source_pids}
+    extend Librato::Rails::Configuration
+    extend Librato::Rails::Logging
+
     FORKING_SERVERS = [:unicorn, :passenger]
-    LOG_LEVELS = [:off, :error, :warn, :info, :debug, :trace]
     SOURCE_REGEX = /\A[-:A-Za-z0-9_.]{1,255}\z/
 
-    mattr_accessor :config_file
-    self.config_file = 'config/librato.yml'
-
     # config options
     mattr_accessor :user
     mattr_accessor :token
@@ -49,31 +49,6 @@ module Librato
 
     class << self
 
-      # set custom api endpoint
-      def api_endpoint=(endpoint)
-        @api_endpoint = endpoint
-      end
-
-      # detect / update configuration
-      def check_config
-        self.log_level = ENV['LIBRATO_METRICS_LOG_LEVEL'] if ENV['LIBRATO_METRICS_LOG_LEVEL']
-        if self.config_file && File.exists?(self.config_file)
-          log :debug, "configuring with librato.yml; ignoring environment variables.."
-          if env_specific = YAML.load(ERB.new(File.read(config_file)).result)[::Rails.env]
-            settable = CONFIG_SETTABLE & env_specific.keys
-            settable.each { |key| self.send("#{key}=", env_specific[key]) }
-          else
-            log :debug, "current environment not in config file, halting"
-          end
-        else
-          log :debug, "using environment variables for configuration.."
-          %w{user token source log_level}.each do |settable|
-            env_var = "LIBRATO_METRICS_#{settable.upcase}"
-            send("#{settable}=", ENV[env_var]) if ENV[env_var]
-          end
-        end
-      end
-
       # check to see if we've forked into a process where a worker
       # isn't running yet, if so start it up!
       def check_worker
@@ -109,33 +84,6 @@ module Librato
         log :error, "submission failed permanently: #{error}"
       end
 
-      def log(level, message)
-        return unless should_log?(level)
-        case level
-        when :error, :warn
-          method = level
-        else
-          method = :info
-        end
-        message = '[librato-rails] ' << message
-        logger.send(method, message)
-      end
-
-      # set log level to any of LOG_LEVELS
-      def log_level=(level)
-        level = level.to_sym
-        if LOG_LEVELS.index(level)
-          @log_level = level
-          require 'pp' if should_log?(:debug)
-        else
-          raise "Invalid log level '#{level}'"
-        end
-      end
-
-      def log_level
-        @log_level ||= :info
-      end
-
       # source including process pid
       def qualified_source
         self.source_pids ? "#{source}.#{$$}" : source
@@ -210,16 +158,6 @@ module Librato
         FORKING_SERVERS.include?(app_server)
       end
 
-      def logger
-        @logger ||= if on_heroku
-          logger = Logger.new(STDOUT)
-          logger.level = Logger::INFO
-          logger
-        else
-          ::Rails.logger
-        end
-      end
-
       def on_heroku
         # would be nice to have something more specific here,
         # but nothing characteristic in ENV, etc.
@@ -240,10 +178,6 @@ module Librato
         RUBY_DESCRIPTION.split[0]
       end
 
-      def should_log?(level)
-        LOG_LEVELS.index(self.log_level) >= LOG_LEVELS.index(level)
-      end
-
       def should_start?
         if !self.user || !self.token
           # don't show this unless we're debugging, expected behavior
@@ -264,31 +198,6 @@ module Librato
         source =~ /[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}/i
       end
 
-      # trace current environment
-      def trace_environment
-        log :info, "Environment: " + ENV.pretty_inspect
-      end
-
-      # trace metrics being sent
-      def trace_queued(queued)
-        log :trace, "Queued: " + queued.pretty_inspect
-      end
-
-      def trace_settings
-        settings = {
-          :user => self.user,
-          :token => self.token,
-          :source => source,
-          :explicit_source => self.explicit_source ? 'true' : 'false',
-          :source_pids => self.source_pids ? 'true' : 'false',
-          :qualified_source => qualified_source,
-          :log_level => log_level,
-          :prefix => prefix,
-          :flush_interval => self.flush_interval
-        }
-        log :info, 'Settings: ' + settings.pretty_inspect
-      end
-
       def user_agent
         ua_chunks = []
         ua_chunks << "librato-rails/#{Librato::Rails::VERSION}"

data/test/unit/configuration_test.rb

@@ -7,6 +7,10 @@ class LibratoRailsConfigTest < MiniTest::Unit::TestCase
   end
 
   def teardown
+    ENV.delete('LIBRATO_USER')
+    ENV.delete('LIBRATO_TOKEN')
+    ENV.delete('LIBRATO_SOURCE')
+    # legacy
     ENV.delete('LIBRATO_METRICS_USER')
     ENV.delete('LIBRATO_METRICS_TOKEN')
     ENV.delete('LIBRATO_METRICS_SOURCE')
@@ -16,6 +20,17 @@ class LibratoRailsConfigTest < MiniTest::Unit::TestCase
   end
 
   def test_environmental_variable_config
+    ENV['LIBRATO_USER'] = 'foo@bar.com'
+    ENV['LIBRATO_TOKEN'] = 'api_key'
+    ENV['LIBRATO_SOURCE'] = 'source'
+    Librato::Rails.check_config
+    assert_equal 'foo@bar.com', Librato::Rails.user
+    assert_equal 'api_key', Librato::Rails.token
+    assert_equal 'source', Librato::Rails.source
+    assert Librato::Rails.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'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: librato-rails
 version: !ruby/object:Gem::Version
-  version: 0.7.3
+  version: 0.8.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-09 00:00:00.000000000 Z
+date: 2012-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -87,8 +87,10 @@ files:
 - lib/librato/rack.rb
 - lib/librato/rails/aggregator.rb
 - lib/librato/rails/collector.rb
+- lib/librato/rails/configuration.rb
 - lib/librato/rails/counter_cache.rb
 - lib/librato/rails/group.rb
+- lib/librato/rails/logging.rb
 - lib/librato/rails/railtie.rb
 - lib/librato/rails/subscribers.rb
 - lib/librato/rails/validating_queue.rb
@@ -137,12 +139,8 @@ files:
 - test/dummy/config/routes.rb
 - test/dummy/config/unicorn.rb
 - test/dummy/config.ru
-- test/dummy/db/development.sqlite3
 - test/dummy/db/migrate/20120719231810_create_users.rb
 - test/dummy/db/schema.rb
-- test/dummy/db/test.sqlite3
-- test/dummy/log/development.log
-- test/dummy/log/test.log
 - test/dummy/public/404.html
 - test/dummy/public/422.html
 - test/dummy/public/500.html
@@ -150,24 +148,6 @@ files:
 - test/dummy/Rakefile
 - test/dummy/README.rdoc
 - test/dummy/script/rails
-- test/dummy/tmp/cache/assets/CBF/9D0/sprockets%2F541895701c40c7d7fd678356b18cb59d
-- test/dummy/tmp/cache/assets/CD8/370/sprockets%2F357970feca3ac29060c1e3861e2c0953
-- test/dummy/tmp/cache/assets/CDF/870/sprockets%2Fb878faf942403e313a5b103e5d80488e
-- test/dummy/tmp/cache/assets/CE8/7E0/sprockets%2F178e2a1f9aa891d473009c7f3095df28
-- test/dummy/tmp/cache/assets/CF9/7C0/sprockets%2F40fc2f3d2a468a00e463f1d313cb1683
-- test/dummy/tmp/cache/assets/D02/220/sprockets%2F1410fa948b990522bdfeca7841d31b13
-- test/dummy/tmp/cache/assets/D04/890/sprockets%2F587335c079eef8d5a63784fc8f99905a
-- test/dummy/tmp/cache/assets/D05/D40/sprockets%2F1c9faaf28d05409b88ad3113374d613c
-- test/dummy/tmp/cache/assets/D19/710/sprockets%2F5b878936d488c1f601c231fda1d678ea
-- test/dummy/tmp/cache/assets/D32/A10/sprockets%2F13fe41fee1fe35b49d145bcc06610705
-- test/dummy/tmp/cache/assets/D4E/1B0/sprockets%2Ff7cbd26ba1d28d48de824f0e94586655
-- test/dummy/tmp/cache/assets/D4F/000/sprockets%2F25e44896aac12384727e9dab827ebef9
-- test/dummy/tmp/cache/assets/D5A/EA0/sprockets%2Fd771ace226fc8215a3572e0aa35bb0d6
-- test/dummy/tmp/cache/assets/D69/610/sprockets%2F3902e4b1ffbdb61222bf5fc45a44799a
-- test/dummy/tmp/cache/assets/D8B/F90/sprockets%2Ffe6ce696e9141eb755d8eed79128e17c
-- test/dummy/tmp/cache/assets/D98/8B0/sprockets%2Fedbef6e0d0a4742346cf479f2c522eb0
-- test/dummy/tmp/cache/assets/DDC/400/sprockets%2Fcffd775d018f68ce5dba1ee0d951a994
-- test/dummy/tmp/cache/assets/E04/890/sprockets%2F2f5173deea6c795b8fdde723bb4b63af
 - test/fixtures/config/librato.yml
 - test/fixtures/config/simple.yml
 - test/integration/custom_test.rb
@@ -196,18 +176,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 1346909575512186282
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 1346909575512186282
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
@@ -252,12 +226,8 @@ test_files:
 - test/dummy/config/routes.rb
 - test/dummy/config/unicorn.rb
 - test/dummy/config.ru
-- test/dummy/db/development.sqlite3
 - test/dummy/db/migrate/20120719231810_create_users.rb
 - test/dummy/db/schema.rb
-- test/dummy/db/test.sqlite3
-- test/dummy/log/development.log
-- test/dummy/log/test.log
 - test/dummy/public/404.html
 - test/dummy/public/422.html
 - test/dummy/public/500.html
@@ -265,24 +235,6 @@ test_files:
 - test/dummy/Rakefile
 - test/dummy/README.rdoc
 - test/dummy/script/rails
-- test/dummy/tmp/cache/assets/CBF/9D0/sprockets%2F541895701c40c7d7fd678356b18cb59d
-- test/dummy/tmp/cache/assets/CD8/370/sprockets%2F357970feca3ac29060c1e3861e2c0953
-- test/dummy/tmp/cache/assets/CDF/870/sprockets%2Fb878faf942403e313a5b103e5d80488e
-- test/dummy/tmp/cache/assets/CE8/7E0/sprockets%2F178e2a1f9aa891d473009c7f3095df28
-- test/dummy/tmp/cache/assets/CF9/7C0/sprockets%2F40fc2f3d2a468a00e463f1d313cb1683
-- test/dummy/tmp/cache/assets/D02/220/sprockets%2F1410fa948b990522bdfeca7841d31b13
-- test/dummy/tmp/cache/assets/D04/890/sprockets%2F587335c079eef8d5a63784fc8f99905a
-- test/dummy/tmp/cache/assets/D05/D40/sprockets%2F1c9faaf28d05409b88ad3113374d613c
-- test/dummy/tmp/cache/assets/D19/710/sprockets%2F5b878936d488c1f601c231fda1d678ea
-- test/dummy/tmp/cache/assets/D32/A10/sprockets%2F13fe41fee1fe35b49d145bcc06610705
-- test/dummy/tmp/cache/assets/D4E/1B0/sprockets%2Ff7cbd26ba1d28d48de824f0e94586655
-- test/dummy/tmp/cache/assets/D4F/000/sprockets%2F25e44896aac12384727e9dab827ebef9
-- test/dummy/tmp/cache/assets/D5A/EA0/sprockets%2Fd771ace226fc8215a3572e0aa35bb0d6
-- test/dummy/tmp/cache/assets/D69/610/sprockets%2F3902e4b1ffbdb61222bf5fc45a44799a
-- test/dummy/tmp/cache/assets/D8B/F90/sprockets%2Ffe6ce696e9141eb755d8eed79128e17c
-- test/dummy/tmp/cache/assets/D98/8B0/sprockets%2Fedbef6e0d0a4742346cf479f2c522eb0
-- test/dummy/tmp/cache/assets/DDC/400/sprockets%2Fcffd775d018f68ce5dba1ee0d951a994
-- test/dummy/tmp/cache/assets/E04/890/sprockets%2F2f5173deea6c795b8fdde723bb4b63af
 - test/fixtures/config/librato.yml
 - test/fixtures/config/simple.yml
 - test/integration/custom_test.rb