elastic-apm 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c00a8dd4ed640c7c98fa3b32f0a252920237e549a10d6592de58d6d4b281ab48
-  data.tar.gz: 3fc4f34aab25ace89c0b689747316245b667bc77b348c4d9d2b08605681179ff
+  metadata.gz: 61f733d62bd857f1f2b7e505d7bc2007422b8bd35219eff02c9c3b8c27c5264c
+  data.tar.gz: e5626d4e88f9aef2ca50a285530872f7a1cd6f2935135a196de51a90dd6b7aa8
 SHA512:
-  metadata.gz: 6062baf5ed08855d53781d589ff7266b784af1b231511327b527619229743d570868e319be7cb060770bd436a92df24955807e6c8cfcbdb80151d29ac7e7b9fb
-  data.tar.gz: 9516bd876fbfd8c6061b189b603923bb37f740492904d40c10180603f09b0d86a0f97e198962a66570b59851c1fa8e666066f3e4cf51a469ccaa04dfbf5e6955
+  metadata.gz: cc95fa28fe7acb5d81f3bc41c4b424b0732fcb9e8c79bf1b9687ba8a4ea153fdf9eef346f058ed6fa0e40de845a107fb7004c4abbfebaf34ea9f0d182bda4246
+  data.tar.gz: 91f2bc3ab67a4ccbd66c8423c2c65f88701ba99e0048479263555aa63188c2c009744c1393fd54d6230df6e20ecfa8dd7f26e24da2fdbc4bae6fea6b065048c1

data/lib/elastic_apm.rb

@@ -62,9 +62,7 @@ module ElasticAPM
   # @yield [Transaction] Optional block encapsulating transaction
   # @return [Transaction] Unless block given
   def self.transaction(name, type = nil, context: nil, &block)
-    unless agent
-      return block_given? ? yield : nil
-    end
+    return (block_given? ? yield : nil) unless agent
 
     agent.transaction(name, type, context: context, &block)
   end
@@ -78,9 +76,7 @@ module ElasticAPM
   # @return [Span] Unless block given
   def self.span(name, type = nil, context: nil, include_stacktrace: true,
     &block)
-    unless agent
-      return block_given? ? yield : nil
-    end
+    return (block_given? ? yield : nil) unless agent
 
     agent.span(
       name,

data/lib/elastic_apm/agent.rb

@@ -23,15 +23,26 @@ module ElasticAPM
       @instance
     end
 
+    # rubocop:disable Metrics/MethodLength
     def self.start(config)
       return @instance if @instance
 
+      config = Config.new(config) if config.is_a?(Hash)
+
+      unless config.enabled_environments.include?(config.environment)
+        config.logger && config.logger.info(
+          format('Not tracking anything in "%s" env', config.environment)
+        )
+        return
+      end
+
       LOCK.synchronize do
         return @instance if @instance
 
         @instance = new(config.freeze).start
       end
     end
+    # rubocop:enable Metrics/MethodLength
 
     def self.stop
       LOCK.synchronize do
@@ -46,10 +57,7 @@ module ElasticAPM
       !!@instance
     end
 
-    # rubocop:disable Metrics/MethodLength
     def initialize(config)
-      config = Config.new(config) if config.is_a?(Hash)
-
       @config = config
 
       @http = Http.new(config)
@@ -64,17 +72,14 @@ module ElasticAPM
         Serializers::Errors.new(config)
       )
     end
-    # rubocop:enable Metrics/MethodLength
 
     attr_reader :config, :queue, :instrumenter, :context_builder, :http
 
     def start
-      debug 'Starting agent reporting to %s', config.server_url
+      debug '[%s] Starting agent, reporting to %s', VERSION, config.server_url
 
       @instrumenter.start
 
-      boot_worker
-
       config.enabled_injectors.each do |lib|
         require "elastic_apm/injectors/#{lib}"
       end
@@ -83,8 +88,6 @@ module ElasticAPM
     end
 
     def stop
-      debug 'Stopping agent'
-
       @instrumenter.stop
 
       kill_worker
@@ -97,12 +100,16 @@ module ElasticAPM
     end
 
     def enqueue_transactions(transactions)
+      boot_worker unless worker_running?
+
       data = @serializers.transactions.build_all(transactions)
       @queue << Worker::Request.new('/v1/transactions', data)
       transactions
     end
 
     def enqueue_errors(errors)
+      boot_worker unless worker_running?
+
       data = @serializers.errors.build_all(errors)
       @queue << Worker::Request.new('/v1/errors', data)
       errors
@@ -129,6 +136,8 @@ module ElasticAPM
     # errors
 
     def report(exception, handled: true)
+      return if config.filter_exception_types.include?(exception.class.to_s)
+
       error = @error_builder.build_exception(
         exception,
         handled: handled
@@ -170,7 +179,7 @@ module ElasticAPM
     private
 
     def boot_worker
-      debug 'Booting worker in thread'
+      debug 'Booting worker'
 
       @worker_thread = Thread.new do
         Worker.new(@config, @queue, @http).run_forever
@@ -180,13 +189,15 @@ module ElasticAPM
     def kill_worker
       @queue << Worker::StopMessage.new
 
-      unless @worker_thread.join(5) # 5 secs
+      if @worker_thread && !@worker_thread.join(5) # 5 secs
         raise 'Failed to wait for worker, not all messages sent'
       end
 
       @worker_thread = nil
+    end
 
-      debug 'Killed worker'
+    def worker_running?
+      @worker_thread && @worker_thread.alive?
     end
   end
   # rubocop:enable Metrics/ClassLength

data/lib/elastic_apm/config.rb

@@ -13,6 +13,7 @@ module ElasticAPM
       service_name: nil,
       service_version: nil,
       environment: ENV['RAILS_ENV'] || ENV['RACK_ENV'],
+      enabled_environments: %w[production],
       framework_name: nil,
       framework_version: nil,
       hostname: nil,
@@ -25,6 +26,7 @@ module ElasticAPM
       flush_interval: 10,
       transaction_sample_rate: 1.0,
       transaction_max_spans: 500,
+      filter_exception_types: [],
 
       http_timeout: 10,
       http_open_timeout: 10,
@@ -54,6 +56,7 @@ module ElasticAPM
       'ELASTIC_APM_SERVICE_NAME' => 'service_name',
       'ELASTIC_APM_SERVICE_VERSION' => 'service_version',
       'ELASTIC_APM_ENVIRONMENT' => 'environment',
+      'ELASTIC_APM_ENABLED_ENVIRONMENTS' => [:list, 'enabled_environments'],
       'ELASTIC_APM_FRAMEWORK_NAME' => 'framework_name',
       'ELASTIC_APM_FRAMEWORK_VERSION' => 'framework_version',
       'ELASTIC_APM_HOSTNAME' => 'hostname',
@@ -94,6 +97,7 @@ module ElasticAPM
     attr_accessor :framework_name
     attr_accessor :framework_version
     attr_accessor :hostname
+    attr_accessor :enabled_environments
 
     attr_accessor :log_path
     attr_accessor :log_level
@@ -103,6 +107,7 @@ module ElasticAPM
     attr_accessor :transaction_sample_rate
     attr_accessor :transaction_max_spans
     attr_accessor :verify_server_cert
+    attr_accessor :filter_exception_types
 
     attr_accessor :http_timeout
     attr_accessor :http_open_timeout
@@ -168,7 +173,7 @@ module ElasticAPM
       end
     end
 
-    # rubocop:disable Metrics/MethodLength
+    # rubocop:disable Metrics/MethodLength, Metrics/CyclomaticComplexity
     def set_from_env
       ENV_TO_KEY.each do |env_key, key|
         next unless (value = ENV[env_key])
@@ -180,13 +185,14 @@ module ElasticAPM
           when :int then value.to_i
           when :float then value.to_f
           when :bool then !%w[0 false].include?(value.strip.downcase)
+          when :list then value.split(/[ ,]/)
           else value
           end
 
         send("#{key}=", value)
       end
     end
-    # rubocop:enable Metrics/MethodLength
+    # rubocop:enable Metrics/MethodLength, Metrics/CyclomaticComplexity
 
     def set_from_args(options)
       options.each do |key, value|

data/lib/elastic_apm/instrumenter.rb

@@ -127,7 +127,7 @@ module ElasticAPM
     def flush_transactions
       return if @pending_transactions.empty?
 
-      debug 'Flushing transactions'
+      debug 'Sending %i transactions', @pending_transactions.length
 
       @agent.enqueue_transactions @pending_transactions
 

data/lib/elastic_apm/log.rb

@@ -3,7 +3,7 @@
 module ElasticAPM
   # @api private
   module Log
-    PREFIX = '** [ElasticAPM] '.freeze
+    PREFIX = '[ElasticAPM] '.freeze
 
     def debug(msg, *args, &block)
       log(:debug, msg, *args, &block)

data/lib/elastic_apm/railtie.rb

@@ -4,7 +4,6 @@ module ElasticAPM
   # @api private
   class Railtie < Rails::Railtie
     config.elastic_apm = ActiveSupport::OrderedOptions.new
-    Config::DEFAULTS.each { |option, value| config.elastic_apm[option] = value }
 
     initializer 'elastic_apm.initialize' do |app|
       config = Config.new app.config.elastic_apm do |c|
@@ -18,7 +17,6 @@ module ElasticAPM
 
       begin
         ElasticAPM.start config
-        Rails.logger.info "#{Log::PREFIX}Running"
 
         app.middleware.insert 0, Middleware
       rescue StandardError => e

data/lib/elastic_apm/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elastic-apm
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Mikkel Malmberg
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-13 00:00:00.000000000 Z
+date: 2018-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport