metrician 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cb5521c138568656b191ac64370ca87b9bfe3668
-  data.tar.gz: e513db08fd32887b149d03488cff036fe46efcf5
+  metadata.gz: 9cf863462aef4c2b2425233de2c527f3b1286bdf
+  data.tar.gz: 461a4cafdc0255467e2b7cbf9c236c49575a2a6b
 SHA512:
-  metadata.gz: 4400530ab9c2158937cd8f09ee45ad05db2483879dbc8217eb8f2541368fbcf088388adf408b3383be432eb941046f6ff571d4bc31fc5f18528e124a0c925145
-  data.tar.gz: 2f8b7d7e207ff7aa166c0a3c254eff20f33e2958e9331a797e732da4b927679f19e314875410f890660b0839ea8379a321d7a4c3f81705d85a4456d8f6cf787b
+  metadata.gz: 8f98d615943e39c4f1257420c7bb7f301c9d3c9ecf25bdea95b6c4c083b9b4c63b85519218385b468240c550790f126b06d8355764d13f912d708d678e91ba37
+  data.tar.gz: cf46b4c1638fd04ec00d3565e6650b511ea60e37b21edbfa38248ba796b06b9f00c42998903d36bba11928182427c45b823956bb88c9402ee328c20aee0a825f

data/.travis.yml

@@ -17,7 +17,7 @@ matrix:
     - gemfile: gemfiles/Gemfile.5.0.pg
       rvm: 2.1.5
 
-before_script:
+before_install:
   - psql -c 'create database metrician_test;' -U postgres
   - mysql -e 'create database IF NOT EXISTS metrician_test;'
 

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+### 0.0.7 [August 3, 2017]
+* Allow partial config files
+* Officially require Ruby 2
+* Add separate DB command and table configs
+* Don't add method tracing function by default
+* Add example config file
+
 ### 0.0.6 [July 25, 2017]
 * Fix edge case in web error tracking
 

data/gemfiles/Gemfile.4.2.sidekiq-4.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    metrician (0.0.6)
+    metrician (0.0.7)
 
 GEM
   remote: https://rubygems.org/

data/gemfiles/Gemfile.5.0.pg.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    metrician (0.0.6)
+    metrician (0.0.7)
 
 GEM
   remote: https://rubygems.org/

data/lib/metrician/configuration.rb

@@ -7,34 +7,59 @@ module Metrician
     def self.load
       reset_dependents
 
-      if env_location
-        # this should never raise unless a bad ENV setting has been set
-        raise(FileMissing.new(env_location)) unless File.exist?(env_location)
-        return YAML.load(env_location)
-      end
-
-      if File.exist?(app_location)
-        return YAML.load_file(app_location)
+      config = {}
+      config_locations.reverse.each do |location|
+        deep_merge!(config, YAML.load_file(location)) if File.exist?(location)
       end
+      config
+    end
 
-      YAML.load_file(gem_location)
+    def self.config_locations
+      [env_location, *app_locations, gem_location].compact
     end
 
     def self.env_location
-      ENV["METRICIAN_CONFIG"]
+      path = ENV["METRICIAN_CONFIG"]
+      if path && !File.exist?(path)
+        # this should never raise unless a bad ENV setting has been set
+        raise(FileMissing.new(path))
+      end
+      path
     end
 
-    def self.app_location
-      File.join(Dir.pwd, "config", "metrician.yaml")
+    def self.app_locations
+      [
+        File.join(Dir.pwd, "config", "metrician.yaml"),
+        File.join(Dir.pwd, "config", "metrician.yml"),
+      ]
     end
 
     def self.gem_location
-      File.expand_path("../../../config/metrician.yaml", __FILE__)
+      File.expand_path("../../../metrician.defaults.yaml", __FILE__)
     end
 
     def self.reset_dependents
       Metrician::Jobs.reset
       Metrician::Middleware.reset
     end
+
+    def self.deep_merge!(this_hash, other_hash, &block)
+      return this_hash unless other_hash
+      other_hash.each_pair do |current_key, other_value|
+        this_value = this_hash[current_key]
+
+        this_hash[current_key] = if this_value.is_a?(Hash) && other_value.is_a?(Hash)
+          this_value.deep_merge(other_value, &block)
+        else
+          if block_given? && this_hash.key?(current_key)
+            block.call(current_key, this_value, other_value)
+          else
+            other_value
+          end
+        end
+      end
+
+      this_hash
+    end
   end
 end

data/lib/metrician/reporters/active_record.rb

@@ -37,11 +37,11 @@ module Metrician
       config = Metrician.configuration[:database]
       metrics = []
       metrics << "database.query" if config[:query][:enabled]
-      if config[:command][:enabled] || config[:table][:enabled]
+      if [:command, :table, :command_and_table].any?{ |key| config[key][:enabled] }
         command, table = parse_sql(sql)
         metrics << "database.#{command}" if config[:command][:enabled] && command
         metrics << "database.#{table}" if config[:table][:enabled] && table
-        metrics << "database.#{command}.#{table}" if config[:command][:enabled] && config[:table] && command && table
+        metrics << "database.#{command}.#{table}" if config[:command_and_table][:enabled] && command && table
       end
       begin
         log_without_metrician(*args, &block)

data/lib/metrician/version.rb

@@ -1,5 +1,5 @@
 module Metrician
 
-  VERSION = "0.0.6".freeze
+  VERSION = "0.0.7".freeze
 
 end

data/{config/metrician.yaml → metrician.defaults.yaml}

@@ -65,6 +65,10 @@
   :table:
     :enabled: false
 
+  # collect query information about the command issued and table executed against
+  :command_and_table:
+    :enabled: false
+
 
 # "external_service" settings control reporting metrics when Net::HTTP
 # is used to make requests
@@ -133,4 +137,4 @@
 
   # hook into Module with add_metrician_method_tracer added as a base
   # feature of every ruby object
-  :enabled: true
+  :enabled: false

data/metrician.example.yaml

@@ -0,0 +1,136 @@
+# A configuration for Metrician that controls the features of its
+# automated metric reporting
+
+---
+
+# # "request_timing" settings control the features of the Request Timing Rack Middleware
+:request_timing:
+#   # hook into Rack middleware for request timing
+#   :enabled: true
+
+#   # collect basic request timing for every request
+#   :request:
+#     :enabled: true
+
+#   # report 5xx codes as errors
+#   :error:
+#     :enabled: true
+
+#   # report time between requests in a server process as idle time
+#   :idle:
+#     :enabled: false
+
+#   # report the payload size of requests
+#   :response_size:
+#     :enabled: false
+
+#   # report the amount of time spent on middleware per request
+#   :middleware:
+#     :enabled: false
+
+#   # report the amount of time a request spent queued at the web layer
+#   # before hitting Rack
+#   :queue_time:
+#     :enabled: false
+
+#   # report the controller, action, and verb for every request
+#   :route_tracking:
+#     :enabled: false
+
+#   # "apdex" controls the recording of metrics to measure apdex
+#   # More here: https://en.wikipedia.org/wiki/Apdex
+#   # Note this requires "request" tracking to be enabled
+#   :apdex:
+#     :enabled: true
+
+#     # set the threshold (seconds), above which a request is no longer
+#     # considered "sasifactory". The "tolerates" threshold will be
+#     # 4x this number.
+#     :satisfied_threshold: 2.5
+
+# # "database" settings control ActiveRecord metric reporting features
+:database:
+#   # hook into ActiveRecord for db call timing
+#   :enabled: true
+
+#   # collect basic query tracking for every query
+#   :query:
+#     :enabled: true
+
+#   # collect generic sql query information (select, update, insert, etc.)
+#   :command:
+#     :enabled: false
+
+#   # collect query information for specific tables
+#   :table:
+#     :enabled: false
+
+
+# # "external_service" settings control reporting metrics when Net::HTTP
+# # is used to make requests
+:external_service:
+#   # hook into Net::HTTP to record timing metrics
+#   :enabled: true
+
+#   # collect basic external request timing information
+#   :request:
+#     :enabled: true
+
+
+# # "jobs" settings control reporting metrics when ruby job systems
+# # work through their queues
+:jobs:
+
+#   # hook into job system middleware when presence detected
+#   :enabled: true
+
+#   # record the basic timing of every job
+#   :run:
+#     :enabled: true
+
+#   # record when an error occurs in the a job
+#   :error:
+#     :enabled: true
+
+#   # record metrics for each kind of job that is worked from the queue
+#   :job_specific:
+#     :enabled: false
+
+# # "cache" settings control timing of commands to services often used as
+# # application caches like memcached and redis
+:cache:
+
+#   # hook into caching libraries
+#   :enabled: true
+
+#   # record aggregate timing information for all cache commands
+#   :command:
+#     :enabled: true
+
+#   # record the timing of each command as its own metric
+#   :command_specific:
+#     :enabled: false
+
+
+# # "exception" settings control reporting when exceptions are caught
+# # by an exception tracker in your application
+:exception:
+
+#   # hook into exception tracking libraries
+#   :enabled: false
+
+#   # report when an exception is raised and caught by an exception tracker
+#   :raise:
+#     :enabled: true
+
+#   # report a metric per exception type raised
+#   :exception_specific:
+#     :enabled: false
+
+# # "method_tracing" settings control hooking into Module and allowing
+# # ruby methods to be timed
+:method_tracer:
+
+#   # hook into Module with add_metrician_method_tracer added as a base
+#   # feature of every ruby object
+#   :enabled: true

data/metrician.gemspec

@@ -13,6 +13,7 @@ Gem::Specification.new do |s|
   s.metadata    = {
     "source_code_uri" => "https://github.com/Instrumental/metrician-ruby"
   }
+  s.required_ruby_version = '>= 2.0.0'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/script/setup

@@ -15,7 +15,6 @@ brew list mysql > /dev/null 2>&1 || (
 
 brew list postgresql > /dev/null 2>&1 || brew install postgresql
 
-# TODO: Install all rubies in .travis
 rbenv which ruby >/dev/null 2>&1 || (brew upgrade ruby-build || true; rbenv install)
 
 # Setup rbenv so we can switch rubies below
@@ -43,7 +42,7 @@ for ruby_version in `ruby -ryaml -e 'puts YAML.load(File.read(".travis.yml"))["r
 
   gem list -i gemika >/dev/null || gem install gemika
 
-  rake matrix:install
+  rake -t matrix:install
 done
 
 if ! psql postgres -tc "SELECT 1 FROM pg_database WHERE datname = 'metrician_test'" | grep -q 1; then

data/spec/metrician_spec.rb

@@ -10,12 +10,32 @@ end
 RSpec.describe Metrician do
   before(:each) do
     Metrician.reset
+    ENV.delete("METRICIAN_CONFIG")
   end
 
   it "has a version number" do
     Metrician::VERSION.should_not be nil
   end
 
+  it "can load config from ENV" do
+    config = {request_timing: {enabled: "test value"}}
+    t = Tempfile.new("metrician_config")
+    t.write(config.to_yaml)
+    t.flush
+    ENV["METRICIAN_CONFIG"] = t.path
+    Metrician.reset
+    Metrician.configuration[:request_timing][:enabled].should == "test value"
+  end
+
+  specify "partially defined config shouldn't error" do
+    t = Tempfile.new("metrician_config")
+    t.write({request_timing: {enabled: true}}.to_yaml)
+    t.flush
+    ENV["METRICIAN_CONFIG"] = t.path
+    Metrician.reset
+    lambda { Metrician::Jobs.run? }.should_not raise_error
+  end
+
   describe "Metrician.activate" do
     it "takes an agent" do
       # if this excepts, the world changed
@@ -70,8 +90,7 @@ RSpec.describe Metrician do
     end
 
     specify "per command and table instrumentation" do
-      Metrician.configuration[:database][:command][:enabled] = true
-      Metrician.configuration[:database][:table][:enabled] = true
+      Metrician.configuration[:database][:command_and_table][:enabled] = true
       @agent.stub(:gauge)
       @agent.should_receive(:gauge).with("database.select.users", anything)
 

data/spec/support/database.travis.yml

@@ -1,6 +1,6 @@
 mysql:
   database: metrician_test
-  username: travis
+  username: root
   password:
 
 postgresql:

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metrician
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Expected Behavior
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-25 00:00:00.000000000 Z
+date: 2017-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: instrumental_agent
@@ -114,7 +114,6 @@ files:
 - METRICS.MD
 - README.md
 - Rakefile
-- config/metrician.yaml
 - gemfiles/Gemfile.4.2.sidekiq-4
 - gemfiles/Gemfile.4.2.sidekiq-4.lock
 - gemfiles/Gemfile.5.0.pg
@@ -140,6 +139,8 @@ files:
 - lib/metrician/reporters/resque.rb
 - lib/metrician/reporters/sidekiq.rb
 - lib/metrician/version.rb
+- metrician.defaults.yaml
+- metrician.example.yaml
 - metrician.gemspec
 - script/setup
 - script/test
@@ -166,7 +167,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="