graphite 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/HISTORY.rdoc

@@ -0,0 +1,4 @@
+= graphite history
+
+== 0.1.0
+* Initial extraction from OIB

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 CapitalThought
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,17 @@
+= graphite
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 CapitalThought. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,54 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "graphite"
+    gem.summary = gem.description = %Q{Ruby client for sending stats to Graphite}
+    gem.email = "mike@capitalthought.com"
+    gem.homepage = "http://github.com/otherinbox/graphite"
+    gem.authors = ["Ian Ragsdale", "Mike Subelsky"]
+    gem.add_dependency "eventmachine"
+    gem.add_dependency "rufus-scheduler"
+
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "graphite #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/TODO.txt

@@ -0,0 +1 @@
+* Write tests

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/examples/example_daemon.rb

@@ -0,0 +1,36 @@
+#!/usr/bin/env ruby
+ENV["RAILS_ENV"] ||= "production"
+require File.dirname(__FILE__) + "/../../config/environment"
+
+Thread.abort_on_exception = true
+EM.threadpool_size = 1
+
+Graphite::Client.new(GRAPHITE_SERVER, "yourapp.#{Rails.env}.global") do |graphite|
+
+  REPLICATION_SECONDS_BEHIND_OID = '.1.3.6.1.4.1.8072.1.3.2.4.1.2.11.115.108.97.118.101.83.116.97.116.117.115.6'
+
+  graphite.metric "health.database.slave_seconds_behind", 5.minutes do
+    `/usr/bin/snmpget -v2c -c oibsnmp db.example.com #{REPLICATION_SECONDS_BEHIND_OID}`.split.last.to_f
+  end
+
+  graphite.metric "users.new_past_week", 15.minutes do
+    User.count(:conditions => ["created_at >= '?'",7.days.ago])
+  end
+
+  graphite.metric "users.new_past_day", 15.minutes do
+    User.count(:conditions => ["created_at >= '?'",1.day.ago])
+  end
+
+  graphite.metric "users.new_past_hour", 1.minutes, :shifts => ['24h', '7d', '30d','90d'] do
+    User.count(:conditions => ["created_at >= '?'",1.hour.ago])
+  end
+
+  graphite.metric "users.active", 5.minutes, :shifts => ['24h','7d','30d','90d'] do
+    User.count(:conditions => "active = 1")
+  end
+
+  graphite.metric "users.inactive", 5.minutes do
+    User.count(:conditions => "active = 0")
+  end
+    
+end

data/graphite.gemspec

@@ -0,0 +1,64 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{graphite}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Ian Ragsdale", "Mike Subelsky"]
+  s.date = %q{2010-02-03}
+  s.description = %q{Ruby client for sending stats to Graphite}
+  s.email = %q{mike@capitalthought.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "HISTORY.rdoc",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "TODO.txt",
+     "VERSION",
+     "examples/example_daemon.rb",
+     "graphite.gemspec",
+     "lib/graphite.rb",
+     "lib/graphite/client.rb",
+     "lib/graphite/event_machine_handler.rb",
+     "lib/graphite/logger.rb",
+     "test/helper.rb",
+     "test/test_graphite.rb"
+  ]
+  s.homepage = %q{http://github.com/otherinbox/graphite}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Ruby client for sending stats to Graphite}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_graphite.rb",
+     "examples/example_daemon.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<eventmachine>, [">= 0"])
+      s.add_runtime_dependency(%q<rufus-scheduler>, [">= 0"])
+    else
+      s.add_dependency(%q<eventmachine>, [">= 0"])
+      s.add_dependency(%q<rufus-scheduler>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<eventmachine>, [">= 0"])
+    s.add_dependency(%q<rufus-scheduler>, [">= 0"])
+  end
+end
+

data/lib/graphite.rb

@@ -0,0 +1,6 @@
+module Graphite
+end
+
+require File.join(File.dirname(__FILE__),'graphite','logger')
+require File.join(File.dirname(__FILE__),'graphite','event_machine_handler')
+require File.join(File.dirname(__FILE__),'graphite','client')

data/lib/graphite/client.rb

@@ -0,0 +1,109 @@
+require 'eventmachine'
+require 'rufus-scheduler'
+
+module Graphite
+  class Client
+    
+    # Expects a string in the form of "hostname:port_num" where port_num is optional, and a prefix 
+    # to identify this server. Example:
+    # Graphite::Client.new("graphite.example.com", "yourapp.#{Rails.env}.instances.#{hostname}.#{$$}")
+
+    def initialize(server, prefix)
+      @logger = Graphite::Logger.new(server)
+      @prefix = prefix
+      @metrics = {}
+      @counters = {}
+      @shifts = {}
+
+      if block_given?
+        @scheduler = Rufus::Scheduler::EmScheduler.start_new
+        yield self
+        start_logger_timer
+        @scheduler.join
+      else
+        Graphite::EventMachineHandler.ensure_running
+        @scheduler = Rufus::Scheduler::EmScheduler.start_new
+        start_logger_timer
+      end
+    end
+
+    def metric(name, frequency = 1.minute, options = {})
+      add_shifts(name,options[:shifts]) if options[:shifts]
+      @scheduler.every(frequency, :first_in => '1m') do
+        result = yield
+        log({name => result})
+        cleanup
+      end
+    end
+
+    def add_shifts(name, shifts)
+      shifts.each do |seconds|
+        @shifts[seconds] ||= []
+        @shifts[seconds] << name
+      end
+    end
+
+    def metrics(frequency = 1.minute)
+      @scheduler.every(frequency, :first_in => '1m') do
+        results = yield
+        log(results)
+        cleanup
+      end
+    end
+
+    def increment!(counter, n = 1)
+      full_counter = "#{@prefix}.#{counter}"
+      @counters[full_counter] ||= 0
+      @counters[full_counter]  += n
+    end
+
+    private
+
+    def log(results)
+      results.keys.each do |k,v|
+        @metrics["#{@prefix}.#{k}"] = results.delete(k)
+      end
+    end
+
+    def send_counters
+      to_send = {}
+      @counters.keys.each do |k|
+        to_send[k] = @counters.delete(k)
+      end
+      @logger.log(Time.now, to_send) if to_send.size > 0
+    end
+
+    def send_metrics
+      @logger.log(Time.now, @metrics) if @metrics.size > 0
+      send_counters
+      send_shifts
+    end
+
+    # Sends metrics into the future
+    def send_shifts
+      @shifts.each do |time, metrics|
+        to_send = {}
+
+        metrics.each do |k|
+          key = "#{@prefix}.#{k}"
+          shifted_key = key + "_shifted.#{time}_ago"
+          to_send[shifted_key] = @metrics[key]
+        end
+
+        seconds = Rufus.parse_time_string time
+        @logger.log(Time.now + seconds,to_send)
+      end
+    end
+
+    def start_logger_timer
+      @scheduler.every("60s", :blocking => true) do
+        send_metrics
+      end
+    end
+
+    # Blocks get run in a threadpool -- sharing is caring.
+    def cleanup
+      ActiveRecord::Base.clear_active_connections! if defined?(ActiveRecord::Base)
+    end
+  end
+end

data/lib/graphite/event_machine_handler.rb

@@ -0,0 +1,33 @@
+# This code originally written by Bob Potter is extracted from OtherInbox
+# TODO EMH code should be spun out into its own gem
+
+module Graphite
+  class EventMachineHandler
+  
+    def self.ensure_running
+      start_em unless EventMachine.reactor_running? 
+    end
+           
+    private
+
+    def self.start_em
+      em = Thread.new { EM.run{} }
+
+      # We want to fail if there is an exception in EM otherwise we're dead in the water
+      em.abort_on_exception = true
+
+      %w(INT TERM).each do |sig|
+        old = trap(sig) do 
+          EM.stop if EM.reactor_running?
+
+          if old.respond_to? :call
+            old.call
+          else
+            old
+          end
+        end
+      end
+    end
+  
+  end
+end

data/lib/graphite/logger.rb

@@ -0,0 +1,40 @@
+require 'socket'
+
+module Graphite
+  class Logger
+    attr_accessor :logger
+    
+    DEFAULT_PORT = 2003
+  
+    # Initialize a new Graphite::Logger class; expects a string containing a DNS name for the Graphite server.
+    # This hostname may optional include a port number, e.g. "graphite.example.com:3333". If not specified,
+    # DEFAULT_PORT will be used. If you specify a Ruby-compatible logger object in the second parameter,
+    # a string containing the graphite message will be logged there before it is sent to the socket.
+    
+    def initialize(server_host, logger = nil)
+      @server = server_host
+      @logger = logger
+    end
+    
+    def socket
+      if @socket.nil? || @socket.closed?
+        host, port = @server.split(/:/)
+        port ||= DEFAULT_PORT
+        @socket = TCPSocket.new(host, port)
+      end
+      @socket
+    end
+    
+    # Write a bunch of values to the server taken at the given time
+    def log(time, measurements)
+      message = ""
+      measurements.each do |key, value|
+        raise "Measurement is not numeric" unless value.respond_to? :to_f
+        message << "#{key} #{value.to_f} #{time.to_i}\n"
+      end
+      logger.info("Graphite: #{message}") if logger
+      socket.write(message)
+    end
+    
+  end
+end

data/test/helper.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'test/unit'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'graphite'
+
+class Test::Unit::TestCase
+end

data/test/test_graphite.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestGraphite < Test::Unit::TestCase
+  def test_something_for_real
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification 
+name: graphite
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Ian Ragsdale
+- Mike Subelsky
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-03 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: eventmachine
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rufus-scheduler
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Ruby client for sending stats to Graphite
+email: mike@capitalthought.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- HISTORY.rdoc
+- LICENSE
+- README.rdoc
+- Rakefile
+- TODO.txt
+- VERSION
+- examples/example_daemon.rb
+- graphite.gemspec
+- lib/graphite.rb
+- lib/graphite/client.rb
+- lib/graphite/event_machine_handler.rb
+- lib/graphite/logger.rb
+- test/helper.rb
+- test/test_graphite.rb
+has_rdoc: true
+homepage: http://github.com/otherinbox/graphite
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Ruby client for sending stats to Graphite
+test_files: 
+- test/helper.rb
+- test/test_graphite.rb
+- examples/example_daemon.rb