appoptics_apm 4.11.0 → 4.12.2

data/lib/appoptics_apm/inst/graphql.rb

@@ -13,23 +13,23 @@
 # ____  what is in the graphql gem and vice-versa
 
 
-if defined?(GraphQL::Tracing)
+if defined?(GraphQL::Tracing) && !(AppOpticsAPM::Config[:graphql][:enabled] == false)
   module GraphQL
     module Tracing
       # AppOpticsTracing in the graphql gem may be a different version than the
       # one defined here, we want to use the newer one
-      dont_redefine = false
+      redefine = true
       this_version = Gem::Version.new('1.0.0')
 
       if defined?(GraphQL::Tracing::AppOpticsTracing)
         if this_version > GraphQL::Tracing::AppOpticsTracing.version
           send(:remove_const, :AppOpticsTracing)
         else
-          dont_redefine = true
+          redefine = false
         end
       end
 
-      unless dont_redefine
+      if redefine
         #-----------------------------------------------------------------------------#
         #----- this class is duplicated in the graphql gem ---------------------------#
         #-----------------------------------------------------------------------------#
@@ -84,7 +84,7 @@ if defined?(GraphQL::Tracing)
 
           def transaction_name(query)
             return if gql_config[:transaction_name] == false ||
-                      ::AppOpticsAPM::SDK.get_transaction_name
+              ::AppOpticsAPM::SDK.get_transaction_name
 
             split_query = query.strip.split(/\W+/, 3)
             split_query[0] = 'query' if split_query[0].empty?
@@ -95,7 +95,7 @@ if defined?(GraphQL::Tracing)
 
           def multiplex_transaction_name(names)
             return if gql_config[:transaction_name] == false ||
-                      ::AppOpticsAPM::SDK.get_transaction_name
+              ::AppOpticsAPM::SDK.get_transaction_name
 
             name = "graphql.multiplex.#{names.join('.')}"
             name = "#{name[0..251]}..." if name.length > 254
@@ -167,8 +167,8 @@ if defined?(GraphQL::Tracing)
 
             # remove arguments
             query.gsub(/"[^"]*"/, '"?"')                 # strings
-                 .gsub(/-?[0-9]*\.?[0-9]+e?[0-9]*/, '?') # ints + floats
-                 .gsub(/\[[^\]]*\]/, '[?]')              # arrays
+              .gsub(/-?[0-9]*\.?[0-9]+e?[0-9]*/, '?') # ints + floats
+              .gsub(/\[[^\]]*\]/, '[?]')              # arrays
           end
 
           def remove_comments(query)
@@ -184,10 +184,16 @@ if defined?(GraphQL::Tracing)
 
   module AppOpticsAPM
     module GraphQLSchemaPrepend
-      def use(plugin, options = {})
-        super unless GraphQL::Schema.plugins.find { |pl| pl[0].to_s == plugin.to_s }
+      def use(plugin, **options)
+        # super unless GraphQL::Schema.plugins.find { |pl| pl[0].to_s == plugin.to_s }
+        super unless self.plugins.find { |pl| pl[0].to_s == plugin.to_s }
 
-        GraphQL::Schema.plugins
+        self.plugins
+      end
+
+      def inherited(subclass)
+        subclass.use(GraphQL::Tracing::AppOpticsTracing)
+        super
       end
     end
 
@@ -200,16 +206,35 @@ if defined?(GraphQL::Tracing)
       end
     end
     # rubocop:enable Style/RedundantSelf
-  end
 
-  if defined?(GraphQL::Schema)
-    GraphQL::Schema.singleton_class.prepend(AppOpticsAPM::GraphQLSchemaPrepend)
-    GraphQL::Schema.use(GraphQL::Tracing::AppOpticsTracing)
+    # a different way of autoinstrumenting for graphql 1.7.4 - < 1.8.0
+    module GraphQLSchemaPrepend17
+      def initialize
+        super
+        unless tracers.find { |tr| tr.is_a? GraphQL::Tracing::AppOpticsTracing }
+          tracer = GraphQL::Tracing::AppOpticsTracing.new
+          tracers.push(tracer)
+          instrumenters[:field] << tracer
+        end
+      end
+    end
   end
 
-  # rubocop:disable Style/IfUnlessModifier
-  if defined?(GraphQL::Error)
-    GraphQL::Error.prepend(AppOpticsAPM::GraphQLErrorPrepend)
+  if Gem.loaded_specs['graphql'] && Gem.loaded_specs['graphql'].version >= Gem::Version.new('1.8.0')
+    AppOpticsAPM.logger.info '[appoptics_apm/loading] Instrumenting GraphQL' if AppOpticsAPM::Config[:verbose]
+    if defined?(GraphQL::Schema)
+      GraphQL::Schema.singleton_class.prepend(AppOpticsAPM::GraphQLSchemaPrepend)
+    end
+
+    # rubocop:disable Style/IfUnlessModifier
+    if defined?(GraphQL::Error)
+      GraphQL::Error.prepend(AppOpticsAPM::GraphQLErrorPrepend)
+    end
+    # rubocop:enable Style/IfUnlessModifier
+  elsif Gem.loaded_specs['graphql'] && Gem.loaded_specs['graphql'].version >= Gem::Version.new('1.7.4')
+    AppOpticsAPM.logger.info '[appoptics_apm/loading] Instrumenting GraphQL' if AppOpticsAPM::Config[:verbose]
+    if defined?(GraphQL::Schema)
+      GraphQL::Schema.prepend(AppOpticsAPM::GraphQLSchemaPrepend17)
+    end
   end
-  # rubocop:enable Style/IfUnlessModifier
 end

data/lib/appoptics_apm/inst/grpc_client.rb

@@ -156,4 +156,4 @@ if defined?(GRPC) && AppOpticsAPM::Config[:grpc_client][:enabled]
 
     end
   end
-end
+end

data/lib/appoptics_apm/inst/http.rb

@@ -4,70 +4,78 @@
 require 'net/http'
 
 if AppOpticsAPM::Config[:nethttp][:enabled]
-
-  Net::HTTP.class_eval do
-    def request_with_appoptics(*args, &block)
-      # Avoid cross host tracing for blacklisted domains
-      blacklisted = AppOpticsAPM::API.blacklisted?(addr_port)
-
-      # If we're not tracing, just do a fast return. Since
-      # net/http.request calls itself, only trace
-      # once the http session has been started.
-      if !AppOpticsAPM.tracing? || !started?
-        unless blacklisted
-          xtrace = AppOpticsAPM::Context.toString
-          args[0]['X-Trace'] = xtrace if AppOpticsAPM::XTrace.valid?(xtrace)
-        end
-        return request_without_appoptics(*args, &block)
-      end
-
-      opts = {}
-      AppOpticsAPM::API.trace(:'net-http', opts) do
-        context = AppOpticsAPM::Context.toString
-        # task_id = AppOpticsAPM::XTrace.task_id(context)
-
-        # Collect KVs to report in the info event
-        if args.respond_to?(:first) && args.first
-          req = args.first
-
-          opts[:Spec] = 'rsc'
-          opts[:IsService] = 1
-          opts[:RemoteURL] = "#{use_ssl? ? 'https' : 'http'}://#{addr_port}"
-          opts[:RemoteURL] << (AppOpticsAPM::Config[:nethttp][:log_args] ? req.path : req.path.split('?').first)
-          opts[:HTTPMethod] = req.method
-          opts[:Blacklisted] = true if blacklisted
-          opts[:Backtrace] = AppOpticsAPM::API.backtrace if AppOpticsAPM::Config[:nethttp][:collect_backtraces]
-
-          req['X-Trace'] = context unless blacklisted
-        end
-
-        begin
-          # The actual net::http call
-          resp = request_without_appoptics(*args, &block)
-
-          # Re-attach net::http edge unless blacklisted and is a valid X-Trace ID
-          unless blacklisted
-            xtrace = resp.get_fields('X-Trace')
-            xtrace = xtrace[0] if xtrace && xtrace.is_a?(Array)
-
-            AppOpticsAPM::XTrace.continue_service_context(context, xtrace)
+  module AppOpticsAPM
+    module Inst
+      module NetHttp
+        # Net::HTTP.class_eval do
+        # def request_with_appoptics(*args, &block)
+        def request(*args, &block)
+          # Avoid cross host tracing for blacklisted domains
+          blacklisted = AppOpticsAPM::API.blacklisted?(addr_port)
+
+          # If we're not tracing, just do a fast return. Since
+          # net/http.request calls itself, only trace
+          # once the http session has been started.
+          if !AppOpticsAPM.tracing? || !started?
+            if blacklisted # if the other site is blacklisted, we don't want to leak its X-trace
+              resp = super
+              resp.delete('X-Trace') # if resp['X-Trace']
+              return resp
+            else
+              xtrace = AppOpticsAPM::Context.toString
+              args[0]['X-Trace'] = xtrace if AppOpticsAPM::XTrace.valid?(xtrace)
+              return super
+            end
           end
 
-          opts[:HTTPStatus] = resp.code
-
-          # If we get a redirect, report the location header
-          if ((300..308).to_a.include? resp.code.to_i) && resp.header["Location"]
-            opts[:Location] = resp.header["Location"]
+          opts = {}
+          AppOpticsAPM::API.trace(:'net-http', opts) do
+            context = AppOpticsAPM::Context.toString
+
+            # Collect KVs to report in the exit event
+            if args.respond_to?(:first) && args.first
+              req = args.first
+
+              opts[:Spec] = 'rsc'
+              opts[:IsService] = 1
+              opts[:RemoteURL] = "#{use_ssl? ? 'https' : 'http'}://#{addr_port}"
+              opts[:RemoteURL] << (AppOpticsAPM::Config[:nethttp][:log_args] ? req.path : req.path.split('?').first)
+              opts[:HTTPMethod] = req.method
+              opts[:Blacklisted] = true if blacklisted
+              opts[:Backtrace] = AppOpticsAPM::API.backtrace if AppOpticsAPM::Config[:nethttp][:collect_backtraces]
+
+              req['X-Trace'] = context unless blacklisted
+            end
+
+            begin
+              # The actual net::http call
+              resp = super
+              # Re-attach net::http edge unless blacklisted and is a valid X-Trace ID
+              xtrace = resp.get_fields('X-Trace')
+              if blacklisted
+                # we don't want the x-trace if it is from a blacklisted address
+                resp.delete('X-Trace') # if xtrace
+              else
+                xtrace = xtrace[0] if xtrace && xtrace.is_a?(Array)
+                AppOpticsAPM::XTrace.continue_service_context(context, xtrace)
+              end
+
+              opts[:HTTPStatus] = resp.code
+
+              # If we get a redirect, report the location header
+              if ((300..308).to_a.include? resp.code.to_i) && resp.header["Location"]
+                opts[:Location] = resp.header["Location"]
+              end
+
+              next resp
+            end
           end
-
-          next resp
         end
+
       end
     end
-
-    alias request_without_appoptics request
-    alias request request_with_appoptics
-
-    AppOpticsAPM.logger.info '[appoptics_apm/loading] Instrumenting net/http' if AppOpticsAPM::Config[:verbose]
   end
+
+  Net::HTTP.prepend(AppOpticsAPM::Inst::NetHttp)
+  AppOpticsAPM.logger.info '[appoptics_apm/loading] Instrumenting net/http' if AppOpticsAPM::Config[:verbose]
 end

data/lib/appoptics_apm/inst/rack_cache.rb

@@ -0,0 +1,35 @@
+# Copyright (c) 2020 SolarWinds, LLC.
+# All rights reserved.
+
+module AppOpticsAPM
+  module RackCacheContext
+
+    ###
+    # This adds a controller.action like transaction name for
+    # requests directly served from the cache without involving a controller.
+    # The resulting transaction name is `rack-cache.<cache-store>`,
+    # e.g. `rack-cache.memcached`
+    #
+    # It is not a full instrumentation, no span is added.
+    #
+    def call!(env)
+      metastore_type = begin
+        if options['rack-cache.metastore']
+          options['rack-cache.metastore'].match(/^([^\:]*)\:/)[1]
+        end || 'unknown_store'
+      rescue
+        'unknown_store'
+      end
+
+      env['appoptics_apm.action'] = metastore_type
+      env['appoptics_apm.controller'] = 'rack-cache'
+
+      super
+    end
+  end
+end
+
+if AppOpticsAPM::Config[:rack_cache][:transaction_name] && defined?(Rack::Cache::Context)
+  AppOpticsAPM.logger.info '[appoptics_apm/loading] Instrumenting rack_cache' if AppOpticsAPM::Config[:verbose]
+  Rack::Cache::Context.send(:prepend, ::AppOpticsAPM::RackCacheContext)
+end

data/lib/appoptics_apm/noop/context.rb

@@ -10,8 +10,6 @@ module AppOpticsAPM
     # noop version of :toString
     # toString would return the current context (xtrace) as string
     #
-    # the noop version returns an empty string
-    #
     def self.toString
       '2B0000000000000000000000000000000000000000000000000000000000'
     end
@@ -23,4 +21,4 @@ module AppOpticsAPM
 
     end
   end
-end
+end

data/lib/appoptics_apm/oboe_init_options.rb

@@ -8,7 +8,7 @@ module AppOpticsAPM
   class OboeInitOptions
     include Singleton
 
-    attr_reader :reporter, :host, :service_name, :ec2_md_timeout  # exposing these mainly for testing
+    attr_reader :reporter, :host, :service_name, :ec2_md_timeout, :grpc_proxy  # exposing these mainly for testing
 
     # TODO decide if these globals are useful when testing
     # OBOE_HOSTNAME_ALIAS = 0
@@ -71,6 +71,7 @@ module AppOpticsAPM
       @file_single = (ENV['APPOPTICS_REPORTER_FILE_SINGLE'].to_s.downcase == 'true') ? 1 : 0
       # timeout for ec2 metadata
       @ec2_md_timeout = read_and_validate_ec2_md_timeout
+      @grpc_proxy = read_and_validate_proxy
     end
 
     def re_init # for testing with changed ENV vars
@@ -97,7 +98,8 @@ module AppOpticsAPM
         @token_bucket_capacity,
         @token_bucket_rate,
         @file_single,
-        @ec2_md_timeout
+        @ec2_md_timeout,
+        @grpc_proxy
       ]
     end
 
@@ -183,11 +185,23 @@ module AppOpticsAPM
     end
 
     def read_and_validate_ec2_md_timeout
-      timeout = (ENV['APPOPTICS_EC2_METADATA_TIMEOUT'] || AppOpticsAPM::Config[:ec2_metadata_timeout])
+      timeout = ENV['APPOPTICS_EC2_METADATA_TIMEOUT'] || AppOpticsAPM::Config[:ec2_metadata_timeout]
       return 1000 unless timeout.is_a?(Integer) || timeout =~ /^\d+$/
       timeout = timeout.to_i
       return timeout.between?(0, 3000) ? timeout : 1000
     end
+
+    def read_and_validate_proxy
+      proxy = ENV['APPOPTICS_PROXY'] || AppOpticsAPM::Config[:http_proxy] || ''
+      return proxy if proxy == ''
+
+      unless proxy =~ /http:\/\/.*:\d+$/
+        AppOpticsAPM.logger.error "[appoptics_apm/oboe_options] APPOPTICS_PROXY/http_proxy doesn't start with 'http://', #{proxy}"
+        return '' # try without proxy, it may work, shouldn't crash but may not report
+      end
+
+      proxy
+    end
   end
 end
 

data/lib/appoptics_apm/sdk/current_trace.rb

@@ -37,14 +37,10 @@ module AppOpticsAPM
         attr_reader :id
 
         def initialize
-          if AppOpticsAPM::Config[:log_traceId] == :never
-            @id = '0000000000000000000000000000000000000000-0'
-          else
-            @xtrace = AppOpticsAPM::Context.toString
-            task_id = AppOpticsAPM::XTrace.task_id(@xtrace)
-            sampled = AppOpticsAPM::XTrace.sampled?(@xtrace)
-            @id = "#{task_id}-#{sampled ? 1 : 0}"
-          end
+          @xtrace = AppOpticsAPM::Context.toString
+          task_id = AppOpticsAPM::XTrace.task_id(@xtrace)
+          sampled = AppOpticsAPM::XTrace.sampled?(@xtrace)
+          @id = "#{task_id}-#{sampled ? 1 : 0}"
         end
 
         # for_log returns a string in the format 'traceId=<current_trace.id>' or ''.
@@ -78,4 +74,4 @@ module AppOpticsAPM
 
     extend CurrentTrace
   end
-end
+end

data/lib/appoptics_apm/sdk/custom_metrics.rb

@@ -29,7 +29,7 @@ module AppOpticsAPM
       #   end
       #
       # === Returns:
-      # * true on success, false on failure
+      # * 0 on success, error code on failure
       #
       def increment_metric(name, count = 1, with_hostname = false, tags_kvs = {})
         return true unless AppOpticsAPM.loaded
@@ -62,7 +62,7 @@ module AppOpticsAPM
       #   end
       #
       # === Returns:
-      # * true on success, false on failure
+      # * 0 on success, error code on failure
       #
       def summary_metric(name, value, count = 1, with_hostname = false, tags_kvs = {})
         return true unless AppOpticsAPM.loaded

data/lib/appoptics_apm/support/transaction_metrics.rb

@@ -64,4 +64,4 @@ module AppOpticsAPM
 
     end
   end
-end
+end

data/lib/appoptics_apm/support/transaction_settings.rb

@@ -55,7 +55,7 @@ module AppOpticsAPM
         args << options.timestamp
       end
 
-      metrics, sample, @rate, @source, @type, @auth, @status_msg, @auth_msg, @status =
+      metrics, sample, @rate, @source, @bucket_rate, @bucket_cap, @type, @auth, @status_msg, @auth_msg, @status =
         AppOpticsAPM::Context.getDecisions(*args)
 
       if @status > AO_TRACING_DECISIONS_OK

data/lib/appoptics_apm/test.rb

@@ -53,13 +53,13 @@ module AppOpticsAPM
       def set_postgresql_env
         if ENV.key?('TRAVIS_PSQL_PASS')
           ENV['DATABASE_URL'] = "postgresql://postgres:#{ENV['TRAVIS_PSQL_PASS']}@127.0.0.1:5432/travis_ci_test"
-        elsif ENV.key?('DOCKER_PSQL_PASS')
-          ENV['DATABASE_URL'] = "postgresql://docker:#{ENV['DOCKER_PSQL_PASS']}@127.0.0.1:5432/travis_ci_test"
+        elsif ENV.key?('POSTGRES_USER')
+          ENV['DATABASE_URL'] = "postgresql://#{ENV['POSTGRES_PASSWORD']}:#{ENV['POSTGRES_USER']}@#{ENV['PSQL_HOST']}:5432/travis_ci_test"
+          # ENV['DATABASE_URL'] = "postgresql://postgres@#{ENV['PSQL_HOST']}:5432/travis_ci_test"
         else
           ENV['DATABASE_URL'] = 'postgresql://postgres@127.0.0.1:5432/travis_ci_test'
         end
       end
-
       ##
       # set_mysql_env
       #

data/lib/appoptics_apm/util.rb

@@ -271,12 +271,13 @@ module AppOpticsAPM
           platform_info['Force']                        = true
           platform_info['Ruby.Platform.Version']        = RUBY_PLATFORM
           platform_info['Ruby.Version']                 = RUBY_VERSION
-          platform_info['Ruby.AppOptics.Version']    = AppOpticsAPM::Version::STRING
+          platform_info['Ruby.AppOptics.Version']       = AppOpticsAPM::Version::STRING
 
+          # oboe not loaded yet, can't use oboe_api function to read oboe VERSION
           clib_version_file = File.join(Gem::Specification.find_by_name('appoptics_apm').gem_dir, 'ext', 'oboe_metal', 'src', 'VERSION')
-          platform_info['Ruby.clib.Version']            = File.read(clib_version_file).chomp
+          platform_info['Ruby.AppOpticsExtension.Version'] = File.read(clib_version_file).chomp
           platform_info['RubyHeroku.AppOpticsAPM.Version'] = AppOpticsAPMHeroku::Version::STRING if defined?(AppOpticsAPMHeroku)
-          platform_info['Ruby.TraceMode.Version']       = AppOpticsAPM::Config[:tracing_mode]
+          platform_info['Ruby.TraceMode.Version']          = AppOpticsAPM::Config[:tracing_mode]
 
           # Collect up the loaded gems
           if defined?(Gem) && Gem.respond_to?(:loaded_specs)