appoptics_apm 4.8.3 → 4.11.0

data/lib/appoptics_apm/version.rb

@@ -7,8 +7,8 @@ module AppOpticsAPM
   # appoptics_apm.gemspec during gem build process
   module Version
     MAJOR = 4 # breaking,
-    MINOR = 8 # feature,
-    PATCH = 3 # fix => BFF
+    MINOR = 11 # feature,
+    PATCH = 0 # fix => BFF
 
     STRING = [MAJOR, MINOR, PATCH].compact.join('.')
   end

data/lib/appoptics_apm/xtrace.rb

@@ -97,16 +97,16 @@ module AppOpticsAPM
       # +finish+ is the context returned to us (as an HTTP response header
       # if that be the case)
       #
-      def continue_service_context(start, finish)
-        if AppOpticsAPM::XTrace.valid?(finish) && AppOpticsAPM.tracing?
+      def continue_service_context(start_xtrace, end_xtrace)
+        if AppOpticsAPM::XTrace.valid?(end_xtrace) && AppOpticsAPM.tracing?
 
-          # Assure that we received back a valid X-Trace with the same task_id
+          # Make sure that we received back a valid X-Trace with the same task_id
           # and the sampling bit is set, otherwise it is a response from a non-sampling service
-          if AppOpticsAPM::XTrace.task_id(start) == AppOpticsAPM::XTrace.task_id(finish) &&
-            AppOpticsAPM::XTrace.sampled?(finish)
-            AppOpticsAPM::Context.fromString(finish)
+          if AppOpticsAPM::XTrace.task_id(start_xtrace) == AppOpticsAPM::XTrace.task_id(end_xtrace) &&
+            AppOpticsAPM::XTrace.sampled?(end_xtrace)
+            AppOpticsAPM::Context.fromString(end_xtrace)
           else
-            AppOpticsAPM.logger.debug "[XTrace] Sampling flag unset or mismatched start and finish ids:\n#{start}\n#{finish}"
+            AppOpticsAPM.logger.debug "[XTrace] Sampling flag unset or mismatched start and finish ids:\n#{start_xtrace}\n#{end_xtrace}"
           end
         end
       end

data/lib/oboe_metal.rb

@@ -5,7 +5,7 @@ require 'thread'
 
 # Disable docs and Camelcase warns since we're implementing
 # an interface here.  See OboeBase for details.
-# rubocop:disable Style/Documentation, Style/MethodName
+# rubocop:disable Style/Documentation, Naming/MethodName
 module AppOpticsAPM
   extend AppOpticsAPMBase
   include Oboe_metal

data/lib/rails/generators/appoptics_apm/install_generator.rb

@@ -20,26 +20,28 @@ module AppOpticsAPM
 
     private
 
-      def print_header
-        say ""
-        say shell.set_color "Welcome to the AppOpticsAPM Ruby instrumentation setup.", :green, :bold
-        say ""
-        say shell.set_color "Documentation Links", :magenta
-        say "-------------------"
-        say ""
-        say "AppOpticsAPM Installation Overview:"
-        say "http://docs.appoptics.solarwinds.com/AppOpticsAPM/install-instrumentation.html"
-        say ""
-        say "More information on instrumenting Ruby applications can be found here:"
-        say "http://docs.appoptics.solarwinds.com/Instrumentation/ruby.html#installing-ruby-instrumentation"
-      end
-
-      def print_footer
-        say ""
-        say "You can change configuration values in the future by modifying config/initializers/appoptics_apm.rb"
-        say ""
-        say "Thanks! Creating the AppOpticsAPM initializer..."
-        say ""
-      end
+    # rubocop:disable Metrics/MethodLength
+    def print_header
+      say ""
+      say shell.set_color "Welcome to the AppOpticsAPM Ruby instrumentation setup.", :green, :bold
+      say ""
+      say shell.set_color "Documentation Links", :magenta
+      say "-------------------"
+      say ""
+      say "AppOpticsAPM Installation Overview:"
+      say "http://docs.appoptics.solarwinds.com/AppOpticsAPM/install-instrumentation.html"
+      say ""
+      say "More information on instrumenting Ruby applications can be found here:"
+      say "http://docs.appoptics.solarwinds.com/Instrumentation/ruby.html#installing-ruby-instrumentation"
+    end
+    # rubocop:enable Metrics/MethodLength
+
+    def print_footer
+      say ""
+      say "You can change configuration values in the future by modifying config/initializers/appoptics_apm.rb"
+      say ""
+      say "Thanks! Creating the AppOpticsAPM initializer..."
+      say ""
+    end
   end
 end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # AppOpticsAPM Initializer (for the appoptics_apm gem)
 # https://www.appoptics.com/
 #
@@ -50,7 +52,7 @@ if defined?(AppOpticsAPM::Config)
   AppOpticsAPM::Config[:verbose] = false
 
   #
-  # Turn tracing on or off
+  # Turn Tracing on or off
   #
   # By default tracing is set to :enabled, the other option is :disabled.
   # :enabled means that sampling will be done according to the current
@@ -61,31 +63,41 @@ if defined?(AppOpticsAPM::Config)
   #
   AppOpticsAPM::Config[:tracing_mode] = :enabled
 
+  #
+  # Turn Trigger Tracing on or off
+  #
+  # By default trigger tracing is :enabled, the other option is :disabled.
+  # It allows to use the X-Trace-Options header to force a request to be
+  # traced (within rate limits set for trigger tracing)
+  #
+  AppOpticsAPM::Config[:trigger_tracing_mode] = :enabled
+
   #
   # Trace Context in Logs
   #
-  # Configure if and when the traceId should be included in application logs.
+  # Configure if and when the Trace ID should be included in application logs.
   # Common Ruby and Rails loggers are auto-instrumented, so that they can include
-  # the current traceId in log messages.
+  # the current Trace ID in log messages.
   #
   # The added string will look like: "ao.traceId=7435A9FE510AE4533414D425DADF4E180D2B4E36-0"
   # It ends in '-1' if the request is sampled and in '-0' otherwise.
   #
   # The following options are available:
   # :never    (default)
-  # :sampled  only include the traceId of sampled requests
-  # :traced   include the traceId for all traced requests
-  # :always   always add a traceId, it will be '0000000000000000000000000000000000000000-0'
+  # :sampled  only include the Trace ID of sampled requests
+  # :traced   include the Trace ID for all traced requests
+  # :always   always add a Trace ID, it will be '0000000000000000000000000000000000000000-0'
   #           when there is no tracing context.
   #
   AppOpticsAPM::Config[:log_traceId] = :never
 
   #
-  # Prepend domain to transaction name
+  # Prepend Domain to Transaction Name
   #
-  # If this is set to `true` transaction names will be composed as `my.host.com/controller.action` instead of
-  # `controller.action`. This configuration applies to all transaction names, whether deduced by the instrumentation
-  # or implicitly set.
+  # If this is set to `true` transaction names will be composed as
+  # `my.host.com/controller.action` instead of `controller.action`.
+  # This configuration applies to all transaction names, whether deduced by the
+  # instrumentation or implicitly set.
   #
   AppOpticsAPM::Config[:transaction_name][:prepend_domain] = false
 
@@ -100,6 +112,25 @@ if defined?(AppOpticsAPM::Config)
   AppOpticsAPM::Config[:sanitize_sql_regexp] = '(\'[^\']*\'|\d*\.\d+|\d+|NULL)'
   AppOpticsAPM::Config[:sanitize_sql_opts]   = Regexp::IGNORECASE
 
+  #
+  # GraphQL
+  #
+  # Enable tracing for GraphQL.
+  # (true | false, default: true)
+  AppOpticsAPM::Config[:graphql][:enabled] = true
+  # Replace query arguments with a '?' when sent with a trace.
+  # (true | false, default: true)
+  AppOpticsAPM::Config[:graphql][:sanitize] = true
+  # Remove comments from queries when sent with a trace.
+  # (true | false, default: true)
+  AppOpticsAPM::Config[:graphql][:remove_comments] = true
+  # Create a transaction name by combining
+  # "query" or "mutation" with the first word of the query.
+  # This overwrites the default transaction name, which is a combination of
+  # controller + action and would be the same for all graphql queries.
+  # (true | false, default: true)
+  AppOpticsAPM::Config[:graphql][:transaction_name] = true
+
   #
   # Do Not Trace - DNT
   #
@@ -126,7 +157,6 @@ if defined?(AppOpticsAPM::Config)
   #
   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
-  #
 
   #
   # Transaction Settings
@@ -154,21 +184,20 @@ if defined?(AppOpticsAPM::Config)
   #
   AppOpticsAPM::Config[:transaction_settings] = {
     url: [
-    #   {
-    #     extensions: %w['long_job'],
-    #     tracing: :disabled
-    #   },
-    #   {
-    #     regexp: '^.*\/long_job\/.*$',
-    #     opts: Regexp::IGNORECASE,
-    #     tracing: :disabled
-    #   },
-    #   {
-    #     regexp: /batch/,
-    #   }
+      #   {
+      #     extensions: %w['long_job'],
+      #     tracing: :disabled
+      #   },
+      #   {
+      #     regexp: '^.*\/long_job\/.*$',
+      #     opts: Regexp::IGNORECASE,
+      #     tracing: :disabled
+      #   },
+      #   {
+      #     regexp: /batch/,
+      #   }
     ]
   }
-  #
 
   #
   # Blacklist urls
@@ -182,7 +211,6 @@ if defined?(AppOpticsAPM::Config)
   # Example: AppOpticsAPM::Config[:blacklist] = ['google.com']
   #
   AppOpticsAPM::Config[:blacklist] = []
-  #
 
   #
   # Rails Exception Logging
@@ -193,7 +221,20 @@ if defined?(AppOpticsAPM::Config)
   # report all raised exceptions regardless.
   #
   AppOpticsAPM::Config[:report_rescued_errors] = false
+
+  #
+  # EC2 Metadata Fetching Timeout
+  #
+  # The timeout can be in the range 0 - 3000 (milliseconds)
+  # Setting to 0 milliseconds effectively disables fetching from
+  # the metadata URL (not waiting), and should only be used if
+  # not running on EC2 / Openstack to minimize agent start up time.
   #
+  AppOpticsAPM::Config[:ec2_metadata_timeout] = 1000
+
+  #############################################
+  ## SETTINGS FOR INDIVIDUAL GEMS/FRAMEWORKS ##
+  #############################################
 
   #
   # Bunny Controller and Action
@@ -213,7 +254,6 @@ if defined?(AppOpticsAPM::Config)
   #
   AppOpticsAPM::Config[:bunnyconsumer][:controller] = :app_id
   AppOpticsAPM::Config[:bunnyconsumer][:action] = :type
-  #
 
   #
   # Enabling/Disabling Instrumentation
@@ -235,7 +275,7 @@ if defined?(AppOpticsAPM::Config)
   AppOpticsAPM::Config[:dalli][:enabled] = true
   AppOpticsAPM::Config[:delayed_jobclient][:enabled] = true
   AppOpticsAPM::Config[:delayed_jobworker][:enabled] = true
-  AppOpticsAPM::Config[:em_http_request][:enabled] = false
+  # AppOpticsAPM::Config[:em_http_request][:enabled] = false # not supported anymore
   AppOpticsAPM::Config[:excon][:enabled] = true
   AppOpticsAPM::Config[:faraday][:enabled] = true
   AppOpticsAPM::Config[:grpc_client][:enabled] = true
@@ -257,7 +297,6 @@ if defined?(AppOpticsAPM::Config)
   AppOpticsAPM::Config[:sidekiqworker][:enabled] = true
   AppOpticsAPM::Config[:sinatra][:enabled] = true
   AppOpticsAPM::Config[:typhoeus][:enabled] = true
-  #
 
   #
   # Argument logging
@@ -280,7 +319,6 @@ if defined?(AppOpticsAPM::Config)
   AppOpticsAPM::Config[:sidekiqclient][:log_args] = true
   AppOpticsAPM::Config[:sidekiqworker][:log_args] = true
   AppOpticsAPM::Config[:typhoeus][:log_args] = true
-  #
 
   #
   # Enabling/Disabling Backtrace Collection
@@ -301,7 +339,7 @@ if defined?(AppOpticsAPM::Config)
   AppOpticsAPM::Config[:dalli][:collect_backtraces] = false
   AppOpticsAPM::Config[:delayed_jobclient][:collect_backtraces] = false
   AppOpticsAPM::Config[:delayed_jobworker][:collect_backtraces] = false
-  AppOpticsAPM::Config[:em_http_request][:collect_backtraces] = true
+  # AppOpticsAPM::Config[:em_http_request][:collect_backtraces] = true # not supported anymore
   AppOpticsAPM::Config[:excon][:collect_backtraces] = true
   AppOpticsAPM::Config[:faraday][:collect_backtraces] = false
   AppOpticsAPM::Config[:grape][:collect_backtraces] = true

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: appoptics_apm
 version: !ruby/object:Gem::Version
-  version: 4.8.3
+  version: 4.11.0
 platform: ruby
 authors:
 - Maia Engeli
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-28 00:00:00.000000000 Z
+date: 2020-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -60,6 +60,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: irb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
@@ -88,6 +102,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.5.0
+- !ruby/object:Gem::Dependency
+  name: minitest-focus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.2
 - !ruby/object:Gem::Dependency
   name: benchmark-ips
   requirement: !ruby/object:Gem::Requirement
@@ -105,7 +133,7 @@ dependencies:
 description: 'Automatic tracing and metrics for Ruby applications. Get started at
   appoptics.com. @AppOptics
 
-'
+  '
 email: support@appoptics.com
 executables:
 - appoptics_apm_config
@@ -125,11 +153,8 @@ files:
 - Gemfile
 - LICENSE
 - README.md
-- Rakefile
 - appoptics_apm.gemspec
 - bin/appoptics_apm_config
-- build_gem.sh
-- build_gem_upload_to_packagecloud.sh
 - examples/SDK/01_basic_tracing.rb
 - examples/carrying_context.rb
 - ext/oboe_metal/README.md
@@ -150,7 +175,6 @@ files:
 - 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
 - lib/appoptics_apm/base.rb
@@ -159,12 +183,11 @@ files:
 - lib/appoptics_apm/frameworks/padrino.rb
 - lib/appoptics_apm/frameworks/rails.rb
 - lib/appoptics_apm/frameworks/rails/inst/action_controller.rb
-- lib/appoptics_apm/frameworks/rails/inst/action_controller3.rb
 - lib/appoptics_apm/frameworks/rails/inst/action_controller4.rb
 - lib/appoptics_apm/frameworks/rails/inst/action_controller5.rb
+- lib/appoptics_apm/frameworks/rails/inst/action_controller6.rb
 - lib/appoptics_apm/frameworks/rails/inst/action_controller_api.rb
 - lib/appoptics_apm/frameworks/rails/inst/action_view.rb
-- lib/appoptics_apm/frameworks/rails/inst/action_view_30.rb
 - lib/appoptics_apm/frameworks/rails/inst/active_record.rb
 - lib/appoptics_apm/frameworks/rails/inst/connection_adapters/mysql.rb
 - lib/appoptics_apm/frameworks/rails/inst/connection_adapters/mysql2.rb
@@ -181,6 +204,7 @@ files:
 - lib/appoptics_apm/inst/em-http-request.rb
 - lib/appoptics_apm/inst/excon.rb
 - lib/appoptics_apm/inst/faraday.rb
+- lib/appoptics_apm/inst/graphql.rb
 - lib/appoptics_apm/inst/grpc_client.rb
 - lib/appoptics_apm/inst/grpc_server.rb
 - lib/appoptics_apm/inst/http.rb
@@ -202,10 +226,8 @@ files:
 - lib/appoptics_apm/inst/twitter-cassandra.rb
 - lib/appoptics_apm/inst/typhoeus.rb
 - lib/appoptics_apm/instrumentation.rb
-- lib/appoptics_apm/legacy_method_profiling.rb
 - lib/appoptics_apm/loading.rb
 - lib/appoptics_apm/logger.rb
-- lib/appoptics_apm/method_profiling.rb
 - lib/appoptics_apm/noop/README.md
 - lib/appoptics_apm/noop/context.rb
 - lib/appoptics_apm/noop/metadata.rb
@@ -217,6 +239,7 @@ files:
 - lib/appoptics_apm/sdk/tracing.rb
 - lib/appoptics_apm/support/transaction_metrics.rb
 - lib/appoptics_apm/support/transaction_settings.rb
+- lib/appoptics_apm/support/x_trace_options.rb
 - lib/appoptics_apm/support_report.rb
 - lib/appoptics_apm/test.rb
 - lib/appoptics_apm/thread_local.rb
@@ -225,16 +248,13 @@ files:
 - lib/appoptics_apm/xtrace.rb
 - lib/joboe_metal.rb
 - lib/oboe.rb
-- lib/oboe/README
-- lib/oboe/backward_compatibility.rb
-- lib/oboe/inst/rack.rb
 - lib/oboe_metal.rb
 - lib/rails/generators/appoptics_apm/install_generator.rb
 - lib/rails/generators/appoptics_apm/templates/appoptics_apm_initializer.rb
 - yardoc_frontpage.md
 homepage: https://www.appoptics.com/
 licenses:
-- Librato Open License, Version 1.0
+- Librato Open License, Version 1.0, https://bit.ly/2Kmm0mN
 metadata:
   changelog_uri: https://github.com/appoptics/appoptics-apm-ruby/releases
   documentation_uri: https://docs.appoptics.com/kb/apm_tracing/ruby/
@@ -248,14 +268,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: AppOptics APM performance instrumentation gem for Ruby