elastic-apm 3.11.0 → 3.14.0

data/lib/elastic_apm/spies/elasticsearch.rb

@@ -31,7 +31,8 @@ module ElasticAPM
           begin
             config = ElasticAPM.agent.config
             ElasticAPM::Transport::Filters::HashSanitizer.new(
-              key_patterns: config.custom_key_filters + config.sanitize_field_names
+              key_patterns: config.custom_key_filters +
+                            config.sanitize_field_names
             )
           end
       end
@@ -53,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
@@ -53,20 +55,25 @@ module ElasticAPM
               tmp_request = build_request(method) do |req|
                 yield(req) if block_given?
               end
-              uri = URI(tmp_request.path)
+              uri = tmp_request.path && URI(tmp_request.path)
             end
 
-            host = uri.host
+            host = uri&.host || 'localhost'
 
             upcased_method = method.to_s.upcase
 
-            destination = ElasticAPM::Span::Context::Destination.from_uri(uri)
-
-            context =
-              ElasticAPM::Span::Context.new(
-                http: { url: uri, method: upcased_method },
-                destination: destination
-              )
+            if uri
+              destination = ElasticAPM::Span::Context::Destination.from_uri(uri)
+
+              context =
+                ElasticAPM::Span::Context.new(
+                  http: { url: uri, method: upcased_method },
+                  destination: destination
+                )
+            else
+              context =
+                ElasticAPM::Span::Context.new(http: { url: uri, method: upcased_method })
+            end
 
             ElasticAPM.with_span(
               "#{upcased_method} #{host}",
@@ -89,13 +96,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,19 @@ module ElasticAPM
         end
 
         def failed(event)
-          pop_event(event)
+          if (span = pop_event(event))
+            span.outcome = Span::Outcome::FAILURE
+          end
+
+          span
         end
 
         def succeeded(event)
-          pop_event(event)
+          if span = pop_event(event)
+            span.outcome = Span::Outcome::SUCCESS
+          end
+
+          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
@@ -60,7 +61,7 @@ module ElasticAPM
               return request_without_apm(req, body, &block)
             end
 
-            host = req['host']&.split(':')&.first || address
+            host = req['host']&.split(':')&.first || address || 'localhost'
             method = req.method.to_s.upcase
             path, query = req.path.split('?')
 
@@ -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

@@ -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
 

data/lib/elastic_apm/trace_context/traceparent.rb

@@ -27,7 +27,6 @@ module ElasticAPM
       TRACE_ID_LENGTH = 16
       ID_LENGTH = 8
 
-      # rubocop:disable Metrics/ParameterLists
       def initialize(
         version: VERSION,
         trace_id: nil,
@@ -42,7 +41,6 @@ module ElasticAPM
         @id = id || hex(ID_LENGTH)
         @recorded = recorded
       end
-      # rubocop:enable Metrics/ParameterLists
 
       attr_accessor :version, :id, :trace_id, :parent_id, :recorded
 

data/lib/elastic_apm/trace_context/tracestate.rb

@@ -37,12 +37,13 @@ module ElasticAPM
         end
       end
 
+      # @api private
       class EsEntry
         ASSIGN = ':'
         SPLIT = ';'
 
-        SHORT_TO_LONG = { 's' => 'sample_rate' }
-        LONG_TO_SHORT = { 'sample_rate' => 's' }
+        SHORT_TO_LONG = { 's' => 'sample_rate' }.freeze
+        LONG_TO_SHORT = { 'sample_rate' => 's' }.freeze
 
         def initialize(values = nil)
           parse(values)
@@ -83,7 +84,7 @@ module ElasticAPM
 
           values.split(SPLIT).map do |kv|
             k, v = kv.split(ASSIGN)
-            next unless SHORT_TO_LONG.keys.include?(k)
+            next unless SHORT_TO_LONG.key?(k)
             send("#{SHORT_TO_LONG[k]}=", v)
           end
         end
@@ -136,8 +137,9 @@ module ElasticAPM
         def split_by_nl_and_comma(str)
           # HTTP allows multiple headers with the same name, eg. multiple
           # Set-Cookie headers per response.
-          # Rack handles this by joining the headers under the same key, separated
-          # by newlines, see https://www.rubydoc.info/github/rack/rack/file/SPEC
+          # Rack handles this by joining the headers under the same key,
+          # separated by newlines.
+          # See https://www.rubydoc.info/github/rack/rack/file/SPEC
           String(str).split("\n").map { |s| s.split(',') }.flatten
         end
       end

data/lib/elastic_apm/transaction.rb

@@ -20,6 +20,17 @@
 module ElasticAPM
   # @api private
   class Transaction
+    # @api private
+    class Outcome
+      FAILURE = "failure"
+      SUCCESS = "success"
+      UNKNOWN = "unknown"
+
+      def self.from_http_status(code)
+        code.to_i >= 500 ? FAILURE : SUCCESS
+      end
+    end
+
     extend Forwardable
     include ChildDurations::Methods
 
@@ -33,10 +44,10 @@ module ElasticAPM
     def initialize(
       name = nil,
       type = nil,
+      config:,
       sampled: true,
       sample_rate: 1,
       context: nil,
-      config:,
       trace_context: nil
     )
       @name = name
@@ -63,7 +74,9 @@ module ElasticAPM
       unless (@trace_context = trace_context)
         @trace_context = TraceContext.new(
           traceparent: TraceContext::Traceparent.new(recorded: sampled),
-          tracestate: TraceContext::Tracestate.new(sample_rate: sampled ? sample_rate : 0)
+          tracestate: TraceContext::Tracestate.new(
+            sample_rate: sampled ? sample_rate : 0
+          )
         )
       end
 
@@ -74,7 +87,7 @@ module ElasticAPM
     end
     # rubocop:enable Metrics/ParameterLists
 
-    attr_accessor :name, :type, :result
+    attr_accessor :name, :type, :result, :outcome
 
     attr_reader(
       :breakdown_metrics,
@@ -90,7 +103,7 @@ module ElasticAPM
       :started_spans,
       :timestamp,
       :trace_context,
-      :transaction_max_spans 
+      :transaction_max_spans
     )
 
     alias :collect_metrics? :collect_metrics