elastic-apm 0.7.4 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 34b8dc72e1bc64618a6d3b3654ccdef57bdf3c596d875397b9f76df8236a0fef
-  data.tar.gz: ba96b0160a873f20c840c3151bb1665d0c7c7bcb3fa6157c506107cae32197b1
+  metadata.gz: 3de476b7401d77bda31a38d7ba12a62eba3d0baa31827ad4ce255adaeb1d406d
+  data.tar.gz: e2f1752eeea668ab5dcbb3ea0f9eaea6b8378a40a8196350b08a3b03ada9c013
 SHA512:
-  metadata.gz: 243f5ba02db88ca818d432679862b3bb0cd6469f305bf75391d4f180345228c6d0d11a7a60fc43a3e0276d58ead39933bd7450665cd799cf667fa9782f0bf9c2
-  data.tar.gz: 26c7e98aa546c255a6b42e7a34d4b99680bc30de2225a2a3b697fae0f0b76d9326e13fe16f7ddcf65d58508a14aa9d80f5dec69c15169517479cb61d87de6c78
+  metadata.gz: 28ceced097366bc0576da434bfd9e8c21924335caf7dba8e09df3cc25cd1510b063aa79a2b3df103b6c5903d07191ed62a4dae5ab2ecf62e0650ed1451420145
+  data.tar.gz: b1ca5cf053a35c9b07ee8255363257e023cdc0c1e9d0f948c1591bdfd8dcba7e5239704996b43d59f2c81acd5bf7d2df531c5acee02fd8a3d048fd71ab9de7ff

data/.gitignore

@@ -13,3 +13,4 @@
 Gemfile.lock
 /html_docs/
 spec/elastic_apm.log
+spec/ruby-agent-junit.xml

data/CHANGELOG.md

@@ -0,0 +1,31 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+This project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+## 0.8.0 (2018-06-13)
+
+### Added
+
+- Added an option to disable metrics collection ([#145](https://github.com/elastic/apm-agent-ruby/pulls/145))
+- Filters can cancel the entire payload by returning `nil` ([#148](https://github.com/elastic/apm-agent-ruby/pulls/148))
+- Added `ENV` version of the logging options ([#146](https://github.com/elastic/apm-agent-ruby/pull/146))
+- Added `config.ignore_url_patterns` ([#151](https://github.com/elastic/apm-agent-ruby/pull/151))
+
+### Changed
+
+- Use concurrent-ruby's TimerTask instead of `Thread#sleep`. Adds dependency on `concurrent-ruby`. ([#141](https://github.com/elastic/apm-agent-ruby/pull/141))
+
+### Fixed
+
+- Remove newline on `hostname`
+- Fixed ActionMailer spans renaming their transaction
+
+## 0.7.4 - 2018-06-07
+
+Beginning of this document
+
+### Fixed
+
+- Fix overwriting custom logger with Rails'

data/docs/api.asciidoc

@@ -260,14 +260,17 @@ Arguments:
 
 Return the altered payload.
 
+If `nil` is returned all subsequent filters will be skipped and the post request cancelled.
+
 Example:
 
 [source,ruby]
 ----
 ElasticAPM.add_filter(:filter_pings) do |payload|
-  payload['transactions']&.reject! do |t|
-    t['name'] == 'PingsController#index'
+  payload[:transactions]&.reject! do |t|
+    t[:name] == 'PingsController#index'
   end
+  payload
 end
 ----
 
@@ -275,17 +278,72 @@ end
 [[api-transaction]]
 === Transaction
 
-Things
+`ElasticAPM.transaction` returns a `Transaction` (if the agent is running).
+
+[float]
+==== Properties
+
+- `name`: String
+- `type`: String
+
+[float]
+[[api-transaction-release]]
+==== `#release`
+
+Makes sure the transaction is no longer `ElasticAPM.current_transaction`.
+
+[float]
+[[api-transaction-done]]
+==== `#done(result)`
+
+*Args:*
+
+- `result`: String result of transaction, eg. `success`. Default: `nil`.
+
+Ends the transaction, settings its `duration` to µs since it began and sets its result.
+
+Returns `self`.
+
+[float]
+[[api-transaction-done_]]
+==== `#done?`
+
+Returns whether the transaction is done.
+
+[float]
+[[api-transaction-submit]]
+==== `#submit(result, status:, headers:)`
+
+*Args:*
+
+- `result`: String result of transaction, eg. `success`. Default: `nil`.
+- `status`: HTTP status code (for request transactions). Default: `nil`.
+- `headers`: HTTP headers (for request transactions). Default: `{}`.
+
+Ends transaction with done, adds HTTP request information, releases it and submits
+it to the queue of transactions waiting to be sent to APM Server.
+
+Returns `self`.
+
+[float]
+[[api-transaction-sampled_]]
+==== #sampled?
+
+Whether the transaction is _sampled_ eg. it includes stacktraces for its spans.
 
 [float]
 [[api-span]]
 === Span
 
-Things
+[float]
+==== Properties
+
+- `name`: String
+- `type`: String
 
 [float]
 [[api-context]]
 === Context
 
-Things
+A `Context` provides more information to transactions. Build one with `ElasticAPM.build_context`.
 

data/docs/configuration.asciidoc

@@ -209,6 +209,48 @@ otherwise, the default is `nil`.
 
 The host name to use when sending error and transaction data to the APM server.
 
+[float]
+[[config-log-path]]
+==== `log_path`
+
+[options="header"]
+|============
+| Environment            | `Config` key | Default | Example
+| `ELASTIC_APM_LOG_PATH` | `log_path`   | `nil`   | `log/elastic_apm.log`
+|============
+
+A path to a log file.
+
+By default Elastic APM logs to `stdout` or uses `Rails.log` when used with Rails.
+
+Should support both absolute and relative paths. Just make sure the directory exists.
+
+[float]
+[[config-log-level]]
+==== `log_level`
+
+[options="header"]
+|============
+| Environment             | `Config` key | Default
+| `ELASTIC_APM_LOG_LEVEL` | `log_level`  | `Logger::DEBUG # => 0`
+|============
+
+By default Elastic APM logs to `stdout` or uses `Rails.log` when used with Rails.
+
+[float]
+[[config-logger]]
+==== `logger`
+
+[options="header"]
+|============
+| Environment | `Config` key | Default | Example
+| N/A         | `logger`     | Depends | `Logger.new('path/to_file.log')`
+|============
+
+By default Elastic APM logs to `stdout` or uses `Rails.log` when used with Rails.
+
+Use this to provide another logger. Expected to have the same API as Ruby's built-in `Logger`.
+
 [float]
 [[config-source-lines-error-app-frames]]
 ==== `source_lines_error_app_frames`
@@ -361,6 +403,25 @@ https://github.com/elastic/apm-agent-ruby/blob/1.x/lib/elastic_apm/filters/secre
 what looks like confidential information] from the request/response headers.
 Use this option to add your own custom header keys to the list of filtered keys.
 
+When setting this option via `ENV`, use a comma separated string.
+Eg. `ELASTIC_APM_CUSTOM_KEY_FILTERS="a,b" # => [/a/, /b/]`
+
+[float]
+[[config-custom-ignore-url-patterns]]
+==== `ignore_url_patterns`
+[options="header"]
+|============
+| Environment                       | `Config` key          | Default | Example
+| `ELASTIC_APM_IGNORE_URL_PATTERNS` | `ignore_url_patterns` | `[]`    | `['^/ping', %r{^/admin}]`
+|============
+
+Use this option to ignroe certain URL patterns eg. healthchecks or admin sections.
+
+_Ignoring_ in this context means _don't wrap in a <<api-transaction,Transaction>>_.
+Errors will still be reported.
+
+When setting this option via `ENV`, use a comma separated string.
+Eg. `ELASTIC_APM_IGNORE_URL_PATTERNS="a,b" # => [/a/, /b/]`
 
 [float]
 [[config-filter-exception-types]]

data/elastic-apm.gemspec

@@ -18,5 +18,7 @@ Gem::Specification.new do |spec|
     f.match(%r{^(test|spec|features)/})
   end
 
+  spec.add_dependency('concurrent-ruby', '~> 1.0.0')
+
   spec.require_paths = ['lib']
 end

data/lib/elastic_apm/agent.rb

@@ -8,7 +8,7 @@ require 'elastic_apm/error'
 require 'elastic_apm/http'
 require 'elastic_apm/spies'
 require 'elastic_apm/serializers'
-require 'elastic_apm/timed_worker'
+require 'elastic_apm/worker'
 
 module ElasticAPM
   # rubocop:disable Metrics/ClassLength
@@ -107,12 +107,23 @@ module ElasticAPM
       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(TimedWorker::ErrorMsg.new(error))
+      messages.push(Worker::ErrorMsg.new(error))
     end
 
     # instrumentation
@@ -182,7 +193,7 @@ module ElasticAPM
       debug 'Booting worker'
 
       @worker_thread = Thread.new do
-        TimedWorker.new(
+        Worker.new(
           config,
           messages,
           pending_transactions,
@@ -192,7 +203,7 @@ module ElasticAPM
     end
 
     def kill_worker
-      messages << TimedWorker::StopMsg.new
+      messages << Worker::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

@@ -14,6 +14,7 @@ module ElasticAPM
       environment: ENV['RAILS_ENV'] || ENV['RACK_ENV'],
       enabled_environments: %w[production],
       disable_environment_warning: false,
+      instrument: true,
 
       log_path: nil,
       log_level: Logger::DEBUG,
@@ -46,6 +47,7 @@ module ElasticAPM
       current_user_username_method: :username,
 
       custom_key_filters: [],
+      ignore_url_patterns: [],
 
       view_paths: [],
       root_path: Dir.pwd
@@ -59,6 +61,10 @@ module ElasticAPM
       'ELASTIC_APM_ENABLED_ENVIRONMENTS' => [:list, 'enabled_environments'],
       'ELASTIC_APM_DISABLE_ENVIRONMENT_WARNING' =>
         [:bool, 'disable_environment_warning'],
+      'ELASTIC_APM_INSTRUMENT' => [:bool, 'instrument'],
+
+      'ELASTIC_APM_LOG_PATH' => 'log_path',
+      'ELASTIC_APM_LOG_LEVEL' => [:int, 'log_level'],
 
       'ELASTIC_APM_SERVICE_NAME' => 'service_name',
       'ELASTIC_APM_SERVICE_VERSION' => 'service_version',
@@ -78,6 +84,7 @@ module ElasticAPM
         [: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',
@@ -109,6 +116,7 @@ module ElasticAPM
     attr_accessor :environment
     attr_accessor :enabled_environments
     attr_accessor :disable_environment_warning
+    attr_accessor :instrument
 
     attr_accessor :service_name
     attr_accessor :service_version
@@ -152,6 +160,7 @@ module ElasticAPM
     attr_accessor :current_user_username_method
 
     attr_reader   :custom_key_filters
+    attr_reader   :ignore_url_patterns
 
     alias :disable_environment_warning? :disable_environment_warning
     alias :verify_server_cert? :verify_server_cert
@@ -188,6 +197,10 @@ module ElasticAPM
       @custom_key_filters = Array(filters).map(&Regexp.method(:new))
     end
 
+    def ignore_url_patterns=(strings)
+      @ignore_url_patterns = Array(strings).map(&Regexp.method(:new))
+    end
+
     # rubocop:disable Metrics/MethodLength
     def available_spies
       %w[

data/lib/elastic_apm/filters.rb

@@ -32,7 +32,9 @@ module ElasticAPM
 
       def apply(payload)
         @filters.reduce(payload) do |result, (_key, filter)|
-          filter.call(result)
+          result = filter.call(result)
+          break if result.nil?
+          result
         end
       end
 

data/lib/elastic_apm/http.rb

@@ -33,7 +33,9 @@ module ElasticAPM
 
     def post(path, payload = {})
       payload.merge! @base_payload
-      filters.apply(payload)
+
+      payload = filters.apply(payload)
+      return if payload.nil?
 
       request = prepare_request path, payload.to_json
       response = @adapter.perform request

data/lib/elastic_apm/instrumenter.rb

@@ -55,8 +55,14 @@ module ElasticAPM
       @transaction_info.current = transaction
     end
 
-    # rubocop:disable Metrics/MethodLength
+    # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+    # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
     def transaction(*args)
+      unless config.instrument
+        yield if block_given?
+        return
+      end
+
       if (transaction = current_transaction)
         yield transaction if block_given?
         return transaction
@@ -82,7 +88,8 @@ module ElasticAPM
 
       transaction
     end
-    # rubocop:enable Metrics/MethodLength
+    # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+    # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
 
     def random_sample?
       rand <= config.transaction_sample_rate

data/lib/elastic_apm/middleware.rb

@@ -7,19 +7,16 @@ module ElasticAPM
       @app = app
     end
 
-    # rubocop:disable Metrics/MethodLength
+    # rubocop:disable Metrics/CyclomaticComplexity, Metrics/MethodLength
     def call(env)
       begin
-        transaction = ElasticAPM.transaction 'Rack', 'request',
-          context: ElasticAPM.build_context(env)
+        if running? && !path_ignored?(env)
+          transaction = build_transaction(env)
+        end
 
         resp = @app.call env
-        status, headers, = resp
 
-        if transaction
-          result = "HTTP #{status.to_s[0]}xx"
-          transaction.submit(result, status: status, headers: headers)
-        end
+        submit_transaction(transaction, *resp) if transaction
       rescue InternalError
         raise # Don't report ElasticAPM errors
       rescue ::Exception => e
@@ -32,6 +29,30 @@ module ElasticAPM
 
       resp
     end
-    # rubocop:enable Metrics/MethodLength
+    # rubocop:enable Metrics/CyclomaticComplexity, Metrics/MethodLength
+
+    def submit_transaction(transaction, status, headers, _body)
+      result = "HTTP #{status.to_s[0]}xx"
+      transaction.submit(result, status: status, headers: headers)
+    end
+
+    def path_ignored?(env)
+      config.ignore_url_patterns.any? do |r|
+        env['PATH_INFO'] =~ r
+      end
+    end
+
+    def build_transaction(env)
+      ElasticAPM.transaction 'Rack', 'request',
+        context: ElasticAPM.build_context(env)
+    end
+
+    def running?
+      ElasticAPM.running?
+    end
+
+    def config
+      ElasticAPM.agent.config
+    end
   end
 end

data/lib/elastic_apm/normalizers/action_mailer.rb

@@ -8,9 +8,8 @@ module ElasticAPM
         register 'process.action_mailer'
         TYPE = 'app.mailer.action'.freeze
 
-        def normalize(transaction, _name, payload)
-          transaction.name = endpoint(payload)
-          [transaction.name, TYPE, nil]
+        def normalize(_transaction, _name, payload)
+          [endpoint(payload), TYPE, nil]
         end
 
         private

data/lib/elastic_apm/span.rb

@@ -30,8 +30,8 @@ module ElasticAPM
     end
     # rubocop:enable Metrics/ParameterLists
 
-    attr_accessor :name, :context, :type, :stacktrace, :original_backtrace
-    attr_reader :id, :duration, :parent, :relative_start
+    attr_accessor :name, :type, :original_backtrace
+    attr_reader :id, :context, :stacktrace, :duration, :parent, :relative_start
 
     def start
       @relative_start = Util.micros - @transaction.timestamp
@@ -43,7 +43,7 @@ module ElasticAPM
       @duration = Util.micros - @transaction.timestamp - relative_start
 
       if original_backtrace && long_enough_for_stacktrace?
-        self.stacktrace =
+        @stacktrace =
           @transaction.instrumenter.agent.stacktrace_builder.build(
             original_backtrace, type: :span
           )

data/lib/elastic_apm/system_info.rb

@@ -9,7 +9,7 @@ module ElasticAPM
 
     def build
       {
-        hostname: @config.hostname || `hostname`,
+        hostname: @config.hostname || `hostname`.chomp,
         architecture: platform.cpu,
         platform: platform.os
       }

data/lib/elastic_apm/transaction.rb

@@ -3,7 +3,6 @@
 require 'securerandom'
 
 module ElasticAPM
-  # rubocop:disable Metrics/ClassLength
   # @api private
   class Transaction
     DEFAULT_TYPE = 'custom'.freeze
@@ -37,9 +36,9 @@ module ElasticAPM
     end
     # rubocop:enable Metrics/MethodLength
 
-    attr_accessor :id, :name, :result, :type
-    attr_reader :context, :duration, :dropped_spans, :root_span, :timestamp,
-      :spans, :notifications, :sampled, :instrumenter
+    attr_accessor :name, :type
+    attr_reader :id, :context, :duration, :dropped_spans, :root_span,
+      :timestamp, :spans, :result, :notifications, :sampled, :instrumenter
 
     def release
       @instrumenter.current_transaction = nil
@@ -53,7 +52,7 @@ module ElasticAPM
     end
 
     def done?
-      !!(@result && @duration)
+      !!@duration
     end
 
     def submit(result = nil, status: nil, headers: {})
@@ -70,10 +69,6 @@ module ElasticAPM
       self
     end
 
-    def running_spans
-      spans.select(&:running?)
-    end
-
     # rubocop:disable Metrics/MethodLength
     def span(name, type = nil, backtrace: nil, context: nil)
       unless sampled?
@@ -102,17 +97,6 @@ module ElasticAPM
     end
     # rubocop:enable Metrics/MethodLength
 
-    def build_and_start_span(name, type, context, backtrace)
-      span = next_span(name, type, context)
-      spans << span
-
-      if backtrace && span_frames_min_duration?
-        span.original_backtrace = backtrace
-      end
-
-      span.start
-    end
-
     def current_span
       spans.reverse.lazy.find(&:running?)
     end
@@ -148,6 +132,16 @@ module ElasticAPM
     def span_frames_min_duration?
       @instrumenter.agent.config.span_frames_min_duration != 0
     end
+
+    def build_and_start_span(name, type, context, backtrace)
+      span = next_span(name, type, context)
+      spans << span
+
+      if backtrace && span_frames_min_duration?
+        span.original_backtrace = backtrace
+      end
+
+      span.start
+    end
   end
-  # rubocop:enable Metrics/ClassLength
 end

data/lib/elastic_apm/version.rb

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

data/lib/elastic_apm/{timed_worker.rb → worker.rb}

@@ -1,15 +1,17 @@
 # frozen_string_literal: true
 
+require 'concurrent/timer_task'
+
 module ElasticAPM
   # @api private
-  class TimedWorker
+  class Worker
     include Log
 
-    SLEEP_INTERVAL = 0.1
+    # @api private
+    class StopMsg; end
 
     # @api private
-    class StopMsg
-    end
+    class FlushMsg; end
 
     # @api private
     class ErrorMsg
@@ -26,8 +28,6 @@ module ElasticAPM
       @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)
@@ -36,46 +36,43 @@ module ElasticAPM
 
     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
+    def run_forever
+      @timer_task = build_timer_task.execute
 
-      while (msg = messages.pop(true))
+      while (msg = messages.pop)
         case msg
         when ErrorMsg
           post_error msg
+        when FlushMsg
+          collect_and_send_transactions
         when StopMsg
-          should_exit = true
-
           # empty collected transactions before exiting
           collect_and_send_transactions
+          stop!
         end
       end
-    rescue ThreadError # queue empty
-      Thread.exit if should_exit
     end
     # rubocop:enable Metrics/MethodLength
 
+    private
+
+    def stop!
+      @timer_task && @timer_task.shutdown
+      Thread.exit
+    end
+
+    def build_timer_task
+      Concurrent::TimerTask.new(execution_interval: config.flush_interval) do
+        messages.push(FlushMsg.new)
+      end
+    end
+
     def post_error(msg)
       payload = @serializers.errors.build_all([msg.error])
       @adapter.post('/v1/errors', payload)
     end
 
-    # rubocop:disable Metrics/MethodLength
     def collect_and_send_transactions
       return if pending_transactions.empty?
 
@@ -90,10 +87,7 @@ module ElasticAPM
         debug e.backtrace.join("\n")
         nil
       end
-
-      @last_sent_transactions = Time.now
     end
-    # rubocop:enable Metrics/MethodLength
 
     def collect_batched_transactions
       batch = []
@@ -108,14 +102,5 @@ module ElasticAPM
 
       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

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: elastic-apm
 version: !ruby/object:Gem::Version
-  version: 0.7.4
+  version: 0.8.0
 platform: ruby
 authors:
 - Mikkel Malmberg
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-07 00:00:00.000000000 Z
-dependencies: []
+date: 2018-06-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
 description: 
 email:
 - mikkel@elastic.co
@@ -22,6 +36,7 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE
@@ -95,7 +110,6 @@ files:
 - lib/elastic_apm/stacktrace_builder.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
@@ -103,6 +117,7 @@ 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: