appoptics_apm 4.5.2 → 4.6.0

data/lib/appoptics_apm/test.rb

@@ -69,7 +69,7 @@ module AppOpticsAPM
         if ENV.key?('TRAVIS_MYSQL_PASS')
           ENV['DATABASE_URL'] = "mysql://root:#{ENV['TRAVIS_MYSQL_PASS']}@127.0.0.1:3306/travis_ci_test"
         elsif ENV.key?('DOCKER_MYSQL_PASS')
-          ENV['DATABASE_URL'] = "mysql://root:#{ENV['DOCKER_MYSQL_PASS']}@mysql:3306/travis_ci_test"
+          ENV['DATABASE_URL'] = "mysql://root:#{ENV['DOCKER_MYSQL_PASS']}@#{ENV['MYSQL_HOST']}:3306/travis_ci_test"
         else
           ENV['DATABASE_URL'] = 'mysql://root@127.0.0.1:3306/travis_ci_test'
         end
@@ -84,7 +84,7 @@ module AppOpticsAPM
         if ENV.key?('TRAVIS_MYSQL_PASS')
           ENV['DATABASE_URL'] = "mysql2://root:#{ENV['TRAVIS_MYSQL_PASS']}@127.0.0.1:3306/travis_ci_test"
         elsif ENV.key?('DOCKER_MYSQL_PASS')
-          ENV['DATABASE_URL'] = "mysql2://root:#{ENV['DOCKER_MYSQL_PASS']}@mysql:3306/travis_ci_test"
+          ENV['DATABASE_URL'] = "mysql2://root:#{ENV['DOCKER_MYSQL_PASS']}@#{ENV['MYSQL_HOST']}:3306/travis_ci_test"
         else
           ENV['DATABASE_URL'] = 'mysql2://root@127.0.0.1:3306/travis_ci_test'
         end

data/lib/appoptics_apm/util.rb

@@ -97,19 +97,6 @@ module AppOpticsAPM
         target_cls.send(:include, cls) if defined?(target_cls)
       end
 
-      ##
-      # static_asset?
-      #
-      # Given a path, this method determines whether it is a static asset or not (based
-      # solely on filename)
-      #
-      def static_asset?(path)
-        path =~ Regexp.new(AppOpticsAPM::Config[:dnt_regexp], AppOpticsAPM::Config[:dnt_opts])
-      rescue => e
-        AppOpticsAPM.logger.warn "[AppOpticsAPM/debug] Could not apply Regex.new to path. #{e.inspect}"
-        false
-      end
-
       ##
       # prettify
       #
@@ -173,6 +160,25 @@ module AppOpticsAPM
         sql.gsub(/\\\'/,'').gsub(regexp, '?')
       end
 
+      ##
+      # deep_dup
+      #
+      # deep duplicate of array or hash
+      #
+      def deep_dup(obj)
+        if obj.is_a? Array
+          new_obj = []
+          obj.each do |v|
+            new_obj << deep_dup(v)
+          end
+        elsif obj.is_a? Hash
+          new_obj = {}
+          obj.each_pair do |key, value|
+            new_obj[key] = deep_dup(value)
+          end
+        end
+      end
+
       ##
       # legacy_build_init_report
       #
@@ -186,7 +192,7 @@ module AppOpticsAPM
       #
       # @deprecated Please use {#build_init_report} instead
       def legacy_build_init_report
-        AppOpticsAPM.logger.warn '[appoptics_apm/warn] Oboe::API will be deprecated in a future version.'
+        AppOpticsAPM.logger.warn '[appoptics_apm/deprecated] Oboe::API will be deprecated in a future version.'
         platform_info = {}
 
         begin
@@ -243,7 +249,7 @@ module AppOpticsAPM
 
           platform_info['Error'] = "Error in legacy_build_init_report: #{e.message}"
 
-          AppOpticsAPM.logger.warn "[appoptics_apm/warn] Error in legacy_build_init_report: #{e.message}"
+          AppOpticsAPM.logger.warn "[appoptics_apm/legacy] Error in legacy_build_init_report: #{e.message}"
           AppOpticsAPM.logger.debug e.backtrace
         end
         platform_info

data/lib/appoptics_apm/version.rb

@@ -7,8 +7,8 @@ module AppOpticsAPM
   # appoptics_apm.gemspec during gem build process
   module Version
     MAJOR = 4
-    MINOR = 5
-    PATCH = 2
+    MINOR = 6
+    PATCH = 0
 
     STRING = [MAJOR, MINOR, PATCH].compact.join('.')
   end

data/lib/appoptics_apm/xtrace.rb

@@ -81,9 +81,8 @@ module AppOpticsAPM
       # 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
+      # +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)

data/lib/joboe_metal.rb

@@ -66,9 +66,9 @@ module Oboe_metal
           cfg = LayerUtil.getLocalSampleRate(nil, nil)
 
           if cfg.hasSampleStartFlag
-            AppOpticsAPM::Config.tracing_mode = :always
+            AppOpticsAPM::Config.tracing_mode = :enabled
           else
-            AppOpticsAPM::Config.tracing_mode = :never
+            AppOpticsAPM::Config.tracing_mode = :disabled
           end
 
           AppOpticsAPM.sample_rate = cfg.getSampleRate

data/lib/oboe_metal.rb

@@ -172,15 +172,15 @@ module AppOpticsAPM
       value = mode.to_sym
 
       case value
-      when :never
-        AppOpticsAPM::Context.setTracingMode(APPOPTICS_TRACE_NEVER)
+      when :disabled, :never
+        AppOpticsAPM::Context.setTracingMode(APPOPTICS_TRACE_DISABLED)
 
-      when :always
-        AppOpticsAPM::Context.setTracingMode(APPOPTICS_TRACE_ALWAYS)
+      when :enabled, :always
+        AppOpticsAPM::Context.setTracingMode(APPOPTICS_TRACE_ENABLED)
 
       else
         AppOpticsAPM.logger.fatal "[oboe/error] Invalid tracing mode set: #{mode}"
-        AppOpticsAPM::Context.setTracingMode(APPOPTICS_TRACE_NEVER)
+        AppOpticsAPM::Context.setTracingMode(APPOPTICS_TRACE_DISABLED)
       end
     end
 

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

@@ -11,7 +11,7 @@ if defined?(AppOpticsAPM::Config)
   # :service_key, :hostname_alias, and :debug_level are startup settings and can't be changed afterwards.
   #
   # Set APPOPTICS_SERVICE_KEY
-  # This Setting will be overridden if APPOPTICS_SERVICE_KEY is set as an environment variable.
+  # This setting will be overridden if APPOPTICS_SERVICE_KEY is set as an environment variable.
   # This is a required setting. If the service key is not set here it needs to be set as environment variable.
   #
   # The service key is a combination of the API token plus a service name.
@@ -21,7 +21,7 @@ if defined?(AppOpticsAPM::Config)
 
   #
   # Set APPOPTICS_HOSTNAME_ALIAS
-  # This Setting will be overridden if APPOPTICS_HOSTNAME_ALIAS is set as an environment variable
+  # This setting will be overridden if APPOPTICS_HOSTNAME_ALIAS is set as an environment variable
   #
   # AppOpticsAPM::Config[:hostname_alias] = 'alias_name'
 
@@ -42,7 +42,7 @@ if defined?(AppOpticsAPM::Config)
 
   #
   # Set APPOPTICS_GEM_VERBOSE
-  # This Setting will be overridden if APPOPTICS_GEM_VERBOSE is set as an environment variable
+  # This setting will be overridden if APPOPTICS_GEM_VERBOSE is set as an environment variable
   #
   # On startup the components that are being instrumented will be reported if this is set to true.
   # If true and the log level is 4 or higher this may create extra debug log messages
@@ -52,11 +52,13 @@ if defined?(AppOpticsAPM::Config)
   #
   # Turn tracing on or off
   #
-  # By default tracing is set to 'always', the other option is 'never'.
-  # 'always' means that sampling will be done according to the current
-  # sampling rate. 'never' means that there is no sampling.
+  # By default tracing is set to :enabled, the other option is :disabled.
+  # :enabled means that sampling will be done according to the current
+  # sampling rate. :disabled means that there is no sampling.
   #
-  AppOpticsAPM::Config[:tracing_mode] = :always
+  # The values :always and :never are deprecated
+  #
+  AppOpticsAPM::Config[:tracing_mode] = :enabled
 
   #
   # Prepend domain to transaction name
@@ -80,33 +82,70 @@ if defined?(AppOpticsAPM::Config)
 
   #
   # 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
-  # a regular expression object.  That is then used to match against
-  # the incoming request path.
+  # DEPRECATED
+  # Please comment out if no filtering is desired, e.g. your static
+  # assets are served by the web server and not the application
+  #
+  # This configuration allows creating a regexp for paths for which no metrics or
+  # traces should get recorded. These requests should not include transactions
+  # with outbound calls, for which metrics and traces aren't desired either.
+  #
+  # For example:
+  # - static assets that aren't served by the web server, or
+  # - healthcheck endpoints that respond to a heart beat.
+  #
+  # :dnt_regexp is the regular expression that is applied to the incoming path
+  # to determine whether the request should be measured and traced or not.
   #
-  # The path string originates from the rack layer and is retrieved
-  # as follows:
+  # :dnt_opts can be commented out, nil, or Regexp::IGNORECASE
   #
+  # The matching happens before routes are applied.
+  # The path originates from the rack layer and is retrieved as follows:
   #   req = ::Rack::Request.new(env)
   #   path = URI.unescape(req.path)
   #
-  # Usage:
-  #   AppOpticsAPM::Config[:dnt_regexp] = "lobster$"
-  #   AppOpticsAPM::Config[:dnt_opts]   = Regexp::IGNORECASE
+  AppOpticsAPM::Config[:dnt_regexp] = '\.(jpg|jpeg|gif|png|ico|css|zip|tgz|gz|rar|bz2|pdf|txt|tar|wav|bmp|rtf|js|flv|swf|otf|eot|ttf|woff|woff2|svg|less)(\?.+){0,1}$'
+  AppOpticsAPM::Config[:dnt_opts] = Regexp::IGNORECASE
   #
-  # This will ignore all requests that end with the string lobster
-  # regardless of case
+
   #
-  # Requests with positive matches (non nil) will not be traced.
-  # See lib/appoptics_apm/util.rb: AppOpticsAPM::Util.static_asset?
+  # Transaction Settings
+  #
+  # Use this configuration to add exceptions to the global tracing mode and
+  # disable/enable metrics and traces for certain transactions.
+  #
+  # Currently allowed hash keys:
+  # :url to apply listed filters to urls.
+  #      The matching of settings to urls happens before routes are applied.
+  #      The url is extracted from the env argument passed to rack: `env['PATH_INFO']`
+  #
+  # :extensions  takes an array of strings for filtering (not regular expressions!)
+  # :regexp      is a regular expression that is applied to the incoming path
+  # :opts        (optional) nil(default) or Regexp::IGNORECASE (options for regexp)
+  # :tracing     defaults to :disabled, can be set to :enabled to override
+  #              the global :disabled setting
+  #
+  # Be careful not to add too many :regexp configurations as they will slow
+  # down execution.
+  #
+  AppOpticsAPM::Config[:transaction_settings] = {
+    url: [
+    #   {
+    #     extensions: %w['long_job'],
+    #     tracing: :disabled
+    #   },
+    #   {
+    #     regexp: '^.*\/long_job\/.*$',
+    #     opts: Regexp::IGNORECASE,
+    #     tracing: :disabled
+    #   },
+    #   {
+    #     regexp: /batch/,
+    #   }
+    ]
+  }
   #
-  AppOpticsAPM::Config[:dnt_regexp] = '\.(jpg|jpeg|gif|png|ico|css|zip|tgz|gz|rar|bz2|pdf|txt|tar|wav|bmp|rtf|js|flv|swf|otf|eot|ttf|woff|woff2|svg|less)(\?.+){0,1}$'
-  AppOpticsAPM::Config[:dnt_opts]   = Regexp::IGNORECASE
 
   #
   # Blacklist urls

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: appoptics_apm
 version: !ruby/object:Gem::Version
-  version: 4.5.2
+  version: 4.6.0
 platform: ruby
 authors:
 - Maia Engeli
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-15 00:00:00.000000000 Z
+date: 2019-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -75,47 +75,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 8.0.0
 - !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.10.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.10.0
-- !ruby/object:Gem::Dependency
-  name: pry-byebug
+  name: minitest-hooks
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 1.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 1.5.0
 - !ruby/object:Gem::Dependency
-  name: minitest-hooks
+  name: benchmark-ips
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: 2.7.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: 2.7.2
 description: 'Automatic tracing and metrics for Ruby applications. Get started at
   appoptics.com. @AppOptics
 
@@ -221,7 +207,9 @@ files:
 - lib/appoptics_apm/ruby.rb
 - lib/appoptics_apm/sdk/custom_metrics.rb
 - lib/appoptics_apm/sdk/tracing.rb
-- lib/appoptics_apm/support.rb
+- lib/appoptics_apm/support/transaction_metrics.rb
+- lib/appoptics_apm/support/transaction_settings.rb
+- lib/appoptics_apm/support_report.rb
 - lib/appoptics_apm/test.rb
 - lib/appoptics_apm/thread_local.rb
 - lib/appoptics_apm/util.rb
@@ -260,7 +248,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: AppOptics APM performance instrumentation gem for Ruby