elastic-apm 3.10.0 → 3.12.1

data/lib/elastic_apm/middleware.rb

@@ -41,9 +41,14 @@ module ElasticAPM
         ElasticAPM.report(e, context: context, handled: false)
         raise
       ensure
-        if resp && transaction
-          status, headers, _body = resp
-          transaction.add_response(status, headers: headers.dup)
+        if transaction
+          if resp
+            status, headers, _body = resp
+            transaction.add_response(status, headers: headers.dup)
+            transaction&.outcome = Transaction::Outcome.from_http_status(status)
+          else
+            transaction&.outcome = Transaction::Outcome::FAILURE
+          end
         end
 
         ElasticAPM.end_transaction http_result(status)

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
@@ -38,7 +49,8 @@ module ElasticAPM
       action: nil,
       context: nil,
       stacktrace_builder: nil,
-      sync: nil
+      sync: nil,
+      sample_rate: nil
     )
       @name = name
 
@@ -53,6 +65,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 +78,7 @@ module ElasticAPM
       :action,
       :name,
       :original_backtrace,
+      :outcome,
       :subtype,
       :trace_context,
       :type
@@ -73,6 +87,7 @@ module ElasticAPM
       :context,
       :duration,
       :parent,
+      :sample_rate,
       :self_time,
       :stacktrace,
       :timestamp,

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,8 @@ module ElasticAPM
       def self.name_from_payload(payload_object)
         if payload_object.is_a?(::Delayed::PerformableMethod)
           performable_method_name(payload_object)
+        elsif payload_object.class.name == 'ActiveJob::QueueAdapters::DelayedJobAdapter::JobWrapper'
+          payload_object.job_data['job_class']
         else
           payload_object.class.name
         end

data/lib/elastic_apm/spies/elasticsearch.rb

@@ -27,7 +27,13 @@ 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 +53,7 @@ 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

@@ -89,6 +89,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/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

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

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

@@ -61,7 +61,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,7 +75,11 @@ module ElasticAPM
                 end
               end
             end
+          rescue
+            span&.outcome = Span::Outcome::FAILURE
+            raise
           ensure
+            span&.outcome ||= Span::Outcome::SUCCESS
             ElasticAPM.end_span
           end
         end

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

data/lib/elastic_apm/trace_context/traceparent.rb

@@ -33,8 +33,7 @@ module ElasticAPM
         trace_id: nil,
         span_id: nil,
         id: nil,
-        recorded: true,
-        tracestate: nil
+        recorded: true
       )
         @version = version
         @trace_id = trace_id || hex(TRACE_ID_LENGTH)
@@ -42,11 +41,10 @@ module ElasticAPM
         @parent_id = span_id
         @id = id || hex(ID_LENGTH)
         @recorded = recorded
-        @tracestate = tracestate
       end
       # rubocop:enable Metrics/ParameterLists
 
-      attr_accessor :version, :id, :trace_id, :parent_id, :recorded, :tracestate
+      attr_accessor :version, :id, :trace_id, :parent_id, :recorded
 
       alias :recorded? :recorded
 

data/lib/elastic_apm/trace_context/tracestate.rb

@@ -17,26 +17,129 @@
 
 # frozen_string_literal: true
 
+require 'elastic_apm/util/precision_validator'
+
 module ElasticAPM
   class TraceContext
     # @api private
     class Tracestate
-      def initialize(values = [])
-        @values = values
+      # @api private
+      class Entry
+        def initialize(key, value)
+          @key = key
+          @value = value
+        end
+
+        attr_reader :key, :value
+
+        def to_s
+          "#{key}=#{value}"
+        end
       end
 
-      attr_accessor :values
+      class EsEntry
+        ASSIGN = ':'
+        SPLIT = ';'
+
+        SHORT_TO_LONG = { 's' => 'sample_rate' }
+        LONG_TO_SHORT = { 'sample_rate' => 's' }
+
+        def initialize(values = nil)
+          parse(values)
+        end
+
+        attr_reader :sample_rate
+
+        def key
+          'es'
+        end
+
+        def value
+          LONG_TO_SHORT.map do |l, s|
+            "#{s}#{ASSIGN}#{send(l)}"
+          end.join(SPLIT)
+        end
+
+        def empty?
+          !sample_rate
+        end
+
+        def sample_rate=(val)
+          @sample_rate = Util::PrecisionValidator.validate(
+            val, precision: 4, minimum: 0.0001
+          )
+        end
+
+        def to_s
+          return nil if empty?
+
+          "es=#{value}"
+        end
+
+        private
+
+        def parse(values)
+          return unless values
+
+          values.split(SPLIT).map do |kv|
+            k, v = kv.split(ASSIGN)
+            next unless SHORT_TO_LONG.keys.include?(k)
+            send("#{SHORT_TO_LONG[k]}=", v)
+          end
+        end
+      end
+
+      extend Forwardable
+
+      def initialize(entries: {}, sample_rate: nil)
+        @entries = entries
+
+        self.sample_rate = sample_rate if sample_rate
+      end
+
+      attr_accessor :entries
+
+      def_delegators :es_entry, :sample_rate, :sample_rate=
 
       def self.parse(header)
-        # 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
-        new(String(header).split("\n"))
+        entries =
+          split_by_nl_and_comma(header)
+          .each_with_object({}) do |entry, hsh|
+            k, v = entry.split('=')
+
+            hsh[k] =
+              case k
+              when 'es' then EsEntry.new(v)
+              else Entry.new(k, v)
+              end
+          end
+
+        new(entries: entries)
       end
 
       def to_header
-        values.join(',')
+        return "" unless entries.any?
+
+        entries.values.map(&:to_s).join(',')
+      end
+
+      private
+
+      def es_entry
+        # lazy generate this so we only add it if necessary
+        entries['es'] ||= EsEntry.new
+      end
+
+      class << self
+        private
+
+        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
+          String(str).split("\n").map { |s| s.split(',') }.flatten
+        end
       end
     end
   end