appoptics_apm 4.0.5 → 4.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ff856df7c5459eb39bfa7b9d5a248c44f74a6d3e
-  data.tar.gz: e41c9199c097afcae143d271016566f2fb2077f2
+  metadata.gz: 3b94b0d15e2fc4895a343bb84ef881116864407e
+  data.tar.gz: 2225955904b5ce063dcddb123014d1deb2f923a3
 SHA512:
-  metadata.gz: ce3d4658d0bb2f448561fa6aa46f38a506eeabb6eb07681c726b2de3b1b63c5976be1b72851c598c7dcf975a53a85bc9a600267cf569fb1a834ee7ffac0f401e
-  data.tar.gz: 374174feff92a2d0accbd4ce04548f580814d5d3246d390c67d694703474f91da860517cab0c1ba777c2ff4b499c00fcb9556fb0bbee4d2d02a7d50d32546ce6
+  metadata.gz: fafaacdc392b750d72c273a2295614ea808cc58da3048871e75d2337ea911381d632cd1c706291f01abe54e6a7d81c89e34a522475b6c765221669c7c46c1db5
+  data.tar.gz: 491ce4b517259a6bddb40513c158c11998d5e8556c3a8668317b6400725f6456f713216f70ec54e004ecf2c417498f2b84222144132064b6d5b0e762c4d68765

data/.travis.yml

@@ -20,12 +20,49 @@ gemfile:
   - gemfiles/frameworks.gemfile
   - gemfiles/rails32.gemfile
   - gemfiles/rails42.gemfile
-  - gemfiles/rails50.gemfile
   - gemfiles/rails51.gemfile
   - gemfiles/delayed_job.gemfile
 
+env:
+  - DBTYPE=mysql
+  - DBTYPE=mysql2
+  - DBTYPE=postgresql
+
 matrix:
   exclude:
+    - rvm: 2.5.0
+      env: DBTYPE=mysql
+    - rvm: 2.4.3
+      env: DBTYPE=mysql
+
+    - gemfile: gemfiles/noop.gemfile
+      env: DBTYPE=mysql
+    - gemfile: gemfiles/libraries.gemfile
+      env: DBTYPE=mysql
+    - gemfile: gemfiles/instrumentation_mocked.gemfile
+      env: DBTYPE=mysql
+    - gemfile: gemfiles/instrumentation_mocked_oldgems.gemfile
+      env: DBTYPE=mysql
+    - gemfile: gemfiles/frameworks.gemfile
+      env: DBTYPE=mysql
+    - gemfile: gemfiles/rails51.gemfile
+      env: DBTYPE=mysql
+    - gemfile: gemfiles/delayed_job.gemfile
+      env: DBTYPE=mysql
+
+    - gemfile: gemfiles/noop.gemfile
+      env: DBTYPE=mysql2
+    - gemfile: gemfiles/libraries.gemfile
+      env: DBTYPE=mysql2
+    - gemfile: gemfiles/instrumentation_mocked.gemfile
+      env: DBTYPE=mysql2
+    - gemfile: gemfiles/instrumentation_mocked_oldgems.gemfile
+      env: DBTYPE=mysql2
+    - gemfile: gemfiles/frameworks.gemfile
+      env: DBTYPE=mysql2
+    - gemfile: gemfiles/delayed_job.gemfile
+      env: DBTYPE=mysql2
+
     # Rails 3.2 is not compatible with Ruby >= '2.4'
     - rvm: 2.5.0
       gemfile: gemfiles/rails32.gemfile

data/.yardopts

@@ -0,0 +1,5 @@
+--no-private
+--readme yardoc_frontpage.md
+lib/appoptics_apm/api/logging.rb
+lib/appoptics_apm/api/profiling.rb
+lib/appoptics_apm/api/tracing.rb

data/Dockerfile_test

@@ -31,10 +31,11 @@ RUN  git clone https://github.com/rbenv/rbenv.git ~/.rbenv \
      && echo 'bundler' > ~/.rbenv/default-gems
 
 # install rubies to build our gem against
-RUN .  ~/.profile \
+RUN . ~/.profile \
     && rbenv install 1.9.3-p551 \
-    && rbenv install 2.3.1 \
-    && rbenv install 2.4.1
+    && rbenv install 2.3.6 \
+    && rbenv install 2.4.3 \
+    && rbenv install 2.5.0
 #    && rbenv install jruby-9.0.5.0
 
 # install swig 3.0.8

data/Rakefile

@@ -99,24 +99,25 @@ task :compile do
   if !defined?(JRUBY_VERSION)
     puts "== Building the c extension against Ruby #{RUBY_VERSION}"
 
-    pwd     = Dir.pwd
-    ext_dir = File.expand_path('ext/oboe_metal')
-    symlink = File.expand_path('lib/oboe_metal.so')
-    so_file = File.expand_path('ext/oboe_metal/oboe_metal.so')
+    pwd      = Dir.pwd
+    ext_dir  = File.expand_path('ext/oboe_metal')
+    final_so = File.expand_path('lib/oboe_metal.so')
+    so_file  = File.expand_path('ext/oboe_metal/oboe_metal.so')
 
     Dir.chdir ext_dir
+    ENV['FROM_S3'] = 'TRUE'
     cmd = [Gem.ruby, 'extconf.rb']
     sh cmd.join(' ')
     sh '/usr/bin/env make'
 
-    File.delete symlink if File.exist? symlink
+    File.delete(final_so) if File.exist?(final_so)
 
-    if File.exist? so_file
-      File.symlink so_file, symlink
-      Dir.chdir pwd
-      puts "== Extension built and symlink'd to #{symlink}"
+    if File.exist?(so_file)
+      FileUtils.mv(so_file, final_so)
+      Dir.chdir(pwd)
+      puts "== Extension built and moved to #{final_so}"
     else
-      Dir.chdir pwd
+      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.'
     end

data/ext/oboe_metal/extconf.rb

@@ -16,26 +16,33 @@ jruby = defined?(JRUBY_VERSION) ? true : false
 ao_lib_dir = File.join(ext_dir, 'lib')
 ao_include = File.join(ext_dir, 'src')
 
-# Download the appropriate liboboe from files.appoptics.com
-ao_path = File.join('https://files.appoptics.com/c-lib', File.read(File.join(ao_include, 'VERSION')).chomp)
+# Download the appropriate liboboe from S3(via rake for testing) or files.appoptics.com (production)
+version = File.read(File.join(ao_include, 'VERSION')).chomp
+if ENV['FROM_S3']
+  ao_path = File.join('https://s3-us-west-2.amazonaws.com/rc-files-t2/c-lib/', version)
+  puts "Fetching c-lib from S3"
+else
+  ao_path = File.join('https://files.appoptics.com/c-lib', version)
+end
 ao_arch = `ldd --version 2>&1` =~ /musl/ ? 'alpine-x86_64' : 'x86_64'
 ao_clib = "liboboe-1.0-#{ao_arch}.so.0.0.0"
 ao_item = File.join(ao_path, ao_clib)
 ao_checksum_item = "#{ao_item}.sha256"
-target = File.join(ao_lib_dir, ao_clib)
+clib = File.join(ao_lib_dir, ao_clib)
 
 retries = 3
+success = false
 while retries > 0
   begin
     # download
     download = open(ao_item, 'rb')
-    IO.copy_stream(download, target)
+    IO.copy_stream(download, clib)
 
     checksum = open(ao_checksum_item, 'r').read.chomp
-    target_checksum = Digest::SHA256.file(target).hexdigest
+    clib_checksum = Digest::SHA256.file(clib).hexdigest
 
     # verify_checksum
-    if target_checksum != checksum
+    if clib_checksum != checksum
       $stderr.puts '== ERROR ================================================================='
       $stderr.puts 'Checksum Verification failed for the c-extension of the appoptics_apm gem.'
       $stderr.puts 'appoptics_apm will not instrument the code. No tracing will occur.'
@@ -48,7 +55,7 @@ while retries > 0
       retries = 0
     end
   rescue => e
-    File.write(target, '')
+    File.write(clib, '')
     retries -= 1
     if retries == 0
       $stderr.puts '== ERROR =========================================================='
@@ -63,11 +70,13 @@ while retries > 0
 end
 
 if success
-  # Create symlinks for the AppOpticsAPM library
-  File.symlink(target, File.join(ao_lib_dir, 'liboboe.so'))
-  File.symlink(target, File.join(ao_lib_dir, 'liboboe-1.0.so.0'))
+  # Create relative symlinks for the AppOpticsAPM library
+  Dir.chdir(ao_lib_dir) do
+    File.symlink(ao_clib, 'liboboe.so')
+    File.symlink(ao_clib, 'liboboe-1.0.so.0')
+  end
 
-  dir_config('oboe', ao_include, ao_lib_dir)
+  dir_config('oboe', 'src', 'lib')
 
   if jruby || ENV.key?('APPOPTICS_URL')
     # Build the noop extension under JRuby and Heroku.
@@ -84,12 +93,8 @@ if success
     $CFLAGS << " #{ENV['CFLAGS']}"
     $CPPFLAGS << " #{ENV['CPPFLAGS']}"
     $LIBS << " #{ENV['LIBS']}"
-    $LDFLAGS << " #{ENV['LDFLAGS']} -Wl,-rpath=#{ao_lib_dir}"
+    $LDFLAGS << " #{ENV['LDFLAGS']} '-Wl,-rpath=$$ORIGIN/../ext/oboe_metal/lib'"
 
-    if RUBY_VERSION < '1.9'
-      cpp_command('g++')
-      $CPPFLAGS << '-I./src/'
-    end
     create_makefile('oboe_metal', 'src')
 
   else

data/lib/appoptics_apm/api/logging.rb

@@ -305,6 +305,7 @@ module AppOpticsAPM
 
       ##
       #:nodoc:
+      # @private
       # Internal: Report an event.
       #
       # ==== Arguments

data/lib/appoptics_apm/version.rb

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

data/ruby_setup.sh

@@ -7,8 +7,14 @@
 
 cd /code/ruby-appoptics_apm/
 
-rbenv local $1
+rbenv global $1
+
+rm gemfiles/*.lock
+
+export RVM_TEST=$1
+export BUNDLE_GEMFILE=$2
 bundle install
+
 bundle update
 bundle exec rake fetch_ext_deps
 bundle exec rake clean
@@ -26,15 +32,11 @@ service memcached start
 # mysql add table for tests
 mysql -e 'create database travis_ci_test;' -h$MYSQL_HOST -p$MYSQL_ROOT_PASSWORD
 
-bundle install --gemfile $2
-
-export RVM_TEST=$1
-export BUNDLE_GEMFILE=$2
-
 # replicate stdout of tests to file in local log directory
 export TEST_RUNS_TO_FILE=true
+export $3
 
-if [ "$3" == "true" ]; then
+if [ "$4" == "true" ]; then
   /bin/bash
   # now run tests either with:
   # bundle exec rake test TEST=test/instrumentation/curb_test.rb

data/yardoc_frontpage.md

@@ -0,0 +1,26 @@
+# Welcome to the AppOpticsAPM Ruby Gem
+
+
+The appoptics_apm gem provides automatic tracing and metrics for Ruby applications. 
+It requires an AppOptics account: sign up for a free trial at https://www.appoptics.com.
+
+![ruby_trace](https://docs.appoptics.com/_images/ruby_trace.png)
+
+## Documentation
+https://docs.appoptics.com/kb/apm_tracing/ruby
+
+## Getting started
+The gem instruments the ruby language and ruby on rails frameworks. It is hosted on RubyGems, making installation as 
+simple as: `gem install appoptics_apm`.
+
+Our ruby extension gets detailed insights out-of-the-box without any code modification. 
+For a list of instrumented gems and components see https://docs.appoptics.com/kb/apm_tracing/ruby/support-matrix
+
+Detailled installation instructions for Ruby and different frameworks like Rails, Sinatra, Padrino, and Grape can be 
+found here https://docs.appoptics.com/kb/apm_tracing/ruby/install
+
+## Custom instrumentation
+If you have code or a library that is not on the platform support list, use our SDK (as documented here) to customize.
+
+
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: appoptics_apm
 version: !ruby/object:Gem::Version
-  version: 4.0.5
+  version: 4.0.6
 platform: ruby
 authors:
 - Maia Engeli
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-01 00:00:00.000000000 Z
+date: 2018-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -96,6 +96,7 @@ files:
 - ".gitignore"
 - ".rubocop.yml"
 - ".travis.yml"
+- ".yardopts"
 - CHANGELOG.md
 - CONFIG.md
 - Dockerfile
@@ -207,6 +208,7 @@ files:
 - ruby_setup.sh
 - run_docker_build_gem_upload_to_packagecloud.sh
 - run_tests_docker.rb
+- yardoc_frontpage.md
 homepage: https://www.appoptics.com/
 licenses:
 - Librato Open License, Version 1.0