traceview 3.0.0-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 'traceview'

data/lib/joboe_metal.rb

@@ -0,0 +1,206 @@
+# Copyright (c) 2013 AppNeta, Inc.
+# All rights reserved.
+
+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
+        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 TraceView Context, reporter and report the initialization
+    #
+    def self.start
+      return unless TraceView.loaded
+
+      if ENV.key?('TRACEVIEW_GEM_TEST')
+        TraceView.reporter = Java::ComTracelyticsJoboe::TestReporter.new
+      else
+        TraceView.reporter = Java::ComTracelyticsJoboe::ReporterFactory.getInstance.buildUdpReporter
+      end
+
+
+      begin
+        # 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
+          TraceView::Config.tracing_mode = 'always'
+        elsif cfg.hasSampleThroughFlag
+          TraceView::Config.tracing_mode = 'through'
+        else
+          TraceView::Config.tracing_mode = 'never'
+        end
+
+        TraceView.sample_rate = cfg.getSampleRate
+        TraceView::Config.sample_rate = cfg.sampleRate
+        TraceView::Config.sample_source = cfg.sampleRateSourceValue
+      rescue => e
+        TraceView.logger.debug "[traceview/debug] Couldn't retrieve/acces joboe sampleRateCfg"
+        TraceView.logger.debug "[traceview/debug] #{e.message}"
+      end
+
+      # Only report __Init from here if we are not instrumenting a framework.
+      # Otherwise, frameworks will handle reporting __Init after full initialization
+      unless defined?(::Rails) || defined?(::Sinatra) || defined?(::Padrino) || defined?(::Grape)
+        TraceView::API.report_init unless ENV.key?('TRACEVIEW_GEM_TEST')
+      end
+    end
+
+    ##
+    # clear_all_traces
+    #
+    # Truncates the trace output file to zero
+    #
+    def self.clear_all_traces
+      TraceView.reporter.reset if TraceView.loaded
+    end
+
+    ##
+    # get_all_traces
+    #
+    # Retrieves all traces written to the trace file
+    #
+    def self.get_all_traces
+      return [] unless TraceView.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 = []
+      TraceView.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(TraceView.reporter)
+    end
+  end
+end
+
+module TraceView
+  extend TraceViewBase
+  include Oboe_metal
+
+  class << self
+    def sample?(opts = {})
+      begin
+        return false unless TraceView.always? && TraceView.loaded
+
+        return true if ENV.key?('TRACEVIEW_GEM_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)      && opts[:layer].empty?
+        opts[:xtrace] = nil      if opts[:xtrace].is_a?(String)     && opts[:xtrace].empty?
+        opts['X-TV-Meta'] = nil  if opts['X-TV-Meta'].is_a?(String) && 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 TraceView::Config
+        if sr_cfg
+          begin
+            TraceView::Config.sample_rate = cfg.sampleRate
+            TraceView::Config.sample_source = cfg.sampleRateSourceValue
+            # If we fail here, we do so quietly.  This was we don't spam logs
+            # on every request
+          end
+        else
+          TraceView.sample_rate = -1
+          TraceView.sample_source = -1
+        end
+
+        sr_cfg ? true : false
+      rescue => e
+        TraceView.logger.debug "[traceview/debug] #{e.message}"
+        false
+      end
+    end
+
+    def set_tracing_mode(_mode)
+      TraceView.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
+case Java::ComTracelyticsAgent::Agent.getStatus
+  when Java::ComTracelyticsAgent::Agent::AgentStatus::INITIALIZED_SUCCESSFUL
+    TraceView.loaded = true
+
+  when Java::ComTracelyticsAgent::Agent::AgentStatus::INITIALIZED_FAILED
+    TraceView.loaded = false
+    $stderr.puts '=============================================================='
+    $stderr.puts 'TraceView Java Agent not initialized properly.'
+    $stderr.puts 'Possibly misconfigured?  Going into no-op mode.'
+    $stderr.puts 'See: http://bit.ly/1zwS5xj'
+    $stderr.puts '=============================================================='
+
+  when Java::ComTracelyticsAgent::Agent::AgentStatus::UNINITIALIZED
+    TraceView.loaded = false
+    $stderr.puts '=============================================================='
+    $stderr.puts 'TraceView Java Agent not loaded. Going into no-op mode.'
+    $stderr.puts 'To preload the TraceView java agent see:'
+    $stderr.puts 'https://support.appneta.com/cloud/installing-jruby-instrumentation'
+    $stderr.puts '=============================================================='
+
+  else
+    TraceView.loaded = false
+end

data/lib/oboe/README

@@ -0,0 +1,2 @@
+This directory is kept for backward compatibility for applications
+making calls to Oboe modules.

data/lib/oboe/backward_compatibility.rb

@@ -0,0 +1,59 @@
+require 'traceview/thread_local'
+
+module Oboe
+  extend TraceViewBase
+  include Oboe_metal
+
+  #
+  # Support for Oboe::API calls
+  #
+  module API
+    include TraceView::API
+    extend ::TraceView::ThreadLocal
+    thread_local :deprecation_notified
+
+    def self.method_missing(sym, *args, &blk)
+      # Notify of deprecation only once
+      unless @deprecated_notified
+        TraceView.logger.warn "[traceview/warn] Note that Oboe::API has been renamed to TraceView::API. (#{sym}:#{args})"
+        TraceView.logger.warn "[traceview/warn] Oboe::API will be deprecated in a future version."
+        @deprecated_notified = true
+      end
+      TraceView::API.send(sym, *args, &blk)
+    end
+  end
+
+
+  #
+  # Support for Oboe::Config calls
+  #
+  module Config
+    extend ::TraceView::ThreadLocal
+    thread_local :deprecation_notified
+
+    def self.method_missing(sym, *args)
+      # Notify of deprecation only once
+      unless @deprecated_notified
+        TraceView.logger.warn "[traceview/warn] Note that Oboe::Config has been renamed to TraceView::Config. (#{sym}:#{args})"
+        TraceView.logger.warn "[traceview/warn] Oboe::Config will be deprecated in a future version."
+        @deprecated_notified = true
+      end
+      TraceView::Config.send(sym, *args)
+    end
+  end
+end
+
+
+#
+# Support for OboeMethodProfiling
+#
+module OboeMethodProfiling
+  def self.included(klass)
+    klass.extend ClassMethods
+  end
+
+  module ClassMethods
+    include TraceViewMethodProfiling::ClassMethods
+  end
+end
+

data/lib/oboe/inst/rack.rb

@@ -0,0 +1,11 @@
+require 'traceview/inst/rack'
+
+module Oboe
+  class Rack < TraceView::Rack
+    # This simply makes Oboe::Rack available (and a clone of TraceView::Rack) for
+    # backward compatibility
+    #
+    # Provided for pre-existing apps (sinatra, padrino, grape etc..) that may still
+    # call `use Oboe::Rack`
+  end
+end

data/lib/oboe.rb

@@ -0,0 +1,7 @@
+# Copyright (c) 2015 AppNeta, Inc.
+# All rights reserved.
+
+# This module is provided for backward compatibility.
+# It simply redirects to the traceview module which will
+# also load backward compatibility support.
+require 'traceview'

data/lib/oboe_metal.rb

@@ -0,0 +1,151 @@
+# Copyright (c) 2013 AppNeta, Inc.
+# All rights reserved.
+
+# Disable docs and Camelcase warns since we're implementing
+# an interface here.  See OboeBase for details.
+# rubocop:disable Style/Documentation, Style/MethodName
+module TraceView
+  extend TraceViewBase
+  include Oboe_metal
+
+  class Reporter
+    ##
+    # Initialize the TraceView Context, reporter and report the initialization
+    #
+    def self.start
+      return unless TraceView.loaded
+
+      begin
+        Oboe_metal::Context.init
+
+        if ENV.key?('TRACEVIEW_GEM_TEST')
+          TraceView.reporter = TraceView::FileReporter.new('/tmp/trace_output.bson')
+        else
+          TraceView.reporter = TraceView::UdpReporter.new(TraceView::Config[:reporter_host], TraceView::Config[:reporter_port])
+        end
+
+        # Only report __Init from here if we are not instrumenting a framework.
+        # Otherwise, frameworks will handle reporting __Init after full initialization
+        unless defined?(::Rails) || defined?(::Sinatra) || defined?(::Padrino) || defined?(::Grape)
+          TraceView::API.report_init unless ENV.key?('TRACEVIEW_GEM_TEST')
+        end
+
+      rescue => e
+        $stderr.puts e.message
+        raise
+      end
+    end
+
+    def self.sendReport(evt)
+      TraceView.reporter.sendReport(evt)
+    end
+
+    ##
+    # clear_all_traces
+    #
+    # Truncates the trace output file to zero
+    #
+    def self.clear_all_traces
+      File.truncate($trace_file, 0)
+    end
+
+    ##
+    # get_all_traces
+    #
+    # Retrieves all traces written to the trace file
+    #
+    def self.get_all_traces
+      io = File.open($trace_file, 'r')
+      contents = io.readlines(nil)
+
+      return contents if contents.empty?
+
+      s = StringIO.new(contents[0])
+
+      traces = []
+
+      until s.eof?
+        if ::BSON.respond_to? :read_bson_document
+          traces << BSON.read_bson_document(s)
+        else
+          traces << BSON::Document.from_bson(s)
+        end
+      end
+
+      traces
+    end
+  end
+
+  class Event
+    def self.metadataString(evt)
+      evt.metadataString
+    end
+  end
+
+  class << self
+    def sample?(opts = {})
+      begin
+        return false unless TraceView.always? && TraceView.loaded
+
+        # Assure defaults since SWIG enforces Strings
+        layer   = opts[:layer]      ? opts[:layer].strip      : ''
+        xtrace  = opts[:xtrace]     ? opts[:xtrace].strip     : ''
+        tv_meta = opts['X-TV-Meta'] ? opts['X-TV-Meta'].strip : ''
+
+        rv = TraceView::Context.sampleRequest(layer, xtrace, tv_meta)
+
+        if rv == 0
+          if ENV.key?('TRACEVIEW_GEM_TEST')
+            # When in test, always trace and don't clear
+            # the stored sample rate/source
+            true
+          else
+            TraceView.sample_rate = -1
+            TraceView.sample_source = -1
+            false
+          end
+        else
+          # liboboe version > 1.3.1 returning a bit masked integer with SampleRate and
+          # source embedded
+          TraceView.sample_rate = (rv & SAMPLE_RATE_MASK)
+          TraceView.sample_source = (rv & SAMPLE_SOURCE_MASK) >> 24
+          true
+        end
+      rescue StandardError => e
+        TraceView.logger.debug "[oboe/error] sample? error: #{e.inspect}"
+        false
+      end
+    end
+
+    def set_tracing_mode(mode)
+      return unless TraceView.loaded
+
+      value = mode.to_sym
+
+      case value
+      when :never
+        TraceView::Context.setTracingMode(OBOE_TRACE_NEVER)
+
+      when :always
+        TraceView::Context.setTracingMode(OBOE_TRACE_ALWAYS)
+
+      when :through
+        TraceView::Context.setTracingMode(OBOE_TRACE_THROUGH)
+
+      else
+        TraceView.logger.fatal "[oboe/error] Invalid tracing mode set: #{mode}"
+        TraceView::Context.setTracingMode(OBOE_TRACE_THROUGH)
+      end
+    end
+
+    def set_sample_rate(rate)
+      return unless TraceView.loaded
+
+      # Update liboboe with the new SampleRate value
+      TraceView::Context.setDefaultSampleRate(rate.to_i)
+    end
+  end
+end
+# rubocop:enable Style/Documentation
+
+TraceView.loaded = true

data/lib/rails/generators/traceview/install_generator.rb

@@ -0,0 +1,76 @@
+# Copyright (c) 2013 AppNeta, Inc.
+# All rights reserved.
+
+module Oboe
+  class InstallGenerator < ::Rails::Generators::Base
+    source_root File.join(File.dirname(__FILE__), 'templates')
+    desc "Copies an oboe initializer files to your application."
+
+    def copy_initializer
+      # Set defaults
+      @tracing_mode = 'through'
+      @sample_rate = '300000'
+      @verbose = 'false'
+
+      print_header
+
+      while true do
+        print_body
+
+        user_tracing_mode = ask shell.set_color "* Tracing Mode? [through]:", :yellow
+        user_tracing_mode.downcase!
+
+        break if user_tracing_mode.blank?
+        valid = ['always', 'through', 'never'].include?(user_tracing_mode)
+
+        say shell.set_color "Valid values are 'always', 'through' or 'never'", :red, :bold unless valid
+        if valid
+          @tracing_mode = user_tracing_mode
+          break
+        end
+      end
+
+      print_footer
+
+      template "oboe_initializer.rb", "config/initializers/traceview.rb"
+    end
+
+    private
+
+      def print_header
+        say ""
+        say shell.set_color "Welcome to the TraceView Ruby instrumentation setup.", :green, :bold
+        say ""
+        say "To instrument your Rails application, you can setup your tracing strategy here."
+        say ""
+        say shell.set_color "Documentation Links", :magenta
+        say "-------------------"
+        say ""
+        say "Details on configuring your sample rate:"
+        say "https://support.appneta.com/cloud/configuring-sampling"
+        say ""
+        say "More information on instrumenting Ruby applications can be found here:"
+        say "https://support.appneta.com/cloud/installing-ruby-instrumentation"
+      end
+
+      def print_body
+        say ""
+        say shell.set_color "Tracing Mode", :magenta
+        say "------------"
+        say "Tracing Mode determines when traces should be initiated for incoming requests.  Valid"
+        say "options are #{shell.set_color "always", :yellow}, #{shell.set_color "through", :yellow} (when using an instrumented Apache or Nginx) and #{shell.set_color "never", :yellow}."
+        say ""
+        say "If you're not using an instrumented Apache or Nginx, set this directive to #{shell.set_color "always", :yellow} in"
+        say "order to initiate tracing from Ruby."
+        say ""
+      end
+
+      def print_footer
+        say ""
+        say "You can change configuration values in the future by modifying config/initializers/traceview.rb"
+        say ""
+        say "Thanks! Creating the TraceView initializer..."
+        say ""
+      end
+  end
+end