oboe 1.4.2.2 → 2.1.1

data/lib/oboe/inst/resque.rb

@@ -147,7 +147,7 @@ module Oboe
 end
 
 if defined?(::Resque)
-  puts "[oboe/loading] Instrumenting resque" if Oboe::Config[:verbose]
+  Oboe.logger.info "[oboe/loading] Instrumenting resque" if Oboe::Config[:verbose]
 
   ::Resque.module_eval do
     include Oboe::Inst::Resque
@@ -157,7 +157,7 @@ if defined?(::Resque)
         module_eval "alias #{m}_without_oboe #{m}"
         module_eval "alias #{m} #{m}_with_oboe"
       elsif Oboe::Config[:verbose]
-        puts "[oboe/loading] Couldn't properly instrument Resque (#{m}).  Partial traces may occur."
+        Oboe.logger.warn "[oboe/loading] Couldn't properly instrument Resque (#{m}).  Partial traces may occur."
       end
     end
   end
@@ -170,7 +170,7 @@ if defined?(::Resque)
         alias perform_without_oboe perform
         alias perform perform_with_oboe
       elsif Oboe::Config[:verbose]
-        puts "[oboe/loading] Couldn't properly instrument ResqueWorker (perform).  Partial traces may occur."
+        Oboe.logger.warn "[oboe/loading] Couldn't properly instrument ResqueWorker (perform).  Partial traces may occur."
       end
     end
   end
@@ -183,7 +183,7 @@ if defined?(::Resque)
         alias fail_without_oboe fail
         alias fail fail_with_oboe
       elsif Oboe::Config[:verbose]
-        puts "[oboe/loading] Couldn't properly instrument ResqueWorker (fail).  Partial traces may occur."
+        Oboe.logger.warn "[oboe/loading] Couldn't properly instrument ResqueWorker (fail).  Partial traces may occur."
       end
     end
   end

data/lib/oboe/instrumentation.rb

@@ -7,7 +7,7 @@ module Oboe
         begin
           require f
         rescue => e
-          $stderr.puts "[oboe/loading] Error loading insrumentation file '#{f}' : #{e}"
+          Oboe.logger.error "[oboe/loading] Error loading insrumentation file '#{f}' : #{e}"
         end
       end
     end

data/lib/oboe/loading.rb

@@ -24,6 +24,11 @@ module Oboe
   end
 
   module Loading
+    def self.setup_logger
+      if defined?(::Rails) and ::Rails.logger
+        Oboe.logger = ::Rails.logger
+      end
+    end
 
     def self.load_access_key
       unless Oboe::Config.access_key
@@ -40,7 +45,7 @@ module Oboe
             end
           end
         rescue
-          puts "Having trouble parsing #{config_file}..."
+          Oboe.logger.error "Having trouble parsing #{config_file}..."
         end
       end
     end
@@ -57,7 +62,7 @@ module Oboe
       begin
         Oboe::API.extend_with_tracing
       rescue LoadError => e
-        puts "[oboe/error] Couldn't load oboe api."
+        Oboe.logger.fatal "[oboe/error] Couldn't load oboe api."
       end
       
       require 'oboe/config'
@@ -69,7 +74,7 @@ module Oboe
         begin
           require f
         rescue => e
-          $stderr.puts "[oboe/loading] Error loading framework file '#{f}' : #{e}"
+          Oboe.logger.error "[oboe/loading] Error loading framework file '#{f}' : #{e}"
         end
       end
     end

data/lib/oboe/logger.rb

@@ -0,0 +1,39 @@
+# Copyright (c) 2013 by AppNeta
+# All rights reserved.
+
+module Oboe
+  class << self
+    attr_accessor :logger
+  end
+
+  class Logger
+    # Fatal message
+    def fatal(string, exception = nil)
+      Oboe.logger.fatal(string) if Oboe.logger
+    end
+    
+    # Error message
+    def error(msg, exception = nil)
+      Oboe.logger.error(string) if Oboe.logger
+    end
+    
+    # Warn message
+    def warn(msg, exception = nil)
+      Oboe.logger.warn(string) if Oboe.logger
+    end
+    
+    # Info message
+    def info(msg, exception = nil)
+      Oboe.logger.info(string) if Oboe.logger
+    end
+    
+    # Debug message
+    def debug(msg, exception = nil)
+      Oboe.logger.debug(string) if Oboe.logger
+    end
+
+  end
+end
+
+Oboe.logger = Logger.new(STDERR)
+

data/lib/oboe/version.rb

@@ -1,9 +1,9 @@
 module Oboe
   module Version
-    MAJOR = 1
-    MINOR = 4
-    PATCH = 2
-    BUILD = 2
+    MAJOR = 2
+    MINOR = 1
+    PATCH = 1
+    BUILD = nil
 
     STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join('.')
   end

data/lib/oboe_metal.rb

@@ -9,33 +9,29 @@ module Oboe_metal
   end
 
   class Context
-    def self.log(layer, label, options = {}, with_backtrace = true)
-      evt = Oboe::Context.createEvent()
-      evt.addInfo("Layer", layer.to_s)
-      evt.addInfo("Label", label.to_s)
+    class << self
+      attr_accessor :layer_op
 
-      options.each_pair do |k, v|
-        evt.addInfo(k.to_s, v.to_s)
-      end
+      def log(layer, label, options = {}, with_backtrace = true)
+        evt = Oboe::Context.createEvent()
+        evt.addInfo("Layer", layer.to_s)
+        evt.addInfo("Label", label.to_s)
 
-      evt.addInfo("Backtrace", Oboe::API.backtrace) if with_backtrace
+        options.each_pair do |k, v|
+          evt.addInfo(k.to_s, v.to_s)
+        end
 
-      Oboe::Reporter.sendReport(evt)
-    end
+        evt.addInfo("Backtrace", Oboe::API.backtrace) if with_backtrace
 
-    def self.layer_op=(op)
-      @layer_op = op
-    end
-
-    def self.layer_op
-      @layer_op
-    end
+        Oboe.reporter.sendReport(evt)
+      end
 
-    def self.tracing_layer_op?(operation)
-      if operation.is_a?(Array)
-        return operation.include?(@layer_op)
-      else
-        return @layer_op == operation
+      def tracing_layer_op?(operation)
+        if operation.is_a?(Array)
+          return operation.include?(@layer_op)
+        else
+          return @layer_op == operation
+        end
       end
     end
   end
@@ -50,13 +46,57 @@ end
 module Oboe
   include Oboe_metal
 
-  def self.reporter
-    if !@reporter
-      @reporter = Oboe::UdpReporter.new(Oboe::Config[:reporter_host])
+  class << self
+    attr_accessor :reporter
+ 
+    def always?
+      Oboe::Config[:tracing_mode].to_s == "always"
+    end
+    
+    def continue?
+      Oboe::Context.isValid and not Oboe.never?
+    end
+    
+    def log(layer, label, options = {})
+      Context.log(layer, label, options = options)
+    end
+
+    def never?
+      Oboe::Config[:tracing_mode].to_s == "never"
+    end
+
+    def now?
+      Oboe::Context.isValid and not Oboe.never?
+    end
+    
+    def passthrough?
+      ["always", "through"].include?(Oboe::Config[:tracing_mode])
+    end
+      
+    def sample?
+      Oboe::Config[:sample_rate].to_i < rand(1e6)
+    end
+
+    def start?
+      not Oboe::Context.isValid and Oboe.always?
+    end
+    
+    def through?
+      Oboe::Config[:tracing_mode] == "through"
+    end
+      
+    def tracing?
+      Oboe::Context.isValid and not Oboe.never?
     end
-    return @reporter
   end
 end
 
-Oboe_metal::Context.init() 
+begin
+  Oboe_metal::Context.init() 
+  Oboe.reporter = Oboe::UdpReporter.new("127.0.0.1")
+
+rescue Exception => e
+  $stderr.puts e.message
+  raise
+end
 

data/oboe.gemspec

@@ -0,0 +1,19 @@
+$:.push File.expand_path("../lib", __FILE__)
+require "oboe/version"
+
+Gem::Specification.new do |s|
+    s.name = %q{oboe}
+    s.version = Oboe::Version::STRING
+    s.date = Time.now.strftime('%Y-%m-%d')
+    s.authors = ["Tracelytics, Inc."]
+    s.email = %q{contact@tracelytics.com}
+    s.summary = %q{Tracelytics instrumentation gem}
+    s.homepage = %q{http://tracelytics.com}
+    s.description = %q{The oboe gem provides AppNeta instrumentation for Ruby and Ruby frameworks.}
+    s.extra_rdoc_files = ["LICENSE"]
+    s.files = `git ls-files`.split("\n")
+    s.extensions = ['ext/oboe_metal/extconf.rb']
+    s.test_files  = Dir.glob("{spec}/**/*.rb")
+    s.add_development_dependency 'rake'
+    s.add_development_dependency 'rspec'
+end

data/oboe_fu.gemspec

@@ -0,0 +1,13 @@
+Gem::Specification.new do |s|
+  s.name = %q{oboe_fu}
+  s.version = "1.3.0"
+  s.date = %{2012-09-19}
+  s.authors = ["Tracelytics, Inc."]
+  s.email = %q{contact@tracelytics.com}
+  s.summary = %q{(Deprecated) Oboe instrumentation for Ruby frameworks}
+  s.homepage = %q{http://tracelytics.com}
+  s.description = %q{This gem has been replace by the 'oboe' gem.  Please update.}
+  s.extra_rdoc_files = ["LICENSE"]
+  s.files = ['lib/oboe_fu.rb'] + ['LICENSE']
+  s.add_dependency('oboe', '= 1.3.0')
+end

data/release.sh

@@ -0,0 +1,65 @@
+#!/bin/bash
+#
+# for use only when you're ready to push from prod -> rubygems
+#
+
+if [ $# -ne 0 ]
+then
+  echo -e "Usage: `basename $0`"
+  echo -e "-Summary-"
+  echo -e "\t This script will help you build and release a new version of the oboe Ruby gem."
+  echo -e "\t It will also create a git tag with the version being released."
+  echo -e ""
+  echo -e "-Steps-"
+  echo -e "\t 1. Update lib/oboe/version.rb with the new version you wish to release."
+  echo -e "\t 2. Re-run this script without any arguments."
+  echo -e ""
+  echo -e "-Notes-"
+  echo -e "\t You must have ~/.gem/credentials setup with the Appneta API key for Rubygems."
+  echo -e "\t The API key should be titled :rubygems_appneta: in the credentials file."
+  echo -e ""
+  echo -e "\t Gems with letters in the build number (e.g. pre1 or beta1)will be released "
+  echo -e "\t as a prerelease gem on Rubygems."
+  echo -e ""
+  echo -e "\t See here for an explanation on prelease gems:"
+  echo -e "\t http://guides.rubygems.org/patterns/#prerelease-gems"
+  exit $E_BADARGS
+fi
+
+if [ $(git branch -a | grep ^* | awk '{print $2}') != "prod" ]; then
+  echo -e "You can only release gems from prod branch."
+  echo -e "Do a 'git checkout prod' and try again."
+  exit
+fi
+
+#set -e # stop on first non-zero exit code
+#set -x # show commands as they happen
+
+# Get gem version from lib/oboe/version.rb
+VERSION=`/usr/bin/env ruby ./get_version.rb`
+
+read -p "Are you sure you want to release oboe gem version $VERSION to Rubygems? [y/N]" -n 1 -r
+if [[ $REPLY =~ ^[Yy]$ ]]
+then
+  echo -e ""
+  
+  # tag release (if tag already exists, bails out)
+  echo -e "Creating git tag rel-$VERSION..."
+  if ! git tag rel-$VERSION; then
+    echo -e "Couldn't create tag for ${VERSION}: if it already exists, you need to bump the version."
+    exit
+  fi
+
+  echo -e "Pushing tags to origin (Github)..."
+  git push --tags
+
+  # Build and publish the gem to Rubygems.org
+  echo -e "Building gem..."
+  gem build oboe.gemspec
+  echo -e "Pushing built gem to Rubygems..."
+  gem push -k rubygems_appneta oboe-$VERSION.gem
+else
+  echo -e ""
+  echo -e "Canceled...nothing done.  Have a nice day."
+fi
+

data/spec/instrumentation/cassandra_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe Oboe::Inst::Cassandra do
+  it 'Stock Cassandra should be loaded, defined and ready' do
+    defined?(::Cassandra).should_not == nil 
+  end
+
+  it 'Cassandra should have oboe methods defined' do
+    [ :insert, :remove, :count_columns, :get_columns, :multi_get_columns, :get,
+      :multi_get, :get_range_single, :get_range_batch, :get_indexed_slices,
+      :create_index, :drop_index, :add_column_family, :drop_column_family,
+      :add_keyspace, :drop_keyspace ].each do |m|
+      ::Cassandra.method_defined?("#{m}_with_oboe").should == true
+    end
+    # Special 'exists?' case
+    ::Cassandra.method_defined?("exists_with_oboe?").should == true
+  end
+end

data/spec/instrumentation/dalli_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+describe Oboe::Inst::Dalli do
+  it 'Stock Dalli should be loaded, defined and ready' do
+    defined?(::Dalli).should_not == nil 
+    defined?(::Dalli::Client).should_not == nil
+  end
+
+  it 'Dalli should have oboe methods defined' do
+    [ :perform_with_oboe, :get_multi_with_oboe ].each do |m|
+      ::Dalli::Client.method_defined?(m).should == true
+    end
+  end
+end

data/spec/instrumentation/http_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+
+describe Oboe::Inst do
+  it 'Net::HTTP should be defined and ready' do
+    defined?(::Net::HTTP).should_not == nil 
+  end
+
+  it 'Net::HTTP should have oboe methods defined' do
+    [ :request_with_oboe ].each do |m|
+      ::Net::HTTP.method_defined?(m).should == true
+    end
+  end
+end

data/spec/instrumentation/memcache_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+require 'memcache'
+
+describe Oboe::API::Memcache do
+  it 'Stock MemCache should be loaded, defined and ready' do
+    defined?(::MemCache).should_not == nil 
+  end
+
+  it 'MemCache should have oboe methods defined' do
+    Oboe::API::Memcache::MEMCACHE_OPS.each do |m|
+      if ::MemCache.method_defined?(m)
+        ::MemCache.method_defined?("#{m}_with_oboe").should == true 
+      end
+      ::MemCache.method_defined?(:request_setup_with_oboe).should == true 
+      ::MemCache.method_defined?(:cache_get_with_oboe).should == true 
+      ::MemCache.method_defined?(:get_multi_with_oboe).should == true 
+    end
+  end
+end

data/spec/instrumentation/memcached_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+if (RUBY_VERSION =~ /^1./) == 0
+  describe Oboe::Inst::Memcached do
+    require 'memcached'
+    require 'memcached/rails'
+
+    it 'Stock Memcached should be loaded, defined and ready' do
+      defined?(::Memcached).should_not == nil 
+      defined?(::Memcached::Rails).should_not == nil 
+    end
+
+    it 'Memcached should have oboe methods defined' do
+      Oboe::API::Memcache::MEMCACHE_OPS.each do |m|
+        if ::Memcached.method_defined?(m)
+          ::Memcached.method_defined?("#{m}_with_oboe").should == true 
+        end
+        ::Memcached::Rails.method_defined?(:get_multi_with_oboe).should == true 
+      end
+    end
+  end
+end