appoptics_apm 4.2.2 → 4.2.3

data/lib/appoptics_apm/support.rb

@@ -83,23 +83,6 @@ module AppOpticsAPM
       AppOpticsAPM.logger.warn 'No ActiveRecord'
     end
 
-    # TODO we don't have libs in /usr/lib anymore, is this still needed???
-    # AppOpticsAPM.logger.warn '********************************************************'
-    # AppOpticsAPM.logger.warn '* AppOpticsAPM Libraries'
-    # AppOpticsAPM.logger.warn '********************************************************'
-    # files = []
-    # ['/usr/lib/liboboe*', '/usr/lib64/liboboe*'].each do |d|
-    #   files = Dir.glob(d)
-    #   break if !files.empty?
-    # end
-    # if files.empty?
-    #   AppOpticsAPM.logger.warn 'Error: No liboboe libs!'
-    # else
-    #   files.each { |f|
-    #     AppOpticsAPM.logger.warn f
-    #   }
-    # end
-
     AppOpticsAPM.logger.warn '********************************************************'
     AppOpticsAPM.logger.warn '* AppOpticsAPM::Config Values'
     AppOpticsAPM.logger.warn '********************************************************'

data/lib/appoptics_apm/test.rb

@@ -16,7 +16,7 @@ module AppOpticsAPM
           # Load all of the test workers
           pattern = File.join(File.dirname(__FILE__), '../../test/jobs/**/', '*.rb')
           Dir.glob(pattern) do |f|
-            AppOpticsAPM.logger.debug "Loading test job file: #{File.basename(f)}"
+            AppOpticsAPM.logger.debug "[appoptics_apm/test] Loading test job file: #{File.basename(f)}"
             require f
           end
         end

data/lib/appoptics_apm/util.rb

@@ -262,9 +262,10 @@ module AppOpticsAPM
           platform_info['Force']                        = true
           platform_info['Ruby.Platform.Version']        = RUBY_PLATFORM
           platform_info['Ruby.Version']                 = RUBY_VERSION
-          platform_info['Ruby.AppOpticsAPM.Version']       = ::AppOpticsAPM::Version::STRING
-          # Should this be the oboe version, separate from the Ruby library's version?
-          platform_info['Ruby.Oboe.Version']            = ::AppOpticsAPM::Version::STRING
+          platform_info['Ruby.AppOpticsAPM.Version']    = ::AppOpticsAPM::Version::STRING
+
+          clib_version_file = File.join(Gem::Specification.find_by_name('appoptics_apm').gem_dir, 'ext', 'oboe_metal', 'src', 'VERSION')
+          platform_info['Ruby.clib.Version']            = File.read(clib_version_file).chomp
           platform_info['RubyHeroku.AppOpticsAPM.Version'] = ::AppOpticsAPMHeroku::Version::STRING if defined?(::AppOpticsAPMHeroku)
           platform_info['Ruby.TraceMode.Version']       = ::AppOpticsAPM::Config[:tracing_mode]
 

data/lib/appoptics_apm/version.rb

@@ -8,7 +8,7 @@ module AppOpticsAPM
   module Version
     MAJOR = 4
     MINOR = 2
-    PATCH = 2
+    PATCH = 3
 
     STRING = [MAJOR, MINOR, PATCH].compact.join('.')
   end

data/lib/appoptics_apm/xtrace.rb

@@ -24,7 +24,7 @@ module AppOpticsAPM
 
         true
       rescue StandardError => e
-        AppOpticsAPM.logger.debug e.message
+        AppOpticsAPM.logger.debug "[appoptics_apm/xtrace] #{e.message}"
         AppOpticsAPM.logger.debug e.backtrace
         false
       end
@@ -51,7 +51,7 @@ module AppOpticsAPM
 
         xtrace[2..41]
       rescue StandardError => e
-        AppOpticsAPM.logger.debug e.message
+        AppOpticsAPM.logger.debug "[appoptics_apm/xtrace] #{e.message}"
         AppOpticsAPM.logger.debug e.backtrace
         return nil
       end
@@ -66,7 +66,7 @@ module AppOpticsAPM
 
         xtrace[42..57]
       rescue StandardError => e
-        AppOpticsAPM.logger.debug e.message
+        AppOpticsAPM.logger.debug "[appoptics_apm/xtrace] #{e.message}"
         AppOpticsAPM.logger.debug e.backtrace
         return nil
       end

data/lib/joboe_metal.rb

@@ -150,13 +150,11 @@ module AppOpticsAPM
 
         # 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[:layer]      ||= nil
         opts[:xtrace]     ||= nil
 
-        sr_cfg = Java::ComTracelyticsJoboe::LayerUtil.shouldTraceRequest(opts[:layer], { 'X-Trace' => opts[:xtrace] })
+        sr_cfg = Java::ComTracelyticsJoboe::LayerUtil.shouldTraceRequest(APPOPTICS_STR_BLANK, { 'X-Trace' => opts[:xtrace] })
 
         # Store the returned SampleRateConfig into AppOpticsAPM::Config
         if sr_cfg
@@ -179,7 +177,7 @@ module AppOpticsAPM
     end
 
     def set_tracing_mode(_mode)
-      AppOpticsAPM.logger.warn 'When using JRuby set the tracing mode in /usr/local/tracelytics/javaagent.json instead'
+      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)

data/lib/oboe_metal.rb

@@ -134,10 +134,10 @@ module AppOpticsAPM
       return false unless AppOpticsAPM.loaded
 
       # Assure defaults since SWIG enforces Strings
-      layer   = opts[:layer]      ? opts[:layer].to_s.strip.freeze : APPOPTICS_STR_BLANK
       xtrace  = opts[:xtrace]     ? opts[:xtrace].to_s.strip       : APPOPTICS_STR_BLANK
 
-      rv = AppOpticsAPM::Context.sampleRequest(layer, xtrace)
+      # 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
@@ -162,14 +162,14 @@ module AppOpticsAPM
 
       case value
       when :never
-        AppOpticsAPM::Context.setTracingMode(OBOE_TRACE_NEVER)
+        AppOpticsAPM::Context.setTracingMode(APPOPTICS_TRACE_NEVER)
 
       when :always
-        AppOpticsAPM::Context.setTracingMode(OBOE_TRACE_ALWAYS)
+        AppOpticsAPM::Context.setTracingMode(APPOPTICS_TRACE_ALWAYS)
 
       else
         AppOpticsAPM.logger.fatal "[oboe/error] Invalid tracing mode set: #{mode}"
-        AppOpticsAPM::Context.setTracingMode(OBOE_TRACE_NEVER)
+        AppOpticsAPM::Context.setTracingMode(APPOPTICS_TRACE_NEVER)
       end
     end
 

data/lib/rails/generators/appoptics_apm/templates/appoptics_apm_initializer.rb

@@ -43,12 +43,13 @@ if defined?(AppOpticsAPM::Config)
   AppOpticsAPM::Config[:sanitize_sql_opts]   = Regexp::IGNORECASE
 
   #
-  # Do Not Trace
-  # These two values allow you to configure specific URL patterns to
-  # never be traced.  By default, this is set to common static file
+  # Do Not Trace - DNT
+  # 'dnt_regexp' and 'dnt_opts' allow you to configure specific URL patterns
+  # to never be traced.  By default, this is set to common static file
   # extensions but you may want to customize this list for your needs.
+  # Examples of such files may be images, javascript, pdfs, and text files.
   #
-  # dnt_regexp and dnt_opts is passed to Regexp.new to create
+  # 'dnt_regexp' and 'dnt_opts' is passed to Regexp.new to create
   # a regular expression object.  That is then used to match against
   # the incoming request path.
   #

data/run_tests_docker.rb

@@ -8,6 +8,12 @@
 # `docker build -f Dockerfile_test -t ruby_appoptics_apm .`
 # (docker-compose will build it too if missing)
 
+
+# remove rbenv .ruby_version file that may be stuck on a different ruby version
+# because we mounted this directory in a docker container
+require 'fileutils'
+FileUtils.rm_f('.ruby_version')
+
 require 'yaml'
 travis = YAML.load_file('.travis.yml')
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: appoptics_apm
 version: !ruby/object:Gem::Version
-  version: 4.2.2
+  version: 4.2.3
 platform: ruby
 authors:
 - Maia Engeli
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-11 00:00:00.000000000 Z
+date: 2018-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -133,14 +133,8 @@ files:
 - build_gems.sh
 - config/initializers/.keep
 - docker-compose.yml
-- examples/DNT.md
+- examples/SDK/01_basic_tracing.rb
 - examples/carrying_context.rb
-- examples/instrumenting_metal_controller.rb
-- examples/puma_on_heroku_config.rb
-- examples/tracing_async_threads.rb
-- examples/tracing_background_jobs.rb
-- examples/tracing_forked_processes.rb
-- examples/unicorn_on_heroku_config.rb
 - ext/oboe_metal/extconf.rb
 - ext/oboe_metal/lib/.keep
 - ext/oboe_metal/noop/noop.c
@@ -158,6 +152,7 @@ files:
 - lib/appoptics_apm/api/layerinit.rb
 - lib/appoptics_apm/api/logging.rb
 - lib/appoptics_apm/api/memcache.rb
+- lib/appoptics_apm/api/metrics.rb
 - lib/appoptics_apm/api/profiling.rb
 - lib/appoptics_apm/api/tracing.rb
 - lib/appoptics_apm/api/util.rb
@@ -215,6 +210,7 @@ files:
 - lib/appoptics_apm/noop/README.md
 - lib/appoptics_apm/noop/context.rb
 - lib/appoptics_apm/ruby.rb
+- lib/appoptics_apm/sdk.rb
 - lib/appoptics_apm/support.rb
 - lib/appoptics_apm/test.rb
 - lib/appoptics_apm/thread_local.rb

data/examples/DNT.md

@@ -1,35 +0,0 @@
-By default, the AppOpticsAPM gem will not trace routes with extensions
-for common static files.  Examples of such files may be images,
-javascript, pdfs and text files.
-
-This is done by using the regular expression stored in
-`AppOpticsAPM::Config[:dnt_regexp]`:
-
-    .(jpg|jpeg|gif|png|ico|css|zip|tgz|gz|rar|bz2|pdf|txt|tar|wav|bmp|rtf|js|flv|swf|ttf|woff|svg|less)$
-
-This string is used as a regular expression and is tested against
-candidate URLs to be instrumented.
-
-To replace the pattern in use, you can update this regular expression
-string.  Here are some examples.
-
-If you prefer that you want your javascript and CSS files instrumented,
-you can update `AppOpticsAPM::Config[:dnt_regexp]` with an updated regexp
-pattern (without the "js" and "css" entries):
-
-    .(jpg|jpeg|gif|png|ico|zip|tgz|gz|rar|bz2|pdf|txt|tar|wav|bmp|rtf|flv|swf|ttf|woff|svg|less)$
-
-If you prefer to not instrument all javascript files except for one
-named `show.js`, you could put this assignment into your initializer,
-rackup file or application.rb (note that this example uses a standard
-regexp [negative
-look-behind](http://www.regular-expressions.info/lookaround.html) that
-isn't supported in Ruby 1.8):
-
-    AppOpticsAPM::Config[:dnt_regexp] = "(\.js$)(?<!show.js)"
-
-Since this pattern is used with the standard Ruby Regexp class, you can
-use any Regexp supported pattern.  See the documentation on Ruby Regexp
-[here](https://www.omniref.com/ruby/2.2.0/symbols/Regexp?d=380181456&n=0#doc_uncollapsed=true&d=380181456&n=0)
-or you can also view the oboe gem [source code documentation for this
-feature](https://github.com/tracelytics/ruby-appoptics/blob/master/lib/appoptics/config.rb#L129).

data/examples/instrumenting_metal_controller.rb

@@ -1,8 +0,0 @@
-class MetalController < ActionController::Metal
-  def index
-    self.response_body = 'Hello Metal!'
-  end
-
-  include AppOpticsAPMMethodProfiling
-  profile_method :index, 'metal-index'
-end

data/examples/puma_on_heroku_config.rb

@@ -1,17 +0,0 @@
-workers Integer(ENV['WEB_CONCURRENCY'] || 2)
-threads_count = Integer(ENV['MAX_THREADS'] || 5)
-threads threads_count, threads_count
-
-preload_app!
-
-rackup      DefaultRackup
-port        ENV['PORT']     || 3000
-environment ENV['RACK_ENV'] || 'development'
-
-on_worker_boot do
-  ::AppOpticsAPM.reconnect! if defined?(::AppOpticsAPM)
-end
-
-on_worker_shutdown do
-  ::AppOpticsAPM.disconnect! if defined?(::AppOpticsAPM)
-end

data/examples/tracing_async_threads.rb

@@ -1,124 +0,0 @@
-#
-# This sample demonstrates how to instrument a main loop that
-# retrieves work and spawn threads that do the actual work
-#
-
-require 'math'
-require 'oboe'
-
-AppOpticsAPM::Config[:tracing_mode] = :always
-AppOpticsAPM::Config[:verbose] = true
-
-# The parent process/loop which collects data
-Kernel.loop do
-
-  # For each loop, we instrument the work retrieval.  These traces
-  # will show up as layer 'get_the_work'.
-  AppOpticsAPM::API.start_trace('get_the_work') do
-    work = get_the_work
-
-    # Loop through work and pass to `do_the_work` method
-    # that spawns a thread each time
-    work.each do |j|
-
-      # In the new Thread block, the AppOpticsAPM tracing context isn't there
-      # so we carry it over manually and pass it to the `start_trace`
-      # method.
-
-      # In the AppOptics dashboard, this will show up as parent traces
-      # (layer 'get_the_work') with child traces (layer 'do_the_work').
-
-      tracing_context = AppOpticsAPM::Context.toString
-
-      Thread.new do
-        result = nil
-
-        AppOpticsAPM::API.start_trace('do_the_work', tracing_context, :Async => 1) do
-          result = do_the_work(j)
-        end
-
-        result
-      end
-    end
-  end
-  sleep 5
-end
-
-
-##
-# get_the_work
-#
-# Method to retrieve work to do
-#
-def get_the_work
-  # We'll just return random integers as a
-  # fake work load
-  w = []
-  w << rand(25)
-  w << rand(25)
-  w << rand(25)
-end
-
-##
-# do_the_work
-#
-# The work-horse method
-#
-def do_the_work(job_to_do)
-  i = job_to_do
-  i * Math::PI
-end
-
-####################################################
-# Notes
-####################################################
-
-# The above code generates a trace for each loop of the parent data collection process.
-# Those traces have the layer name of `get_the_work` and will show up in the AppOptics
-# dashboard as such.
-#
-# Then as threads are spawned to process individual bits of work, we carry over the
-# `tracing_context` and start a new asynchronous trace using `start_trace`.  (An
-# asynchronous trace is noted by passing the `Async` Hash key with a value of `1`).
-#
-# In the AppOptics dashboard, the two traces (parent and child; or one to many) will
-# be linked and displayed together as a single trace.
-
-####################################################
-# Caveats
-####################################################
-
-# If the main loop is retrieving many jobs (work) to process on each loop then
-# linking the traces may not be the best strategy as such large relationships
-# are difficult to display correctly in the AppOptics dashboard and provide little
-# added value.
-#
-# If there are more than 8 - 12 threads spawned from each loop, then you may want to consider
-# NOT carrying over tracing context into the spawned threads.
-#
-# In this case, you can simply omit `tracing_context` and passing it to `start_trace` in
-# the `Thread.new` block. (lines 32 + 37).  Also remove the `{ Async => 1 }` Hash!
-#
-# This will produce two sets of traces with two the layer names 'get_the_work' +
-# 'do_the_work'.
-#
-# In the AppOptics dashboard, you can then separate or unify these traces into
-# independent applications.  e.g. job processor, data retrieval, thread worker etc...
-#
-# An implementation of the work loop without carrying over tracing context would look
-# like the following:
-#
-#    work.each do |j|
-#      Thread.new do
-#        result = nil
-#
-#        AppOpticsAPM::API.start_trace('do_the_work') do
-#          result = do_the_work(j)
-#        end
-#
-#        result
-#      end
-#    end
-#
-# If anything isn't clear, please don't hesitate to reach us at support (support@appoptics.com).
-#

data/examples/tracing_background_jobs.rb

@@ -1,53 +0,0 @@
-require 'rubygems'
-require 'bundler'
-
-Bundler.require
-
-# Make sure oboe is at the bottom of your Gemfile.
-# This is likely redundant but just in case.
-require 'oboe'
-
-# Tracing mode can be 'never' or 'always'
-AppOpticsAPM::Config[:tracing_mode] = 'always'
-
-#
-# Update April 9, 2015 - this is done automagically now
-# and doesn't have to be called manually
-#
-# Load library instrumentation to auto-capture stuff we know about...
-# e.g. ActiveRecord, Cassandra, Dalli, Redis, Memcache, Mongo
-# AppOpticsAPM::Ruby.load
-
-# Some KVs to report to the dashboard
-report_kvs = {}
-report_kvs[:command_line_params] = ARGV.to_s
-report_kvs[:user_id] = `whoami`
-
-AppOpticsAPM::API.start_trace('my_background_job', nil, report_kvs) do
-  #
-  # Initialization code
-  #
-
-  tasks = get_all_tasks
-
-  tasks.each do |t|
-    # Optional: Here we embed another 'trace' to separate actual
-    # work for each task.  In the APPOPTICS dashboard, this will show
-    # up as a large 'my_background_job' parent layer with many
-    # child 'task" layers.
-    AppOpticsAPM::API.trace('task', :task_id => t.id) do
-      t.perform
-    end
-  end
-  #
-  # cleanup code
-  #
-end
-
-# Note that we use 'start_trace' in the outer block and 'trace' for
-# any sub-blocks of code we wish to instrument.  The arguments for
-# both methods vary slightly.
-#
-# TODO update location of the following doc
-# Details in RubyDoc:
-# https://www.omniref.com/ruby/gems/oboe/2.7.10.1/symbols/AppOpticsAPM::API::Tracing#tab=Methods