appoptics_apm 4.8.4 → 4.11.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 37478c40a16c8636f4589a15e63db8d1b2eb0eae
-  data.tar.gz: 2f2ac3b316e00963c42593680e638ecfc1792e3b
+SHA256:
+  metadata.gz: 26c9d31f4b5d680bd14d2cc041c337ea687f87e85c909fb6133d92e3f8292105
+  data.tar.gz: 1694af39aa2e9c8105a7d1b4fa590af16a5a86ae2b41bc9998531f2b16d192af
 SHA512:
-  metadata.gz: f695fc74e9f23d799709c32faab13b8c8c56e2f7da34b6968a5f085daf964927d3c98ffcadc49be6ab181fb66a872a4ec97d121468f01ed205c449e0d0873abc
-  data.tar.gz: 730addb2cda57f6555d4965656cfeb1e753e32e7886e13cc1714c8b97b094664c4d0702a5494dc49ea7c266de6c101b25c4927a82ed652822890a581e45550b0
+  metadata.gz: 3257648c80a8da542d0e3f99a49c53b4ea6f3c2dd3ef37d6e6ebc1384f53054b3883b41f6ae43880f310a5ff4b49c37eaa67450a2d9818946e248180c6834222
+  data.tar.gz: ba4d2a1e71ab6805d73a038bbd1c6593889249e5ebdac1005cbb9df6befad04ef728bcfc67780db2352a10a43c694e991314530452dca57d17297f75c30c3d69

data/.gitignore

@@ -1,5 +1,5 @@
 oboe*.gem
-Gemfile.lock
+*.lock
 gemfiles/*.lock
 .ruby-version
 *~
@@ -27,3 +27,9 @@ coverage
 doc
 .*byebug*
 gemfiles/vendor*
+scrap*
+.irbrc
+*.code-workspace
+.irb_history
+.bundle/
+/builds/

data/.rubocop.yml

@@ -1,8 +1,29 @@
-Metrics/LineLength:
-  Max: 120
+Style/StringLiterals:
+  Description: 'Checks if uses of quotes match the configured preference.'
+  StyleGuide: '#consistent-string-literals'
+  Enabled: false
 
-Style/HashSyntax:
-  EnforcedStyle: hash_rockets
+Layout/LineLength:
+  Description: 'Limit lines to 80 characters.'
+  Enabled: false
 
-Layout/TrailingWhitespace:
-  Enabled: false
+Naming/VariableNumber:
+  Description: 'Use the configured style when numbering variables.'
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Description: >-
+    Add the frozen_string_literal comment to the top of files
+    to help transition to frozen string literals by default.
+  Enabled: false
+
+Style/Documentation:
+  Description: 'Document classes and non-namespace modules.'
+  Enabled: false
+
+Style/WordArray:
+  EnforcedStyle: brackets
+
+Metrics/BlockLength:
+  Exclude:
+    - test/*/*_test.rb

data/.travis.yml

@@ -8,9 +8,9 @@ cache:
 env:
   - DBTYPE=postgresql
   - DBTYPE=mysql2
-  - DBTYPE=mysql
 
 rvm:
+  - 2.7.0
   - 2.6.4
   - 2.5.5
   - 2.4.5
@@ -33,38 +33,14 @@ matrix:
   exclude:
     - rvm: ruby-head
       gemfile: gemfiles/rails42.gemfile
+    - rvm: 2.7.0
+      gemfile: gemfiles/rails42.gemfile
     - rvm: 2.6.4
       gemfile: gemfiles/rails42.gemfile
     - rvm: 2.4.5
       gemfile: gemfiles/rails60.gemfile
-
-    - rmv: 2.6.4
-      env: DBTYPE=mysql
-    - rvm: 2.5.5
-      env: DBTYPE=mysql
-    - rvm: 2.4.5
-      env: DBTYPE=mysql
-    - rvm: ruby-head
-      env: DBTYPE=mysql
-
-    - gemfile: gemfiles/unit.gemfile
-      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/rails52.gemfile
-      env: DBTYPE=mysql
-    - gemfile: gemfiles/rails60.gemfile
-      env: DBTYPE=mysql
-    - gemfile: gemfiles/delayed_job.gemfile
-      env: DBTYPE=mysql
+    - rvm: 2.4.5  # excluding because of new sprockets version (4.0.0)
+      gemfile: gemfiles/rails52.gemfile
 
     - gemfile: gemfiles/unit.gemfile
       env: DBTYPE=mysql2
@@ -83,7 +59,8 @@ matrix:
   allow_failures:
     - rvm: ruby-head
 
-# FIXME: Figure out if this is still an issue when reviewing cassandra test setup
+# FIXME: No cassandra tests for now
+# ____   Figure out if this is still an issue when reviving cassandra
 # Attempt Travis/Cassandra fix re: https://github.com/travis-ci/travis-ci/issues/1484
 # Updated Cassandra: https://github.com/travis-ci/travis-ci/issues/1650
 
@@ -98,9 +75,17 @@ matrix:
 #  - sudo service cassandra start
 
 install:
-  - curl -LO http://kent.dl.sourceforge.net/project/swig/swig/swig-3.0.8/swig-3.0.8.tar.gz
-  - tar xzf swig-3.0.8.tar.gz
-  - pushd swig-3.0.8
+#  - curl -LO http://kent.dl.sourceforge.net/project/swig/swig/swig-3.0.12/swig-3.0.12.tar.gz
+#  - curl -LO http://kent.dl.sourceforge.net/project/swig/swig/swig-4.0.1/swig-4.0.1.tar.gz
+#  - tar xzf swig-4.0.1.tar.gz
+#  - pushd swig-4.0.1
+#  - ./configure && make && sudo make install
+#  - popd
+
+# use swig from git, it is the only one that works with Ruby 2.7 for now
+  - git clone https://github.com/swig/swig.git
+  - pushd swig
+  - ./autogen.sh
   - ./configure && make && sudo make install
   - popd
 
@@ -111,15 +96,17 @@ before_script:
   - export APPOPTICS_REPORTER_FILE_SINGLE=false
   - export APPOPTICS_TOKEN_BUCKET_CAPACITY=1000
   - export APPOPTICS_TOKEN_BUCKET_RATE=1000
-  - export OBOE_VERSION=5.1.1
-  - bundle --jobs=3 --retry=3
-  - bundle exec rake clean fetch compile
+  - export APPOPTICS_FROM_S3=true
+
+#  - bundle update --jobs=3 --retry=3
+  - ./.travis/bundle.sh
+  - bundle exec rake distclean fetch compile
   - psql -c 'create database travis_ci_test;' -U postgres
   - mysql -e 'create database travis_ci_test;'
   - redis-server --requirepass secret_pass &
   - sleep 10
 
-script: "N=1 bundle exec rake test"
+script: "bundle exec rake test"
 
 services:
   - mongodb

data/.travis/bundle.sh

@@ -0,0 +1,9 @@
+#!/bin/bash
+
+if [[ $BUNDLE_GEMFILE == *"gemfiles/frameworks.gemfile"* ]]
+then
+  gem install bundler -v 1.17.3
+  bundle _1.17.3_ update --jobs=3 --retry=3
+else
+  bundle update --jobs=3 --retry=3
+fi

data/CONFIG.md

@@ -17,7 +17,7 @@ Name | Description | Default
 
 Name | Description | Default
 ---- | ----------- | -------
-`APPOPTICS_GEM_TEST` | puts the gem in test mode.  Traces are written to /tmp/trace_output.bson. | `false`
+`APPOPTICS_GEM_TEST` | puts the gem in test mode to avoid restarting certain background services used in testing.   `false`
 `DBTYPE` | For tests on Ruby on Rails, specifies the database type to test against.  `postgres`, `mysql` and `mysql2` are valid options. | `postgres`
 `APPOPTICS_CASSANDRA_SERVER` | specifies the Cassandra server to test against. | `127.0.0.1:9160`
 `APPOPTICS_MONGO_SERVER` | specifies the Mongo server to test against. | `127.0.0.1:27017`

data/Gemfile

@@ -1,7 +1,7 @@
 source 'https://rubygems.org'
+gem 'rake'
 
 group :development, :test do
-  gem 'rake'
   gem 'minitest'
   gem 'minitest-reporters', '< 1.0.18'
   gem 'minitest-debugger', :require => false
@@ -18,12 +18,12 @@ group :development, :test do
   gem 'byebug'
   gem 'get_process_mem'
   gem 'memory_profiler'
-end
 
-if defined?(JRUBY_VERSION)
-  gem 'sinatra', :require => false
-else
-  gem 'sinatra'
+  if defined?(JRUBY_VERSION)
+    gem 'sinatra', :require => false
+  else
+    gem 'sinatra'
+  end
 end
 
 gemspec

data/appoptics_apm.gemspec

@@ -6,7 +6,7 @@ Gem::Specification.new do |s|
   s.version = AppOpticsAPM::Version::STRING
   s.date = Time.now.strftime('%Y-%m-%d')
 
-  s.license = "Librato Open License, Version 1.0"
+  s.license = "Librato Open License, Version 1.0, https://bit.ly/2Kmm0mN"
 
   s.authors = ["Maia Engeli", "Peter Giacomo Lombardo", "Spiros Eliopoulos"]
   s.email = %q{support@appoptics.com}
@@ -32,6 +32,9 @@ Automatic tracing and metrics for Ruby applications. Get started at appoptics.co
               'ext/oboe_metal/src/bson/bson.h',
               'ext/oboe_metal/src/bson/platform_hacks.h',
               'ext/oboe_metal/src/VERSION']
+  s.files -= ['build_gem.sh',
+              'build_gem_upload_to_packagecloud.sh',
+              'Rakefile']
 
   # TODO this is commented out util we can actually provide gems for different platforms
   # it will create a gem that goes into noop on Darwin and other unsupported platforms
@@ -51,9 +54,10 @@ Automatic tracing and metrics for Ruby applications. Get started at appoptics.co
   unless defined?(JRUBY_VERSION)
     s.add_development_dependency('byebug', '>= 8.0.0')
     s.add_development_dependency('minitest-hooks', '>= 1.5.0')
+    s.add_development_dependency('minitest-focus', '>=1.1.2')
     s.add_development_dependency('benchmark-ips', '>= 2.7.2')
   end
 
-  s.required_ruby_version = '>= 2.0.0'
+  s.required_ruby_version = '>= 2.4.0'
   s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
 end

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/extconf.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Copyright (c) 2016 SolarWinds, LLC.
 # All rights reserved.
 
@@ -20,7 +22,7 @@ ao_include = File.join(ext_dir, 'src')
 version = File.read(File.join(ao_include, 'VERSION')).chomp
 if ENV['APPOPTICS_FROM_S3'].to_s.downcase == 'true'
   ao_path = File.join('https://s3-us-west-2.amazonaws.com/rc-files-t2/c-lib/', version)
-  puts "Fetching c-lib from S3"
+  puts 'Fetching c-lib from S3'
 else
   ao_path = File.join('https://files.appoptics.com/c-lib', version)
 end
@@ -29,7 +31,7 @@ ao_arch = 'x86_64'
 if File.exist?('/etc/alpine-release')
   version = open('/etc/alpine-release').read.chomp
   ao_arch =
-    if Gem::Version.new(version) <  Gem::Version.new('3.9')
+    if Gem::Version.new(version) < Gem::Version.new('3.9')
       'alpine-libressl-x86_64'
     else # openssl
       'alpine-x86_64'
@@ -46,6 +48,8 @@ success = false
 while retries > 0
   begin
     # download
+    # TODO warning: calling URI.open via Kernel#open is deprecated, call URI.open directly or use URI#open
+    # ____ figure out if URI.open is supported in older rubies
     download = open(ao_item, 'rb')
     IO.copy_stream(download, clib)
 

data/ext/oboe_metal/noop/noop.c

@@ -3,5 +3,6 @@
 /* ruby calls this to load the extension */
 void Init_oboe_noop(void) {
   /* assume we haven't yet defined Hola */
-  VALUE klass = rb_define_class("OboeNoop", rb_cObject);
+//  VALUE klass = rb_define_class("OboeNoop", rb_cObject);
+  rb_define_class("OboeNoop", rb_cObject);
 }

data/ext/oboe_metal/src/VERSION

@@ -1 +1 @@
-5.1.1
+7.1.1

data/lib/appoptics_apm.rb

@@ -43,12 +43,11 @@ begin
 
   # appoptics_apm/loading can set AppOpticsAPM.loaded = false if the service key is not working
   require 'appoptics_apm/loading'
-  require 'appoptics_apm/legacy_method_profiling'
-  require 'appoptics_apm/method_profiling'
 
   if AppOpticsAPM.loaded
     require 'appoptics_apm/instrumentation'
     require 'appoptics_apm/support/transaction_metrics'
+    require 'appoptics_apm/support/x_trace_options'
 
     # Frameworks
     require 'appoptics_apm/frameworks/rails'
@@ -68,7 +67,6 @@ begin
   # Load Ruby module last.  If there is no framework detected,
   # it will load all of the Ruby instrumentation
   require 'appoptics_apm/ruby'
-  require 'oboe/backward_compatibility'
 
   require 'appoptics_apm/test' if ENV['APPOPTICS_GEM_TEST']
 rescue => e

data/lib/appoptics_apm/api.rb

@@ -6,7 +6,6 @@ module AppOpticsAPM
   module API
     extend AppOpticsAPM::API::Logging
     extend AppOpticsAPM::API::Metrics
-    extend AppOpticsAPM::API::Profiling
     extend AppOpticsAPM::API::LayerInit
     extend AppOpticsAPM::API::Util
 

data/lib/appoptics_apm/api/logging.rb

@@ -55,7 +55,7 @@ module AppOpticsAPM
       # ==== Arguments
       #
       # * +layer+ - The layer the reported event belongs to
-      # * +exception+ - The exception to report
+      # * +exception+ - The exception to report, responds to :message and :backtrace(optional)
       # * +opts+ - Custom params if you want to log extra information
       #
       # ==== Example
@@ -80,7 +80,10 @@ module AppOpticsAPM
         opts.merge!(:Spec => 'error',
                     :ErrorClass => exception.class.name,
                     :ErrorMsg => exception.message)
-        opts.merge!(:Backtrace => exception.backtrace.join("\r\n")) if exception.backtrace
+
+        if exception.respond_to?(:backtrace) && exception.backtrace
+          opts.merge!(:Backtrace => exception.backtrace.join("\r\n"))
+        end
 
         exception.instance_variable_set(:@exn_logged, true)
         log(layer, :error, opts)
@@ -205,6 +208,7 @@ module AppOpticsAPM
       def log_info(layer, opts = {})
         return AppOpticsAPM::Context.toString unless AppOpticsAPM.tracing?
 
+        opts[:Spec] = 'info'
         log_event(layer, :info, AppOpticsAPM::Context.createEvent, opts)
       end
 

data/lib/appoptics_apm/api/tracing.rb

@@ -48,6 +48,10 @@ module AppOpticsAPM
         [start_trace_with_target(span, xtrace, target, opts) { yield }, target['X-Trace']]
       end
 
+      def profile_method(*args)
+        AppOpticsAPM.logger.warn("DEPRECATED: AppOpticsAPM::API.profile_method is deprecated. Use: AppOpticsAPM::SDK::trace_method")
+        AppOpticsAPM::SDK.trace_method(*args)
+      end
     end
   end
 end

data/lib/appoptics_apm/api/util.rb

@@ -24,16 +24,14 @@ module AppOpticsAPM
 
       # Internal: Get the current backtrace.
       #
-      # ignore - Number of frames to ignore at the top of the backtrace. Use
-      #          when you know how many layers deep in the key call is being
-      #          made.
+      # from - int, from position in array of backtraces
+      # to - int, end position in array of backtraces, can be negative to count from the end
       #
       # Returns a string with each frame of the backtrace separated by '\r\n'.
       #
-      def backtrace(ignore = 0)
+      def backtrace(from = 0, to = -1)
         bt = Kernel.caller
-        bt.slice!(0, ignore)
-        trim_backtrace(bt).join("\r\n")
+        trim_backtrace(bt[from..to]).join("\r\n")
       end
 
       # Internal: Trim a backtrace to a manageable size
@@ -115,7 +113,7 @@ module AppOpticsAPM
       end
 
       def xtrace_v2?(xtr)
-        return xtr && xtr.start_with?('2B')
+        xtr && xtr.start_with?('2B')
       end
     end
   end

data/lib/appoptics_apm/config.rb

@@ -16,13 +16,20 @@ module AppOpticsAPM
     @@instrumentation = [:action_controller, :action_controller_api, :action_view,
                          :active_record, :bunnyclient, :bunnyconsumer, :cassandra, :curb,
                          :dalli, :delayed_jobclient, :delayed_jobworker,
-                         :em_http_request, :excon, :faraday, :grpc_client, :grpc_server, :grape,
+                         :excon, :faraday, :graphql, :grpc_client, :grpc_server, :grape,
                          :httpclient, :nethttp, :memcached, :mongo, :moped, :padrino, :rack, :redis,
                          :resqueclient, :resqueworker, :rest_client,
                          :sequel, :sidekiqclient, :sidekiqworker, :sinatra, :typhoeus]
 
+    # ignore configs for instrumentations we don't have anymore
+    # can't remove because the config may still be present in configs created
+    # with previous gem versions
+    @@ignore = [:em_http_request]
+
     # Subgrouping of instrumentation
-    @@http_clients = [:curb, :excon, :em_http_request, :faraday, :httpclient, :nethttp, :rest_client, :typhoeus]
+    @@http_clients = [:curb, :excon,
+                      # :em_http_request,
+                      :faraday, :httpclient, :nethttp, :rest_client, :typhoeus]
 
     ##
     # load_config_file
@@ -136,7 +143,7 @@ module AppOpticsAPM
     #
     # rubocop:disable Metrics/AbcSize
     def self.initialize(_data = {})
-      @@instrumentation.each { |k| @@config[k] = {} }
+      (@@instrumentation+@@ignore).each { |k| @@config[k] = {} }
       @@config[:transaction_name] = {}
 
       # Always load the template, it has all the keys and defaults defined,
@@ -240,11 +247,15 @@ module AppOpticsAPM
         end
 
       elsif key == :tracing_mode
-      #   CAN'T DO THIS ANYMORE, ALL TRACING COMMUNICATION TO OBOE
+      #   CAN'T DO `set_tracing_mode` ANYMORE, ALL TRACING COMMUNICATION TO OBOE
       #   IS NOW HANDLED BY TransactionSettings
       #   AppOpticsAPM.set_tracing_mode(value.to_sym) if AppOpticsAPM.loaded
 
-      # Make sure that the mode is stored as a symbol
+        # Make sure that the mode is stored as a symbol
+        @@config[key.to_sym] = value.to_sym
+
+      elsif key == :trigger_tracing_mode
+        # Make sure that the mode is stored as a symbol
         @@config[key.to_sym] = value.to_sym
       end
     end