elastic-apm 3.1.0 → 3.2.0

data/lib/elastic_apm/opentracing.rb

@@ -67,7 +67,7 @@ module ElasticAPM
 
       # rubocop:disable Metrics/MethodLength
       def finish(clock_end: Util.monotonic_micros, end_time: nil)
-        return unless (instrumenter = ElasticAPM.agent&.instrumenter)
+        return unless (agent = ElasticAPM.agent)
 
         if end_time
           warn '[ElasticAPM] DEPRECATED: Setting a custom end time as a ' \
@@ -79,12 +79,12 @@ module ElasticAPM
 
         case elastic_span
         when ElasticAPM::Transaction
-          instrumenter.current_transaction = nil
+          agent.instrumenter.current_transaction = nil
         when ElasticAPM::Span
-          instrumenter.current_spans.delete(elastic_span)
+          agent.instrumenter.current_spans.delete(elastic_span)
         end
 
-        instrumenter.enqueue.call elastic_span
+        agent.enqueue elastic_span
       end
       # rubocop:enable Metrics/MethodLength
 

data/lib/elastic_apm/rails.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'elastic_apm/railtie'
 require 'elastic_apm/subscriber'
 require 'elastic_apm/normalizers/rails'
 
@@ -8,6 +9,7 @@ module ElasticAPM
   # It is recommended to use the Railtie instead.
   module Rails
     extend self
+
     # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
     # rubocop:disable Metrics/CyclomaticComplexity
     # Start the ElasticAPM agent and hook into Rails.
@@ -17,11 +19,13 @@ module ElasticAPM
     # @return [true, nil] true if the agent was started, nil otherwise.
     def start(config)
       config = Config.new(config) unless config.is_a?(Config)
+
       if (reason = should_skip?(config))
         unless config.disable_start_message?
           config.logger.info "Skipping because: #{reason}. " \
             "Start manually with `ElasticAPM.start'"
         end
+
         return
       end
 
@@ -35,10 +39,16 @@ module ElasticAPM
          )
         require 'elastic_apm/spies/action_dispatch'
       end
+
       ElasticAPM.running?
     rescue StandardError => e
-      config.logger.error format('Failed to start: %s', e.message)
-      config.logger.debug "Backtrace:\n" + e.backtrace.join("\n")
+      if config.disable_start_message?
+        config.logger.error format('Failed to start: %s', e.message)
+        config.logger.debug "Backtrace:\n" + e.backtrace.join("\n")
+      else
+        puts format('Failed to start: %s', e.message)
+        puts "Backtrace:\n" + e.backtrace.join("\n")
+      end
     end
     # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
     # rubocop:enable Metrics/CyclomaticComplexity

data/lib/elastic_apm/railtie.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'elastic_apm/rails'
-
 module ElasticAPM
   # @api private
   class Railtie < ::Rails::Railtie
@@ -13,9 +11,7 @@ module ElasticAPM
     end
 
     initializer 'elastic_apm.initialize' do |app|
-      config = Config.new(app.config.elastic_apm).tap do |c|
-        c.app = app
-
+      config = Config.new(app.config.elastic_apm.merge(app: app)).tap do |c|
         # Prepend Rails.root to log_path if present
         if c.log_path && !c.log_path.start_with?('/')
           c.log_path = ::Rails.root.join(c.log_path)

data/lib/elastic_apm/sinatra.rb

@@ -9,7 +9,7 @@ module ElasticAPM
     # @param app [Sinatra::Base] A Sinatra app.
     # @param config [Config, Hash] An instance of Config or a Hash config.
     # @return [true, nil] true if the agent was started, nil otherwise.
-    def start(app, config)
+    def start(app, config = {})
       config = Config.new(config) unless config.is_a?(Config)
       configure_app(app, config)
 

data/lib/elastic_apm/span.rb

@@ -1,24 +1,21 @@
 # frozen_string_literal: true
 
-require 'securerandom'
-require 'forwardable'
-
 require 'elastic_apm/span/context'
 
 module ElasticAPM
   # @api private
   class Span
     extend Forwardable
-
-    def_delegators :@trace_context, :trace_id, :parent_id, :id
+    include ChildDurations::Methods
 
     DEFAULT_TYPE = 'custom'
 
     # rubocop:disable Metrics/ParameterLists, Metrics/MethodLength
     def initialize(
       name:,
-      transaction_id:,
+      transaction:,
       trace_context:,
+      parent:,
       type: nil,
       subtype: nil,
       action: nil,
@@ -35,14 +32,17 @@ module ElasticAPM
         @action = action
       end
 
-      @transaction_id = transaction_id
-      @trace_context = trace_context
+      @transaction = transaction
+      @parent = parent
+      @trace_context = trace_context || parent.trace_context.child
 
       @context = context || Span::Context.new
       @stacktrace_builder = stacktrace_builder
     end
     # rubocop:enable Metrics/ParameterLists, Metrics/MethodLength
 
+    def_delegators :@trace_context, :trace_id, :parent_id, :id
+
     attr_accessor(
       :action,
       :name,
@@ -54,9 +54,11 @@ module ElasticAPM
     attr_reader(
       :context,
       :duration,
+      :parent,
+      :self_time,
       :stacktrace,
       :timestamp,
-      :transaction_id
+      :transaction
     )
 
     # life cycle
@@ -64,11 +66,14 @@ module ElasticAPM
     def start(clock_start = Util.monotonic_micros)
       @timestamp = Util.micros
       @clock_start = clock_start
+      @parent.child_started
       self
     end
 
     def stop(clock_end = Util.monotonic_micros)
       @duration ||= (clock_end - @clock_start)
+      @parent.child_stopped
+      @self_time = @duration - child_durations.duration
       self
     end
 
@@ -96,7 +101,7 @@ module ElasticAPM
     # relations
 
     def inspect
-      "<ElasticAPM::Span id:#{id}" \
+      "<ElasticAPM::Span id:#{trace_context&.id}" \
         " name:#{name.inspect}" \
         " type:#{type.inspect}" \
         '>'

data/lib/elastic_apm/spies.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require 'forwardable'
 require 'elastic_apm/util/inflector'
 
 module ElasticAPM

data/lib/elastic_apm/sql_summarizer.rb

@@ -9,21 +9,23 @@ module ElasticAPM
     TABLE_REGEX = %{["'`]?([A-Za-z0-9_]+)["'`]?}
 
     REGEXES = {
-      /^BEGIN/i => 'BEGIN',
-      /^COMMIT/i => 'COMMIT',
-      /^SELECT .* FROM #{TABLE_REGEX}/i => 'SELECT FROM ',
-      /^INSERT INTO #{TABLE_REGEX}/i => 'INSERT INTO ',
-      /^UPDATE #{TABLE_REGEX}/i => 'UPDATE ',
-      /^DELETE FROM #{TABLE_REGEX}/i => 'DELETE FROM '
+      /^BEGIN/iu => 'BEGIN',
+      /^COMMIT/iu => 'COMMIT',
+      /^SELECT .* FROM #{TABLE_REGEX}/iu => 'SELECT FROM ',
+      /^INSERT INTO #{TABLE_REGEX}/iu => 'INSERT INTO ',
+      /^UPDATE #{TABLE_REGEX}/iu => 'UPDATE ',
+      /^DELETE FROM #{TABLE_REGEX}/iu => 'DELETE FROM '
     }.freeze
 
     FORMAT = '%s%s'
+    UTF8 = 'UTF-8'
 
     def self.cache
       @cache ||= Util::LruCache.new
     end
 
     def summarize(sql)
+      sql = sql.encode(UTF8, invalid: :replace, undef: :replace)
       self.class.cache[sql] ||=
         REGEXES.find do |regex, sig|
           if (match = sql[0...1000].match(regex))

data/lib/elastic_apm/subscriber.rb

@@ -54,7 +54,7 @@ module ElasticAPM
     end
     # rubocop:enable Metrics/MethodLength
 
-    def finish(_name, id, _payload)
+    def finish(name, id, payload)
       # debug "AS::Notification#finish:#{name}:#{id}"
       return unless (transaction = @agent.current_transaction)
 
@@ -62,6 +62,9 @@ module ElasticAPM
         next unless notification.id == id
 
         if (span = notification.span)
+          if @agent.config.span_frames_min_duration?
+            span.original_backtrace ||= @normalizers.backtrace(name, payload)
+          end
           @agent.end_span if span == @agent.current_span
         end
         return

data/lib/elastic_apm/transaction.rb

@@ -1,19 +1,17 @@
 # frozen_string_literal: true
 
-require 'securerandom'
-require 'forwardable'
-
 module ElasticAPM
   # @api private
   class Transaction
     extend Forwardable
+    include ChildDurations::Methods
 
     def_delegators :@trace_context,
       :trace_id, :parent_id, :id, :ensure_parent_id
 
     DEFAULT_TYPE = 'custom'
 
-    # rubocop:disable Metrics/ParameterLists, Metrics/MethodLength
+    # rubocop:disable Metrics/MethodLength, Metrics/ParameterLists
     def initialize(
       name = nil,
       type = nil,
@@ -40,12 +38,12 @@ module ElasticAPM
 
       @notifications = [] # for AS::Notifications
     end
-    # rubocop:enable Metrics/ParameterLists, Metrics/MethodLength
+    # rubocop:enable Metrics/MethodLength, Metrics/ParameterLists
 
     attr_accessor :name, :type, :result
 
     attr_reader :context, :duration, :started_spans, :dropped_spans,
-      :timestamp, :trace_context, :notifications, :config
+      :timestamp, :trace_context, :notifications, :self_time, :config
 
     def sampled?
       @sampled
@@ -66,6 +64,8 @@ module ElasticAPM
     def stop(clock_end = Util.monotonic_micros)
       raise 'Transaction not yet start' unless timestamp
       @duration = clock_end - @clock_start
+      @self_time = @duration - child_durations.duration
+
       self
     end
 

data/lib/elastic_apm/transport/base.rb

@@ -1,10 +1,14 @@
 # frozen_string_literal: true
 
 require 'elastic_apm/metadata'
+require 'elastic_apm/transport/user_agent'
+require 'elastic_apm/transport/headers'
 require 'elastic_apm/transport/connection'
 require 'elastic_apm/transport/worker'
 require 'elastic_apm/transport/serializers'
 require 'elastic_apm/transport/filters'
+require 'elastic_apm/transport/connection/http'
+
 require 'elastic_apm/util/throttle'
 
 module ElasticAPM
@@ -39,6 +43,8 @@ module ElasticAPM
 
         ensure_watcher_running
         ensure_worker_count
+
+        @stopped.make_false unless @stopped.false?
       end
 
       def stop
@@ -54,6 +60,7 @@ module ElasticAPM
       def submit(resource)
         if @stopped.true?
           warn '%s: Transport stopping, no new events accepted', pid_str
+          debug 'Dropping: %s', resource.inspect
           return false
         end
 

data/lib/elastic_apm/transport/connection.rb

@@ -1,13 +1,7 @@
 # frozen_string_literal: true
 
-require 'concurrent'
-require 'zlib'
-
-require 'elastic_apm/transport/connection/http'
-
 module ElasticAPM
   module Transport
-    # rubocop:disable Metrics/ClassLength
     # @api private
     class Connection
       include Logging
@@ -24,20 +18,14 @@ module ElasticAPM
       # with ongoing write requests to `http`, write and close
       # requests have to be synchronized.
 
-      HEADERS = {
-        'Content-Type' => 'application/x-ndjson',
-        'Transfer-Encoding' => 'chunked'
-      }.freeze
-      GZIP_HEADERS = HEADERS.merge(
-        'Content-Encoding' => 'gzip'
-      ).freeze
-
-      def initialize(config, metadata)
+      def initialize(config)
         @config = config
-        @headers = build_headers(metadata)
-        @metadata = JSON.fast_generate(metadata)
+        @metadata = JSON.fast_generate(
+          Serializers::MetadataSerializer.new(config).build(
+            Metadata.new(config)
+          )
+        )
         @url = config.server_url + '/intake/v2/events'
-        @ssl_context = build_ssl_context
         @mutex = Mutex.new
       end
 
@@ -81,9 +69,8 @@ module ElasticAPM
 
       def inspect
         format(
-          '@%s http connection closed? :%s>',
-          super.split.first,
-          http.closed?
+          '<%s url:%s closed:%s >',
+          super.split.first, url, http&.closed?
         )
       end
 
@@ -93,11 +80,9 @@ module ElasticAPM
         schedule_closing if @config.api_request_time
 
         @http =
-          Http.open(
-            @config, @url,
-            headers: @headers,
-            ssl_context: @ssl_context
-          ).tap { |http| http.write(@metadata) }
+          Http.open(@config, @url).tap do |http|
+            http.write(@metadata)
+          end
       end
       # rubocop:enable
 
@@ -108,49 +93,6 @@ module ElasticAPM
             flush(:timeout)
           end
       end
-
-      def build_headers(metadata)
-        (
-          @config.http_compression? ? GZIP_HEADERS : HEADERS
-        ).dup.tap do |headers|
-          headers['User-Agent'] = build_user_agent(metadata)
-
-          if (token = @config.secret_token)
-            headers['Authorization'] = "Bearer #{token}"
-          end
-        end
-      end
-
-      def build_user_agent(metadata)
-        runtime = metadata.dig(:metadata, :service, :runtime)
-
-        [
-          "elastic-apm-ruby/#{VERSION}",
-          HTTP::Request::USER_AGENT,
-          [runtime[:name], runtime[:version]].join('/')
-        ].join(' ')
-      end
-
-      def build_ssl_context # rubocop:disable Metrics/MethodLength
-        return unless @config.use_ssl?
-
-        OpenSSL::SSL::SSLContext.new.tap do |context|
-          if @config.server_ca_cert
-            context.ca_file = @config.server_ca_cert
-          else
-            context.cert_store =
-              OpenSSL::X509::Store.new.tap(&:set_default_paths)
-          end
-
-          context.verify_mode =
-            if @config.verify_server_cert
-              OpenSSL::SSL::VERIFY_PEER
-            else
-              OpenSSL::SSL::VERIFY_NONE
-            end
-        end
-      end
     end
-    # rubocop:enable Metrics/ClassLength
   end
 end

data/lib/elastic_apm/transport/connection/http.rb

@@ -1,9 +1,5 @@
 # frozen_string_literal: true
 
-require 'http'
-require 'concurrent'
-require 'zlib'
-
 require 'elastic_apm/transport/connection/proxy_pipe'
 
 module ElasticAPM
@@ -13,23 +9,43 @@ module ElasticAPM
       class Http
         include Logging
 
-        def initialize(config)
+        def initialize(config, headers: nil)
           @config = config
-          @closed = Concurrent::AtomicBoolean.new
-
-          @rd, @wr = ProxyPipe.pipe(compress: @config.http_compression?)
+          @headers = headers || Headers.new(config)
+          @client = build_client
+          @closed = Concurrent::AtomicBoolean.new(true)
         end
 
-        def open(url, headers: {}, ssl_context: nil)
-          @request = open_request_in_thread(url, headers, ssl_context)
+        def open(url)
+          @closed.make_false
+          @rd, @wr = ProxyPipe.pipe(compress: @config.http_compression?)
+          @request = open_request_in_thread(url)
         end
 
-        def self.open(config, url, headers: {}, ssl_context: nil)
+        def self.open(config, url)
           new(config).tap do |http|
-            http.open(url, headers: headers, ssl_context: ssl_context)
+            http.open(url)
           end
         end
 
+        def post(url, body: nil, headers: nil)
+          request(:post, url, body: body, headers: headers)
+        end
+
+        def get(url, headers: nil)
+          request(:get, url, headers: headers)
+        end
+
+        def request(method, url, body: nil, headers: nil)
+          @client.send(
+            method,
+            url,
+            body: body,
+            headers: (headers ? @headers.merge(headers) : @headers).to_h,
+            ssl_context: @config.ssl_context
+          ).flush
+        end
+
         def write(str)
           @wr.write(str)
           @wr.bytes_sent
@@ -69,23 +85,29 @@ module ElasticAPM
           format('[THREAD:%s]', Thread.current.object_id)
         end
 
-        # rubocop:disable Metrics/LineLength
-        def open_request_in_thread(url, headers, ssl_context)
-          client = build_client(headers)
-
+        # rubocop:disable Metrics/MethodLength
+        def open_request_in_thread(url)
           debug '%s: Opening new request', thread_str
           Thread.new do
             begin
-              post(client, url, ssl_context)
+              resp = post(url, body: @rd, headers: @headers.chunked.to_h)
+
+              if resp&.status == 202
+                debug 'APM Server responded with status 202'
+              elsif resp
+                error "APM Server responded with an error:\n%p", resp.body.to_s
+              end
             rescue Exception => e
-              error "Couldn't establish connection to APM Server:\n%p", e.inspect
+              error(
+                "Couldn't establish connection to APM Server:\n%p", e.inspect
+              )
             end
           end
         end
-        # rubocop:enable Metrics/LineLength
+        # rubocop:enable Metrics/MethodLength
 
-        def build_client(headers)
-          client = HTTP.headers(headers)
+        def build_client
+          client = HTTP.headers(@headers)
           return client unless @config.proxy_address && @config.proxy_port
 
           client.via(
@@ -96,20 +118,6 @@ module ElasticAPM
             @config.proxy_headers
           )
         end
-
-        def post(client, url, ssl_context)
-          resp = client.post(
-            url,
-            body: @rd,
-            ssl_context: ssl_context
-          ).flush
-
-          if resp&.status == 202
-            debug 'APM Server responded with status 202'
-          elsif resp
-            error "APM Server responded with an error:\n%p", resp.body.to_s
-          end
-        end
       end
     end
   end