elastic-apm 3.3.0 → 3.4.0

data/docs/configuration.asciidoc

@@ -145,7 +145,7 @@ One example to generate a secure secret token is:
 ruby -r securerandom -e 'print SecureRandom.uuid'
 ----
 
-WARNING: Secret tokens only provide any real security if your APM server use TLS.
+WARNING: Secret tokens only provide any real security if your APM server uses TLS.
 
 [float]
 [[config-active]]
@@ -726,6 +726,23 @@ between `0.0` and `1.0`.
 We still record overall time and the result for unsampled transactions, but no
 context information, tags, or spans.
 
+[float]
+[[config-use-experimental-sql-parser]]
+==== `use_experimental_sql_parser`
+|============
+| Environment                               | `Config` key                  | Default
+| `ELASTIC_APM_USE_EXPERIMENTAL_SQL_PARSER` | `use_experimental_sql_parser` | `false`
+|============
+
+Use a newer, more precise but still experimental approach to generating summaries of
+your app's SQL statements.
+Without this, your SQL statements will still be summarized albeit less accurately.
+
+The summaries become the spans' names -- what it says in the waterfall view in Kibana.
+
+NOTE: This should work just fine but is still deamed experimental. That means it is
+subject to change. Please let us know if you come across any issues.
+
 [float]
 [[config-verify-server-cert]]
 ==== `verify_server_cert`

data/docs/supported-technologies.asciidoc

@@ -26,7 +26,7 @@ https://www.ruby-lang.org/en/downloads/branches/[Ruby Maintenance Branches].
 We have automatic support for Ruby on Rails and all Rack compatible web
 frameworks.
 
-We test against all supported minor versions of Rails and Sinatra.
+We test against all supported minor versions of Rails, Sinatra, and Grape.
 
 [float]
 [[supported-technologies-rails]]
@@ -45,6 +45,14 @@ We currently support all versions of Sinatra since 1.0.
 
 See <<getting-started-rack>>.
 
+[float]
+[[supported-technologies-grape]]
+==== Grape
+
+We currently support all versions of Grape since 1.2.
+
+See <<getting-started-grape>>.
+
 [float]
 [[supported-technologies-databases]]
 === Databases
@@ -67,3 +75,14 @@ requests using these libraries:
 - `net/http`
 - Http.rb (v0.6+)
 - Faraday (v0.2.1+)
+
+[float]
+[[supported-technologies-backgroud-processing]]
+=== Background Processing
+
+We automatically instrument background processing using:
+
+- DelayedJob
+- Sidekiq
+- Shoryuken
+- Sneakers (v2.12.0+) (Experimental, see {pull}676[#676])

data/lib/elastic_apm.rb

@@ -97,6 +97,8 @@ module ElasticAPM
     # @param type [String] The kind of the transaction, eg `app.request.get` or
     # `db.mysql2.query`
     # @param context [Context] An optional [Context]
+    # @param trace_context [TraceContext] An optional [TraceContext] object for
+    #   Distributed Tracing.
     # @return [Transaction]
     def start_transaction(
       name = nil,
@@ -127,6 +129,8 @@ module ElasticAPM
     # @param type [String] The kind of the transaction, eg `app.request.get` or
     # `db.mysql2.query`
     # @param context [Context] An optional [Context]
+    # @param trace_context [TraceContext] An optional [TraceContext] object for
+    #   Distributed Tracing.
     # @yield [Transaction]
     # @return result of block
     def with_transaction(
@@ -165,6 +169,11 @@ module ElasticAPM
     # @param action [String] The span action type, eq `connect` or `query`
     # @param context [Span::Context] Context information about the span
     # @param include_stacktrace [Boolean] Whether or not to capture a stacktrace
+    # @param trace_context [TraceContext] An optional [TraceContext] object for
+    #   Distributed Tracing.
+    # @param parent [Transaction,Span] The parent transaction or span.
+    #   Relevant when the span is created in another thread.
+    # @param sync [Boolean] Whether the span is created synchronously or not.
     # @return [Span]
     def start_span(
       name,
@@ -173,7 +182,9 @@ module ElasticAPM
       action: nil,
       context: nil,
       include_stacktrace: true,
-      trace_context: nil
+      trace_context: nil,
+      parent: nil,
+      sync: nil
     )
       agent&.start_span(
         name,
@@ -181,7 +192,9 @@ module ElasticAPM
         subtype: subtype,
         action: action,
         context: context,
-        trace_context: trace_context
+        trace_context: trace_context,
+        parent: parent,
+        sync: sync
       ).tap do |span|
         break unless span && include_stacktrace
         break unless agent.config.span_frames_min_duration?
@@ -202,9 +215,16 @@ module ElasticAPM
     # Wrap a block in a Span, ending it after the block
     #
     # @param name [String] A description of the span, eq `SELECT FROM "users"`
-    # @param type [String] The kind of span, eq `db.mysql2.query`
+    # @param type [String] The kind of span, eq `db`
+    # @param subtype [String] The subtype of span eg. `postgresql`.
+    # @param action [String] The action type of span eg. `connect` or `query`.
     # @param context [Span::Context] Context information about the span
     # @param include_stacktrace [Boolean] Whether or not to capture a stacktrace
+    # @param trace_context [TraceContext] An optional [TraceContext] object for
+    #   Distributed Tracing.
+    # @param parent [Transaction,Span] The parent transaction or span.
+    #   Relevant when the span is created in another thread.
+    # @param sync [Boolean] Whether the span is created synchronously or not.
     # @yield [Span]
     # @return Result of block
     def with_span(
@@ -214,7 +234,9 @@ module ElasticAPM
       action: nil,
       context: nil,
       include_stacktrace: true,
-      trace_context: nil
+      trace_context: nil,
+      parent: nil,
+      sync: nil
     )
       unless block_given?
         raise ArgumentError,
@@ -232,7 +254,9 @@ module ElasticAPM
             action: action,
             context: context,
             include_stacktrace: include_stacktrace,
-            trace_context: trace_context
+            trace_context: trace_context,
+            parent: parent,
+            sync: sync
           )
         yield span
       ensure

data/lib/elastic_apm/agent.rb

@@ -165,7 +165,9 @@ module ElasticAPM
       action: nil,
       backtrace: nil,
       context: nil,
-      trace_context: nil
+      trace_context: nil,
+      parent: nil,
+      sync: nil
     )
       instrumenter.start_span(
         name,
@@ -174,7 +176,9 @@ module ElasticAPM
         action: action,
         backtrace: backtrace,
         context: context,
-        trace_context: trace_context
+        trace_context: trace_context,
+        parent: parent,
+        sync: sync
       )
     end
     # rubocop:enable Metrics/ParameterLists

data/lib/elastic_apm/child_durations.rb

@@ -24,18 +24,23 @@ module ElasticAPM
         @nesting_level = 0
         @start = nil
         @duration = 0
+        @mutex = Mutex.new
       end
 
       attr_reader :duration
 
       def start
-        @nesting_level += 1
-        @start = Util.micros if @nesting_level == 1
+        @mutex.synchronize do
+          @nesting_level += 1
+          @start = Util.micros if @nesting_level == 1
+        end
       end
 
       def stop
-        @nesting_level -= 1
-        @duration = (Util.micros - @start) if @nesting_level == 0
+        @mutex.synchronize do
+          @nesting_level -= 1
+          @duration = (Util.micros - @start) if @nesting_level == 0
+        end
       end
     end
   end

data/lib/elastic_apm/config.rb

@@ -17,6 +17,7 @@ module ElasticAPM
     option :config_file,                       type: :string, default: 'config/elastic_apm.yml'
     option :server_url,                        type: :url,    default: 'http://localhost:8200'
     option :secret_token,                      type: :string
+    option :api_key,                           type: :string
 
     option :active,                            type: :bool,   default: true
     option :api_buffer_size,                   type: :int,    default: 256
@@ -69,6 +70,9 @@ module ElasticAPM
     option :transaction_max_spans,             type: :int,    default: 500
     option :transaction_sample_rate,           type: :float,  default: 1.0
     option :verify_server_cert,                type: :bool,   default: true
+
+    option :use_experimental_sql_parser,      type: :bool,   default: false
+
     # rubocop:enable Metrics/LineLength, Layout/ExtraSpacing
     def initialize(options = {})
       @options = load_schema
@@ -105,6 +109,7 @@ module ElasticAPM
 
     def available_instrumentations
       %w[
+        action_dispatch
         delayed_job
         elasticsearch
         faraday
@@ -112,12 +117,14 @@ module ElasticAPM
         json
         mongo
         net_http
+        rake
         redis
         sequel
+        shoryuken
         sidekiq
         sinatra
+        sneakers
         tilt
-        rake
       ]
     end
 

data/lib/elastic_apm/config/options.rb

@@ -83,9 +83,8 @@ module ElasticAPM
           @schema ||= {}
         end
 
-        def option(*args)
-          key = args.shift
-          schema[key] = *args
+        def option(key, **args)
+          schema[key] = args
         end
       end
 
@@ -93,7 +92,7 @@ module ElasticAPM
       module InstanceMethods
         def load_schema
           Hash[self.class.schema.map do |key, args|
-            [key, Option.new(key, *args)]
+            [key, Option.new(key, **args)]
           end]
         end
 

data/lib/elastic_apm/context/response.rb

@@ -11,12 +11,20 @@ module ElasticAPM
         finished: true
       )
         @status_code = status_code
-        @headers = headers
         @headers_sent = headers_sent
         @finished = finished
+
+        self.headers = headers
       end
 
-      attr_accessor :status_code, :headers, :headers_sent, :finished
+      attr_accessor :status_code, :headers_sent, :finished
+      attr_reader :headers
+
+      def headers=(headers)
+        @headers = headers.each_with_object({}) do |(k, v), hsh|
+          hsh[k] = v.to_s
+        end
+      end
     end
   end
 end

data/lib/elastic_apm/instrumenter.rb

@@ -136,6 +136,7 @@ module ElasticAPM
     end
 
     # rubocop:disable Metrics/CyclomaticComplexity
+    # rubocop:disable Metrics/PerceivedComplexity
     # rubocop:disable Metrics/ParameterLists
     def start_span(
       name,
@@ -144,19 +145,25 @@ module ElasticAPM
       action: nil,
       backtrace: nil,
       context: nil,
-      trace_context: nil
+      trace_context: nil,
+      parent: nil,
+      sync: nil
     )
-      return unless (transaction = current_transaction)
-      return unless transaction.sampled?
-
-      transaction.inc_started_spans!
 
-      if transaction.max_spans_reached?
-        transaction.inc_dropped_spans!
-        return
-      end
+      transaction =
+        case parent
+        when Span
+          parent.transaction
+        when Transaction
+          parent
+        else
+          current_transaction
+        end
+      return unless transaction
+      return unless transaction.sampled?
+      return unless transaction.inc_started_spans!
 
-      parent = current_span || transaction
+      parent ||= (current_span || current_transaction)
 
       span = Span.new(
         name: name,
@@ -167,7 +174,8 @@ module ElasticAPM
         trace_context: trace_context,
         type: type,
         context: context,
-        stacktrace_builder: stacktrace_builder
+        stacktrace_builder: stacktrace_builder,
+        sync: sync
       )
 
       if backtrace && transaction.config.span_frames_min_duration?
@@ -180,6 +188,7 @@ module ElasticAPM
     end
     # rubocop:enable Metrics/ParameterLists
     # rubocop:enable Metrics/CyclomaticComplexity
+    # rubocop:enable Metrics/PerceivedComplexity
 
     def end_span
       return unless (span = current_spans.pop)

data/lib/elastic_apm/normalizers/rails/active_record.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'elastic_apm/sql_summarizer'
+require 'elastic_apm/sql'
 
 module ElasticAPM
   module Normalizers
@@ -17,7 +17,8 @@ module ElasticAPM
         def initialize(*args)
           super
 
-          @summarizer = SqlSummarizer.new
+          @summarizer = Sql.summarizer
+
           @adapters = {}
         end
 
@@ -25,14 +26,20 @@ module ElasticAPM
           return :skip if SKIP_NAMES.include?(payload[:name])
 
           name = summarize(payload[:sql]) || payload[:name]
+          subtype = subtype_for(payload)
+
           context =
-            Span::Context.new(db: { statement: payload[:sql], type: 'sql' })
-          [name, TYPE, subtype(payload), ACTION, context]
+            Span::Context.new(
+              db: { statement: payload[:sql], type: 'sql' },
+              destination: { name: subtype, resource: subtype, type: TYPE }
+            )
+
+          [name, TYPE, subtype, ACTION, context]
         end
 
         private
 
-        def subtype(payload)
+        def subtype_for(payload)
           cached_adapter_name(
             payload[:connection]&.adapter_name ||
               ::ActiveRecord::Base.connection_config[:adapter]

data/lib/elastic_apm/rails.rb

@@ -9,7 +9,6 @@ module ElasticAPM
   # It is recommended to use the Railtie instead.
   module Rails
     extend self
-    # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
     # Start the ElasticAPM agent and hook into Rails.
     # Note that the agent won't be started if the Rails console is being used.
     #
@@ -31,13 +30,6 @@ module ElasticAPM
         attach_subscriber(agent)
       end
 
-      if ElasticAPM.running? &&
-         !ElasticAPM.agent.config.disabled_instrumentations.include?(
-           'action_dispatch'
-         )
-        require 'elastic_apm/spies/action_dispatch'
-      end
-
       ElasticAPM.running?
     rescue StandardError => e
       if config.disable_start_message?
@@ -48,12 +40,11 @@ module ElasticAPM
         puts "Backtrace:\n" + e.backtrace.join("\n")
       end
     end
-    # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
 
     private
 
     def should_skip?(_config)
-      if ::Rails.const_defined? 'Rails::Console'
+      if ::Rails.const_defined?('Console', false)
         return 'Rails console'
       end
 

data/lib/elastic_apm/railtie.rb

@@ -7,7 +7,7 @@ module ElasticAPM
 
     Config.schema.each do |key, args|
       next unless args.length > 1
-      config.elastic_apm[key] = args.last[:default]
+      config.elastic_apm[key] = args[:default]
     end
 
     initializer 'elastic_apm.initialize' do |app|

data/lib/elastic_apm/span.rb

@@ -20,7 +20,8 @@ module ElasticAPM
       subtype: nil,
       action: nil,
       context: nil,
-      stacktrace_builder: nil
+      stacktrace_builder: nil,
+      sync: nil
     )
       @name = name
 
@@ -36,7 +37,7 @@ module ElasticAPM
       @parent = parent
       @trace_context = trace_context || parent.trace_context.child
 
-      @context = context || Span::Context.new
+      @context = context || Span::Context.new(sync: sync)
       @stacktrace_builder = stacktrace_builder
     end
     # rubocop:enable Metrics/ParameterLists