elastic-apm 3.1.0 → 3.2.0

data/docs/api.asciidoc

@@ -193,9 +193,9 @@ Returns the built context.
 
 [float]
 [[rails-start]]
-=== Manually hooking into Rails
+=== Rails
 
-Start the agent and hook into Rails explicitly. This is useful if you skip requiring
+Start the agent and hook into Rails manually. This is useful if you skip requiring
 the gem and using the `Railtie`.
 
 [source,ruby]
@@ -214,6 +214,17 @@ Start the agent and hook into Sinatra.
 ElasticAPM::Sinatra.start(MySinatraApp, server_url: 'http://localhost:8200')
 ----
 
+[float]
+[[grape-start]]
+=== Grape
+
+Start the agent and hook into Grape.
+
+[source,ruby]
+----
+ElasticAPM::Grape.start(MyGrapeApp, server_url: 'http://localhost:8200')
+----
+
 [float]
 === Errors
 

data/docs/configuration.asciidoc

@@ -66,6 +66,23 @@ ElasticAPM::Sinatra.start(
 
 See <<getting-started-rack>>.
 
+[float]
+=== Grape and Rack
+
+When using APM with Grape and Rack (without Rails), you can configure it when starting
+the agent:
+
+[source,ruby]
+----
+# config.ru or similar
+ElasticAPM::Grape.start(
+  MyApp,
+  service_name: 'SomeOtherName'
+)
+----
+
+See <<getting-started-rack>>.
+
 [float]
 === Options
 
@@ -184,6 +201,19 @@ APM Server has its own limit of 30 seconds before it will close requests.
 
 It has to be provided in *<<config-format-duration, duration format>>*.
 
+[float]
+[[config-breakdown-metrics]]
+==== `breakdown-metrics`
+|============
+| Environment                     | `Config` key        | Default
+| `ELASTIC_APM_BREAKDOWN_METRICS` | `breakdown_metrics` | `true`
+|============
+
+Enable/disable the tracking and collection of breakdown metrics.
+By setting this to `False`, tracking this metric is completely disabled, which can reduce the overhead of the agent.
+
+NOTE: This feature requires APM Server and Kibana >= 7.3.
+
 [float]
 [[config-capture-body]]
 ==== `capture_body`

data/docs/getting-started-rack.asciidoc

@@ -72,3 +72,27 @@ run MySinatraApp
 at_exit { ElasticAPM.stop }
 ----
 
+[float]
+[[getting-started-grape]]
+==== Grape example
+
+[source,ruby]
+----
+# Example config.ru
+
+require 'grape'
+
+module Twitter
+  class API < Grape::API
+    use ElasticAPM::Middleware
+
+  # ...
+  end
+end
+
+# Start the agent and hook in your app
+ElasticAPM::Grape.start(Twitter::API, config)
+
+run Twitter::API
+
+----

data/docs/release-notes.asciidoc

@@ -1,4 +1,4 @@
-:pull: https://github.com/elastic/apm-server/pull/
+:pull: https://github.com/elastic/apm-agent-ruby/pull/
 
 [[release-notes]]
 == Release notes

data/lib/elastic_apm.rb

@@ -1,5 +1,15 @@
 # frozen_string_literal: true
 
+require 'erb'
+require 'http'
+require 'json'
+require 'yaml'
+require 'zlib'
+require 'logger'
+require 'concurrent'
+require 'forwardable'
+require 'securerandom'
+
 require 'elastic_apm/version'
 require 'elastic_apm/internal_error'
 require 'elastic_apm/logging'
@@ -13,8 +23,9 @@ require 'elastic_apm/util'
 
 require 'elastic_apm/middleware'
 
-require 'elastic_apm/railtie' if defined?(::Rails::Railtie)
+require 'elastic_apm/rails' if defined?(::Rails::Railtie)
 require 'elastic_apm/sinatra' if defined?(::Sinatra)
+require 'elastic_apm/grape' if defined?(::Grape)
 
 # ElasticAPM
 module ElasticAPM # rubocop:disable Metrics/ModuleLength

data/lib/elastic_apm/agent.rb

@@ -62,6 +62,7 @@ module ElasticAPM
       !!@instance
     end
 
+    # rubocop:disable Metrics/MethodLength
     def initialize(config)
       @stacktrace_builder = StacktraceBuilder.new(config)
       @context_builder = ContextBuilder.new(config)
@@ -69,12 +70,14 @@ module ElasticAPM
 
       @central_config = CentralConfig.new(config)
       @transport = Transport::Base.new(config)
+      @metrics = Metrics.new(config) { |event| enqueue event }
       @instrumenter = Instrumenter.new(
         config,
+        metrics: metrics,
         stacktrace_builder: stacktrace_builder
       ) { |event| enqueue event }
-      @metrics = Metrics.new(config) { |event| enqueue event }
     end
+    # rubocop:enable Metrics/MethodLength
 
     attr_reader(
       :central_config,
@@ -91,8 +94,11 @@ module ElasticAPM
 
     # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
     def start
-      unless config.disable_start_message
-        info '[%s] Starting agent, reporting to %s', VERSION, config.server_url
+      unless config.disable_start_message?
+        config.logger.info format(
+          '[%s] Starting agent, reporting to %s',
+          VERSION, config.server_url
+        )
       end
 
       central_config.start
@@ -231,6 +237,12 @@ module ElasticAPM
     def add_filter(key, callback)
       transport.add_filter(key, callback)
     end
+
+    # misc
+
+    def inspect
+      super.split.first + '>'
+    end
   end
   # rubocop:enable Metrics/ClassLength
 end

data/lib/elastic_apm/central_config.rb

@@ -4,7 +4,7 @@ require 'elastic_apm/central_config/cache_control'
 
 module ElasticAPM
   # @api private
-  class CentralConfig
+  class CentralConfig # rubocop:disable Metrics/ClassLength
     include Logging
 
     # @api private
@@ -23,10 +23,8 @@ module ElasticAPM
     def initialize(config)
       @config = config
       @modified_options = {}
-      @service_info = {
-        'service.name': config.service_name,
-        'service.environment': config.environment
-      }.to_json
+      @http = Transport::Connection::Http.new(config)
+      @etag = 1
     end
 
     attr_reader :config
@@ -35,9 +33,17 @@ module ElasticAPM
     def start
       return unless config.central_config?
 
+      debug 'Starting CentralConfig'
+
       fetch_and_apply_config
     end
 
+    def stop
+      debug 'Stopping CentralConfig'
+
+      @scheduled_task&.cancel
+    end
+
     def fetch_and_apply_config
       @promise =
         Concurrent::Promise
@@ -46,10 +52,6 @@ module ElasticAPM
         .rescue(&method(:handle_error))
     end
 
-    def stop
-      @scheduled_task&.cancel
-    end
-
     # rubocop:disable Metrics/MethodLength
     def fetch_config
       resp = perform_request
@@ -90,15 +92,25 @@ module ElasticAPM
       @config = config.dup.tap { |new_config| new_config.assign(new_options) }
     end
 
-    # rubocop:disable Metrics/MethodLength
+    # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+    # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
     def handle_success(resp)
+      if (etag = resp.headers['Etag'])
+        @etag = etag
+      end
+
       if resp.status == 304
         info 'Received 304 Not Modified'
       else
-        update = JSON.parse(resp.body.to_s)
-        assign(update)
+        if resp.body && !resp.body.empty?
+          update = JSON.parse(resp.body.to_s)
+          assign(update)
+        end
 
-        info 'Updated config from Kibana'
+        if @modified_options.any?
+          info 'Updated config from Kibana'
+          debug 'Modified: %s', @modified_options.inspect
+        end
       end
 
       schedule_next_fetch(resp)
@@ -108,7 +120,8 @@ module ElasticAPM
       error 'Failed to apply remote config, %s', e.inspect
       debug { e.backtrace.join('\n') }
     end
-    # rubocop:enable Metrics/MethodLength
+    # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+    # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
 
     def handle_error(error)
       debug(
@@ -122,11 +135,18 @@ module ElasticAPM
     end
 
     def perform_request
-      Http.post(
-        config.server_url + '/config/v1/agents',
-        body: @service_info,
-        headers: { etag: 1, content_type: 'application/json' }
-      )
+      @http.get(server_url, headers: headers)
+    end
+
+    def server_url
+      @server_url ||=
+        config.server_url +
+        '/config/v1/agents' \
+        "?service.name=#{config.service_name}"
+    end
+
+    def headers
+      { 'Etag': @etag }
     end
 
     def schedule_next_fetch(resp)

data/lib/elastic_apm/child_durations.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module ElasticAPM
+  # @api private
+  module ChildDurations
+    # @api private
+    module Methods
+      def child_durations
+        @child_durations ||= Durations.new
+      end
+
+      def child_started
+        child_durations.start
+      end
+
+      def child_stopped
+        child_durations.stop
+      end
+    end
+
+    # @api private
+    class Durations
+      def initialize
+        @nesting_level = 0
+        @start = nil
+        @duration = 0
+      end
+
+      attr_reader :duration
+
+      def start
+        @nesting_level += 1
+        @start = Util.micros if @nesting_level == 1
+      end
+
+      def stop
+        @nesting_level -= 1
+        @duration = (Util.micros - @start) if @nesting_level == 0
+      end
+    end
+  end
+end

data/lib/elastic_apm/config.rb

@@ -1,11 +1,5 @@
 # frozen_string_literal: true
 
-require 'logger'
-require 'yaml'
-require 'erb'
-
-require 'elastic_apm/util/prefixed_logger'
-
 require 'elastic_apm/config/options'
 require 'elastic_apm/config/duration'
 require 'elastic_apm/config/bytes'
@@ -28,6 +22,7 @@ module ElasticAPM
     option :api_buffer_size,                   type: :int,    default: 256
     option :api_request_size,                  type: :bytes,  default: '750kb', converter: Bytes.new
     option :api_request_time,                  type: :float,  default: '10s',   converter: Duration.new
+    option :breakdown_metrics,                 type: :bool,   default: true
     option :capture_body,                      type: :string, default: 'off'
     option :capture_headers,                   type: :bool,   default: true
     option :capture_env,                       type: :bool,   default: true
@@ -79,8 +74,6 @@ module ElasticAPM
     def initialize(options = {})
       @options = load_schema
 
-      custom_logger = options.delete(:logger)
-
       assign(options)
 
       # Pick out config_file specifically as we need it now to load it,
@@ -95,10 +88,10 @@ module ElasticAPM
 
       yield self if block_given?
 
-      @logger = custom_logger || build_logger
+      self.logger ||= build_logger
 
-      @__view_paths = []
-      @__root_path = Dir.pwd
+      @__view_paths ||= []
+      @__root_path ||= Dir.pwd
     end
     # rubocop:enable Metrics/MethodLength
 
@@ -173,6 +166,29 @@ module ElasticAPM
       @span_frames_min_duration_us ||= span_frames_min_duration * 1_000_000
     end
 
+    # rubocop:disable Metrics/MethodLength
+    def ssl_context
+      return unless use_ssl?
+
+      @ssl_context ||=
+        OpenSSL::SSL::SSLContext.new.tap do |context|
+          if server_ca_cert
+            context.ca_file = server_ca_cert
+          else
+            context.cert_store =
+              OpenSSL::X509::Store.new.tap(&:set_default_paths)
+          end
+
+          context.verify_mode =
+            if verify_server_cert
+              OpenSSL::SSL::VERIFY_PEER
+            else
+              OpenSSL::SSL::VERIFY_NONE
+            end
+        end
+    end
+    # rubocop:enable Metrics/MethodLength
+
     def inspect
       super.split.first + '>'
     end

data/lib/elastic_apm/context/request/socket.rb

@@ -8,7 +8,7 @@ module ElasticAPM
       # @api private
       class Socket
         def initialize(req)
-          @remote_addr = req.ip
+          @remote_addr = req.env['REMOTE_ADDR']
           @encrypted = req.scheme == 'https'
         end
 

data/lib/elastic_apm/context_builder.rb

@@ -38,7 +38,7 @@ module ElasticAPM
       request.headers = headers if config.capture_headers?
       request.env = env if config.capture_env?
 
-      request.cookies = req.cookies
+      request.cookies = req.cookies.dup
 
       context
     end

data/lib/elastic_apm/error.rb

@@ -18,5 +18,15 @@ module ElasticAPM
     attr_accessor :id, :culprit, :exception, :log, :transaction_id,
       :transaction, :context, :parent_id, :trace_id
     attr_reader :timestamp
+
+    def inspect
+      "<ElasticAPM::Error id:#{id}" \
+        " culprit:#{culprit}" \
+        " timestamp:#{timestamp}" \
+        " transaction_id:#{transaction_id}" \
+        " trace_id:#{trace_id}" \
+        " exception:#{exception.inspect}" \
+        ">"
+    end
   end
 end