appoptics_apm_mnfst 4.5.2

data/lib/appoptics_apm/version.rb

@@ -0,0 +1,15 @@
+# Copyright (c) 2016 SolarWinds, LLC.
+# All rights reserved.
+
+module AppOpticsAPM
+  ##
+  # The current version of the gem.  Used mainly by
+  # appoptics_apm.gemspec during gem build process
+  module Version
+    MAJOR = 4
+    MINOR = 5
+    PATCH = 2
+
+    STRING = [MAJOR, MINOR, PATCH].compact.join('.')
+  end
+end

data/lib/appoptics_apm/xtrace.rb

@@ -0,0 +1,103 @@
+# Copyright (c) 2016 SolarWinds, LLC.
+# All rights reserved.
+
+module AppOpticsAPM
+  ##
+  # Methods to act on, manipulate or investigate an X-Trace
+  # value
+  module XTrace
+    class << self
+      ##
+      #  AppOpticsAPM::XTrace.valid?
+      #
+      #  Perform basic validation on a potential X-Trace ID
+      #
+      def valid?(xtrace)
+        # Shouldn't be nil
+        return false unless xtrace
+
+        # The X-Trace ID shouldn't be an initialized empty ID
+        return false if (xtrace =~ /^2b0000000/i) == 0
+
+        # Valid X-Trace IDs have a length of 60 bytes and start with '2b'
+        return false unless xtrace.length == 60 && (xtrace =~ /^2b/i) == 0
+
+        true
+      rescue StandardError => e
+        AppOpticsAPM.logger.debug "[appoptics_apm/xtrace] #{e.message}"
+        AppOpticsAPM.logger.debug e.backtrace
+        false
+      end
+
+      def sampled?(xtrace)
+        valid?(xtrace) && xtrace[59].to_i & 1 == 1
+      end
+
+      def set_sampled(xtrace)
+        xtrace[59] = (xtrace[59].hex | 1).to_s(16).upcase
+      end
+
+      def unset_sampled(xtrace)
+        xtrace[59] = (~(~xtrace[59].hex | 1)).to_s(16).upcase
+      end
+
+      ##
+      # AppOpticsAPM::XTrace.task_id
+      #
+      # Extract and return the task_id portion of an X-Trace ID
+      #
+      def task_id(xtrace)
+        return nil unless AppOpticsAPM::XTrace.valid?(xtrace)
+
+        xtrace[2..41]
+      rescue StandardError => e
+        AppOpticsAPM.logger.debug "[appoptics_apm/xtrace] #{e.message}"
+        AppOpticsAPM.logger.debug e.backtrace
+        return nil
+      end
+
+      ##
+      # AppOpticsAPM::XTrace.edge_id
+      #
+      # Extract and return the edge_id portion of an X-Trace ID
+      #
+      def edge_id(xtrace)
+        return nil unless AppOpticsAPM::XTrace.valid?(xtrace)
+
+        xtrace[42..57]
+      rescue StandardError => e
+        AppOpticsAPM.logger.debug "[appoptics_apm/xtrace] #{e.message}"
+        AppOpticsAPM.logger.debug e.backtrace
+        return nil
+      end
+
+      ##
+      # continue_service_context
+      #
+      # In the case of service calls such as external HTTP requests, we
+      # pass along X-Trace headers so that request context can be maintained
+      # across servers and applications.
+      #
+      # Remote requests can return a X-Trace header in which case we want
+      # to pickup on and continue the context in most cases.
+      #
+      # @start is the context just before the outgoing request
+      #
+      # @finish is the context returned to us (as an HTTP response header
+      # if that be the case)
+      #
+      def continue_service_context(start, finish)
+        if AppOpticsAPM::XTrace.valid?(finish) && AppOpticsAPM.tracing?
+
+          # Assure that we received back a valid X-Trace with the same task_id
+          # and the sampling bit is set, otherwise it is a response from a non-sampling service
+          if AppOpticsAPM::XTrace.task_id(start) == AppOpticsAPM::XTrace.task_id(finish) && AppOpticsAPM::XTrace.sampled?(finish)
+            AppOpticsAPM::Context.fromString(finish)
+          else
+            AppOpticsAPM.logger.debug "[XTrace] Sampling flag unset or mismatched start and finish ids:\n#{start}\n#{finish}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/joboe_metal.rb

@@ -0,0 +1,212 @@
+# Copyright (c) 2016 SolarWinds, LLC.
+# 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
+
+  module EventUtil
+    def self.metadataString(evt)
+      evt.getMetadata.toHexString
+    end
+  end
+
+  def UdpReporter
+    Java::ComTracelyticsJoboe
+  end
+
+  module Metadata
+    Java::ComTracelyticsJoboeMetaData
+  end
+
+  module Reporter
+    class << self
+      ##
+      # start
+      #
+      # Start the AppOpticsAPM Reporter
+      #
+      def start
+        return unless AppOpticsAPM.loaded
+
+        if ENV.key?('APPOPTICS_GEM_TEST')
+          AppOpticsAPM.reporter = Java::ComTracelyticsJoboe::ReporterFactory.getInstance.buildTestReporter(false)
+        else
+          AppOpticsAPM.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
+            AppOpticsAPM::Config.tracing_mode = :always
+          else
+            AppOpticsAPM::Config.tracing_mode = :never
+          end
+
+          AppOpticsAPM.sample_rate = cfg.getSampleRate
+          AppOpticsAPM::Config.sample_rate = cfg.sampleRate
+          AppOpticsAPM::Config.sample_source = cfg.sampleRateSourceValue
+        rescue => e
+          AppOpticsAPM.logger.debug "[appoptics_apm/debug] Couldn't retrieve/acces joboe sampleRateCfg"
+          AppOpticsAPM.logger.debug "[appoptics_apm/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)
+          AppOpticsAPM::API.report_init unless ENV.key?('APPOPTICS_GEM_TEST')
+        end
+      end
+
+      ##
+      # restart
+      #
+      # This is a nil method for AppOpticsAPM under Java.  It is maintained only
+      # for compability across interfaces.
+      #
+      def restart
+        AppOpticsAPM.logger.warn "[appoptics_apm/reporter] Reporter.restart isn't supported under JRuby"
+      end
+
+      ##
+      # clear_all_traces
+      #
+      # Truncates the trace output file to zero
+      #
+      def clear_all_traces
+        AppOpticsAPM.reporter.reset if AppOpticsAPM.loaded
+      end
+
+      ##
+      # get_all_traces
+      #
+      # Retrieves all traces written to the trace file
+      #
+      def get_all_traces
+        return [] unless AppOpticsAPM.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 = []
+        AppOpticsAPM.reporter.getSentEventsAsBsonDocument.to_a.each do |e|
+          t = {}
+          e.each_pair { |k, v|
+            t[k] = v
+          }
+          traces << t
+        end
+        traces
+      end
+
+      def sendReport(evt)
+        evt.report(AppOpticsAPM.reporter)
+      end
+    end
+  end
+end
+
+module AppOpticsAPM
+  extend AppOpticsAPMBase
+  include Oboe_metal
+
+  class << self
+    def sample?(opts = {})
+      begin
+        # Return false if no-op mode
+        return false unless AppOpticsAPM.loaded
+
+        return true if ENV.key?('APPOPTICS_GEM_TEST')
+
+        # Validation to make Joboe happy.  Assure that we have the KVs and that they
+        # are not empty strings.
+        opts[:xtrace] = nil      if opts[:xtrace].is_a?(String)     && opts[:xtrace].empty?
+
+        opts[:xtrace]     ||= nil
+
+        sr_cfg = Java::ComTracelyticsJoboe::LayerUtil.shouldTraceRequest(APPOPTICS_STR_BLANK, { 'X-Trace' => opts[:xtrace] })
+
+        # Store the returned SampleRateConfig into AppOpticsAPM::Config
+        if sr_cfg
+          begin
+            AppOpticsAPM::Config.sample_rate = sr_cfg.sampleRate
+            AppOpticsAPM::Config.sample_source = sr_cfg.sampleRateSourceValue
+            # If we fail here, we do so quietly.  This was we don't spam logs
+            # on every request
+          end
+        else
+          AppOpticsAPM.sample_rate = -1
+          AppOpticsAPM.sample_source = -1
+        end
+
+        sr_cfg ? true : false
+      rescue => e
+        AppOpticsAPM.logger.debug "[appoptics_apm/debug] #{e.message}"
+        false
+      end
+    end
+
+    def set_tracing_mode(_mode)
+      AppOpticsAPM.logger.warn '[appoptics_apm/joboe] 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
+    AppOpticsAPM.loaded = true
+
+  when Java::ComTracelyticsAgent::Agent::AgentStatus::INITIALIZED_FAILED
+    AppOpticsAPM.loaded = false
+    $stderr.puts '=============================================================='
+    $stderr.puts 'AppOpticsAPM Java Agent not initialized properly.'
+    $stderr.puts 'Possibly misconfigured?  Going into no-op mode.'
+    $stderr.puts 'http://docs.appoptics.solarwinds.com/Instrumentation/other-instrumentation-modules.html#jruby'
+    $stderr.puts '=============================================================='
+
+  when Java::ComTracelyticsAgent::Agent::AgentStatus::UNINITIALIZED
+    AppOpticsAPM.loaded = false
+    $stderr.puts '=============================================================='
+    $stderr.puts 'AppOpticsAPM Java Agent not loaded. Going into no-op mode.'
+    $stderr.puts 'To preload the AppOpticsAPM java agent see:'
+    $stderr.puts 'http://docs.appoptics.solarwinds.com/Instrumentation/other-instrumentation-modules.html#jruby'
+    $stderr.puts '=============================================================='
+
+  else
+    AppOpticsAPM.loaded = false
+end

data/lib/oboe.rb

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

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,80 @@
+require 'appoptics_apm/thread_local'
+
+module Oboe
+  extend AppOpticsAPMBase
+  if AppOpticsAPM.loaded
+    include Oboe_metal
+  end
+
+  #
+  # Support for Oboe::API calls
+  #
+  module API
+    include AppOpticsAPM::API
+    extend AppOpticsAPM::ThreadLocal
+    thread_local :deprecation_notified
+
+    def self.method_missing(sym, *args, &blk)
+      # Notify of deprecation only once
+      unless @deprecated_notified
+        AppOpticsAPM.logger.warn "[appoptics_apm/warn] Note that Oboe::API has been renamed to AppOpticsAPM::API. (#{sym}:#{args})"
+        AppOpticsAPM.logger.warn '[appoptics_apm/warn] Oboe::API will be deprecated in a future version.'
+        AppOpticsAPM.logger.warn "[appoptics_apm/warn] Caller: #{Kernel.caller[0]}"
+        @deprecated_notified = true
+      end
+      AppOpticsAPM::API.send(sym, *args, &blk)
+    end
+  end
+
+
+  #
+  # Support for Oboe::Config calls
+  #
+  module Config
+    extend AppOpticsAPM::ThreadLocal
+    thread_local :deprecation_notified
+
+    def self.method_missing(sym, *args)
+      # Notify of deprecation only once
+      unless @deprecated_notified
+        AppOpticsAPM.logger.warn "[appoptics_apm/warn] Note that Oboe::Config has been renamed to AppOpticsAPM::Config. (#{sym}:#{args})"
+        AppOpticsAPM.logger.warn '[appoptics_apm/warn] Oboe::Config will be deprecated in a future version.'
+        AppOpticsAPM.logger.warn "[appoptics_apm/warn] Caller: #{Kernel.caller[0]}"
+        @deprecated_notified = true
+      end
+      AppOpticsAPM::Config.send(sym, *args)
+    end
+  end
+
+  #
+  # Support for legacy Oboe::Ruby.load calls
+  #
+  module Ruby
+    extend AppOpticsAPM::ThreadLocal
+    thread_local :deprecation_notified
+
+    def self.method_missing(sym, *args)
+      # Notify of deprecation only once
+      unless @deprecated_notified
+        AppOpticsAPM.logger.warn "[appoptics_apm/warn] Note that Oboe::Ruby has been renamed to AppOpticsAPM::Ruby. (#{sym}:#{args})"
+        AppOpticsAPM.logger.warn '[appoptics_apm/warn] Oboe::Ruby will be deprecated in a future version.'
+        AppOpticsAPM.logger.warn "[appoptics_apm/warn] Caller: #{Kernel.caller[0]}"
+        @deprecated_notified = true
+      end
+      AppOpticsAPM::Ruby.send(sym, *args)
+    end
+  end
+end
+
+#
+# Support for OboeMethodProfiling
+#
+module OboeMethodProfiling
+  def self.included(klass)
+    klass.extend ClassMethods
+  end
+
+  module ClassMethods
+    include AppOpticsAPMMethodProfiling::ClassMethods
+  end
+end

data/lib/oboe/inst/rack.rb

@@ -0,0 +1,11 @@
+require 'appoptics_apm/inst/rack'
+
+module Oboe
+  class Rack < AppOpticsAPM::Rack
+    # This simply makes Oboe::Rack available (and a clone of AppOpticsAPM::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_metal.rb

@@ -0,0 +1,198 @@
+# Copyright (c) 2016 SolarWinds, LLC.
+# All rights reserved.
+
+require 'thread'
+
+# Disable docs and Camelcase warns since we're implementing
+# an interface here.  See OboeBase for details.
+# rubocop:disable Style/Documentation, Style/MethodName
+module AppOpticsAPM
+  extend AppOpticsAPMBase
+  include Oboe_metal
+
+  class Reporter
+    class << self
+      ##
+      # start
+      #
+      # Start the AppOpticsAPM Reporter
+      #
+      def start
+        return unless AppOpticsAPM.loaded
+
+        begin
+          options = []
+
+          ENV['APPOPTICS_REPORTER'] = 'file' if ENV.key?('APPOPTICS_GEM_TEST')
+
+          case ENV['APPOPTICS_REPORTER']
+          when 'file'
+            ENV['APPOPTICS_REPORTER_FILE'] = TRACE_FILE
+          when 'udp'
+            ENV['APPOPTICS_REPORTER_UDP'] = "#{AppOpticsAPM::Config[:reporter_host]}:#{AppOpticsAPM::Config[:reporter_port]}"
+          else # default is ssl, service_key is mandatory
+            return unless valid_service_key?
+            # Oboe will override these settings if there are env settings for them
+            options << AppOpticsAPM::Config[:service_key].to_s
+            options << AppOpticsAPM::Config[:hostname_alias].to_s
+            options << AppOpticsAPM::Config[:debug_level] unless AppOpticsAPM::Config[:debug_level].nil?
+          end
+          AppOpticsAPM.reporter = Oboe_metal::Reporter.new(*options)
+
+          # 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)
+            AppOpticsAPM::API.report_init
+          end
+
+        rescue => e
+          $stderr.puts e.message
+          raise
+        end
+      end
+      alias :restart :start
+
+      def valid_service_key?
+        service_key = (ENV['APPOPTICS_SERVICE_KEY'] || AppOpticsAPM::Config[:service_key]).to_s
+        if service_key == ''
+          AppOpticsAPM.logger.warn '[appoptics_apm/warn] APPOPTICS_SERVICE_KEY not set. Cannot submit data.'
+          AppOpticsAPM.loaded = false
+          return false
+        elsif service_key !~ /^[0-9a-fA-F]{64}:[-.:_?\\\/\w ]{1,255}$/
+          AppOpticsAPM.logger.warn '[appoptics_apm/warn] APPOPTICS_SERVICE_KEY problem. No service name or api token in wrong format. Cannot submit data.'
+          AppOpticsAPM.loaded = false
+          return false
+        end
+        true
+      end
+      ##
+      # sendReport
+      #
+      # Send the report for the given event
+      #
+      def sendReport(evt)
+        AppOpticsAPM.reporter.sendReport(evt)
+      end
+
+      ##
+      # sendStatus
+      #
+      # Send the report for the given event
+      #
+      def sendStatus(evt, context = nil)
+        AppOpticsAPM.reporter.sendStatus(evt, context)
+      end
+
+      ##
+      # clear_all_traces
+      #
+      # Truncates the trace output file to zero
+      #
+      def clear_all_traces
+        File.truncate(TRACE_FILE, 0)
+      end
+
+      ##
+      # get_all_traces
+      #
+      # Retrieves all traces written to the trace file
+      #
+      def get_all_traces
+        io = File.open(TRACE_FILE, 'r')
+        contents = io.readlines(nil)
+
+        return contents if contents.empty?
+
+        traces = []
+
+        #
+        # We use Gem.loaded_spec because older versions of the bson
+        # gem didn't even have a version embedded in the gem.  If the
+        # gem isn't in the bundle, it should rightfully error out
+        # anyways.
+        #
+        if Gem.loaded_specs['bson'].version.to_s < '4.0'
+          s = StringIO.new(contents[0])
+
+          until s.eof?
+            traces << if ::BSON.respond_to? :read_bson_document
+                        BSON.read_bson_document(s)
+                      else
+                        BSON::Document.from_bson(s)
+                      end
+          end
+        else
+          bbb = BSON::ByteBuffer.new(contents[0])
+          until bbb.length == 0
+            traces << Hash.from_bson(bbb)
+          end
+        end
+
+        traces
+      end
+    end
+  end
+
+  module EventUtil
+    def self.metadataString(evt)
+      evt.metadataString
+    end
+  end
+
+  class << self
+    def sample?(opts = {})
+      # Return false if no-op mode
+      return false unless AppOpticsAPM.loaded
+
+      # Assure defaults since SWIG enforces Strings
+      xtrace  = opts[:xtrace]     ? opts[:xtrace].to_s.strip       : APPOPTICS_STR_BLANK
+
+      # the first arg has changed to be the service name, blank means to use the default (from the service key)
+      rv = AppOpticsAPM::Context.sampleRequest(APPOPTICS_STR_BLANK, xtrace)
+
+      if rv == 0
+        AppOpticsAPM.sample_rate = -1
+        AppOpticsAPM.sample_source = -1
+        false
+      else
+        # liboboe version > 1.3.1 returning a bit masked integer with SampleRate and
+        # source embedded
+        AppOpticsAPM.sample_rate = (rv & SAMPLE_RATE_MASK)
+        AppOpticsAPM.sample_source = (rv & SAMPLE_SOURCE_MASK) >> 24
+        true
+      end
+    rescue StandardError => e
+      AppOpticsAPM.logger.debug "[oboe/error] sample? error: #{e.inspect}"
+      false
+    end
+
+    def set_tracing_mode(mode)
+      return unless AppOpticsAPM.loaded
+
+      value = mode.to_sym
+
+      case value
+      when :never
+        AppOpticsAPM::Context.setTracingMode(APPOPTICS_TRACE_NEVER)
+
+      when :always
+        AppOpticsAPM::Context.setTracingMode(APPOPTICS_TRACE_ALWAYS)
+
+      else
+        AppOpticsAPM.logger.fatal "[oboe/error] Invalid tracing mode set: #{mode}"
+        AppOpticsAPM::Context.setTracingMode(APPOPTICS_TRACE_NEVER)
+      end
+    end
+
+    def set_sample_rate(rate)
+      return unless AppOpticsAPM.loaded
+
+      # Update liboboe with the new SampleRate value
+      AppOpticsAPM::Context.setDefaultSampleRate(rate.to_i)
+    end
+  end
+end
+# rubocop:enable Style/Documentation
+
+AppOpticsAPM.loaded = true
+AppOpticsAPM.config_lock = Mutex.new