elastic-apm 0.5.1 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2efd1832264da2eb5036fdbf6b3fcb26e47b0f3272779caed2d92c8315a0db7a
-  data.tar.gz: c9f91f38ae3433566cdc16584ee862e7c8ac7f364c0fd05879c96ef87a6406d5
+  metadata.gz: da4eac00d32100e5f82cd8dfe3042278eb4f81865c797ee743b4e2fa89269c18
+  data.tar.gz: bd07824d56e89d645b08cfb2b5090a6ec4fcefbf360cb559420cd7f050629cd1
 SHA512:
-  metadata.gz: 29c6d93909f2726527d09a62345ef920aba5b301a0fef1bd72e7739e2ace645afb22fd73039360e321e1d2cf68ac26745341deeada4f2e2aeb37e5f7bd3d70d3
-  data.tar.gz: 48e84149066cb00fd66f2dc03d275626e7b4a9750b1cd97c6530f5cbf0c7d70f1fade887b228ad9d6e178f5e51c7225673e0f0a1a97a2ffe25dae9cab44721df
+  metadata.gz: 1b57fe86030e4f0aeb667cf886ac45708c4c41d26a0e85ed7736ee8c98319763cc15e0504bee2407f29a4503e98c32899061ad7a5b7fd035fcc5ed527cd7b410
+  data.tar.gz: bfc683d303d7b0a7c5400cd064c76f12dca648eeb6c6cecf73bc25cdb6bae4253e32e708aa57168aa9f0963e5531c7e4cdba10dd5f9d10782197c6bc3426e382

data/Gemfile

@@ -40,7 +40,7 @@ else
 end
 
 # doesn't work with Rails master, so skip testing
-gem 'delayed_job' unless [framework, version] == %w[rails master]
+gem 'delayed_job', '~> 4' unless [framework, version] == %w[rails 5.2]
 
 gem 'rails' if framework == 'sinatra'
 gem 'sinatra' if framework == 'rails'

data/lib/elastic_apm/agent.rb

@@ -7,7 +7,7 @@ require 'elastic_apm/error'
 require 'elastic_apm/http'
 require 'elastic_apm/injectors'
 require 'elastic_apm/serializers'
-require 'elastic_apm/worker'
+require 'elastic_apm/timed_worker'
 
 module ElasticAPM
   # rubocop:disable Metrics/ClassLength
@@ -59,20 +59,17 @@ module ElasticAPM
     def initialize(config)
       @config = config
 
+      @messages = Queue.new
+      @pending_transactions = Queue.new
       @http = Http.new(config)
-      @queue = Queue.new
 
       @instrumenter = Instrumenter.new(config, self)
       @context_builder = ContextBuilder.new(config)
       @error_builder = ErrorBuilder.new(config)
-
-      @serializers = Struct.new(:transactions, :errors).new(
-        Serializers::Transactions.new(config),
-        Serializers::Errors.new(config)
-      )
     end
 
-    attr_reader :config, :queue, :instrumenter, :context_builder, :http
+    attr_reader :config, :messages, :pending_transactions, :instrumenter,
+      :context_builder, :http
 
     def start
       debug '[%s] Starting agent, reporting to %s', VERSION, config.server_url
@@ -98,20 +95,16 @@ module ElasticAPM
       stop
     end
 
-    def enqueue_transactions(transactions)
+    def enqueue_transaction(transaction)
       boot_worker unless worker_running?
 
-      data = @serializers.transactions.build_all(transactions)
-      @queue << Worker::Request.new('/v1/transactions', data)
-      transactions
+      pending_transactions.push(transaction)
     end
 
-    def enqueue_errors(errors)
+    def enqueue_error(error)
       boot_worker unless worker_running?
 
-      data = @serializers.errors.build_all(errors)
-      @queue << Worker::Request.new('/v1/errors', data)
-      errors
+      messages.push(TimedWorker::ErrorMsg.new(error))
     end
 
     # instrumentation
@@ -141,7 +134,7 @@ module ElasticAPM
         exception,
         handled: handled
       )
-      enqueue_errors error
+      enqueue_error error
     end
 
     def report_message(message, backtrace: nil, **attrs)
@@ -150,7 +143,7 @@ module ElasticAPM
         backtrace: backtrace,
         **attrs
       )
-      enqueue_errors error
+      enqueue_error error
     end
 
     # context
@@ -181,12 +174,17 @@ module ElasticAPM
       debug 'Booting worker'
 
       @worker_thread = Thread.new do
-        Worker.new(@config, @queue, @http).run_forever
+        TimedWorker.new(
+          config,
+          messages,
+          pending_transactions,
+          http
+        ).run_forever
       end
     end
 
     def kill_worker
-      @queue << Worker::StopMessage.new
+      messages << TimedWorker::StopMsg.new
 
       if @worker_thread && !@worker_thread.join(5) # 5 secs
         raise 'Failed to wait for worker, not all messages sent'

data/lib/elastic_apm/config.rb

@@ -8,7 +8,6 @@ module ElasticAPM
   class Config
     DEFAULTS = {
       config_file: 'config/elastic_apm.yml',
-      worker_process: false,
 
       server_url: 'http://localhost:8200',
       secret_token: nil,
@@ -31,18 +30,21 @@ module ElasticAPM
       transaction_max_spans: 500,
       filter_exception_types: [],
 
-      http_timeout: 10,
-      http_open_timeout: 10,
+      http_read_timeout: 120,
+      http_open_timeout: 60,
       debug_transactions: false,
       debug_http: false,
       verify_server_cert: true,
+      http_compression: true,
+      compression_minimum_size: 1024 * 5,
+      compression_level: 6,
 
       source_lines_error_app_frames: 5,
       source_lines_span_app_frames: 5,
       source_lines_error_library_frames: 0,
       source_lines_span_library_frames: 0,
 
-      disabled_injectors: %w[],
+      disabled_injectors: %w[json],
 
       current_user_id_method: :id,
       current_user_email_method: :email,
@@ -94,7 +96,6 @@ module ElasticAPM
     end
 
     attr_accessor :config_file
-    attr_accessor :worker_process
 
     attr_accessor :server_url
     attr_accessor :secret_token
@@ -117,10 +118,13 @@ module ElasticAPM
     attr_accessor :verify_server_cert
     attr_accessor :filter_exception_types
 
-    attr_accessor :http_timeout
+    attr_accessor :http_read_timeout
     attr_accessor :http_open_timeout
     attr_accessor :debug_transactions
     attr_accessor :debug_http
+    attr_accessor :http_compression
+    attr_accessor :compression_minimum_size
+    attr_accessor :compression_level
 
     attr_accessor :source_lines_error_app_frames
     attr_accessor :source_lines_span_app_frames

data/lib/elastic_apm/http.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'net/http'
+require 'zlib'
 
 require 'elastic_apm/service_info'
 require 'elastic_apm/system_info'
@@ -32,14 +33,15 @@ module ElasticAPM
     def post(path, payload = {})
       payload.merge! @base_payload
       filters.apply(payload)
+
       request = prepare_request path, payload.to_json
       response = @adapter.perform request
 
       status = response.code.to_i
       return response if status >= 200 && status <= 299
 
-      error "POST returned an unsuccessful status code (#{response.code})"
-      error response.body
+      error 'POST returned an unsuccessful status code (%d)', response.code
+      error "apm-server's response: %s", response.body
 
       response
     end
@@ -51,12 +53,25 @@ module ElasticAPM
         req['Accept'] = ACCEPT
         req['Content-Type'] = CONTENT_TYPE
         req['User-Agent'] = USER_AGENT
-        req['Content-Length'] = data.bytesize.to_s
 
         if (token = @config.secret_token)
           req['Authorization'] = "Bearer #{token}"
         end
 
+        prepare_request_body! req, data
+      end
+    end
+
+    def prepare_request_body!(req, data)
+      if @config.http_compression &&
+         data.bytesize > @config.compression_minimum_size
+        deflated = Zlib.deflate data, @config.compression_level
+
+        req['Content-Encoding'] = 'deflate'
+        req['Content-Length'] = deflated.bytesize.to_s
+        req.body = deflated
+      else
+        req['Content-Length'] = data.bytesize.to_s
         req.body = data
       end
     end
@@ -92,7 +107,7 @@ module ElasticAPM
       http = Net::HTTP.new server_uri.host, server_uri.port
       http.use_ssl = @config.use_ssl?
       http.verify_mode = verify_mode
-      http.read_timeout = @config.http_timeout
+      http.read_timeout = @config.http_read_timeout
       http.open_timeout = @config.http_open_timeout
 
       if @config.debug_http

data/lib/elastic_apm/injectors/redis.rb

@@ -5,27 +5,21 @@ module ElasticAPM
   module Injectors
     # @api private
     class RedisInjector
-      # rubocop:disable Metrics/MethodLength
       def install
         ::Redis::Client.class_eval do
           alias call_without_apm call
 
           def call(command, &block)
             name = command[0].upcase
-            statement =
-              format('%s %s', name, command[1..command.length].join(' '))
-            context = Span::Context.new(
-              statement: statement,
-              type: 'redis'
-            )
 
-            ElasticAPM.span(name.to_s, 'db.redis', context: context) do
+            return call_without_apm(command, &block) if command[0] == :auth
+
+            ElasticAPM.span(name.to_s, 'db.redis') do
               call_without_apm(command, &block)
             end
           end
         end
       end
-      # rubocop:enable Metrics/MethodLength
     end
 
     register 'Redis', 'redis', RedisInjector.new

data/lib/elastic_apm/instrumenter.rb

@@ -33,9 +33,6 @@ module ElasticAPM
       @transaction_info = TransactionInfo.new
 
       @subscriber = subscriber_class.new(config)
-
-      @pending_transactions = []
-      @last_sent_transactions = Time.now.utc
     end
 
     attr_reader :config, :pending_transactions
@@ -64,12 +61,10 @@ module ElasticAPM
         return transaction
       end
 
-      sample = rand <= config.transaction_sample_rate
-
       if args.last.is_a? Hash
-        args.last[:sampled] = sample
+        args.last[:sampled] = random_sample?
       else
-        args.push(sampled: sample)
+        args.push(sampled: random_sample?)
       end
 
       transaction = Transaction.new self, *args
@@ -88,6 +83,10 @@ module ElasticAPM
     end
     # rubocop:enable Metrics/MethodLength
 
+    def random_sample?
+      rand <= config.transaction_sample_rate
+    end
+
     def span(*args, &block)
       unless current_transaction
         return yield if block_given?
@@ -113,36 +112,10 @@ module ElasticAPM
     end
 
     def submit_transaction(transaction)
-      @pending_transactions << transaction
-
-      if config.debug_transactions
-        debug('Submitted transaction:') { Util.inspect_transaction transaction }
-      end
-
-      return unless should_flush_transactions?
-      flush_transactions
-    end
-
-    def should_flush_transactions?
-      interval = config.flush_interval
-
-      return true if interval.nil?
-      return true if @pending_transactions.length >= config.max_queue_size
-
-      Time.now.utc - @last_sent_transactions >= interval
-    end
-
-    def flush_transactions
-      return if @pending_transactions.empty?
-
-      debug 'Sending %i transactions', @pending_transactions.length
-
-      @agent.enqueue_transactions @pending_transactions
-
-      @last_sent_transactions = Time.now.utc
-      @pending_transactions = []
+      @agent.enqueue_transaction transaction
 
-      true
+      return unless config.debug_transactions
+      debug('Submitted transaction:') { Util.inspect_transaction transaction }
     end
 
     def inspect

data/lib/elastic_apm/stacktrace.rb

@@ -9,7 +9,7 @@ module ElasticAPM
     JAVA_FORMAT = /^(.+)\.([^\.]+)\(([^\:]+)\:(\d+)\)$/
     RUBY_FORMAT = /^(.+?):(\d+)(?::in `(.+?)')?$/
 
-    RUBY_VERS_REGEX = %r{ruby[-/](\d+\.)+\d}
+    RUBY_VERS_REGEX = %r{ruby(/gems)?[-/](\d+\.)+\d}
     JRUBY_ORG_REGEX = %r{org/jruby}
 
     def initialize(backtrace)
@@ -61,7 +61,7 @@ module ElasticAPM
       return false unless abs_path
 
       if abs_path.start_with?(config.root_path)
-        return true if abs_path.match(config.root_path + '/vendor')
+        return true if abs_path.start_with?(config.root_path + '/vendor')
         return false
       end
 

data/lib/elastic_apm/timed_worker.rb

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+module ElasticAPM
+  # @api private
+  class TimedWorker
+    include Log
+
+    SLEEP_INTERVAL = 0.1
+
+    # @api private
+    class StopMsg
+    end
+
+    # @api private
+    class ErrorMsg
+      def initialize(error)
+        @error = error
+      end
+
+      attr_reader :error
+    end
+
+    def initialize(config, messages, pending_transactions, adapter)
+      @config = config
+      @messages = messages
+      @pending_transactions = pending_transactions
+      @adapter = adapter
+
+      @last_sent_transactions = Time.now.utc
+
+      @serializers = Struct.new(:transactions, :errors).new(
+        Serializers::Transactions.new(config),
+        Serializers::Errors.new(config)
+      )
+    end
+
+    attr_reader :config, :messages, :pending_transactions
+
+    def run_forever
+      loop do
+        run_once
+        sleep SLEEP_INTERVAL
+      end
+    end
+
+    def run_once
+      collect_and_send_transactions if should_flush_transactions?
+      process_messages
+    end
+
+    private
+
+    # rubocop:disable Metrics/MethodLength
+    def process_messages
+      should_exit = false
+
+      while (msg = messages.pop(true))
+        case msg
+        when ErrorMsg
+          post_error msg
+        when StopMsg
+          should_exit = true
+
+          # empty collected transactions before exiting
+          collect_and_send_transactions
+        end
+      end
+    rescue ThreadError # queue empty
+      Thread.exit if should_exit
+    end
+    # rubocop:enable Metrics/MethodLength
+
+    def post_error(msg)
+      payload = @serializers.errors.build_all([msg.error])
+      @adapter.post('/v1/errors', payload)
+    end
+
+    def collect_and_send_transactions
+      return if pending_transactions.empty?
+
+      transactions = collect_batched_transactions
+
+      payload = @serializers.transactions.build_all(transactions)
+
+      begin
+        @adapter.post('/v1/transactions', payload)
+      rescue ::Exception => e
+        fatal 'Failed posting: %s', e.inspect
+        debug e.backtrace.join("\n")
+        nil
+      end
+    end
+
+    def collect_batched_transactions
+      batch = []
+
+      begin
+        while (transaction = pending_transactions.pop(true)) &&
+              batch.length <= config.max_queue_size
+          batch << transaction
+        end
+      rescue ThreadError # queue empty
+      end
+
+      batch
+    end
+
+    def should_flush_transactions?
+      interval = config.flush_interval
+
+      return true if interval.nil?
+      return true if pending_transactions.length >= config.max_queue_size
+
+      Time.now.utc - @last_sent_transactions >= interval
+    end
+  end
+end

data/lib/elastic_apm/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ElasticAPM
-  VERSION = '0.5.1'.freeze
+  VERSION = '0.6.1'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elastic-apm
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.1
 platform: ruby
 authors:
 - Mikkel Malmberg
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-26 00:00:00.000000000 Z
+date: 2018-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -106,6 +106,7 @@ files:
 - lib/elastic_apm/stacktrace/line_cache.rb
 - lib/elastic_apm/subscriber.rb
 - lib/elastic_apm/system_info.rb
+- lib/elastic_apm/timed_worker.rb
 - lib/elastic_apm/transaction.rb
 - lib/elastic_apm/util.rb
 - lib/elastic_apm/util/dig.rb
@@ -113,7 +114,6 @@ files:
 - lib/elastic_apm/util/inspector.rb
 - lib/elastic_apm/util/lru_cache.rb
 - lib/elastic_apm/version.rb
-- lib/elastic_apm/worker.rb
 - vendor/.gitkeep
 homepage: https://github.com/elastic/apm-agent-ruby
 licenses:
@@ -136,7 +136,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: The official Elastic APM agent for Ruby

data/lib/elastic_apm/worker.rb

@@ -1,46 +0,0 @@
-# frozen_string_literal: true
-
-module ElasticAPM
-  # @api private
-  class Worker
-    include Log
-
-    # @api private
-    class StopMessage; end
-
-    # @api private
-    Request = Struct.new(:path, :payload) do
-      # require all params
-      def initialize(path, payload)
-        super
-      end
-    end
-
-    def initialize(config, queue, adapter)
-      @config = config
-      @adapter = adapter
-      @queue = queue
-    end
-
-    def run_forever
-      loop do
-        while (item = @queue.pop)
-          case item
-          when Request
-            process item
-          when StopMessage
-            Thread.exit
-          end
-        end
-      end
-    end
-
-    def process(item)
-      @adapter.post(item.path, item.payload)
-    rescue ::Exception => e
-      fatal 'Failed posting: %s', e.inspect
-      debug e.backtrace.join("\n")
-      nil
-    end
-  end
-end