instrumental_agent 0.5.1 → 0.6.0

data/README.md

@@ -10,14 +10,17 @@ Add the gem to your Gemfile.
 gem 'instrumental_agent'
 ```
 
-Visit instrumentalapp.com[instrumentalapp.com] and create an account, then 
-initialize the agent with your API key, found in the Docs section.
+Visit instrumentalapp.com[instrumentalapp.com] and create an account,
+then  initialize the agent with your API key, found in the Docs section.
+You'll  probably want something like this, only enabling the agent in
+production mode so you don't pollute your data.
 
 ```sh
 I = Instrumental::Agent.new('YOUR_API_KEY', :test_mode => !Rails.env.production?)
 ```
 
-We recommend setting test_mode to true in dev/test modes so that you don't pollute your production data.
+You may want to setup two projects, so that you can verify stats in one,
+and release them to production in another.
 
 Now you can begin to use Instrumental to track your application.
 
@@ -26,16 +29,18 @@ I.gauge('load', 1.23)
 I.increment('signups')
 ```
 
-Data without historical context sucks. Instrumental lets you 
-backfill data, allowing you to see deep into your project's past.
+Streaming data is better with a little historical context. Instrumental
+lets you  backfill data, allowing you to see deep into your project's
+past.
 
 ```sh
+I.synchronous = true # disables command buffering
 User.find_each do |user|
   I.increment('signups', 1, user.created_at)
 end
 ```
 
-Want some general server stats (load, memory, etc.)? Install instrumental_tools and run this command (sorry not daemonized yet :)
+Want some general server stats (load, memory, etc.)? Check out the instrumental_tools gem.
 
 ```sh
 gem install instrumental_tools

data/Rakefile

@@ -1,9 +1,9 @@
 require 'bundler/gem_tasks'
-require "rspec/core/rake_task"
+require 'rspec/core/rake_task'
 
-task :default => 'spec'
+task :default => :spec
 
 RSpec::Core::RakeTask.new(:spec) do |spec|
   spec.pattern = 'spec/*_spec.rb'
-  spec.rspec_opts = ['--backtrace']
-end
+  spec.rspec_opts = ['--color --backtrace']
+end

data/lib/instrumental/agent.rb

@@ -11,9 +11,9 @@ module Instrumental
   class Agent
     BACKOFF = 2.0
     MAX_RECONNECT_DELAY = 15
-    MAX_BUFFER = 100
+    MAX_BUFFER = 5000
 
-    attr_accessor :host, :port
+    attr_accessor :host, :port, :synchronous
     attr_reader :connection, :enabled
 
     def self.logger=(l)
@@ -150,7 +150,9 @@ module Instrumental
         cmd = "%s %s\n" % [cmd, args.collect(&:to_s).join(" ")]
         if @queue.size < MAX_BUFFER
           logger.debug "Queueing: #{cmd.chomp}"
+          @main_thread = Thread.current if @synchronous
           @queue << cmd
+          Thread.stop if @synchronous
           cmd
         else
           logger.warn "Dropping command, queue full(#{@queue.size}): #{cmd.chomp}"
@@ -201,6 +203,7 @@ module Instrumental
           @socket.puts command_and_args
           command_and_args = nil
         end
+        @main_thread.run if @synchronous
       end
     rescue Exception => err
       logger.error err.to_s

data/lib/instrumental/version.rb

@@ -1,3 +1,3 @@
 module Instrumental
-  VERSION = "0.5.1"
+  VERSION = "0.6.0"
 end

data/spec/agent_spec.rb

@@ -140,6 +140,35 @@ describe Instrumental::Agent, "enabled" do
     @server.commands.last.should == "increment increment_test 1 555"
   end
 
+  it "should discard data that overflows the buffer" do
+    with_constants('Instrumental::Agent::MAX_BUFFER' => 3) do
+      5.times do |i|
+        @agent.increment('overflow_test', i + 1, 300)
+      end
+      wait
+      @server.commands.should     include("increment overflow_test 1 300")
+      @server.commands.should     include("increment overflow_test 2 300")
+      @server.commands.should     include("increment overflow_test 3 300")
+      @server.commands.should_not include("increment overflow_test 4 300")
+      @server.commands.should_not include("increment overflow_test 5 300")
+    end
+  end
+
+  it "should send all data in synchronous mode" do
+    with_constants('Instrumental::Agent::MAX_BUFFER' => 3) do
+      @agent.synchronous = true
+      5.times do |i|
+        @agent.increment('overflow_test', i + 1, 300)
+      end
+      wait # let the server receive the commands
+      @server.commands.should include("increment overflow_test 1 300")
+      @server.commands.should include("increment overflow_test 2 300")
+      @server.commands.should include("increment overflow_test 3 300")
+      @server.commands.should include("increment overflow_test 4 300")
+      @server.commands.should include("increment overflow_test 5 300")
+    end
+  end
+
   it "should automatically reconnect" do
     wait
     @server.disconnect_all

data/spec/spec_helper.rb

@@ -12,3 +12,59 @@ RSpec.configure do |config|
   end
 
 end
+
+
+def parse_constant(constant)
+  source, _, constant_name = constant.to_s.rpartition('::')
+
+  [source.constantize, constant_name]
+end
+
+def with_constants(constants, &block)
+  saved_constants = {}
+  constants.each do |constant, val|
+    source_object, const_name = parse_constant(constant)
+
+    saved_constants[constant] = source_object.const_get(const_name)
+    Kernel::silence_warnings { source_object.const_set(const_name, val) }
+  end
+
+  begin
+    block.call
+  ensure
+    constants.each do |constant, val|
+      source_object, const_name = parse_constant(constant)
+
+      Kernel::silence_warnings { source_object.const_set(const_name, saved_constants[constant]) }
+    end
+  end
+end
+alias :with_constant :with_constants
+
+class String
+  # From Rails
+  def constantize
+    names = split('::')
+    names.shift if names.empty? || names.first.empty?
+
+    constant = Object
+    names.each do |name|
+      constant = constant.const_defined?(name) ? constant.const_get(name) : constant.const_missing(name)
+    end
+    constant
+  end
+end
+
+module Kernel
+  # File activesupport/lib/active_support/core_ext/kernel/reporting.rb, line 10
+  def silence_warnings
+    with_warnings(nil) { yield }
+  end
+
+  def with_warnings(flag)
+    old_verbose, $VERBOSE = $VERBOSE, flag
+    yield
+  ensure
+    $VERBOSE = old_verbose
+  end
+end

metadata

@@ -1,102 +1,133 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: instrumental_agent
-version: !ruby/object:Gem::Version
-  version: 0.5.1
+version: !ruby/object:Gem::Version 
+  hash: 7
   prerelease: 
+  segments: 
+  - 0
+  - 6
+  - 0
+  version: 0.6.0
 platform: ruby
-authors:
+authors: 
 - Elijah Miller
 - Christopher Zelenak
 - Kristopher Chambers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-12 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2011-12-13 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  prerelease: false
   name: rake
-  requirement: &70326630447340 !ruby/object:Gem::Requirement
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 0
+        version: "2.0"
   type: :development
   prerelease: false
-  version_requirements: *70326630447340
-- !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70326630446640 !ruby/object:Gem::Requirement
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '2.0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :development
   prerelease: false
-  version_requirements: *70326630446640
-- !ruby/object:Gem::Dependency
   name: guard
-  requirement: &70326630445220 !ruby/object:Gem::Requirement
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  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"
   type: :development
   prerelease: false
-  version_requirements: *70326630445220
-- !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &70326630444280 !ruby/object:Gem::Requirement
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :development
   prerelease: false
-  version_requirements: *70326630444280
-- !ruby/object:Gem::Dependency
   name: growl_notify
-  requirement: &70326630443280 !ruby/object:Gem::Requirement
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  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"
   type: :development
   prerelease: false
-  version_requirements: *70326630443280
-- !ruby/object:Gem::Dependency
   name: rb-fsevent
-  requirement: &70326630442600 !ruby/object:Gem::Requirement
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :development
   prerelease: false
-  version_requirements: *70326630442600
-- !ruby/object:Gem::Dependency
   name: fuubar
-  requirement: &70326630441940 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: *70326630441940
+  version_requirements: *id007
 description: Keep track of anything.
-email:
+email: 
 - support@instrumentalapp.com
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - .gitignore
 - .rspec
 - Gemfile
@@ -116,29 +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'
-required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 1.8.11
+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