elastic-apm 3.11.1 → 3.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 54d7b5d46523e74fc797ec2030a355b6137e92a40ecb8242a9a79d551d6b2f89
-  data.tar.gz: ba614dd32ce665845f09d9c840fff0f6e8a34637a703f849a7b22edbeb350d25
+  metadata.gz: 0c810b4e9b4f1149873235af4d1ddd6b4a85acf7734c491a42d21777443d57a0
+  data.tar.gz: f63af16c444a3a5499cd9246b1d11bba2cd9a7a31efed58bfd23d5b1c8b3e0d3
 SHA512:
-  metadata.gz: fd0d35a56be409fd3ee55352d68a9ef7cfd13add082edb41ca971bde54895c70babd30025e6a87134123a999be2732b476a8868b3db617b9f315940124f8e2ad
-  data.tar.gz: 75e7e737b4f927dbbbb6b828ae5c628b3e37334409a43b1e94cc09cb9b403dcbb7030e766e49cadba9683536032119514f022570abb97c066fce6a59959dbf6f
+  metadata.gz: ed48f7f3870b346a17ec5e263c90c67f68b1f355a4900c3a79ae998bf689b1b549e6658d7c4165b934091669734bea561acf9991b82446a6ca4164558a488301
+  data.tar.gz: f87f347bf3a72e8d331e95d95ceca640d12754cb049ce4c39097b03b75d022c347f95062d3e311e0fb0cbc90f61050449ed1bd6f39f8682c95e935fccf7509f9

data/CHANGELOG.asciidoc

@@ -35,6 +35,14 @@ endif::[]
 [[release-notes-3.x]]
 === Ruby Agent version 3.x
 
+[[release-notes-3.12.0]]
+==== 3.12.0 (2020-11-10)
+
+[float]
+===== Added
+
+- Add outcome to transactions and spans {pull}883[#883]
+
 [[release-notes-3.11.1]]
 ==== 3.11.1 (2020-11-05)
 

data/docs/api.asciidoc

@@ -433,6 +433,7 @@ end
 - `name`: String
 - `type`: String
 - `result`: String
+- `outcome`: String ('unknown', 'success', 'failure', nil)
 - `trace_id`: String (readonly)
 
 [float]
@@ -457,7 +458,7 @@ If your service generates the HTML page dynamically, initializing the
 JavaScript RUM agent with the value of this method allows analyzing the time
 spent in the browser vs in the backend services.
 
-To enable the JavaScript RUM agent, initilialize the RUM agent with the Ruby
+To enable the JavaScript RUM agent, initialize the RUM agent with the Ruby
 agent's current transaction:
 
 [source,html]

data/lib/elastic_apm.rb

@@ -183,7 +183,12 @@ module ElasticAPM
             context: context,
             trace_context: trace_context
           )
-        yield transaction
+        result = yield transaction
+        transaction&.outcome ||= Transaction::Outcome::SUCCESS
+        result
+      rescue
+        transaction&.outcome ||= Transaction::Outcome::FAILURE
+        raise
       ensure
         end_transaction
       end
@@ -287,7 +292,14 @@ module ElasticAPM
             parent: parent,
             sync: sync
           )
-        yield span
+        result = yield span
+        span&.outcome =
+          Span::Outcome::SUCCESS unless span&.outcome
+        result
+      rescue
+        span&.outcome =
+          Span::Outcome::FAILURE unless span&.outcome
+        raise
       ensure
         end_span
       end

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
@@ -67,6 +78,7 @@ module ElasticAPM
       :action,
       :name,
       :original_backtrace,
+      :outcome,
       :subtype,
       :trace_context,
       :type

data/lib/elastic_apm/spies/delayed_job.rb

@@ -42,9 +42,11 @@ module ElasticAPM
         transaction = ElasticAPM.start_transaction(job_name, TYPE)
         job.invoke_job_without_apm(*args, &block)
         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/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/transaction.rb

@@ -20,6 +20,18 @@
 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
 
@@ -74,7 +86,7 @@ module ElasticAPM
     end
     # rubocop:enable Metrics/ParameterLists
 
-    attr_accessor :name, :type, :result
+    attr_accessor :name, :type, :result, :outcome
 
     attr_reader(
       :breakdown_metrics,

data/lib/elastic_apm/transport/serializers/span_serializer.rb

@@ -43,7 +43,8 @@ module ElasticAPM
               stacktrace: span.stacktrace.to_a,
               timestamp: span.timestamp,
               trace_id: span.trace_id,
-              sample_rate: span.sample_rate
+              sample_rate: span.sample_rate,
+              outcome: keyword_field(span.outcome)
             }
           }
         end

data/lib/elastic_apm/transport/serializers/transaction_serializer.rb

@@ -35,6 +35,7 @@ module ElasticAPM
               name: keyword_field(transaction.name),
               type: keyword_field(transaction.type),
               result: keyword_field(transaction.result.to_s),
+              outcome: keyword_field(transaction.outcome),
               duration: ms(transaction.duration),
               timestamp: transaction.timestamp,
               sampled: transaction.sampled?,

data/lib/elastic_apm/version.rb

@@ -18,5 +18,5 @@
 # frozen_string_literal: true
 
 module ElasticAPM
-  VERSION = '3.11.1'
+  VERSION = '3.12.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elastic-apm
 version: !ruby/object:Gem::Version
-  version: 3.11.1
+  version: 3.12.0
 platform: ruby
 authors:
 - Mikkel Malmberg
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-11-05 00:00:00.000000000 Z
+date: 2020-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -38,7 +38,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
-description: 
+description:
 email:
 - mikkel@elastic.co
 executables: []
@@ -245,7 +245,7 @@ licenses:
 - Apache-2.0
 metadata:
   source_code_uri: https://github.com/elastic/apm-agent-ruby
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -260,8 +260,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.0.6
+signing_key:
 specification_version: 4
 summary: The official Elastic APM agent for Ruby
 test_files: []