elastic-apm 3.10.1 → 3.13.0

data/lib/elastic_apm/opentracing.rb

@@ -123,6 +123,7 @@ module ElasticAPM
       end
 
       attr_accessor :trace_context
+
       def_delegators :trace_context, :trace_id, :id, :parent_id
 
       def self.from_header(header)
@@ -345,7 +346,7 @@ module ElasticAPM
         context = context_from_child_of(child_of) ||
                   context_from_references(references) ||
                   context_from_active_scope(ignore_active_scope)
-        return context.child if context&.respond_to?(:child)
+        return context.child if context.respond_to?(:child)
 
         context
       end

data/lib/elastic_apm/span.rb

@@ -25,6 +25,17 @@ module ElasticAPM
     extend Forwardable
     include ChildDurations::Methods
 
+    # @api private
+    class Outcome
+      FAILURE = "failure"
+      SUCCESS = "success"
+      UNKNOWN = "unknown"
+
+      def self.from_http_status(code)
+        code.to_i >= 400 ? FAILURE : SUCCESS
+      end
+    end
+
     DEFAULT_TYPE = 'custom'
 
     # rubocop:disable Metrics/ParameterLists
@@ -53,6 +64,7 @@ module ElasticAPM
       @transaction = transaction
       @parent = parent
       @trace_context = trace_context || parent.trace_context.child
+      @sample_rate = transaction.sample_rate
 
       @context = context || Span::Context.new(sync: sync)
       @stacktrace_builder = stacktrace_builder
@@ -65,6 +77,7 @@ module ElasticAPM
       :action,
       :name,
       :original_backtrace,
+      :outcome,
       :subtype,
       :trace_context,
       :type
@@ -73,6 +86,7 @@ module ElasticAPM
       :context,
       :duration,
       :parent,
+      :sample_rate,
       :self_time,
       :stacktrace,
       :timestamp,

data/lib/elastic_apm/span/context/db.rb

@@ -30,7 +30,7 @@ module ElasticAPM
           rows_affected: nil
         )
           @instance = instance
-          @statement = statement
+          @statement = statement&.encode('utf-8', invalid: :replace, undef: :replace)
           @type = type
           @user = user
           @rows_affected = rows_affected

data/lib/elastic_apm/spies/delayed_job.rb

@@ -41,10 +41,12 @@ module ElasticAPM
         job_name = name_from_payload(job.payload_object)
         transaction = ElasticAPM.start_transaction(job_name, TYPE)
         job.invoke_job_without_apm(*args, &block)
-        transaction.done 'success'
+        transaction&.done 'success'
+        transaction&.outcome = Transaction::Outcome::SUCCESS
       rescue ::Exception => e
         ElasticAPM.report(e, handled: false)
-        transaction.done 'error'
+        transaction&.done 'error'
+        transaction&.outcome = Transaction::Outcome::FAILURE
         raise
       ensure
         ElasticAPM.end_transaction
@@ -53,6 +55,10 @@ module ElasticAPM
       def self.name_from_payload(payload_object)
         if payload_object.is_a?(::Delayed::PerformableMethod)
           performable_method_name(payload_object)
+        elsif payload_object.instance_of?(
+          ActiveJob::QueueAdapters::DelayedJobAdapter::JobWrapper
+        )
+          payload_object.job_data['job_class']
         else
           payload_object.class.name
         end

data/lib/elastic_apm/spies/dynamo_db.rb

@@ -25,9 +25,11 @@ module ElasticAPM
       def self.without_net_http
         return yield unless defined?(NetHTTPSpy)
 
+        # rubocop:disable Style/ExplicitBlockArgument
         ElasticAPM::Spies::NetHTTPSpy.disable_in do
           yield
         end
+        # rubocop:enable Style/ExplicitBlockArgument
       end
 
       def install
@@ -37,7 +39,12 @@ module ElasticAPM
             alias :"#{operation_name}_without_apm" :"#{operation_name}"
 
             define_method(operation_name) do |params = {}, options = {}|
-              ElasticAPM.with_span(operation_name, 'db', subtype: 'dynamodb', action: operation_name) do
+              ElasticAPM.with_span(
+                operation_name,
+                'db',
+                subtype: 'dynamodb',
+                action: operation_name
+              ) do
                 ElasticAPM::Spies::DynamoDBSpy.without_net_http do
                   original_method = method("#{operation_name}_without_apm")
                   original_method.call(params, options)

data/lib/elastic_apm/spies/elasticsearch.rb

@@ -27,7 +27,14 @@ module ElasticAPM
       SUBTYPE = 'elasticsearch'
 
       def self.sanitizer
-        @sanitizer ||= ElasticAPM::Transport::Filters::HashSanitizer.new
+        @sanitizer ||=
+          begin
+            config = ElasticAPM.agent.config
+            ElasticAPM::Transport::Filters::HashSanitizer.new(
+              key_patterns: config.custom_key_filters +
+                            config.sanitize_field_names
+            )
+          end
       end
 
       def install
@@ -47,7 +54,8 @@ module ElasticAPM
             if ElasticAPM.agent.config.capture_elasticsearch_queries
               unless args[1].nil? || args[1].empty?
                 statement << {
-                  body: ElasticAPM::Spies::ElasticsearchSpy.sanitizer.strip_from!(args[1])
+                  body: ElasticAPM::Spies::ElasticsearchSpy
+                             .sanitizer.strip_from(args[1])
                 }
               end
             end

data/lib/elastic_apm/spies/faraday.rb

@@ -28,12 +28,14 @@ module ElasticAPM
       def self.without_net_http
         return yield unless defined?(NetHTTPSpy)
 
+        # rubocop:disable Style/ExplicitBlockArgument
         ElasticAPM::Spies::NetHTTPSpy.disable_in do
           yield
         end
+        # rubocop:enable Style/ExplicitBlockArgument
       end
 
-      # rubocop:disable Metrics/CyclomaticComplexity
+      # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
       def install
         ::Faraday::Connection.class_eval do
           alias run_request_without_apm run_request
@@ -89,13 +91,14 @@ module ElasticAPM
                   http.status_code = result.status.to_s
                 end
 
+                span&.outcome = Span::Outcome.from_http_status(result.status)
                 result
               end
             end
           end
         end
       end
-      # rubocop:enable Metrics/CyclomaticComplexity
+      # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
     end
 
     register 'Faraday', 'faraday', FaradaySpy.new

data/lib/elastic_apm/spies/http.rb

@@ -61,6 +61,7 @@ module ElasticAPM
                 http.status_code = result.status.to_s
               end
 
+              span&.outcome = Span::Outcome.from_http_status(result.status)
               result
             end
           end

data/lib/elastic_apm/spies/mongo.rb

@@ -44,11 +44,15 @@ module ElasticAPM
         end
 
         def failed(event)
-          pop_event(event)
+          span = pop_event(event)
+          span&.outcome = Span::Outcome::FAILURE
+          span
         end
 
         def succeeded(event)
-          pop_event(event)
+          span = pop_event(event)
+          span&.outcome = Span::Outcome::SUCCESS
+          span
         end
 
         private

data/lib/elastic_apm/spies/net_http.rb

@@ -47,6 +47,7 @@ module ElasticAPM
       end
 
       # rubocop:disable Metrics/CyclomaticComplexity
+      # rubocop:disable Metrics/PerceivedComplexity
       def install
         Net::HTTP.class_eval do
           alias request_without_apm request
@@ -96,12 +97,14 @@ module ElasticAPM
                 http.status_code = result.code
               end
 
+              span&.outcome = Span::Outcome.from_http_status(result.code)
               result
             end
           end
         end
       end
       # rubocop:enable Metrics/CyclomaticComplexity
+      # rubocop:enable Metrics/PerceivedComplexity
     end
 
     register 'Net::HTTP', 'net/http', NetHTTPSpy.new

data/lib/elastic_apm/spies/rake.rb

@@ -39,9 +39,11 @@ module ElasticAPM
             begin
               result = execute_without_apm(*args)
 
-              transaction.result = 'success' if transaction
+              transaction&.result = 'success'
+              transaction&.outcome = Transaction::Outcome::SUCCESS
             rescue StandardError => e
-              transaction.result = 'error' if transaction
+              transaction&.result = 'error'
+              transaction&.outcome = Transaction::Outcome::FAILURE
               ElasticAPM.report(e)
 
               raise

data/lib/elastic_apm/spies/resque.rb

@@ -36,10 +36,12 @@ module ElasticAPM
             name = @payload && @payload['class']&.to_s
             transaction = ElasticAPM.start_transaction(name, TYPE)
             perform_without_elastic_apm
-            transaction.done 'success'
+            transaction&.done 'success'
+            transaction&.outcome = Transaction::Outcome::SUCCESS
           rescue ::Exception => e
             ElasticAPM.report(e, handled: false)
-            transaction.done 'error' if transaction
+            transaction&.done 'error'
+            transaction&.outcome = Transaction::Outcome::FAILURE
             raise
           ensure
             ElasticAPM.end_transaction

data/lib/elastic_apm/spies/sequel.rb

@@ -31,6 +31,7 @@ module ElasticAPM
         @summarizer ||= Sql.summarizer
       end
 
+      # rubocop:disable Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
       def install
         require 'sequel/database/logging'
 
@@ -61,7 +62,12 @@ module ElasticAPM
               action: ACTION,
               context: context
             )
-            yield.tap do |result|
+            log_connection_yield_without_apm(
+              sql,
+              connection,
+              args,
+              &block
+            ).tap do |result|
               if name =~ /^(UPDATE|DELETE)/
                 if connection.respond_to?(:changes)
                   span.context.db.rows_affected = connection.changes
@@ -70,11 +76,16 @@ module ElasticAPM
                 end
               end
             end
+          rescue
+            span&.outcome = Span::Outcome::FAILURE
+            raise
           ensure
+            span&.outcome ||= Span::Outcome::SUCCESS
             ElasticAPM.end_span
           end
         end
       end
+      # rubocop:enable Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
     end
 
     register 'Sequel', 'sequel', SequelSpy.new

data/lib/elastic_apm/spies/shoryuken.rb

@@ -37,9 +37,11 @@ module ElasticAPM
           yield
 
           transaction&.done :success
+          transaction&.outcome = Transaction::Outcome::SUCCESS
         rescue ::Exception => e
           ElasticAPM.report(e, handled: false)
           transaction&.done :error
+          transaction&.outcome = Transaction::Outcome::FAILURE
           raise
         ensure
           ElasticAPM.end_transaction

data/lib/elastic_apm/spies/sidekiq.rb

@@ -35,9 +35,11 @@ module ElasticAPM
           yield
 
           transaction&.done :success
+          transaction&.outcome = Transaction::Outcome::SUCCESS
         rescue ::Exception => e
           ElasticAPM.report(e, handled: false)
           transaction&.done :error
+          transaction&.outcome = Transaction::Outcome::FAILURE
           raise
         ensure
           ElasticAPM.end_transaction

data/lib/elastic_apm/spies/sneakers.rb

@@ -57,11 +57,13 @@ module ElasticAPM
 
           res = @app.call(deserialized_msg, delivery_info, metadata, handler)
           transaction&.done(:success)
+          transaction&.outcome = Transaction::Outcome::SUCCESS
 
           res
         rescue ::Exception => e
           ElasticAPM.report(e, handled: false)
           transaction&.done(:error)
+          transaction&.outcome = Transaction::Outcome::FAILURE
           raise
         ensure
           ElasticAPM.end_transaction

data/lib/elastic_apm/spies/sucker_punch.rb

@@ -35,12 +35,14 @@ module ElasticAPM
             transaction = ElasticAPM.start_transaction(name, TYPE)
             __run_perform_without_elastic_apm(*args)
             transaction.done 'success'
+            transaction&.outcome = Transaction::Outcome::SUCCESS
           rescue ::Exception => e
             # Note that SuckerPunch by default doesn't raise the errors from
             # the user-defined JobClass#perform method as it uses an error
             # handler, accessed via `SuckerPunch.exception_handler`.
             ElasticAPM.report(e, handled: false)
             transaction.done 'error'
+            transaction&.outcome = Transaction::Outcome::FAILURE
             raise
           ensure
             ElasticAPM.end_transaction

data/lib/elastic_apm/sql/signature.rb

@@ -36,8 +36,8 @@ module ElasticAPM
       end
 
       def initialize(sql)
-        @sql = sql
-        @tokenizer = Tokenizer.new(sql)
+        @sql = sql.encode('utf-8', invalid: :replace, undef: :replace)
+        @tokenizer = Tokenizer.new(@sql)
       end
 
       def parse
@@ -158,9 +158,11 @@ module ElasticAPM
       def scan_dotted_identifier
         table = @tokenizer.text
 
+        # rubocop:disable Style/WhileUntilModifier
         while scan_token(PERIOD) && scan_token(IDENT)
           table += ".#{@tokenizer.text}"
         end
+        # rubocop:enable Style/WhileUntilModifier
 
         table
       end

data/lib/elastic_apm/sql/tokenizer.rb

@@ -130,7 +130,7 @@ module ElasticAPM
       end
       # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
 
-      # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+      # rubocop:disable Metrics/CyclomaticComplexity
       def scan_dollar_sign
         while (peek = peek_char)
           case peek
@@ -165,7 +165,7 @@ module ElasticAPM
 
         OTHER
       end
-      # rubocop:enable Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
+      # rubocop:enable Metrics/CyclomaticComplexity
 
       def scan_quoted_indentifier(delimiter)
         while (char = next_char)

data/lib/elastic_apm/stacktrace/frame.rb

@@ -38,6 +38,7 @@ module ElasticAPM
         :module,
         :colno
       )
+
       def build_context(context_line_count)
         return unless abs_path && context_line_count > 0
 

data/lib/elastic_apm/stacktrace_builder.rb

@@ -23,7 +23,7 @@ require 'elastic_apm/util/lru_cache'
 module ElasticAPM
   # @api private
   class StacktraceBuilder
-    JAVA_FORMAT = /^(.+)\.([^\.]+)\(([^\:]+)\:(\d+)\)$/.freeze
+    JAVA_FORMAT = /^(.+)\.([^.]+)\(([^:]+):(\d+)\)$/.freeze
     RUBY_FORMAT = /^(.+?):(\d+)(?::in `(.+?)')?$/.freeze
 
     RUBY_VERS_REGEX = %r{ruby(/gems)?[-/](\d+\.)+\d}.freeze
@@ -86,14 +86,13 @@ module ElasticAPM
       [file, number, method, module_name]
     end
 
-    # rubocop:disable Metrics/CyclomaticComplexity
     def library_frame?(config, abs_path)
       return false unless abs_path
 
       return true if abs_path.start_with?(GEMS_PATH)
 
       if abs_path.start_with?(config.__root_path)
-        return true if abs_path.start_with?(config.__root_path + '/vendor')
+        return true if abs_path.start_with?("#{config.__root_path}/vendor")
         return false
       end
 
@@ -102,7 +101,6 @@ module ElasticAPM
 
       false
     end
-    # rubocop:enable Metrics/CyclomaticComplexity
 
     def strip_load_path(path)
       return nil if path.nil?

data/lib/elastic_apm/trace_context.rb

@@ -33,7 +33,7 @@ module ElasticAPM
       **legacy_traceparent_attrs
     )
       @traceparent = traceparent || Traceparent.new(**legacy_traceparent_attrs)
-      @tracestate = tracestate
+      @tracestate = tracestate || Tracestate.new
     end
 
     attr_accessor :traceparent, :tracestate
@@ -42,7 +42,6 @@ module ElasticAPM
       :version, :trace_id, :id, :parent_id, :ensure_parent_id, :recorded?
 
     class << self
-      # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
       def parse(legacy_header = nil, env: nil, metadata: nil)
         unless legacy_header || env || metadata
           raise ArgumentError, 'TraceContext expects env:, metadata: ' \
@@ -57,7 +56,6 @@ module ElasticAPM
           trace_context_from_metadata(metadata)
         end
       end
-      # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
 
       private