oboe 2.7.0.3-java

data/ext/oboe_metal/tests/test.rb

@@ -0,0 +1,11 @@
+# Copyright (c) 2013 AppNeta, Inc.
+# All rights reserved.
+
+require 'oboe'
+
+r = Oboe::UdpReporter.new('127.0.0.1')
+Oboe::Context.init()
+e = Oboe::Context.createEvent()
+e.addInfo("TestKey", "TestValue")
+r.sendReport(e)
+

data/gemfiles/mongo.gemfile

@@ -0,0 +1,33 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "dalli"
+gem "memcache-client"
+gem "memcached", "1.7.2"
+gem "cassandra"
+gem "mongo"
+gem "bson"
+gem "moped", "~> 1.5"
+gem "resque"
+gem "redis"
+gem "sinatra"
+gem "padrino", "0.12.0"
+gem "grape"
+
+group :development, :test do
+  gem "minitest"
+  gem "minitest-reporters"
+  gem "rack-test"
+  gem "appraisal"
+end
+
+group :development do
+  gem "ruby-debug", :platform => :mri_18
+  gem "debugger", :platform => :mri_19
+  gem "byebug", :platforms => [:mri_20, :mri_21]
+  gem "perftools.rb", :platforms => [:mri_20, :mri_21], :require => "perftools"
+  gem "pry"
+end
+
+gemspec :name => "oboe", :path => "../"

data/gemfiles/moped.gemfile

@@ -0,0 +1,33 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "dalli"
+gem "memcache-client"
+gem "memcached", "1.7.2"
+gem "cassandra"
+gem "mongo"
+gem "bson"
+gem "moped", "~> 1.5"
+gem "resque"
+gem "redis"
+gem "sinatra"
+gem "padrino", "0.12.0"
+gem "grape"
+
+group :development, :test do
+  gem "minitest"
+  gem "minitest-reporters"
+  gem "rack-test"
+  gem "appraisal"
+end
+
+group :development do
+  gem "ruby-debug", :platform => :mri_18
+  gem "debugger", :platform => :mri_19
+  gem "byebug", :platforms => [:mri_20, :mri_21]
+  gem "perftools.rb", :platforms => [:mri_20, :mri_21], :require => "perftools"
+  gem "pry"
+end
+
+gemspec :name => "oboe", :path => "../"

data/get_version.rb

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require File.dirname(__FILE__) + '/lib/oboe/version.rb'
+
+puts Oboe::Version::STRING

data/init.rb

@@ -0,0 +1,4 @@
+# Copyright (c) 2013 AppNeta, Inc.
+# All rights reserved.
+
+require 'oboe'

data/lib/base.rb

@@ -0,0 +1,99 @@
+# Copyright (c) 2013 AppNeta, Inc.
+# All rights reserved.
+
+# Constants from liboboe
+OBOE_TRACE_NEVER   = 0
+OBOE_TRACE_ALWAYS  = 1
+OBOE_TRACE_THROUGH = 2
+
+OBOE_SAMPLE_RATE_SOURCE_FILE                   = 1
+OBOE_SAMPLE_RATE_SOURCE_DEFAULT                = 2
+OBOE_SAMPLE_RATE_SOURCE_OBOE                   = 3
+OBOE_SAMPLE_RATE_SOURCE_LAST_OBOE              = 4
+OBOE_SAMPLE_RATE_SOURCE_DEFAULT_MISCONFIGURED  = 5
+OBOE_SAMPLE_RATE_SOURCE_OBOE_DEFAULT           = 6
+
+# Masks for bitwise ops
+ZERO_MASK = 0b0000000000000000000000000000
+
+SAMPLE_RATE_MASK   = 0b0000111111111111111111111111
+SAMPLE_SOURCE_MASK = 0b1111000000000000000000000000
+
+ZERO_SAMPLE_RATE_MASK   = 0b1111000000000000000000000000
+ZERO_SAMPLE_SOURCE_MASK = 0b0000111111111111111111111111
+
+module OboeBase
+  attr_accessor :reporter
+  attr_accessor :loaded
+  attr_accessor :sample_source
+  attr_accessor :sample_rate
+  attr_accessor :layer_op
+
+  def self.included(cls)
+    self.loaded = true
+  end
+
+  def tracing_layer_op?(operation)
+    if operation.is_a?(Array)
+      return operation.include?(@layer_op)
+    else
+      return @layer_op == operation
+    end
+  end
+
+  def always?
+    Oboe::Config[:tracing_mode].to_s == "always"
+  end
+
+  def never?
+    Oboe::Config[:tracing_mode].to_s == "never"
+  end
+
+  def passthrough?
+    ["always", "through"].include?(Oboe::Config[:tracing_mode])
+  end
+
+  def through?
+    Oboe::Config[:tracing_mode] == "through"
+  end
+
+  def tracing?
+    return false unless Oboe.loaded
+
+    Oboe::Context.isValid and not Oboe.never?
+  end
+
+  def log(layer, label, options = {})
+    # WARN: Oboe.log will be deprecated in a future release.  Please use Oboe::API.log instead.
+    Oboe::API.log(layer, label, options)
+  end
+
+  def heroku?
+    false
+  end
+
+  def forking_webserver?
+    (defined?(::Unicorn) and ($0 =~ /unicorn/i)) ? true : false
+  end
+
+  ##
+  # These methods should be implemented by the descendants
+  # (Oboe_metal, Oboe_metal (JRuby), Heroku_metal)
+  #
+  def sample?(opts = {})
+    raise "sample? should be implemented by metal layer."
+  end
+
+  def log(layer, label, options = {})
+    raise "log should be implemented by metal layer."
+  end
+
+  def set_tracing_mode(mode)
+    raise "set_tracing_mode should be implemented by metal layer."
+  end
+
+  def set_sample_rate(rate)
+    raise "set_sample_rate should be implemented by metal layer."
+  end
+end
+

data/lib/joboe_metal.rb

@@ -0,0 +1,185 @@
+# Copyright (c) 2013 AppNeta, Inc.
+# All rights reserved.
+
+require 'base'
+
+module Oboe_metal
+  include_package 'com.tracelytics.joboe'
+  java_import 'com.tracelytics.joboe.LayerUtil'
+  java_import 'com.tracelytics.joboe.SettingsReader'
+  java_import 'com.tracelytics.joboe.Context'
+  java_import 'com.tracelytics.joboe.Event'
+  java_import 'com.tracelytics.agent.Agent'
+
+  class Context
+    class << self
+      def toString
+        md = getMetadata.toHexString
+      end
+
+      def fromString(xtrace)
+        Context.setMetadata(xtrace)
+      end
+
+      def clear
+        clearMetadata
+      end
+
+      def get
+        getMetadata
+      end
+    end
+  end
+
+  class Event
+    def self.metadataString(evt)
+      evt.getMetadata.toHexString
+    end
+  end
+
+  def UdpReporter
+    Java::ComTracelyticsJoboe
+  end
+
+  module Metadata
+    Java::ComTracelyticsJoboeMetaData
+  end
+
+  module Reporter
+    ##
+    # Initialize the Oboe Context, reporter and report the initialization
+    #
+    def self.start
+      begin
+        return unless Oboe.loaded
+
+        if ENV.has_key?("OBOE_GEM_TEST")
+          Oboe.reporter = Java::ComTracelyticsJoboe::TestReporter.new
+        else
+          Oboe.reporter = Java::ComTracelyticsJoboe::ReporterFactory.getInstance().buildUdpReporter()
+        end
+
+
+        # Import the tracing mode and sample rate settings
+        # from the Java agent (user configured in
+        # /usr/local/tracelytics/javaagent.json when under JRuby)
+        cfg = LayerUtil.getLocalSampleRate(nil, nil)
+
+        if cfg.hasSampleStartFlag
+          Oboe::Config.tracing_mode = 'always'
+        elsif cfg.hasSampleThroughFlag
+          Oboe::Config.tracing_mode = 'through'
+        else
+          Oboe::Config.tracing_mode = 'never'
+        end
+
+        Oboe.sample_rate = cfg.sampleRate
+        Oboe::Config.sample_rate = cfg.sampleRate
+        Oboe::Config.sample_source = cfg.sampleRateSource.a
+
+        # Only report __Init from here if we are not instrumenting a framework.
+        # Otherwise, frameworks will handle reporting __Init after full initialization
+        unless defined?(::Rails) or defined?(::Sinatra) or defined?(::Padrino) or defined?(::Grape)
+          Oboe::API.report_init
+        end
+
+      rescue Exception => e
+        $stderr.puts e.message
+        raise
+      end
+    end
+
+    ##
+    # clear_all_traces
+    #
+    # Truncates the trace output file to zero
+    #
+    def self.clear_all_traces
+      Oboe.reporter.reset if Oboe.loaded
+    end
+
+    ##
+    # get_all_traces
+    #
+    # Retrieves all traces written to the trace file
+    #
+    def self.get_all_traces
+      return [] unless Oboe.loaded
+
+      # Joboe TestReporter returns a Java::ComTracelyticsExtEbson::DefaultDocument
+      # document for traces which doesn't correctly support things like has_key? which
+      # raises an unhandled exception on non-existent key (duh).  Here we convert
+      # the Java::ComTracelyticsExtEbson::DefaultDocument doc to a pure array of Ruby
+      # hashes
+      traces = []
+      Oboe.reporter.getSentEventsAsBsonDocument.to_a.each do |e|
+        t = {}
+        e.each_pair { |k,v|
+          t[k] = v
+        }
+        traces << t
+      end
+      traces
+    end
+
+    def self.sendReport(evt)
+      evt.report(Oboe.reporter)
+    end
+  end
+end
+
+module Oboe
+  extend OboeBase
+  include Oboe_metal
+
+  class << self
+    def sample?(opts = {})
+      begin
+        return false unless Oboe.always? and Oboe.loaded
+
+        return true if ENV['OBOE_GEM_TEST'] == "test"
+
+        # Validation to make Joboe happy.  Assure that we have the KVs and that they
+        # are not empty strings.
+        opts[:layer]  = nil      if opts[:layer].is_a?(String)      and opts[:layer].empty?
+        opts[:xtrace] = nil      if opts[:xtrace].is_a?(String)     and opts[:xtrace].empty?
+        opts['X-TV-Meta'] = nil  if opts['X-TV-Meta'].is_a?(String) and opts['X-TV-Meta'].empty?
+
+        opts[:layer]      ||= nil
+        opts[:xtrace]     ||= nil
+        opts['X-TV-Meta'] ||= nil
+
+        sr_cfg = Java::ComTracelyticsJoboe::LayerUtil.shouldTraceRequest( opts[:layer],
+                               { 'X-Trace' => opts[:xtrace], 'X-TV-Meta' => opts['X-TV-Meta'] } )
+
+        # Store the returned SampleRateConfig into Oboe::Config
+        if sr_cfg
+          Oboe.sample_rate = sr_cfg.sampleRate
+          Oboe.sample_source = sr_cfg.sampleRateSource.a
+        end
+
+        sr_cfg
+      rescue => e
+        Oboe.logger.debug "[oboe/debug] #{e.message}"
+        false
+      end
+    end
+
+    def set_tracing_mode(mode)
+      Oboe.logger.warn "When using JRuby set the tracing mode in /usr/local/tracelytics/javaagent.json instead"
+    end
+
+    def set_sample_rate(rate)
+      # N/A
+    end
+  end
+end
+
+# Assure that the Joboe Java Agent was loaded via premain
+status = Java::ComTracelyticsAgent::Agent.getStatus
+if status == Java::ComTracelyticsAgent::Agent::AgentStatus::UNINITIALIZED
+  Oboe.loaded = false
+else
+  Oboe.loaded = true
+end
+

data/lib/method_profiling.rb

@@ -0,0 +1,70 @@
+# Copyright (c) 2013 AppNeta, Inc.
+# All rights reserved.
+
+module OboeMethodProfiling
+  def self.included klass
+    klass.extend ClassMethods
+  end
+
+  module ClassMethods
+    def profile_method(method_name, profile_name, store_args=false, store_return=false, profile=false)
+      begin
+        # this only gets file and line where profiling is turned on, presumably
+        # right after the function definition. ruby 1.9 and 2.0 has nice introspection (Method.source_location)
+        # but its appears no such luck for ruby 1.8
+        version = RbConfig::CONFIG['ruby_version']
+        file = ''
+        line = ''
+        if version and (version.match(/^1.9/) or version.match(/^2.0/))
+          info = self.instance_method(method_name).source_location
+          if !info.nil?
+            file = info[0].to_s
+            line = info[1].to_s
+          end
+        else
+          info = Kernel.caller[0].split(':')
+          file = info.first.to_s
+          line = info.last.to_s
+        end
+
+        # Safety:  Make sure there are no quotes or double quotes to break the class_eval
+        file = file.gsub /[\'\"]/, ''
+        line = line.gsub /[\'\"]/, ''
+
+        # profiling via ruby-prof, is it possible to get return value of profiled code?
+        code = "def _oboe_profiled_#{method_name}(*args, &block)
+                  entry_kvs                  = {}
+                  entry_kvs['Language']      = 'ruby'
+                  entry_kvs['ProfileName']   = '#{Oboe::Util.prettify(profile_name)}'
+                  entry_kvs['FunctionName']  = '#{Oboe::Util.prettify(method_name)}'
+                  entry_kvs['File']          = '#{file}'
+                  entry_kvs['LineNumber']    = '#{line}'
+                  entry_kvs['Args']          = Oboe::API.pps(*args) if #{store_args}
+                  entry_kvs.merge!(::Oboe::API.get_class_name(self))
+
+                  Oboe::API.log(nil, 'profile_entry', entry_kvs)
+
+                  ret = _oboe_orig_#{method_name}(*args, &block)
+
+                  exit_kvs =  {}
+                  exit_kvs['Language'] = 'ruby'
+                  exit_kvs['ProfileName'] = '#{Oboe::Util.prettify(profile_name)}'
+                  exit_kvs['ReturnValue'] = Oboe::API.pps(ret) if #{store_return}
+
+                  Oboe::API.log(nil, 'profile_exit', exit_kvs)
+                  ret
+                end"
+      rescue Exception => e
+        Oboe.logger.warn "[oboe/warn] profile_method: #{e.inspect}"
+      end
+
+      begin
+        class_eval code, __FILE__, __LINE__
+        alias_method "_oboe_orig_#{method_name}", method_name
+        alias_method method_name, "_oboe_profiled_#{method_name}"
+      rescue Exception => e
+        Oboe.logger.warn "[oboe/warn] Fatal error profiling method (#{method_name}): #{e.inspect}" if Oboe::Config[:verbose]
+      end
+    end
+  end
+end