instrumental_agent 0.6.1 → 0.7

data/CHANGELOG.md

@@ -0,0 +1,57 @@
+### 0.7 [January 2, 2012]
+* .notice added to API to allow tracking project-wide events on graphs
+* Removed Rack middleware
+* Logs to STDERR instead of /dev/null
+* Synchronous mode can be specified in agent initialization contributed by [janxious] from (https://github.com/expectedbehavior/)
+* Added CHANGELOG :)
+
+### 0.6.1 [December 16, 2011]
+* Documentation cleanup
+
+### 0.6 [December 13, 2011]
+* Synchronous agent support to allow blocking send of metrics
+* Message buffer increased to 5000
+* Code cleanup
+
+### 0.5.1 [December 12, 2011]
+* instrument_server moved to instrumental_tools gem (https://github.com/fastestforward/instrumental_tools)
+
+### 0.5 [December 9, 2011]
+* Allow negative numbers to be submitted
+* agent logger now can be configured per instance
+* Better RSpec formatting for tests
+
+### 0.4 [December 1, 2011]
+* Support reconnecting on fork() for forking servers like Passenger
+
+### 0.3 [November 17, 2011]
+* Support for test_mode on agent to cause submitted metrics to be thrown away when it reaches Instrumental servers
+* Fix version not being sent in agent hello
+* Exceptions in agent get swallowed and reported to logger
+
+### 0.2 [November 15, 2011]
+* Refactored agent to use TCPSocket instead of EventMachine
+
+### 0.1.6 [November 14, 2011]
+* Middleware doesn't automatically inject itself into Rack middleware stack
+
+### 0.1.5 [November 1, 2011]
+* Documentation changes
+
+### 0.1.4 [November 1, 2011]
+* Documentation changes
+
+### 0.1.3 [October 31, 2011]
+* Rename the watch_server command to instrument_server
+* Documentation changes
+
+### 0.1.2 [October 30, 2011]
+* Add enabled flag to control agent use in test/non-development environments
+* watch_server runs every 10s
+
+### 0.1.1 [October 27, 2011]
+* Linux support for watch_server
+* Documentation changes
+
+### 0.1 [OCtober 27, 2011]
+* Initial version

data/README.md

@@ -34,6 +34,14 @@ from any problems our service might suffer. If it is unable to connect
 to the service, it will discard data after reaching a low memory
 threshold.
 
+Want to track an event (like an application deploy, or downtime)? You can capture events that
+are instantaneous, or events that happen over a period of time.
+
+```sh
+I.notice('Jeffy deployed rev ef3d6a') # instantaneous event
+I.notice('Testing socket buffer increase', 3.days.ago, 20.minutes) # an event with a duration
+```
+
 ## Backfilling
 
 Streaming data is better with a little historical context. Instrumental
@@ -56,7 +64,7 @@ User.find_each do |user|
 end
 ```
 
-## Server stats
+## Server Stats
 
 Want some general server stats (load, memory, etc.)? Check out the
 [instrumental_tools](https://github.com/fastestforward/instrumental_tools)
@@ -67,18 +75,27 @@ gem install instrumental_tools
 instrument_server
 ```
 
-## Rack middleware
-
-Running under Rails? You can also give our experimental Rack middleware 
-a shot by initializing it with:
-
-```sh
-Instrumental::Middleware.boot
-```
+## Agent Control
 
 Need to quickly disable the agent? set :enabled to false on
 initialization and you don't need to change any application code.
 
+
+## Capistrano Integration
+
+Add `require "instrumental/capistrano"` to your capistrano configuration
+and your deploys will be tracked automatically by Instrumental.
+
+The following configuration will be added:
+
+```ruby
+before "deploy", "instrumental:util:deploy_start"
+after  "deploy", "instrumental:util:deploy_end"
+before "deploy:migrations", "instrumental:util:deploy_start"
+after  "deploy:migrations", "instrumental:util:deploy_end"
+after  "instrumental:util:deploy_end", "instrumental:record_deploy_notice"
+```
+
 ## Troubleshooting & Help
 
 We are here to help, please email us at

data/instrumental_agent.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |s|
   s.email       = ["support@instrumentalapp.com"]
   s.homepage    = "http://github.com/fastestforward/instrumental_agent"
   s.summary     = %q{Agent for reporting data to instrumentalapp.com}
-  s.description = %q{Keep track of anything.}
+  s.description = %q{Track anything.}
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/lib/instrumental/agent.rb

@@ -20,8 +20,12 @@ module Instrumental
       @logger = l
     end
 
-    def self.logger(force = false)
-      @logger ||= Logger.new(File.open('/dev/null', 'a')) # append mode so it's forksafe
+    def self.logger
+      if !@logger 
+        @logger = Logger.new(STDERR)
+        @logger.level = Logger::WARN
+      end
+      @logger
     end
 
     def self.all
@@ -40,18 +44,20 @@ module Instrumental
     #  Instrumental::Agent.new(API_KEY, :collector => 'hostname:port')
     def initialize(api_key, options = {})
       default_options = {
-        :collector => 'instrumentalapp.com:8000',
-        :enabled   => true,
-        :test_mode => false,
+        :collector  => 'instrumentalapp.com:8000',
+        :enabled    => true,
+        :test_mode  => false,
+        :synchronous => false
       }
       options   = default_options.merge(options)
       collector = options[:collector].split(':')
 
-      @api_key   = api_key
-      @host      = collector[0]
-      @port      = (collector[1] || 8000).to_i
-      @enabled   = options[:enabled]
-      @test_mode = options[:test_mode]
+      @api_key     = api_key
+      @host        = collector[0]
+      @port        = (collector[1] || 8000).to_i
+      @enabled     = options[:enabled]
+      @test_mode   = options[:test_mode]
+      @synchronous = options[:synchronous]
       @pid = Process.pid
 
 
@@ -93,6 +99,21 @@ module Instrumental
       nil
     end
 
+    # Send a notice to the server (deploys, downtime, etc.)
+    #
+    # agent.notice('A notice')
+    def notice(note, time = Time.now, duration = 0)
+      if valid_note?(note)
+        send_command("notice", time.to_i, duration.to_i, note)
+        note
+      else
+        nil
+      end
+    rescue Exception => e
+      report_exception(e)
+      nil
+    end
+
     def enabled?
       @enabled
     end
@@ -111,6 +132,10 @@ module Instrumental
 
     private
 
+    def valid_note?(note)
+      note !~ /[\n\r]/
+    end
+
     def valid?(metric, value, time)
       valid_metric = metric =~ /^([\d\w\-_]+\.)*[\d\w\-_]+$/i
       valid_value  = value.to_s =~ /^-?\d+(\.\d+)?$/
@@ -209,7 +234,7 @@ module Instrumental
       logger.error err.to_s
       if command_and_args
         logger.debug "requeueing: #{command_and_args}"
-        @queue << command_and_args 
+        @queue << command_and_args
       end
       disconnect
       @failures += 1

data/lib/instrumental/capistrano.rb

@@ -0,0 +1,42 @@
+require 'capistrano'
+require 'instrumental_agent'
+
+if Capistrano::Configuration.instance
+  Capistrano::Configuration.instance.load do
+    namespace :instrumental do
+      namespace :util do
+        desc "marker for beginning of deploy"
+        task :deploy_start do
+          @instrumental_deploy_start = Time.now
+        end
+
+        desc "marker for end of deploy"
+        task :deploy_end do
+          @instrumental_deploy_end = Time.now
+        end
+      end
+
+      desc "send a notice to instrumental about the deploy"
+      task :record_deploy_notice do
+        @instrumental_deploy_start ||= Time.now
+        @instrumental_deploy_end   ||= Time.now
+        deploy_duration_in_seconds = (@instrumental_deploy_end - @instrumental_deploy_start).to_i
+        deployer = Etc.getlogin.chomp
+        agent_options = {}
+        agent_options[:collector] = instrumental_host if exists?(:instrumental_host)
+        agent = Instrumental::Agent.new(instrumental_key, agent_options)
+        agent.synchronous = true
+        agent.notice("#{deployer} deployed #{current_revision}",
+                     @instrumental_deploy_start,
+                     deploy_duration_in_seconds)
+        logger.info("Notified Instrumental of deployment")
+      end
+    end
+
+    before "deploy", "instrumental:util:deploy_start"
+    after  "deploy", "instrumental:util:deploy_end"
+    before "deploy:migrations", "instrumental:util:deploy_start"
+    after  "deploy:migrations", "instrumental:util:deploy_end"
+    after  "instrumental:util:deploy_end", "instrumental:record_deploy_notice"
+  end
+end

data/lib/instrumental/rack/middleware.rb

@@ -1,85 +1,7 @@
 module Instrumental
   class Middleware
     def self.boot
-      if @stack = detect_stack
-        @stack.install_middleware
-        @enabled = true
-      else
-        @enabled = false
-      end
-    end
-
-    def self.stack; @stack; end
-
-    def self.enabled; @enabled; end
-    def self.enabled=(v); @enabled = v; end
-
-    def initialize(app)
-      @app = app
-    end
-
-    def stack
-      Middleware.stack
-    end
-
-    def measure(env, &block)
-      response = nil
-      if Middleware.enabled
-        request = Rack::Request.new(env)
-        key_parts = stack.recognize_uri(request)
-        if key = key_parts.join(".")
-          exc = nil
-          tms = Benchmark.measure do
-            begin
-              response = yield
-            rescue Exception => e
-              exc = e
-            end
-          end
-          begin
-            Agent.all.each do |agent|
-              if exc
-                agent.increment("%s.error.%s" % [key, exc.class])
-              end
-              if response && response.first
-                agent.increment("%s.status.%i" % [key, response.first])
-              else
-                agent.increment(key)
-              end
-            end
-          rescue Exception => e
-            stack.log "Error occurred sending stats: #{e}"
-            stack.log e.backtrace.join("\n")
-          end
-          raise exc if exc
-        end
-      end
-      response ||= yield
-    end
-
-    def call(env)
-      measure(env) do
-        @app.call(env)
-      end
-    end
-
-    class Stack
-      def self.default_logger
-        @logger ||= Logger.new('/dev/null')
-      end
-
-      def log(msg)
-        Stack.default_logger.error(msg)
-      end
-    end
-
-    private
-
-    def self.detect_stack
-      [Rails3, Rails23].collect { |klass| klass.create }.detect { |obj| !obj.nil? }
+      Instrumental::Agent.logger.warn "The Instrumental Rails middlware has been removed - contact support@instrumentalapp.com for more information"
     end
   end
 end
-
-require 'instrumental/rack/rails3'
-require 'instrumental/rack/rails23'

data/lib/instrumental/version.rb

@@ -1,3 +1,3 @@
 module Instrumental
-  VERSION = "0.6.1"
+  VERSION = "0.7"
 end

data/spec/agent_spec.rb

@@ -6,6 +6,7 @@ end
 
 describe Instrumental::Agent, "disabled" do
   before do
+    Instrumental::Agent.logger.level = Logger::UNKNOWN
     @server = TestServer.new
     @agent = Instrumental::Agent.new('test_token', :collector => @server.host_and_port, :enabled => false)
   end
@@ -66,12 +67,19 @@ describe Instrumental::Agent, "enabled in test_mode" do
     wait
     @server.commands.last.should == "increment increment_test 1 #{now.to_i}"
   end
+
+  it "should send notices to the server" do
+    tm = Time.now
+    @agent.notice("Test note", tm)
+    wait
+    @server.commands.join("\n").should include("notice #{tm.to_i} 0 Test note")
+  end
 end
 
 describe Instrumental::Agent, "enabled" do
   before do
     @server = TestServer.new
-    @agent = Instrumental::Agent.new('test_token', :collector => @server.host_and_port)
+    @agent = Instrumental::Agent.new('test_token', :collector => @server.host_and_port, :synchronous => false)
   end
 
   after do
@@ -244,4 +252,38 @@ describe Instrumental::Agent, "enabled" do
     wait
     @server.commands.join("\n").should_not include("increment agent.invalid_value")
   end
+
+  it "should send notices to the server" do
+    tm = Time.now
+    @agent.notice("Test note", tm)
+    wait
+    @server.commands.join("\n").should include("notice #{tm.to_i} 0 Test note")
+  end
+
+  it "should prevent a note w/ newline characters from being sent to the server" do
+    @agent.notice("Test note\n").should be_nil
+    wait
+    @server.commands.join("\n").should_not include("notice Test note")
+  end
+end
+
+describe Instrumental::Agent, "enabled with sync option" do
+  before do
+    @server = TestServer.new
+    @agent = Instrumental::Agent.new('test_token', :collector => @server.host_and_port, :synchronous => true)
+  end
+
+  it "should send all data in synchronous mode" do
+    with_constants('Instrumental::Agent::MAX_BUFFER' => 3) do
+      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
 end

metadata

@@ -1,15 +1,10 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: instrumental_agent
-version: !ruby/object:Gem::Version 
-  hash: 5
+version: !ruby/object:Gem::Version
+  version: '0.7'
   prerelease: 
-  segments: 
-  - 0
-  - 6
-  - 1
-  version: 0.6.1
 platform: ruby
-authors: 
+authors:
 - Elijah Miller
 - Christopher Zelenak
 - Kristopher Chambers
@@ -17,130 +12,103 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-12-16 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
+date: 2012-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rake
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  requirement: &70270468082260 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 2
-        - 0
-        version: "2.0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
   prerelease: false
+  version_requirements: *70270468082260
+- !ruby/object:Gem::Dependency
   name: rspec
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: &70270468080880 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
   type: :development
   prerelease: false
+  version_requirements: *70270468080880
+- !ruby/object:Gem::Dependency
   name: guard
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  requirement: &70270468105920 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
   prerelease: false
+  version_requirements: *70270468105920
+- !ruby/object:Gem::Dependency
   name: guard-rspec
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  requirement: &70270468104540 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
   prerelease: false
+  version_requirements: *70270468104540
+- !ruby/object:Gem::Dependency
   name: growl_notify
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  requirement: &70270468102900 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
   prerelease: false
+  version_requirements: *70270468102900
+- !ruby/object:Gem::Dependency
   name: rb-fsevent
-  version_requirements: *id006
-- !ruby/object:Gem::Dependency 
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  requirement: &70270468099960 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
   prerelease: false
+  version_requirements: *70270468099960
+- !ruby/object:Gem::Dependency
   name: fuubar
-  version_requirements: *id007
-description: Keep track of anything.
-email: 
+  requirement: &70270468099200 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70270468099200
+description: Track anything.
+email:
 - support@instrumentalapp.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - .rspec
+- CHANGELOG.md
 - Gemfile
 - Guardfile
 - README.md
 - Rakefile
 - instrumental_agent.gemspec
 - lib/instrumental/agent.rb
+- lib/instrumental/capistrano.rb
 - lib/instrumental/rack/middleware.rb
-- lib/instrumental/rack/rails23.rb
-- lib/instrumental/rack/rails3.rb
-- lib/instrumental/rack/rails3/middleware_bootstrap.rb
 - lib/instrumental/version.rb
 - lib/instrumental_agent.rb
 - spec/agent_spec.rb
@@ -148,38 +116,30 @@ 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 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
 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
+has_rdoc: 

data/lib/instrumental/rack/rails23.rb

@@ -1,27 +0,0 @@
-module Instrumental
-  class Middleware
-    class Rails23 < Stack
-      def self.create
-        if (defined?(::RAILS_VERSION) && const_get(:RAILS_VERSION).to_s =~ /^2\.3/) ||
-            (defined?(Rails) && Rails.respond_to?(:version) && Rails.version.to_s =~ /^2\.3/)
-          new
-        end
-      end
-
-      def install_middleware
-        Rails.configuration.middleware.use Instrumental::Middleware
-      end
-
-      def log(msg)
-        Rails.logger.error msg
-      end
-
-      def recognize_uri(request)
-        params = ActionController::Routing::Routes.recognize_path(request.path, request.env.merge(:method => request.env["REQUEST_METHOD"].downcase.to_sym))
-        ["controller", params[:controller], params[:action]]
-      rescue ActionController::RoutingError => e
-        ["controller", "unknown"]
-      end
-    end
-  end
-end

data/lib/instrumental/rack/rails3.rb

@@ -1,27 +0,0 @@
-module Instrumental
-  class Middleware
-    class Rails3 < Stack
-      def self.create
-        if defined?(Rails) && Rails.respond_to?(:version) && Rails.version.to_s =~ /^3/
-          new
-        end
-      end
-
-      def install_middleware
-        require 'instrumental/rack/rails3/middleware_bootstrap'
-      end
-
-      def log(msg)
-        Rails.logger.error msg
-      end
-
-      def recognize_uri(request)
-        Rails.application.routes.finalize!
-        params = Rails.application.routes.recognize_path(request.url, request.env)
-        ["controller", params[:controller], params[:action]]
-      rescue ActionController::RoutingError => e
-        ["controller", "unknown"]
-      end
-    end
-  end
-end

data/lib/instrumental/rack/rails3/middleware_bootstrap.rb

@@ -1,6 +0,0 @@
-module Instrumental
-  class MiddlewareBootstrap < Rails::Railtie
-    config.app_middleware.use Instrumental::Middleware
-
-  end
-end