appoptics_apm 4.2.3 → 4.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 984f806c1810b83b4528e75fd4a4e7b48db4bfa7
-  data.tar.gz: 77acebf5def90972f7bbaa165bdcb4fa5d603442
+SHA256:
+  metadata.gz: f9cd8f06bd5c7b8d7b31daf27b9208a3e528ea3ee65f2cc8b9331eeb823f7e52
+  data.tar.gz: 2356b83ed28ad90de5e5daecdf54187e45b742c63be1c5e5835db0588ec257ec
 SHA512:
-  metadata.gz: 1ddf576b6e8d1ee6d638064e9573bf2461fa34fde1140c9eb63eb193d7540e7d383865b9268d96d85285c932a4ebc33d5c6b7178dd2f1164c76e5c54dc9754f0
-  data.tar.gz: bb28f4ca6696d843e9876c32eb277bff52198d90088a680f16468c1e675c1235b09eef5da5432e38ce6c695a01016defb06b92dc3fab0eaa98dfe9290d293d4f
+  metadata.gz: aef1f899cc31324804807be8536b604ac2dc5a163547ac293bea3e14e1ea8595319d33b232c350e2091a994496ad78fed44e302432c1e226e75b6abaaf24a36e
+  data.tar.gz: 8caef4745de30fc3715d2ab19a3ae7f1fd39741f5ef935dcec2273e8af3101bbdf7d89c93a4042e589ca1cb5111a8be35069d22ff6af7e45d560a48392a00c67

data/.gitignore

@@ -15,8 +15,13 @@ ext/oboe_metal/src/oboe.h
 ext/oboe_metal/src/oboe.hpp
 ext/oboe_metal/src/oboe_debug.h
 ext/oboe_metal/src/oboe_wrap.cxx
+ext/oboe_metal/src/bson/*
 log/
 .vagrant
 gemfiles/.bundle
 swig*
 *.gem
+.yardoc
+coverage
+doc
+.*byebug*

data/.travis.yml

@@ -6,37 +6,38 @@ cache:
   - vendor/bundle
 
 env:
-  - DBTYPE=mysql
-  - DBTYPE=mysql2
   - DBTYPE=postgresql
+#  - DBTYPE=mysql2
+#  - DBTYPE=mysql
 
 rvm:
   - 2.5.1
-  - 2.4.4
-  - 2.3.6
+#  - 2.4.4
+#  - 2.3.6
 #  - jruby-9.0.5.0
 
 gemfile:
-  - gemfiles/noop.gemfile
   - gemfiles/libraries.gemfile
+  - gemfiles/unit.gemfile
   - gemfiles/instrumentation_mocked.gemfile
-  - gemfiles/instrumentation_mocked_oldgems.gemfile
+#  - gemfiles/instrumentation_mocked_oldgems.gemfile
   - gemfiles/frameworks.gemfile
-#  - gemfiles/rails32.gemfile # We currently are not supporting Rails 3.2
+  - gemfiles/rails52.gemfile
+#  - gemfiles/rails51.gemfile
   - gemfiles/rails42.gemfile
-  - gemfiles/rails51.gemfile
-#  - gemfiles/rails52.gemfile # postgres test needs fixing first
+##  - gemfiles/rails32.gemfile # We currently are not supporting Rails 3.2
   - gemfiles/delayed_job.gemfile
+  - gemfiles/noop.gemfile
 
 matrix:
   exclude:
     - rvm: 2.5.1
       env: DBTYPE=mysql
-    - rvm: 2.4.3
-      env: DBTYPE=mysql
     - rvm: 2.4.4
       env: DBTYPE=mysql
 
+    - gemfile: gemfiles/unit.gemfile
+      env: DBTYPE=mysql
     - gemfile: gemfiles/noop.gemfile
       env: DBTYPE=mysql
     - gemfile: gemfiles/libraries.gemfile
@@ -54,6 +55,8 @@ matrix:
     - gemfile: gemfiles/delayed_job.gemfile
       env: DBTYPE=mysql
 
+    - gemfile: gemfiles/unit.gemfile
+      env: DBTYPE=mysql2
     - gemfile: gemfiles/noop.gemfile
       env: DBTYPE=mysql2
     - gemfile: gemfiles/libraries.gemfile
@@ -71,7 +74,7 @@ matrix:
     # We currently are not supporting Rails 3.2
     - rvm: 2.5.1
       gemfile: gemfiles/rails32.gemfile
-    - rvm: 2.4.3
+    - rvm: 2.4.4
       gemfile: gemfiles/rails32.gemfile
 
 #    - rvm: jruby-9.0.5.0

data/Gemfile

@@ -13,7 +13,6 @@ group :development, :test do
   gem 'rubocop', require: false
   gem 'ruby-prof'
   gem 'benchmark-ips'
-
   gem 'ruby-debug',   :platforms => [:mri_18, :jruby]
   gem 'debugger',     :platform  =>  :mri_19
   gem 'byebug',       :platforms => [:mri_20, :mri_21, :mri_22, :mri_23, :mri_24]

data/README.md

@@ -11,12 +11,12 @@ Mongo, Memcache, ActiveRecord, Cassandra, Rack, Resque
 It requires an [AppOptics](https://www.appoptics.com/) account to view metrics.  Get yours, 
 [it's free](https://my.appoptics.com/sign_up).
 
-[![Gem Version](https://badge.fury.io/rb/appoptics_apm.png)](https://badge.fury.io/rb/appoptics_apm)
-[![Build Status](https://travis-ci.com/librato/ruby-appoptics.png?branch=master)](https://travis-ci.com/librato/ruby-appoptics)
-[![Code Climate](https://codeclimate.com/github/librato/ruby-appoptics.png)](https://codeclimate.com/github/librato/ruby-appoptics)
+[![Gem Version](https://badge.fury.io/rb/appoptics_apm.svg)](https://badge.fury.io/rb/appoptics_apm)
+[![Build Status](https://travis-ci.org/appoptics/appoptics-apm-ruby.png?branch=master)](https://travis-ci.org/appoptics/appoptics-apm-ruby)
+[![Maintainability](https://api.codeclimate.com/v1/badges/ac7f36241a23a3a82fc5/maintainability)](https://codeclimate.com/github/appoptics/appoptics-apm-ruby/maintainability)
 
-_Note: The repository name has been changed to ruby-appoptics.  Please update your github remotes with 
-`git remote set-url origin git@github.com:librato/ruby-appoptics.git`._
+_Note: The repository is now at https://github.com/appoptics/appoptics-apm-ruby  Please update your github remotes with 
+`git remote set-url origin git@github.com:appoptics/appoptics-apm-ruby.git`._
 
 # Documentation
 
@@ -384,41 +384,10 @@ You can read more about Ruby gems with C extensions in the
 
 ## Running the Tests
 
-There are few caveats with the tests:
-1. They only run on Linux systems, because of the c-lib used by the appoptics-apm gem.
-1. The are split up, different suites can be run with `bundle exec rake test` depending on the Gemfile set in the 
-environment variable `BUNDLE_GEMFILE`.
-1. Some are integration tests that depend on external services and databases.
-
-Unless you are developing on a linux system it may be easiest to run the tests using docker. The docker test setup is 
-currently being improved to become more comprehensive. 
-
-The command `./run_tests_docker.rb` will run the tests and dump the output to a file in the log folder.
-In the shell it will print the commands to run a single test suite, e.g.
-
-```bash
-docker-compose run --rm --service-ports ruby_appoptics_apm /code/ruby-appoptics_apm/ruby_setup.sh 2.5.1 gemfiles/libraries.gemfile DBTYPE=postgresql
-```
-
-If `true` is added to that command line it will stop in a sheel in the docker container, which is great for debugging.
-
-```bash
-docker-compose run --rm --service-ports ruby_appoptics_apm /code/ruby-appoptics_apm/ruby_setup.sh 2.5.1 gemfiles/libraries.gemfile DBTYPE=postgresql true
-```
-
-The gem is setup to be debugged with `pry` and `pry-byebug`, add the following lines in the code for a break:
-```ruby
-require 'pry'
-require 'pry-byebug'
-byebug
-```
-
-If you need further assistance running tests feel free to get in touch with the main developer.
-
-
+See the README in the test directory.
 
 # License
 
 Copyright (c) 2018 SolarWinds, LLC
 
-Released under the [Librato Open License](https://docs.appoptics.com/kb/apm_tracing/librato-open-license/)
+Released under the [Librato Open License](https://docs.appoptics.com/kb/apm_tracing/librato-open-license/)

data/Rakefile

@@ -53,6 +53,9 @@ Rake::TestTask.new do |t|
     t.test_files = FileList['test/mocked/*_test.rb']
   when /noop/
     t.test_files = FileList['test/noop/*_test.rb']
+  when /unit/
+    t.test_files = FileList['test/unit/*_test.rb'] +
+                   FileList['test/unit/*/*_test.rb']
   end
 
   if defined?(JRUBY_VERSION)
@@ -60,6 +63,18 @@ Rake::TestTask.new do |t|
   end
 end
 
+desc "Run all test suites defined by travis"
+task "docker_tests" do
+  Dir.chdir('test/run_tests')
+  exec('docker-compose run --service-ports ruby_appoptics /code/ruby-appoptics/test/run_tests/ruby_setup.sh test')
+end
+
+desc "Start docker container for testing and debugging"
+task "docker" do
+  Dir.chdir('test/run_tests')
+  exec('docker-compose run --service-ports ruby_appoptics /code/ruby-appoptics/test/run_tests/ruby_setup.sh bash')
+end
+
 desc "Fetch extension dependency files"
 task :fetch_ext_deps do
   swig_version = %x{swig -version} rescue ''
@@ -89,6 +104,7 @@ task :fetch_ext_deps do
   # oboe and bson header files
   FileUtils.mkdir_p(File.join(ext_src_dir, 'bson'))
   %w(oboe.h oboe.hpp oboe_debug.h oboe.i bson/bson.h bson/platform_hacks.h).each do |filename|
+  # %w(oboe.h oboe_debug.h oboe.i bson/bson.h bson/platform_hacks.h).each do |filename|
     remote_file = File.join(oboe_s3_dir, 'include', filename)
     local_file = File.join(ext_src_dir, filename)
 
@@ -130,7 +146,7 @@ task :compile do
     else
       Dir.chdir(pwd)
       puts '!! Extension failed to build (see above). Have the required binary and header files been fetched?'
-      puts '!! Try the tasks in this order: clean > fetchsource > compile.'
+      puts '!! Try the tasks in this order: clean > fetch_ext_deps > compile.'
     end
   else
     puts '== Nothing to do under JRuby.'

data/appoptics_apm.gemspec

@@ -32,6 +32,8 @@ Gem::Specification.new do |s|
 
   s.add_runtime_dependency('json', '>= 0')
   s.add_runtime_dependency('no_proxy_fix', '~> 0.1.2', '>= 0.1.2')
+  s.add_runtime_dependency('simplecov', '>= 0.16.0') if ENV["SIMPLECOV_COVERAGE"]
+  s.add_runtime_dependency('simplecov-console', '>= 0.4.0') if ENV["SIMPLECOV_COVERAGE"]
 
   # Development dependencies used in gem development & testing
   s.add_development_dependency('rake', '>= 0.9.0')

data/{build_gems.sh → build_gem.sh}

@@ -1,5 +1,5 @@
 #!/usr/bin/env bash
-# builds the appoptics_apm gem for JRuby and MRI.
+# builds the appoptics_apm gem for MRI.
 
 echo -e "\n=== building for MRI ===\n"
 export RBENV_VERSION=2.3.1

data/build_gem_upload_to_packagecloud.sh

@@ -0,0 +1,15 @@
+#!/bin/bash
+
+# build the gem
+./build_gem.sh
+
+# save current rbenv setting and switch to 2.4.1 for the package_cloud commands
+current_ruby=`rbenv global`
+rbenv global 2.4.1
+
+# prerequisite: package_cloud token needs to be in ~/.packagecloud
+gem=`ls -dt1 appoptics_apm-[^pre]*.gem | head -1`
+package_cloud push AppOptics/apm-instrumentation $gem
+
+# restore ruby version
+rbenv global $current_ruby

data/examples/SDK/01_basic_tracing.rb

@@ -7,7 +7,7 @@
 # `bundle exec ruby 01_basic_tracing.rb`
 
 require 'appoptics_apm'
-unless AppopticsAPM::SDK.appoptics_ready(10_000)
+unless AppopticsAPM::SDK.appoptics_ready?(10_000)
   puts "aborting!!! Agent not ready after 10 seconds"
   exit false
 end

data/ext/oboe_metal/src/VERSION

@@ -1 +1 @@
-3.0.2
+3.1.2

data/ext/oboe_metal/src/bson/bson.h

@@ -70,7 +70,7 @@ typedef struct {
 
 #pragma pack(1)
 typedef union{
-    char bytes[12];
+    char bytes[12];  // Flawfinder: ignore
     int ints[3];
 } bson_oid_t;
 #pragma pack()
@@ -170,7 +170,6 @@ char * bson_buffer_finish( bson_buffer * b );
 void bson_buffer_destroy( bson_buffer * b );
 
 bson_buffer * bson_append_oid( bson_buffer * b , const char * name , const bson_oid_t* oid );
-bson_buffer * bson_append_new_oid( bson_buffer * b , const char * name );
 bson_buffer * bson_append_int( bson_buffer * b , const char * name , const int i );
 bson_buffer * bson_append_long( bson_buffer * b , const char * name , const int64_t i );
 bson_buffer * bson_append_double( bson_buffer * b , const char * name , const double d );

data/ext/oboe_metal/src/bson/platform_hacks.h

@@ -51,11 +51,11 @@ typedef long long int int64_t;
 #ifdef MONGO_BIG_ENDIAN
 #define bson_little_endian64(out, in) ( bson_swap_endian64(out, in) )
 #define bson_little_endian32(out, in) ( bson_swap_endian32(out, in) )
-#define bson_big_endian64(out, in) ( memcpy(out, in, 8) )
-#define bson_big_endian32(out, in) ( memcpy(out, in, 4) )
+#define bson_big_endian64(out, in) ( memmove(out, in, 8) )
+#define bson_big_endian32(out, in) ( memmove(out, in, 4) )
 #else
-#define bson_little_endian64(out, in) ( memcpy(out, in, 8) )
-#define bson_little_endian32(out, in) ( memcpy(out, in, 4) )
+#define bson_little_endian64(out, in) ( memmove(out, in, 8) )
+#define bson_little_endian32(out, in) ( memmove(out, in, 4) )
 #define bson_big_endian64(out, in) ( bson_swap_endian64(out, in) )
 #define bson_big_endian32(out, in) ( bson_swap_endian32(out, in) )
 #endif

data/lib/appoptics_apm.rb

@@ -13,46 +13,44 @@ begin
   require 'appoptics_apm/util'
   require 'appoptics_apm/xtrace'
   require 'appoptics_apm/support'
+  require 'appoptics_apm/base'
+  AppOpticsAPM.loaded = false
 
-  # If OboeHeroku is already defined then we are in a PaaS environment
-  # with an alternate metal (see the oboe-heroku gem)
-  unless defined?(OboeHeroku)
-    require 'appoptics_apm/base'
-    AppOpticsAPM.loaded = false
+  require 'appoptics_apm/config'
+  AppOpticsAPM::Config.load_config_file
 
-    begin
-      if RUBY_PLATFORM == 'java'
-        require '/usr/local/tracelytics/tracelyticsagent.jar'
-        require 'joboe_metal'
-      elsif RUBY_PLATFORM =~ /linux/
-        require 'oboe_metal.so'
-        require 'oboe_metal.rb'  # sets AppOpticsAPM.loaded = true  if successful
-      else
-        $stderr.puts '==================================================================='
-        $stderr.puts "AppOptics warning: Platform #{RUBY_PLATFORM} not yet supported."
-        $stderr.puts 'see: https://docs.appoptics.com/kb/apm_tracing/supported_platforms/'
-        $stderr.puts 'Tracing disabled.'
-        $stderr.puts 'Contact support@appoptics.com if this is unexpected.'
-        $stderr.puts '==================================================================='
-      end
-    rescue LoadError
-      unless ENV['RAILS_GROUP'] == 'assets' or ENV['IGNORE_APPOPTICS_WARNING']
-        $stderr.puts '=============================================================='
-        $stderr.puts 'Missing AppOpticsAPM libraries.  Tracing disabled.'
-        $stderr.puts 'See: https://docs.appoptics.com/kb/apm_tracing/ruby/'
-        $stderr.puts '=============================================================='
-      end
+  begin
+    if RUBY_PLATFORM == 'java'
+      require '/usr/local/tracelytics/tracelyticsagent.jar'
+      require 'joboe_metal'
+    elsif RUBY_PLATFORM =~ /linux/
+      require_relative './oboe_metal.so'
+      require 'oboe_metal.rb'  # sets AppOpticsAPM.loaded = true if successful
+    else
+      $stderr.puts '==================================================================='
+      $stderr.puts "AppOptics warning: Platform #{RUBY_PLATFORM} not yet supported."
+      $stderr.puts 'see: https://docs.appoptics.com/kb/apm_tracing/supported_platforms/'
+      $stderr.puts 'Tracing disabled.'
+      $stderr.puts 'Contact support@appoptics.com if this is unexpected.'
+      $stderr.puts '==================================================================='
+    end
+  rescue LoadError => e
+    unless ENV['RAILS_GROUP'] == 'assets' or ENV['IGNORE_APPOPTICS_WARNING']
+      $stderr.puts '=============================================================='
+      $stderr.puts 'Missing AppOpticsAPM libraries.  Tracing disabled.'
+      $stderr.puts "Error: #{e.message}"
+      $stderr.puts 'See: https://docs.appoptics.com/kb/apm_tracing/ruby/'
+      $stderr.puts '=============================================================='
     end
   end
 
-  require 'appoptics_apm/config'
-  AppOpticsAPM::Config.load_config_file
-
   require 'appoptics_apm/loading'
   require 'appoptics_apm/legacy_method_profiling'
   require 'appoptics_apm/method_profiling'
 
   if AppOpticsAPM.loaded
+    # tracing mode is configured via config file but can only be set once we have oboe_metal loaded
+    AppOpticsAPM.set_tracing_mode(AppOpticsAPM::Config[:tracing_mode].to_sym)
     require 'appoptics_apm/instrumentation'
 
     # Frameworks

data/lib/appoptics_apm/api/logging.rb

@@ -18,6 +18,9 @@ module AppOpticsAPM
     #
     # These are the lower level methods, please see AppOpticsAPM::SDK
     # for the higher level methods
+    #
+    # If using these directly make sure to always match a start/end and entry/exit to
+    # avoid broken traces.
     module Logging
       @@ints_or_nil = [Integer, Float, NilClass, String]
       @@ints_or_nil << Fixnum unless RUBY_VERSION >= '2.4'
@@ -73,9 +76,10 @@ module AppOpticsAPM
           return AppOpticsAPM::Context.toString
         end
 
-        opts.merge!(:ErrorClass => exception.class.name,
-                    :ErrorMsg => exception.message,
-                    :Backtrace => exception.backtrace.join("\r\n")) if exception.backtrace
+        opts.merge!(:Spec => 'error',
+                    :ErrorClass => exception.class.name,
+                    :ErrorMsg => exception.message)
+        opts.merge!(:Backtrace => exception.backtrace.join("\r\n")) if exception.backtrace
 
         exception.instance_variable_set(:@exn_logged, true)
         log(layer, :error, opts)
@@ -125,6 +129,9 @@ module AppOpticsAPM
         # end
         #++
 
+        # This is a bit ugly, but here is the best place to reset the layer_op thread local var.
+        AppOpticsAPM.layer_op = nil unless AppOpticsAPM::Context.isValid
+
         if AppOpticsAPM.sample?(opts.merge(:xtrace => xtrace))
           # Yes, we're sampling this request
           # Probablistic tracing of a subset of requests based off of
@@ -182,9 +189,6 @@ module AppOpticsAPM
       def log_end(layer, opts = {}, event = nil)
         return AppOpticsAPM::Context.toString unless AppOpticsAPM.tracing?
 
-        # Deal with the transaction name
-        opts[:TransactionName] = determine_transaction_name(layer, opts)
-
         event ||= AppOpticsAPM::Context.createEvent
         log_event(layer, :exit, event, opts)
       ensure
@@ -212,7 +216,7 @@ module AppOpticsAPM
       def log_entry(layer, opts = {}, op = nil)
         return AppOpticsAPM::Context.toString unless AppOpticsAPM.tracing?
 
-        AppOpticsAPM.layer_op = op.to_sym if op
+        AppOpticsAPM.layer_op = (AppOpticsAPM.layer_op || []) << op.to_sym if op
         log_event(layer, :entry, AppOpticsAPM::Context.createEvent, opts)
       end
 
@@ -257,7 +261,8 @@ module AppOpticsAPM
       def log_exit(layer, opts = {}, op = nil)
         return AppOpticsAPM::Context.toString unless AppOpticsAPM.tracing?
 
-        AppOpticsAPM.layer_op = nil if op
+        AppOpticsAPM.layer_op.pop if op && AppOpticsAPM.layer_op.is_a?(Array) && AppOpticsAPM.layer_op.last == op.to_sym
+
         log_event(layer, :exit, AppOpticsAPM::Context.createEvent, opts)
       end
 
@@ -306,25 +311,6 @@ module AppOpticsAPM
         AppOpticsAPM::Context.toString
       end
 
-      ##
-      # Determine the transaction name to be set on the trace
-      #
-      # A transaction name set via the opts key `:TransactionName` takes precedence
-      # over a currently set custom transaction name. if neither are provided it
-      # returns `"custom_#{span}"`
-      #
-      # === Argument:
-      # * +opts+ (hash) the value of :TransactionName will be set as custom transaction name
-      #
-      # === Returns:
-      # (string) the current transaction name
-      #
-      def determine_transaction_name(span, opts = {})
-        opts[:TransactionName] ||= opts.delete('TransactionName')
-        AppOpticsAPM::API.set_transaction_name(opts[:TransactionName])
-        AppOpticsAPM.transaction_name || "custom-#{span}"
-      end
-
       private
 
       ##