elastic-apm 1.1.0 → 2.0.0

data/lib/elastic_apm/span_helpers.rb

@@ -27,7 +27,7 @@ module ElasticAPM
               return __without_apm_#{method}(*args, &block)
             end
 
-            ElasticAPM.span "#{name}", "#{type}" do
+            ElasticAPM.with_span "#{name}", "#{type}" do
               __without_apm_#{method}(*args, &block)
             end
           end

data/lib/elastic_apm/spies/delayed_job.rb

@@ -5,9 +5,9 @@ module ElasticAPM
   module Spies
     # @api private
     class DelayedJobSpy
-      CLASS_SEPARATOR = '.'.freeze
-      METHOD_SEPARATOR = '#'.freeze
-      TYPE = 'Delayed::Job'.freeze
+      CLASS_SEPARATOR = '.'
+      METHOD_SEPARATOR = '#'
+      TYPE = 'Delayed::Job'
 
       def install
         ::Delayed::Backend::Base.class_eval do
@@ -22,15 +22,15 @@ module ElasticAPM
 
       def self.invoke_job(job, *args, &block)
         job_name = name_from_payload(job.payload_object)
-        transaction = ElasticAPM.transaction(job_name, TYPE)
+        transaction = ElasticAPM.start_transaction(job_name, TYPE)
         job.invoke_job_without_apm(*args, &block)
-        transaction.submit 'success'
+        transaction.done 'success'
       rescue ::Exception => e
         ElasticAPM.report(e, handled: false)
-        transaction.submit 'error'
+        transaction.done 'error'
         raise
       ensure
-        transaction.release if transaction
+        ElasticAPM.end_transaction
       end
 
       def self.name_from_payload(payload_object)

data/lib/elastic_apm/spies/elasticsearch.rb

@@ -5,8 +5,8 @@ module ElasticAPM
   module Spies
     # @api private
     class ElasticsearchSpy
-      NAME_FORMAT = '%s %s'.freeze
-      TYPE = 'db.elasticsearch'.freeze
+      NAME_FORMAT = '%s %s'
+      TYPE = 'db.elasticsearch'
 
       # rubocop:disable Metrics/MethodLength
       def install
@@ -16,9 +16,9 @@ module ElasticAPM
           def perform_request(method, path, *args, &block)
             name = format(NAME_FORMAT, method, path)
             statement = args[0].is_a?(String) ? args[0] : args[0].to_json
-            context = Span::Context.new(statement: statement)
+            context = Span::Context.new(db: { statement: statement })
 
-            ElasticAPM.span name, TYPE, context: context do
+            ElasticAPM.with_span name, TYPE, context: context do
               perform_request_without_apm(method, path, *args, &block)
             end
           end

data/lib/elastic_apm/spies/http.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module ElasticAPM
+  # @api private
+  module Spies
+    # @api private
+    class HTTPSpy
+      # rubocop:disable Metrics/MethodLength
+      def install
+        ::HTTP::Client.class_eval do
+          alias perform_without_apm perform
+
+          def perform(req, options)
+            unless (transaction = ElasticAPM.current_transaction)
+              return perform_without_apm(req, options)
+            end
+
+            method = req.verb.to_s.upcase
+            host = req.uri.host
+
+            name = "#{method} #{host}"
+            type = "ext.http_rb.#{method}"
+
+            ElasticAPM.with_span name, type do |span|
+              req['Elastic-Apm-Traceparent'] =
+                transaction.traceparent.to_header(span_id: span.id)
+
+              perform_without_apm(req, options)
+            end
+          end
+        end
+      end
+      # rubocop:enable Metrics/MethodLength
+    end
+
+    register 'HTTP', 'http', HTTPSpy.new
+  end
+end

data/lib/elastic_apm/spies/mongo.rb

@@ -14,7 +14,7 @@ module ElasticAPM
 
       # @api private
       class Subscriber
-        TYPE = 'db.mongodb.query'.freeze
+        TYPE = 'db.mongodb.query'
 
         def initialize
           @events = {}
@@ -37,21 +37,32 @@ module ElasticAPM
         def push_event(event)
           return unless ElasticAPM.current_transaction
 
-          ctx = Span::Context.new(
-            instance: event.database_name,
-            statement: nil,
-            type: 'mongodb'.freeze,
-            user: nil
-          )
-          span = ElasticAPM.span(event.command_name.to_s, TYPE, context: ctx)
+          span =
+            ElasticAPM.start_span(
+              event.command_name.to_s,
+              TYPE,
+              context: build_context(event)
+            )
+
           @events[event.operation_id] = span
         end
 
         def pop_event(event)
-          return unless ElasticAPM.current_transaction
-
+          return unless (curr = ElasticAPM.current_span)
           span = @events.delete(event.operation_id)
-          span && span.done
+
+          curr == span && ElasticAPM.end_span
+        end
+
+        def build_context(event)
+          Span::Context.new(
+            db: {
+              instance: event.database_name,
+              statement: nil,
+              type: 'mongodb',
+              user: nil
+            }
+          )
         end
       end
     end

data/lib/elastic_apm/spies/net_http.rb

@@ -5,13 +5,13 @@ module ElasticAPM
   module Spies
     # @api private
     class NetHTTPSpy
-      # rubocop:disable Metrics/MethodLength
+      # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
       def install
         Net::HTTP.class_eval do
           alias request_without_apm request
 
           def request(req, body = nil, &block)
-            unless ElasticAPM.current_transaction
+            unless (transaction = ElasticAPM.current_transaction)
               return request_without_apm(req, body, &block)
             end
 
@@ -23,13 +23,16 @@ module ElasticAPM
             name = "#{method} #{host}"
             type = "ext.net_http.#{method}"
 
-            ElasticAPM.span name, type do
+            ElasticAPM.with_span name, type do |span|
+              req['Elastic-Apm-Traceparent'] =
+                transaction.traceparent.to_header(span_id: span.id)
+
               request_without_apm(req, body, &block)
             end
           end
         end
       end
-      # rubocop:enable Metrics/MethodLength
+      # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
     end
 
     register 'Net::HTTP', 'net/http', NetHTTPSpy.new

data/lib/elastic_apm/spies/rake.rb

@@ -6,7 +6,6 @@ module ElasticAPM
     # @api private
     class RakeSpy
       # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
-      # rubocop:disable Metrics/CyclomaticComplexity
       def install
         ::Rake::Task.class_eval do
           alias execute_without_apm execute
@@ -18,19 +17,20 @@ module ElasticAPM
               return execute_without_apm(*args)
             end
 
-            transaction = ElasticAPM.transaction("Rake::Task[#{name}]", 'Rake')
+            transaction =
+              ElasticAPM.start_transaction("Rake::Task[#{name}]", 'Rake')
 
             begin
               result = execute_without_apm(*args)
 
-              transaction.submit('success') if transaction
+              transaction.result = 'success' if transaction
             rescue StandardError => e
-              transaction.submit(:error) if transaction
+              transaction.result = 'error' if transaction
               ElasticAPM.report(e)
 
               raise
             ensure
-              transaction.release if transaction
+              ElasticAPM.end_transaction
               ElasticAPM.stop
             end
 
@@ -38,7 +38,6 @@ module ElasticAPM
           end
         end
       end
-      # rubocop:enable Metrics/CyclomaticComplexity
       # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
     end
     register 'Rake::Task', 'rake', RakeSpy.new

data/lib/elastic_apm/spies/redis.rb

@@ -14,7 +14,7 @@ module ElasticAPM
 
             return call_without_apm(command, &block) if command[0] == :auth
 
-            ElasticAPM.span(name.to_s, 'db.redis') do
+            ElasticAPM.with_span(name.to_s, 'db.redis') do
               call_without_apm(command, &block)
             end
           end

data/lib/elastic_apm/spies/sequel.rb

@@ -7,12 +7,18 @@ module ElasticAPM
   module Spies
     # @api private
     class SequelSpy
-      TYPE = 'db.sequel.sql'.freeze
+      TYPE = 'db.sequel.sql'
 
       def self.summarizer
         @summarizer ||= SqlSummarizer.new
       end
 
+      def self.build_context(sql, opts)
+        Span::Context.new(
+          db: { statement: sql, type: 'sql', user: opts[:user] }
+        )
+      end
+
       # rubocop:disable Metrics/MethodLength
       def install
         require 'sequel/database/logging'
@@ -27,13 +33,9 @@ module ElasticAPM
 
             summarizer = ElasticAPM::Spies::SequelSpy.summarizer
             name = summarizer.summarize sql
-            context = Span::Context.new(
-              statement: sql,
-              type: 'sql',
-              user: opts[:user]
-            )
+            context = ElasticAPM::Spies::SequelSpy.build_context(sql, opts)
 
-            ElasticAPM.span(name, TYPE, context: context, &block)
+            ElasticAPM.with_span(name, TYPE, context: context, &block)
           end
         end
       end

data/lib/elastic_apm/spies/sidekiq.rb

@@ -6,25 +6,25 @@ module ElasticAPM
     # @api private
     class SidekiqSpy
       ACTIVE_JOB_WRAPPER =
-        'ActiveJob::QueueAdapters::SidekiqAdapter::JobWrapper'.freeze
+        'ActiveJob::QueueAdapters::SidekiqAdapter::JobWrapper'
 
       # @api private
       class Middleware
         # rubocop:disable Metrics/MethodLength
         def call(_worker, job, queue)
           name = SidekiqSpy.name_for(job)
-          transaction = ElasticAPM.transaction(name, 'Sidekiq')
+          transaction = ElasticAPM.start_transaction(name, 'Sidekiq')
           ElasticAPM.set_tag(:queue, queue)
 
           yield
 
-          transaction.submit('success') if transaction
+          transaction.done :success if transaction
         rescue ::Exception => e
           ElasticAPM.report(e, handled: false)
-          transaction.submit(:error) if transaction
+          transaction.done :error if transaction
           raise
         ensure
-          transaction.release if transaction
+          ElasticAPM.end_transaction
         end
         # rubocop:enable Metrics/MethodLength
       end

data/lib/elastic_apm/spies/tilt.rb

@@ -5,7 +5,7 @@ module ElasticAPM
   module Spies
     # @api private
     class TiltSpy
-      TYPE = 'template.tilt'.freeze
+      TYPE = 'template.tilt'
 
       def install
         ::Tilt::Template.class_eval do
@@ -14,7 +14,7 @@ module ElasticAPM
           def render(*args, &block)
             name = options[:__elastic_apm_template_name] || 'Unknown template'
 
-            ElasticAPM.span name, TYPE do
+            ElasticAPM.with_span name, TYPE do
               render_without_apm(*args, &block)
             end
           end

data/lib/elastic_apm/sql_summarizer.rb

@@ -5,8 +5,8 @@ require 'elastic_apm/util/lru_cache'
 module ElasticAPM
   # @api private
   class SqlSummarizer
-    DEFAULT = 'SQL'.freeze
-    TABLE_REGEX = %{["'`]?([A-Za-z0-9]+)}.freeze
+    DEFAULT = 'SQL'
+    TABLE_REGEX = %{["'`]?([A-Za-z0-9]+)}
 
     REGEXES = {
       /^BEGIN/i => 'BEGIN',
@@ -17,7 +17,7 @@ module ElasticAPM
       /^DELETE FROM #{TABLE_REGEX}/i => 'DELETE FROM '
     }.freeze
 
-    FORMAT = '%s%s'.freeze
+    FORMAT = '%s%s'
 
     def self.cache
       @cache ||= Util::LruCache.new

data/lib/elastic_apm/stacktrace_builder.rb

@@ -6,14 +6,14 @@ require 'elastic_apm/util/lru_cache'
 module ElasticAPM
   # @api private
   class StacktraceBuilder
-    JAVA_FORMAT = /^(.+)\.([^\.]+)\(([^\:]+)\:(\d+)\)$/
-    RUBY_FORMAT = /^(.+?):(\d+)(?::in `(.+?)')?$/
+    JAVA_FORMAT = /^(.+)\.([^\.]+)\(([^\:]+)\:(\d+)\)$/.freeze
+    RUBY_FORMAT = /^(.+?):(\d+)(?::in `(.+?)')?$/.freeze
 
-    RUBY_VERS_REGEX = %r{ruby(/gems)?[-/](\d+\.)+\d}
-    JRUBY_ORG_REGEX = %r{org/jruby}
+    RUBY_VERS_REGEX = %r{ruby(/gems)?[-/](\d+\.)+\d}.freeze
+    JRUBY_ORG_REGEX = %r{org/jruby}.freeze
 
-    def initialize(agent)
-      @config = agent.config
+    def initialize(config)
+      @config = config
       @cache = Util::LruCache.new(2048, &method(:build_frame))
     end
 

data/lib/elastic_apm/subscriber.rb

@@ -6,7 +6,7 @@ require 'elastic_apm/normalizers'
 module ElasticAPM
   # @api private
   class Subscriber
-    include Log
+    include Logging
 
     def initialize(agent)
       @agent = agent
@@ -40,7 +40,7 @@ module ElasticAPM
           nil
         else
           name, type, context = normalized
-          @agent.span(name, type, context: context)
+          @agent.start_span(name, type, context: context)
         end
 
       transaction.notifications << Notification.new(id, span)
@@ -54,7 +54,7 @@ module ElasticAPM
         next unless notification.id == id
 
         if (span = notification.span)
-          span.done
+          @agent.end_span if span == @agent.current_span
         end
         return
       end

data/lib/elastic_apm/traceparent.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module ElasticAPM
+  # @api private
+  class Traceparent
+    class InvalidTraceparentHeader < StandardError; end
+
+    VERSION = '00'
+    HEX_REGEX = /[^[:xdigit:]]/.freeze
+
+    def initialize
+      @version = VERSION
+    end
+
+    def self.from_transaction(transaction)
+      new.tap do |t|
+        t.trace_id = SecureRandom.hex(16)
+        t.recorded = transaction.sampled?
+      end
+    end
+
+    # rubocop:disable Metrics/AbcSize
+    def self.parse(header)
+      raise InvalidTraceparentHeader unless header.length == 55
+      raise InvalidTraceparentHeader unless header[0..1] == VERSION
+
+      new.tap do |t|
+        t.version, t.trace_id, t.span_id, t.flags =
+          header.split('-').tap do |values|
+            values[-1] = Util.hex_to_bits(values[-1])
+          end
+
+        raise InvalidTraceparentHeader if HEX_REGEX =~ t.trace_id
+        raise InvalidTraceparentHeader if HEX_REGEX =~ t.span_id
+      end
+    end
+    # rubocop:enable Metrics/AbcSize
+
+    attr_accessor :header, :version, :trace_id, :span_id, :recorded
+
+    alias :recorded? :recorded
+
+    def flags=(flags)
+      @flags = flags
+
+      self.recorded = flags[7] == '1'
+    end
+
+    def flags
+      format('0000000%d', recorded? ? 1 : 0)
+    end
+
+    def hex_flags
+      format('%02x', flags.to_i(2))
+    end
+
+    def to_header(span_id: nil)
+      span_id ||= self.span_id
+      format('%s-%s-%s-%s', version, trace_id, span_id, hex_flags)
+    end
+  end
+end