instrumental_agent 0.7.2 → 0.8.0

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+### 0.8.0 [January 10, 2012]
+* Initial support for timing events.
+
 ### 0.7.2 [January 5, 2012]
 * Deploy durations tracking fixed.
 

data/README.md

@@ -25,8 +25,16 @@ can verify stats in one, and release them to production in another.
 Now you can begin to use Instrumental to track your application.
 
 ```sh
-I.gauge('load', 1.23)  # value at a point in time
-I.increment('signups') # increasing value, think "events"
+I.gauge('load', 1.23)                # value at a point in time
+
+I.increment('signups')               # increasing value, think "events"
+
+I.time('query_time') do              # time a block of code
+  post = Post.find(1)
+end
+I.time_ms('query_time_in_ms') do     # prefer milliseconds?
+  post = Post.find(1)
+end
 ```
 
 **Note**: For your app's safety, the agent is meant to isolate your app

data/lib/instrumental/agent.rb

@@ -84,6 +84,36 @@ module Instrumental
       nil
     end
 
+    # Store the duration of a block in a metric. multiplier can be used
+    # to scale the duration to desired unit or change the duration in
+    # some meaningful way.
+    #
+    #  agent.time('response_time') do
+    #    # potentially slow stuff
+    #  end
+    #
+    #  agent.time('response_time_in_ms', 1000) do
+    #    # potentially slow stuff
+    #  end
+    #
+    #  ids = [1, 2, 3]
+    #  agent.time('find_time_per_post', 1 / ids.size.to_f) do
+    #    Post.find(ids)
+    #  end
+    def time(metric, multiplier = 1)
+      start = Time.now
+      result = yield
+      finish = Time.now
+      duration = finish - start
+      gauge(metric, duration * multiplier, start)
+      result
+    end
+
+    # Calls time and changes durations into milliseconds.
+    def time_ms(metric, &block)
+      time(metric, 1000, &block)
+    end
+
     # Increment a metric, optionally more than one or at a specific time.
     #
     #  agent.increment('users')

data/lib/instrumental/capistrano.rb

@@ -20,8 +20,6 @@ if Capistrano::Configuration.instance
       task :record_deploy_notice do
         start_at = exists?(:instrumental_deploy_start) ? instrumental_deploy_start : Time.now
         end_at = exists?(:instrumental_deploy_end) ? instrumental_deploy_end : start_at
-        puts "@instrumental_deploy_start = #{start_at.inspect}"
-        puts "@instrumental_deploy_end = #{end_at.inspect}"
         deploy_duration_in_seconds = end_at - start_at
         deployer = Etc.getlogin.chomp
         agent_options = { :synchronous => true }

data/lib/instrumental/version.rb

@@ -1,3 +1,3 @@
 module Instrumental
-  VERSION = "0.7.2"
+  VERSION = "0.8.0"
 end

data/spec/agent_spec.rb

@@ -61,6 +61,30 @@ describe Instrumental::Agent, "enabled in test_mode" do
     @server.commands.last.should == "gauge gauge_test 123 #{now.to_i}"
   end
 
+  it "should report a time as gauge and return the block result" do
+    now = Time.now
+    @agent.time("time_value_test") do
+      sleep 0.1
+      1 + 1
+    end.should == 2
+    wait
+    @server.commands.last.should =~ /gauge time_value_test .* #{now.to_i}/
+    time = @server.commands.last.scan(/gauge time_value_test (.*) #{now.to_i}/)[0][0].to_f
+    time.should > 0.1
+  end
+
+  it "should report a time as a millisecond gauge and return the block result" do
+    now = Time.now
+    @agent.time_ms("time_ms_test") do
+      sleep 0.1
+      1 + 1
+    end.should == 2
+    wait
+    @server.commands.last.should =~ /gauge time_ms_test .* #{now.to_i}/
+    time = @server.commands.last.scan(/gauge time_ms_test (.*) #{now.to_i}/)[0][0].to_f
+    time.should > 100
+  end
+
   it "should report an increment" do
     now = Time.now
     @agent.increment("increment_test")
@@ -108,6 +132,15 @@ describe Instrumental::Agent, "enabled" do
     @server.commands.last.should == "gauge gauge_test 123 #{now.to_i}"
   end
 
+  it "should report a time as gauge and return the block result" do
+    now = Time.now
+    @agent.time("time_value_test") do
+      1 + 1
+    end.should == 2
+    wait
+    @server.commands.last.should =~ /gauge time_value_test .* #{now.to_i}/
+  end
+
   it "should return the value gauged" do
     now = Time.now
     @agent.gauge('gauge_test', 123).should == 123
@@ -209,6 +242,10 @@ describe Instrumental::Agent, "enabled" do
     wait
   end
 
+  it "should let exceptions in time bubble up" do
+    expect { @agent.time('za') { raise "fail" } }.to raise_error
+  end
+
   it "should return nil if the user overflows the MAX_BUFFER" do
     thread = @agent.instance_variable_get(:@thread)
     thread.kill

metadata

@@ -1,10 +1,15 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: instrumental_agent
-version: !ruby/object:Gem::Version
-  version: 0.7.2
+version: !ruby/object:Gem::Version 
+  hash: 63
   prerelease: 
+  segments: 
+  - 0
+  - 8
+  - 0
+  version: 0.8.0
 platform: ruby
-authors:
+authors: 
 - Elijah Miller
 - Christopher Zelenak
 - Kristopher Chambers
@@ -12,92 +17,118 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-05 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: &70284097131220 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+
+date: 2012-01-11 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
   type: :development
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: rake
+  version_requirements: *id001
   prerelease: false
-  version_requirements: *70284097131220
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: &70284097130700 !ruby/object:Gem::Requirement
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :development
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 0
+        version: "2.0"
+  name: rspec
+  version_requirements: *id002
   prerelease: false
-  version_requirements: *70284097130700
-- !ruby/object:Gem::Dependency
-  name: guard
-  requirement: &70284097130220 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+- !ruby/object:Gem::Dependency 
   type: :development
-  prerelease: false
-  version_requirements: *70284097130220
-- !ruby/object:Gem::Dependency
-  name: guard-rspec
-  requirement: &70284097129740 !ruby/object:Gem::Requirement
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: guard
+  version_requirements: *id003
   prerelease: false
-  version_requirements: *70284097129740
-- !ruby/object:Gem::Dependency
-  name: growl_notify
-  requirement: &70284097129260 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+- !ruby/object:Gem::Dependency 
   type: :development
-  prerelease: false
-  version_requirements: *70284097129260
-- !ruby/object:Gem::Dependency
-  name: rb-fsevent
-  requirement: &70284097128780 !ruby/object:Gem::Requirement
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: guard-rspec
+  version_requirements: *id004
+  prerelease: false
+- !ruby/object:Gem::Dependency 
   type: :development
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: growl_notify
+  version_requirements: *id005
   prerelease: false
-  version_requirements: *70284097128780
-- !ruby/object:Gem::Dependency
-  name: fuubar
-  requirement: &70284097128300 !ruby/object:Gem::Requirement
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: rb-fsevent
+  version_requirements: *id006
+  prerelease: false
+- !ruby/object:Gem::Dependency 
   type: :development
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: fuubar
+  version_requirements: *id007
   prerelease: false
-  version_requirements: *70284097128300
 description: Track anything.
-email:
+email: 
 - support@instrumentalapp.com
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - .gitignore
 - .rspec
 - CHANGELOG.md
@@ -116,35 +147,38 @@ files:
 - spec/test_server.rb
 homepage: http://github.com/fastestforward/instrumental_agent
 licenses: []
+
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-      segments:
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
       - 0
-      hash: 2495915029626424189
-required_rubygems_version: !ruby/object:Gem::Requirement
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-      segments:
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
       - 0
-      hash: 2495915029626424189
+      version: "0"
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 1.8.12
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Agent for reporting data to instrumentalapp.com
-test_files:
+test_files: 
 - spec/agent_spec.rb
 - spec/spec_helper.rb
 - spec/test_server.rb