elastic-apm 2.8.1 → 2.11.0

data/lib/elastic_apm/normalizers/active_record.rb

@@ -9,10 +9,13 @@ module ElasticAPM
       class SqlNormalizer < Normalizer
         register 'sql.active_record'
 
+        TYPE = 'db'
+        ACTION = 'sql'
+
         def initialize(*args)
           super
 
-          @type = format('db.%s.sql', lookup_adapter || 'unknown').freeze
+          @subtype = lookup_adapter || 'unknown'
           @summarizer = SqlSummarizer.new
         end
 
@@ -22,7 +25,7 @@ module ElasticAPM
           name = summarize(payload[:sql]) || payload[:name]
           context =
             Span::Context.new(db: { statement: payload[:sql], type: 'sql' })
-          [name, @type, context]
+          [name, TYPE, @subtype, ACTION, context]
         end
 
         private

data/lib/elastic_apm/rails.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require 'elastic_apm/subscriber'
+
+module ElasticAPM
+  # Module for explicitly starting the ElasticAPM agent and hooking into Rails.
+  # 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.
+    # Note that the agent won't be started if the Rails console is being used.
+    #
+    # @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(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
+
+      ElasticAPM.start(config).tap do |agent|
+        attach_subscriber(agent)
+      end
+
+      if ElasticAPM.running? &&
+         !ElasticAPM.agent.config.disabled_spies.include?('action_dispatch')
+        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")
+    end
+    # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
+    # rubocop:enable Metrics/CyclomaticComplexity
+
+    private
+
+    def should_skip?(_config)
+      if ::Rails.const_defined? 'Rails::Console'
+        return 'Rails console'
+      end
+
+      nil
+    end
+
+    def attach_subscriber(agent)
+      return unless agent
+
+      agent.instrumenter.subscriber = ElasticAPM::Subscriber.new(agent)
+    end
+  end
+end

data/lib/elastic_apm/railtie.rb

@@ -1,67 +1,30 @@
 # frozen_string_literal: true
 
-require 'elastic_apm/subscriber'
+require 'elastic_apm/rails'
 
 module ElasticAPM
   # @api private
-  class Railtie < Rails::Railtie
+  class Railtie < ::Rails::Railtie
     config.elastic_apm = ActiveSupport::OrderedOptions.new
 
-    Config::DEFAULTS.each { |option, value| config.elastic_apm[option] = value }
+    Config.schema.each do |key, args|
+      next unless args.length > 1
+      config.elastic_apm[key] = args.last[:default]
+    end
 
     initializer 'elastic_apm.initialize' do |app|
-      config = Config.new(app.config.elastic_apm.merge(app: app)).tap do |c|
+      config = Config.new(app.config.elastic_apm).tap do |c|
+        c.app = app
+
         # 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)
+          c.log_path = ::Rails.root.join(c.log_path)
         end
       end
 
-      if start(config)
+      if Rails.start(config)
         app.middleware.insert 0, Middleware
       end
     end
-
-    config.after_initialize do
-      if ElasticAPM.running? &&
-         !ElasticAPM.agent.config.disabled_spies.include?('action_dispatch')
-        require 'elastic_apm/spies/action_dispatch'
-      end
-    end
-
-    private
-
-    # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
-    def start(config)
-      if (reason = should_skip?(config))
-        unless config.disable_start_message?
-          config.alert_logger.info "Skipping because: #{reason}. " \
-            "Start manually with `ElasticAPM.start'"
-        end
-        return
-      end
-
-      ElasticAPM.start(config).tap do |agent|
-        attach_subscriber(agent)
-      end
-    rescue StandardError => e
-      config.alert_logger.error format('Failed to start: %s', e.message)
-      config.alert_logger.debug "Backtrace:\n" + e.backtrace.join("\n")
-    end
-    # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
-
-    def should_skip?(_config)
-      if Rails.const_defined? 'Rails::Console'
-        return 'Rails console'
-      end
-
-      nil
-    end
-
-    def attach_subscriber(agent)
-      return unless agent
-
-      agent.instrumenter.subscriber = ElasticAPM::Subscriber.new(agent)
-    end
   end
 end

data/lib/elastic_apm/span.rb

@@ -14,17 +14,26 @@ module ElasticAPM
 
     DEFAULT_TYPE = 'custom'
 
-    # rubocop:disable Metrics/ParameterLists
+    # rubocop:disable Metrics/ParameterLists, Metrics/MethodLength
     def initialize(
       name:,
       transaction_id:,
       trace_context:,
       type: nil,
+      subtype: nil,
+      action: nil,
       context: nil,
       stacktrace_builder: nil
     )
       @name = name
-      @type = type || DEFAULT_TYPE
+
+      if subtype.nil? && type&.include?('.')
+        @type, @subtype, @action = type.split('.')
+      else
+        @type = type || DEFAULT_TYPE
+        @subtype = subtype
+        @action = action
+      end
 
       @transaction_id = transaction_id
       @trace_context = trace_context
@@ -32,10 +41,23 @@ module ElasticAPM
       @context = context || Span::Context.new
       @stacktrace_builder = stacktrace_builder
     end
-    # rubocop:enable Metrics/ParameterLists
-
-    attr_accessor :name, :type, :original_backtrace, :trace_context
-    attr_reader :context, :stacktrace, :duration, :timestamp, :transaction_id
+    # rubocop:enable Metrics/ParameterLists, Metrics/MethodLength
+
+    attr_accessor(
+      :action,
+      :name,
+      :original_backtrace,
+      :subtype,
+      :trace_context,
+      :type
+    )
+    attr_reader(
+      :context,
+      :duration,
+      :stacktrace,
+      :timestamp,
+      :transaction_id
+    )
 
     # life cycle
 
@@ -53,6 +75,7 @@ module ElasticAPM
       stop end_time
 
       build_stacktrace! if should_build_stacktrace?
+      self.original_backtrace = nil # release original
 
       self
     end
@@ -82,7 +105,6 @@ module ElasticAPM
 
     def build_stacktrace!
       @stacktrace = @stacktrace_builder.build(original_backtrace, type: :span)
-      self.original_backtrace = nil # release original
     end
 
     def should_build_stacktrace?

data/lib/elastic_apm/spies/faraday.rb

@@ -5,6 +5,9 @@ module ElasticAPM
   module Spies
     # @api private
     class FaradaySpy
+      TYPE = 'ext'
+      SUBTYPE = 'faraday'
+
       def self.without_net_http
         return yield unless defined?(NetHTTPSpy)
 
@@ -37,9 +40,13 @@ module ElasticAPM
                    end
 
             name = "#{method.upcase} #{host}"
-            type = "ext.faraday.#{method}"
 
-            ElasticAPM.with_span name, type do |span|
+            ElasticAPM.with_span(
+              name,
+              TYPE,
+              subtype: SUBTYPE,
+              action: method.to_s
+            ) do |span|
               ElasticAPM::Spies::FaradaySpy.without_net_http do
                 trace_context = span&.trace_context || transaction.trace_context
 

data/lib/elastic_apm/spies/http.rb

@@ -5,6 +5,9 @@ module ElasticAPM
   module Spies
     # @api private
     class HTTPSpy
+      TYPE = 'ext'
+      SUBTYPE = 'http_rb'
+
       # rubocop:disable Metrics/MethodLength
       def install
         ::HTTP::Client.class_eval do
@@ -19,9 +22,13 @@ module ElasticAPM
             host = req.uri.host
 
             name = "#{method} #{host}"
-            type = "ext.http_rb.#{method}"
 
-            ElasticAPM.with_span name, type do |span|
+            ElasticAPM.with_span(
+              name,
+              TYPE,
+              subtype: SUBTYPE,
+              action: method
+            ) do |span|
               trace_context = span&.trace_context || transaction.trace_context
               req['Elastic-Apm-Traceparent'] = trace_context.to_header
               perform_without_apm(req, options)

data/lib/elastic_apm/spies/mongo.rb

@@ -14,7 +14,9 @@ module ElasticAPM
 
       # @api private
       class Subscriber
-        TYPE = 'db.mongodb.query'
+        TYPE = 'db'
+        SUBTYPE = 'mongodb'
+        ACTION = 'query'
 
         def initialize
           @events = {}
@@ -34,18 +36,31 @@ module ElasticAPM
 
         private
 
+        # rubocop:disable Metrics/MethodLength
         def push_event(event)
           return unless ElasticAPM.current_transaction
+          # Some MongoDB commands are not on collections but rather are db
+          # admin commands. For these commands, the value at the `command_name`
+          # key is the integer 1.
+          unless event.command[event.command_name] == 1
+            collection = event.command[event.command_name]
+          end
+          name = [event.database_name,
+                  collection,
+                  event.command_name].compact.join('.')
 
           span =
             ElasticAPM.start_span(
-              event.command_name.to_s,
+              name,
               TYPE,
+              subtype: SUBTYPE,
+              action: ACTION,
               context: build_context(event)
             )
 
           @events[event.operation_id] = span
         end
+        # rubocop:enable Metrics/MethodLength
 
         def pop_event(event)
           return unless (curr = ElasticAPM.current_span)
@@ -58,7 +73,7 @@ module ElasticAPM
           Span::Context.new(
             db: {
               instance: event.database_name,
-              statement: nil,
+              statement: event.command.to_s,
               type: 'mongodb',
               user: nil
             }

data/lib/elastic_apm/spies/net_http.rb

@@ -6,6 +6,8 @@ module ElasticAPM
     # @api private
     class NetHTTPSpy
       KEY = :__elastic_apm_net_http_disabled
+      TYPE = 'ext'
+      SUBTYPE = 'net_http'
 
       # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
       class << self
@@ -46,9 +48,13 @@ module ElasticAPM
             host ||= address
 
             name = "#{method} #{host}"
-            type = "ext.net_http.#{method}"
 
-            ElasticAPM.with_span name, type do |span|
+            ElasticAPM.with_span(
+              name,
+              TYPE,
+              subtype: SUBTYPE,
+              action: method.to_s
+            ) do |span|
               trace_context = span&.trace_context || transaction.trace_context
               req['Elastic-Apm-Traceparent'] = trace_context.to_header
               request_without_apm(req, body, &block)

data/lib/elastic_apm/stacktrace/frame.rb

@@ -32,6 +32,8 @@ module ElasticAPM
         to = lineno + padding - 1
         file_lines = read_lines(abs_path, from..to)
 
+        return unless file_lines
+
         self.context_line = file_lines[padding]
         self.pre_context  = file_lines.first(padding)
         self.post_context = file_lines.last(padding)
@@ -43,7 +45,7 @@ module ElasticAPM
       def read_lines(path, range)
         File.readlines(path)[range]
       rescue Errno::ENOENT
-        []
+        nil
       end
     end
   end

data/lib/elastic_apm/stacktrace_builder.rb

@@ -67,8 +67,8 @@ module ElasticAPM
     def library_frame?(config, abs_path)
       return false unless abs_path
 
-      if abs_path.start_with?(config.root_path)
-        return true if abs_path.start_with?(config.root_path + '/vendor')
+      if abs_path.start_with?(config.__root_path)
+        return true if abs_path.start_with?(config.__root_path + '/vendor')
         return false
       end
 

data/lib/elastic_apm/subscriber.rb

@@ -29,8 +29,8 @@ module ElasticAPM
 
     Notification = Struct.new(:id, :span)
 
+    # rubocop:disable Metrics/MethodLength
     def start(name, id, payload)
-      # debug "AS::Notification#start:#{name}:#{id}"
       return unless (transaction = @agent.current_transaction)
 
       normalized = @normalizers.normalize(transaction, name, payload)
@@ -39,12 +39,20 @@ module ElasticAPM
         if normalized == :skip
           nil
         else
-          name, type, context = normalized
-          @agent.start_span(name, type, context: context)
+          name, type, subtype, action, context = normalized
+
+          @agent.start_span(
+            name,
+            type,
+            subtype: subtype,
+            action: action,
+            context: context
+          )
         end
 
       transaction.notifications << Notification.new(id, span)
     end
+    # rubocop:enable Metrics/MethodLength
 
     def finish(_name, id, _payload)
       # debug "AS::Notification#finish:#{name}:#{id}"

data/lib/elastic_apm/transport/connection.rb

@@ -7,6 +7,7 @@ require 'elastic_apm/transport/connection/http'
 
 module ElasticAPM
   module Transport
+    # rubocop:disable Metrics/ClassLength
     # @api private
     class Connection
       include Logging
@@ -130,13 +131,26 @@ module ElasticAPM
         ].join(' ')
       end
 
-      def build_ssl_context
-        return unless @config.use_ssl? && @config.server_ca_cert
+      def build_ssl_context # rubocop:disable Metrics/MethodLength
+        return unless @config.use_ssl?
 
         OpenSSL::SSL::SSLContext.new.tap do |context|
-          context.ca_file = @config.server_ca_cert
+          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