elastic-apm 1.1.0 → 2.0.0

data/lib/elastic_apm/agent.rb

@@ -5,16 +5,14 @@ require 'elastic_apm/context_builder'
 require 'elastic_apm/error_builder'
 require 'elastic_apm/stacktrace_builder'
 require 'elastic_apm/error'
-require 'elastic_apm/http'
+require 'elastic_apm/transport/base'
 require 'elastic_apm/spies'
-require 'elastic_apm/serializers'
-require 'elastic_apm/worker'
 
 module ElasticAPM
   # rubocop:disable Metrics/ClassLength
   # @api private
   class Agent
-    include Log
+    include Logging
 
     LOCK = Mutex.new
 
@@ -24,22 +22,11 @@ module ElasticAPM
       @instance
     end
 
-    def self.start(config) # rubocop:disable Metrics/MethodLength
+    def self.start(config)
       return @instance if @instance
 
       config = Config.new(config) unless config.is_a?(Config)
 
-      unless config.enabled_environments.include?(config.environment)
-        unless config.disable_environment_warning?
-          puts format(
-            '%sNot tracking anything in "%s" env',
-            Log::PREFIX, config.environment
-          )
-        end
-
-        return
-      end
-
       LOCK.synchronize do
         return @instance if @instance
 
@@ -62,25 +49,23 @@ module ElasticAPM
 
     def initialize(config)
       @config = config
-      @http = Http.new(config)
-
-      @messages = Queue.new
-      @pending_transactions = Queue.new
 
-      @instrumenter = Instrumenter.new(self)
+      @transport = Transport::Base.new(config)
+      @instrumenter = Instrumenter.new(config) { |event| enqueue event }
 
+      @stacktrace_builder = StacktraceBuilder.new(config)
       @context_builder = ContextBuilder.new(self)
       @error_builder = ErrorBuilder.new(self)
-      @stacktrace_builder = StacktraceBuilder.new(self)
     end
 
-    attr_reader :config, :messages, :pending_transactions, :instrumenter,
-      :context_builder, :stacktrace_builder, :http
+    attr_reader :config, :transport, :instrumenter,
+      :stacktrace_builder, :context_builder, :error_builder
 
     def start
-      debug '[%s] Starting agent, reporting to %s', VERSION, config.server_url
+      info '[%s] Starting agent, reporting to %s', VERSION, config.server_url
 
-      @instrumenter.start
+      transport.start
+      instrumenter.start
 
       config.enabled_spies.each do |lib|
         require "elastic_apm/spies/#{lib}"
@@ -90,9 +75,10 @@ module ElasticAPM
     end
 
     def stop
-      @instrumenter.stop
+      debug 'Stopping agent'
 
-      kill_worker
+      instrumenter.stop
+      transport.stop
 
       self
     end
@@ -101,29 +87,10 @@ module ElasticAPM
       stop
     end
 
-    # queues
+    # transport
 
-    def enqueue_transaction(transaction)
-      boot_worker unless worker_running?
-
-      pending_transactions.push(transaction)
-
-      return unless should_flush_transactions?
-
-      messages.push(Worker::FlushMsg.new)
-    end
-
-    def should_flush_transactions?
-      return true unless config.flush_interval
-      return true if pending_transactions.length >= config.max_queue_size
-
-      false
-    end
-
-    def enqueue_error(error)
-      boot_worker unless worker_running?
-
-      messages.push(Worker::ErrorMsg.new(error))
+    def enqueue(obj)
+      transport.submit obj
     end
 
     # instrumentation
@@ -132,26 +99,53 @@ module ElasticAPM
       instrumenter.current_transaction
     end
 
-    def transaction(name = nil, type = nil, context: nil, sampled: nil, &block)
-      instrumenter.transaction(
+    def current_span
+      instrumenter.current_span
+    end
+
+    def start_transaction(
+      name = nil,
+      type = nil,
+      context: nil,
+      traceparent: nil
+    )
+      instrumenter.start_transaction(
         name,
         type,
         context: context,
-        sampled: sampled,
-        &block
+        traceparent: traceparent
       )
     end
 
-    def span(name, type = nil, backtrace: nil, context: nil, &block)
-      instrumenter.span(
+    def end_transaction(result = nil)
+      instrumenter.end_transaction(result)
+    end
+
+    def start_span(name = nil, type = nil, backtrace: nil, context: nil)
+      instrumenter.start_span(
         name,
         type,
         backtrace: backtrace,
-        context: context,
-        &block
+        context: context
       )
     end
 
+    def end_span
+      instrumenter.end_span
+    end
+
+    def set_tag(key, value)
+      instrumenter.set_tag(key, value)
+    end
+
+    def set_custom_context(context)
+      instrumenter.set_custom_context(context)
+    end
+
+    def set_user(user)
+      instrumenter.set_user(user)
+    end
+
     def build_context(rack_env)
       @context_builder.build(rack_env)
     end
@@ -165,7 +159,7 @@ module ElasticAPM
         exception,
         handled: handled
       )
-      enqueue_error error
+      enqueue error
     end
 
     def report_message(message, backtrace: nil, **attrs)
@@ -174,58 +168,13 @@ module ElasticAPM
         backtrace: backtrace,
         **attrs
       )
-      enqueue_error error
-    end
-
-    # context
-
-    def set_tag(key, value)
-      instrumenter.set_tag(key, value)
+      enqueue error
     end
 
-    def set_custom_context(context)
-      instrumenter.set_custom_context(context)
-    end
-
-    def set_user(user)
-      instrumenter.set_user(user)
-    end
+    # filters
 
     def add_filter(key, callback)
-      @http.filters.add(key, callback)
-    end
-
-    def inspect
-      '<ElasticAPM::Agent>'
-    end
-
-    private
-
-    def boot_worker
-      debug 'Booting worker'
-
-      @worker_thread = Thread.new do
-        Worker.new(
-          config,
-          messages,
-          pending_transactions,
-          http
-        ).run_forever
-      end
-    end
-
-    def kill_worker
-      messages << Worker::StopMsg.new
-
-      if @worker_thread && !@worker_thread.join(5) # 5 secs
-        raise 'Failed to wait for worker, not all messages sent'
-      end
-
-      @worker_thread = nil
-    end
-
-    def worker_running?
-      @worker_thread && @worker_thread.alive?
+      transport.add_filter(key, callback)
     end
   end
   # rubocop:enable Metrics/ClassLength

data/lib/elastic_apm/config.rb

@@ -3,55 +3,45 @@
 require 'logger'
 require 'yaml'
 
+require 'elastic_apm/config/duration'
+require 'elastic_apm/config/size'
+
 module ElasticAPM
   # rubocop:disable Metrics/ClassLength
   # @api private
   class Config
     DEFAULTS = {
       config_file: 'config/elastic_apm.yml',
+
       server_url: 'http://localhost:8200',
 
+      api_buffer_size: 256,
+      api_request_size: '750kb',
+      api_request_time: '10s',
+      current_user_email_method: :email,
+      current_user_id_method: :id,
+      current_user_username_method: :username,
+      custom_key_filters: [],
+      default_tags: {},
+      disable_send: false,
+      disabled_spies: %w[json],
       environment: ENV['RAILS_ENV'] || ENV['RACK_ENV'],
-      enabled_environments: %w[production],
-      disable_environment_warning: false,
-      instrument: true,
-
-      log_path: nil,
-      log_level: Logger::DEBUG,
-
-      max_queue_size: 500,
-      flush_interval: 10,
-      transaction_sample_rate: 1.0,
-      transaction_max_spans: 500,
       filter_exception_types: [],
-
-      disable_send: false,
-      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,
-
+      ignore_url_patterns: [],
+      instrument: true,
+      instrumented_rake_tasks: [],
+      log_level: Logger::INFO,
+      log_path: nil,
+      pool_size: 1,
       source_lines_error_app_frames: 5,
-      source_lines_span_app_frames: 5,
       source_lines_error_library_frames: 0,
+      source_lines_span_app_frames: 5,
       source_lines_span_library_frames: 0,
-      span_frames_min_duration: 5,
-
-      disabled_spies: %w[json],
-      instrumented_rake_tasks: [],
-
-      default_tags: {},
-
-      current_user_id_method: :id,
-      current_user_email_method: :email,
-      current_user_username_method: :username,
-
-      custom_key_filters: [],
-      ignore_url_patterns: [],
+      span_frames_min_duration: '5ms',
+      transaction_max_spans: 500,
+      transaction_sample_rate: 1.0,
+      verify_server_cert: true,
 
       view_paths: [],
       root_path: Dir.pwd
@@ -61,49 +51,46 @@ module ElasticAPM
       'ELASTIC_APM_SERVER_URL' => 'server_url',
       'ELASTIC_APM_SECRET_TOKEN' => 'secret_token',
 
+      'ELASTIC_APM_API_BUFFER_SIZE' => [:int, 'api_buffer_size'],
+      'ELASTIC_APM_API_REQUEST_SIZE' => [:int, 'api_request_size'],
+      'ELASTIC_APM_API_REQUEST_TIME' => 'api_request_time',
+      'ELASTIC_APM_CUSTOM_KEY_FILTERS' => [:list, 'custom_key_filters'],
+      'ELASTIC_APM_DEFAULT_TAGS' => [:dict, 'default_tags'],
+      'ELASTIC_APM_DISABLED_SPIES' => [:list, 'disabled_spies'],
+      'ELASTIC_APM_DISABLE_SEND' => [:bool, 'disable_send'],
       'ELASTIC_APM_ENVIRONMENT' => 'environment',
-      'ELASTIC_APM_ENABLED_ENVIRONMENTS' => [:list, 'enabled_environments'],
-      'ELASTIC_APM_DISABLE_ENVIRONMENT_WARNING' =>
-        [:bool, 'disable_environment_warning'],
+      'ELASTIC_APM_FRAMEWORK_NAME' => 'framework_name',
+      'ELASTIC_APM_FRAMEWORK_VERSION' => 'framework_version',
+      'ELASTIC_APM_HOSTNAME' => 'hostname',
+      'ELASTIC_APM_IGNORE_URL_PATTERNS' => [:list, 'ignore_url_patterns'],
       'ELASTIC_APM_INSTRUMENT' => [:bool, 'instrument'],
-
-      'ELASTIC_APM_LOG_PATH' => 'log_path',
+      'ELASTIC_APM_INSTRUMENTED_RAKE_TASKS' =>
+        [:list, 'instrumented_rake_tasks'],
       'ELASTIC_APM_LOG_LEVEL' => [:int, 'log_level'],
-
+      'ELASTIC_APM_LOG_PATH' => 'log_path',
+      'ELASTIC_APM_POOL_SIZE' => [:int, 'pool_size'],
       'ELASTIC_APM_SERVICE_NAME' => 'service_name',
       'ELASTIC_APM_SERVICE_VERSION' => 'service_version',
-      'ELASTIC_APM_FRAMEWORK_NAME' => 'framework_name',
-      'ELASTIC_APM_FRAMEWORK_VERSION' => 'framework_version',
-      'ELASTIC_APM_HOSTNAME' => 'hostname',
-
       'ELASTIC_APM_SOURCE_LINES_ERROR_APP_FRAMES' =>
         [:int, 'source_lines_error_app_frames'],
-      'ELASTIC_APM_SOURCE_LINES_SPAN_APP_FRAMES' =>
-        [:int, 'source_lines_span_app_frames'],
       'ELASTIC_APM_SOURCE_LINES_ERROR_LIBRARY_FRAMES' =>
         [:int, 'source_lines_error_library_frames'],
+      'ELASTIC_APM_SOURCE_LINES_SPAN_APP_FRAMES' =>
+        [:int, 'source_lines_span_app_frames'],
       'ELASTIC_APM_SOURCE_LINES_SPAN_LIBRARY_FRAMES' =>
         [:int, 'source_lines_span_library_frames'],
-      'ELASTIC_APM_SPAN_FRAMES_MIN_DURATION' =>
-        [:int, 'span_frames_min_duration'],
-
-      'ELASTIC_APM_CUSTOM_KEY_FILTERS' => [:list, 'custom_key_filters'],
-      'ELASTIC_APM_IGNORE_URL_PATTERNS' => [:list, 'ignore_url_patterns'],
-
-      'ELASTIC_APM_MAX_QUEUE_SIZE' => [:int, 'max_queue_size'],
-      'ELASTIC_APM_FLUSH_INTERVAL' => 'flush_interval',
+      'ELASTIC_APM_SPAN_FRAMES_MIN_DURATION' => 'span_frames_min_duration',
+      'ELASTIC_APM_TRANSACTION_MAX_SPANS' => [:int, 'transaction_max_spans'],
       'ELASTIC_APM_TRANSACTION_SAMPLE_RATE' =>
         [:float, 'transaction_sample_rate'],
-      'ELASTIC_APM_VERIFY_SERVER_CERT' => [:bool, 'verify_server_cert'],
-      'ELASTIC_APM_TRANSACTION_MAX_SPANS' => [:int, 'transaction_max_spans'],
+      'ELASTIC_APM_VERIFY_SERVER_CERT' => [:bool, 'verify_server_cert']
+    }.freeze
 
-      'ELASTIC_APM_DISABLE_SEND' => [:bool, 'disable_send'],
-      'ELASTIC_APM_DISABLED_SPIES' => [:list, 'disabled_spies'],
-      'ELASTIC_APM_INSTRUMENTED_RAKE_TASKS' =>
-        [:list, 'instrumented_rake_tasks'],
+    DURATION_KEYS = %i[api_request_time span_frames_min_duration].freeze
+    DURATION_DEFAULT_UNITS = { span_frames_min_duration: 'ms' }.freeze
 
-      'ELASTIC_APM_DEFAULT_TAGS' => [:dict, 'default_tags']
-    }.freeze
+    SIZE_KEYS = %i[api_request_size].freeze
+    SIZE_DEFAULT_UNITS = { api_request_size: 'kb' }.freeze
 
     def initialize(options = {})
       set_defaults
@@ -112,9 +99,12 @@ module ElasticAPM
       set_from_config_file
       set_from_env
 
+      normalize_durations
+      normalize_sizes
+
       yield self if block_given?
 
-      build_logger if logger.nil? || log_path
+      build_logger if logger.nil?
     end
 
     attr_accessor :config_file
@@ -122,61 +112,49 @@ module ElasticAPM
     attr_accessor :server_url
     attr_accessor :secret_token
 
+    attr_accessor :api_buffer_size
+    attr_accessor :api_request_size
+    attr_accessor :api_request_time
+    attr_accessor :current_user_email_method
+    attr_accessor :current_user_id_method
+    attr_accessor :current_user_method
+    attr_accessor :current_user_username_method
+    attr_accessor :default_tags
+    attr_accessor :disable_send
+    attr_accessor :disabled_spies
     attr_accessor :environment
-    attr_accessor :enabled_environments
-    attr_accessor :disable_environment_warning
-    attr_accessor :instrument
-
-    attr_accessor :service_name
-    attr_accessor :service_version
+    attr_accessor :filter_exception_types
     attr_accessor :framework_name
     attr_accessor :framework_version
     attr_accessor :hostname
-
-    attr_accessor :log_path
+    attr_accessor :http_compression
+    attr_accessor :instrument
+    attr_accessor :instrumented_rake_tasks
     attr_accessor :log_level
+    attr_accessor :log_path
     attr_accessor :logger
-
-    attr_accessor :max_queue_size
-    attr_accessor :flush_interval
-    attr_accessor :transaction_sample_rate
-    attr_accessor :transaction_max_spans
-    attr_accessor :verify_server_cert
-    attr_accessor :filter_exception_types
-
-    attr_accessor :disable_send
-    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 :pool_size
+    attr_accessor :service_name
+    attr_accessor :service_version
     attr_accessor :source_lines_error_app_frames
-    attr_accessor :source_lines_span_app_frames
     attr_accessor :source_lines_error_library_frames
+    attr_accessor :source_lines_span_app_frames
     attr_accessor :source_lines_span_library_frames
-    attr_accessor :span_frames_min_duration
+    attr_accessor :transaction_max_spans
+    attr_accessor :transaction_sample_rate
+    attr_accessor :verify_server_cert
 
-    attr_accessor :disabled_spies
-    attr_accessor :instrumented_rake_tasks
+    attr_reader   :custom_key_filters
+    attr_reader   :ignore_url_patterns
+    attr_reader   :span_frames_min_duration
+    attr_reader   :span_frames_min_duration_us
 
     attr_accessor :view_paths
     attr_accessor :root_path
 
-    attr_accessor :current_user_method
-    attr_accessor :current_user_id_method
-    attr_accessor :current_user_email_method
-    attr_accessor :current_user_username_method
-
-    attr_accessor :default_tags
-
-    attr_reader   :custom_key_filters
-    attr_reader   :ignore_url_patterns
-
-    alias :disable_environment_warning? :disable_environment_warning
     alias :disable_send? :disable_send
+    alias :http_compression? :http_compression
+    alias :instrument? :instrument
     alias :verify_server_cert? :verify_server_cert
 
     def app=(app)
@@ -186,7 +164,6 @@ module ElasticAPM
       when :rails
         set_rails(app)
       else
-        # TODO: define custom?
         self.service_name = 'ruby'
       end
     end
@@ -221,6 +198,7 @@ module ElasticAPM
         action_dispatch
         delayed_job
         elasticsearch
+        http
         json
         mongo
         net_http
@@ -238,6 +216,32 @@ module ElasticAPM
       available_spies - disabled_spies
     end
 
+    def span_frames_min_duration=(duration)
+      @span_frames_min_duration = duration
+      @span_frames_min_duration_us = duration * 1_000_000
+    end
+
+    DEPRECATED_OPTIONS = %i[
+      compression_level=
+      compression_minimum_size=
+      debug_http=
+      debug_transactions=
+      flush_interval=
+      http_open_timeout=
+      http_read_timeout=
+      enabled_environments=
+      disable_environment_warning=
+    ].freeze
+
+    def respond_to_missing?(name)
+      DEPRECATED_OPTIONS.include? name
+    end
+
+    def method_missing(name, *args)
+      return super unless DEPRECATED_OPTIONS.include?(name)
+      warn "The option `#{name}' has been removed."
+    end
+
     private
 
     def assign(options)
@@ -251,6 +255,7 @@ module ElasticAPM
     end
 
     # rubocop:disable Metrics/MethodLength, Metrics/CyclomaticComplexity
+    # rubocop:disable Metrics/AbcSize
     def set_from_env
       ENV_TO_KEY.each do |env_key, key|
         next unless (value = ENV[env_key])
@@ -270,6 +275,7 @@ module ElasticAPM
         send("#{key}=", value)
       end
     end
+    # rubocop:enable Metrics/AbcSize
     # rubocop:enable Metrics/MethodLength, Metrics/CyclomaticComplexity
 
     def set_from_args(options)
@@ -299,7 +305,7 @@ module ElasticAPM
     end
 
     def build_logger
-      logger = Logger.new(log_path == '-' ? $stdout : log_path)
+      logger = Logger.new(log_path == '-' ? STDOUT : log_path)
       logger.level = log_level
 
       self.logger = logger
@@ -308,6 +314,24 @@ module ElasticAPM
     def format_name(str)
       str.gsub('::', '_')
     end
+
+    def normalize_durations
+      DURATION_KEYS.each do |key|
+        value = send(key).to_s
+        default_unit = DURATION_DEFAULT_UNITS.fetch(key, 's')
+        duration = Duration.parse(value, default_unit: default_unit)
+        send("#{key}=", duration.seconds)
+      end
+    end
+
+    def normalize_sizes
+      SIZE_KEYS.each do |key|
+        value = send(key).to_s
+        default_unit = SIZE_DEFAULT_UNITS.fetch(key, 'b')
+        size = Size.parse(value, default_unit: default_unit)
+        send("#{key}=", size.bytes)
+      end
+    end
   end
   # rubocop:enable Metrics/ClassLength
 end